@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.bb31388

package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx

@@ -0,0 +1,119 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo file sharinglink list
+
+Lists all the sharing links of a specific file
+
+## Usage
+
+```sh
+m365 spo file sharinglink list [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located.
+
+`--fileUrl [fileUrl]`
+: The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`--fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`-s, --scope [scope]`
+: Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
+```
+
+<Global />
+
+## Examples
+
+List sharing links of a file by id
+
+```sh
+m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234
+```
+
+List sharing links of a file by url
+
+```sh
+m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx"
+```
+
+List anonymous sharing links of a file by url
+
+```sh
+m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx" --scope anonymous
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "2a021f54-90a2-4016-b3b3-5f34d2e7d932",
+      "roles": [
+        "read"
+      ],
+      "hasPassword": false,
+      "grantedToIdentitiesV2": [
+        {
+          "user": {
+            "displayName": "John Doe",
+            "email": "john@contoso.onmicrosoft.com",
+            "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a"
+          },
+          "siteUser": {
+            "displayName": "John Doe",
+            "email": "john@contoso.onmicrosoft.com",
+            "id": "9",
+            "loginName": "i:0#.f|membership|john@contoso.onmicrosoft.com"
+          }
+        }
+      ],
+      "grantedToIdentities": [ 
+        {
+          "user": {
+            "displayName": "John Doe",
+            "email": "john@contoso.onmicrosoft.com",
+            "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a"
+          }
+        }
+      ],
+      "link": {
+        "scope": "organization",
+        "type": "view",
+        "webUrl": "https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A",
+        "preventsDownload": false
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                    scope         roles  link                                                            
+  ------------------------------------  ------------  -----  ----------------------------------------------------------------------------------------
+  2a021f54-90a2-4016-b3b3-5f34d2e7d932  organization  read   https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,scope,roles,link
+  2a021f54-90a2-4016-b3b3-5f34d2e7d932,organization,read,https://contoso.sharepoint.com/:w:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/file/file-sharinglink-remove.mdx

@@ -0,0 +1,56 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo file sharinglink remove
+
+Removes a specific sharing link of a file
+
+## Usage
+
+```sh
+m365 spo file sharinglink remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located.
+
+`--fileUrl [fileUrl]`
+: The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`--fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`-i, --id <id>`
+: The ID of the sharing link.
+
+`--confirm`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Removes a specific sharing link from a file by id without prompting for confirmation.
+
+```sh
+m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id c391b57d-5783-4c53-9236-cefb5c6ef323 --confirm
+```
+
+Removes a specific sharing link from a file by a specified site-relative URL.
+
+```sh
+m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl 'Shared Documents/document.docx' --id c391b57d-5783-4c53-9236-cefb5c6ef323
+```
+
+Removes a specific sharing link from a file by a specified server-relative URL.
+
+```sh
+m365 spo file sharinglink remove --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --id c391b57d-5783-4c53-9236-cefb5c6ef323
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx

@@ -0,0 +1,118 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo file sharinglink set
+
+Updates a sharing link of a file
+
+## Usage
+
+```sh
+m365 spo file sharinglink set [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+:	The URL of the site where the file is located.
+
+`--fileUrl [fileUrl]`
+:	The server- or site-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`--fileId [fileId]`
+:	The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`--id <id>`
+: The ID of the sharing link.
+
+`--expirationDateTime <expirationDateTime>`
+:	The date and time to set the expiration. This should be defined as a valid ISO 8601 string. This options only works for anonymous links.
+```
+
+<Global />
+
+## Examples
+
+Updates an anonymous sharing link from a file by a specified site-relative URL with the expirationDateTime parameter
+
+```sh
+m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileUrl "/sites/demo/Shared Documents/Document.docx" --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
+```
+
+Updates an anonymous sharing link from a file by id with the expirationDateTime parameter
+
+```sh
+m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "7c9f97c9-1bda-433c-9364-bb83e81771ee",
+    "roles": [
+      "read"
+    ],
+    "expirationDateTime": "2023-02-09T16:57:00Z",
+    "hasPassword": false,
+    "grantedToIdentitiesV2": [],
+    "grantedToIdentities": [],
+    "link": {
+      "scope": "anonymous",
+      "type": "view",
+      "webUrl": "https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g",
+      "preventsDownload": false
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  expirationDateTime   : 2023-02-09T16:57:00Z
+  grantedToIdentities  : []
+  grantedToIdentitiesV2: []
+  hasPassword          : false
+  id                   : 7c9f97c9-1bda-433c-9364-bb83e81771ee
+  link                 : {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g","preventsDownload":false}
+  roles                : ["read"]
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,roles,expirationDateTime,hasPassword,grantedToIdentitiesV2,grantedToIdentities,link
+  7c9f97c9-1bda-433c-9364-bb83e81771ee,"[""read""]",2023-02-09T16:57:00Z,,[],[],"{""scope"":""anonymous"",""type"":""view"",""webUrl"":""https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g"",""preventsDownload"":false}"
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo file sharinglink set --webUrl "https://contoso.sharepoint.com" --fileUrl "/sites/demo/Shared Documents/Document.docx" --expirationDateTime "2023-02-09T16:57:00.000Z" --id "7c9f97c9-1bda-433c-9364-bb83e81771ee"
+
+  Date: 5/2/2023
+
+  ## 7c9f97c9-1bda-433c-9364-bb83e81771ee
+
+  Property | Value
+  ---------|-------
+  id | 7c9f97c9-1bda-433c-9364-bb83e81771ee
+  roles | ["read"]
+  expirationDateTime | 2023-02-09T16:57:00Z
+  hasPassword | false
+  grantedToIdentitiesV2 | []
+  grantedToIdentities | []
+  link | {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-\_527\_fI9g","preventsDownload":false}
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/file/file-version-clear.mdx

@@ -0,0 +1,59 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo file version clear
+
+Removes all version history of a specified file
+
+## Usage
+
+```sh
+m365 spo file version clear [options]
+```
+
+## Options
+
+```md defintion-list
+`-w, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`-u, --fileUrl [fileUrl]`
+: The server- or site-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
+
+`--confirm [confirm]`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Removes all file version history in a specific site based on fileId and prompts for confirmation
+
+```sh
+m365 spo file version clear --webUrl https://contoso.sharepoint.com --fileId 'b2307a39-e878-458b-bc90-03bc578531d6'
+```
+
+Removes all file version history in a specific site based on fileUrl and prompts for confirmation
+
+```sh
+m365 spo file version clear --webUrl https://contoso.sharepoint.com --fileUrl '/Shared Documents/Document.docx'
+```
+
+Removes all file version history in a specific site based on fileId without prompting for confirmation
+
+```sh
+m365 spo file version clear --webUrl https://contoso.sharepoint.com --fileId 'b2307a39-e878-458b-bc90-03bc578531d6' --confirm
+```
+
+Removes all file version history in a specific site based on fileUrl without prompting for confirmation
+
+```sh
+m365 spo file version clear --webUrl https://contoso.sharepoint.com --fileUrl '/Shared Documents/Document.docx' --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/file/file-version-get.mdx

@@ -0,0 +1,89 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo file version get
+
+Gets information about a specific version of a specified file
+
+## Usage
+
+```sh
+m365 spo file version get [options]
+```
+
+## Options
+
+```md defintion-list
+`-w, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`--label <label>`
+: Label of version which will be retrieved
+
+`-u, --fileUrl [fileUrl]`
+: The server- or site-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+```
+
+<Global />
+
+## Examples
+
+Get file version in a specific site based on fileId
+
+```sh
+m365 spo file version get --webUrl https://contoso.sharepoint.com --label "1.0" --fileId 'b2307a39-e878-458b-bc90-03bc578531d6'
+```
+
+Get file in a specific site based on fileUrl
+
+```sh
+m365 spo file version get --webUrl https://contoso.sharepoint.com --label "1.0" --fileUrl '/Shared Documents/Document.docx'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "CheckInComment": "",
+    "Created": "2022-10-30T12:03:06Z",
+    "ID": 512,
+    "IsCurrentVersion": false,
+    "Length": "18898",
+    "Size": 18898,
+    "Url": "_vti_history/512/Shared Documents/Document.docx",
+    "VersionLabel": "1.0"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  CheckInComment  :
+  Created         : 2022-10-30T12:03:06Z
+  ID              : 512
+  IsCurrentVersion: false
+  Length          : 18898
+  Size            : 18898
+  Url             : _vti_history/512/Shared Documents/Document.docx
+  VersionLabel    : 1.0
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  CheckInComment,Created,ID,IsCurrentVersion,Length,Size,Url,VersionLabel
+  ,2022-10-30T12:03:06Z,512,,18898,18898,_vti_history/512/Shared Documents/Document.docx,1.0
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/file/file-version-list.mdx

@@ -0,0 +1,89 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo file version list
+
+Retrieves all versions of a file
+
+## Usage
+
+```sh
+m365 spo file version list [options]
+```
+
+## Options
+
+```md defintion-list
+`-w, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`-u, --fileUrl [fileUrl]`
+: The server- or site-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
+```
+
+<Global />
+
+## Examples
+
+List file versions of a specific file based on the ID of the file
+
+```sh
+m365 spo file version list --webUrl https://contoso.sharepoint.com --fileId 'b2307a39-e878-458b-bc90-03bc578531d6'
+```
+
+List file versions of a specific file based on the site-relative URL of the file
+
+```sh
+m365 spo file version list --webUrl https://contoso.sharepoint.com --fileUrl '/Shared Documents/Document.docx'
+```
+
+List file versions of a specific file based on the server-relative URL of the file
+
+```sh
+m365 spo file version list --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/Shared Documents/Document.docx'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "CheckInComment": "",
+      "Created": "2022-10-30T12:03:06Z",
+      "ID": 512,
+      "IsCurrentVersion": false,
+      "Length": "18898",
+      "Size": 18898,
+      "Url": "_vti_history/512/Shared Documents/Document.docx",
+      "VersionLabel": "1.0"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Created               ID    IsCurrentVersion  VersionLabel
+  --------------------  ----  ----------------  ------------
+  2022-10-30T12:03:06Z  512   false             1.0
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Created,ID,IsCurrentVersion,VersionLabel
+  2022-10-30T12:03:06Z,512,false,1.0
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/file/file-version-remove.mdx

@@ -0,0 +1,62 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo file version remove
+
+Removes a specific version of a specified file
+
+## Usage
+
+```sh
+m365 spo file version remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-w, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`--label <label>`
+: Label of version which will be removed
+
+`-u, --fileUrl [fileUrl]`
+: The server- or site-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+
+`--confirm [confirm]`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Removes a file version in a specific site based on fileId and prompts for confirmation
+
+```sh
+m365 spo file version remove --webUrl https://contoso.sharepoint.com --label "1.0" --fileId 'b2307a39-e878-458b-bc90-03bc578531d6'
+```
+
+Removes a file version in a specific site based on fileUrl and prompts for confirmation
+
+```sh
+m365 spo file version remove --webUrl https://contoso.sharepoint.com --label "1.0" --fileUrl '/Shared Documents/Document.docx'
+```
+
+Removes a file version in a specific site based on fileId without prompting for confirmation
+
+```sh
+m365 spo file version remove --webUrl https://contoso.sharepoint.com --label "1.0" --fileId 'b2307a39-e878-458b-bc90-03bc578531d6' --confirm
+```
+
+Removes a file version in a specific site based on fileUrl without prompting for confirmation
+
+```sh
+m365 spo file version remove --webUrl https://contoso.sharepoint.com --label "1.0" --fileUrl '/Shared Documents/Document.docx' --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/file/file-version-restore.mdx

@@ -0,0 +1,62 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo file version restore
+
+Restores a specific version of a specified file
+
+## Usage
+
+```sh
+m365 spo file version restore [options]
+```
+
+## Options
+
+```md defintion-list
+`-w, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`--label <label>`
+: Label of version which will be restored
+
+`-u, --fileUrl [fileUrl]`
+: The server- or site-relative URL of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file whose version will be restored. Specify either `fileUrl` or `fileId` but not both
+
+`--confirm [confirm]`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Restores a file version in a specific site based on fileId and prompts for confirmation
+
+```sh
+m365 spo file version restore --webUrl https://contoso.sharepoint.com --label "1.0" --fileId 'b2307a39-e878-458b-bc90-03bc578531d6'
+```
+
+Restores a file version in a specific site based on fileUrl and prompts for confirmation
+
+```sh
+m365 spo file version restore --webUrl https://contoso.sharepoint.com --label "1.0" --fileUrl '/Shared Documents/Document.docx'
+```
+
+Restores a file version in a specific site based on fileId without prompting for confirmation
+
+```sh
+m365 spo file version restore --webUrl https://contoso.sharepoint.com --label "1.0" --fileId 'b2307a39-e878-458b-bc90-03bc578531d6' --confirm
+```
+
+Restores a file version in a specific site based on fileUrl without prompting for confirmation
+
+```sh
+m365 spo file version restore --webUrl https://contoso.sharepoint.com --label "1.0" --fileUrl '/Shared Documents/Document.docx' --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/folder/folder-add.mdx

@@ -0,0 +1,40 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo folder add
+
+Creates a folder within a parent folder
+
+## Usage
+
+```sh
+m365 spo folder add [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder will be created.
+
+`-p, --parentFolderUrl <parentFolderUrl>`
+: The server- or site-relative URL of the parent folder.
+
+`-n, --name <name>`
+: Name of the new folder to be created
+```
+
+<Global />
+
+## Examples
+
+Creates folder in a specific library within the site
+
+```sh
+m365 spo folder add --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --name 'My Folder Name'
+```
+
+Creates folder in a specific folder within the site
+
+```sh
+m365 spo folder add --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/sites/project-x/Shared Documents/Reports' --name 'Financial reports'
+```