@pnp/cli-microsoft365 6.0.0-beta.a9609a1 → 6.0.0-beta.aa5918d

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

@@ -0,0 +1,55 @@
+# spo file version clear
+
+Removes all version history of a specified file
+
+## Usage
+
+```sh
+m365 spo file version clear [options]
+```
+
+## Options
+
+`-w, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`-u, --fileUrl [fileUrl]`
+: The server-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.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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.md

@@ -0,0 +1,76 @@
+# spo file version get
+
+Gets information about a specific version of a specified file
+
+## Usage
+
+```sh
+m365 spo file version get [options]
+```
+
+## Options
+
+`-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-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
+
+--8<-- "docs/cmd/_global.md"
+
+## 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
+
+=== "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"
+    }
+    ```
+
+=== "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
+    ```
+
+=== "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
+    ```

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

@@ -0,0 +1,76 @@
+# spo file version list
+
+Retrieves all versions of a file
+
+## Usage
+
+```sh
+m365 spo file version list [options]
+```
+
+## Options
+
+`-w, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`-u, --fileUrl [fileUrl]`
+: The site-relative or server-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
+
+--8<-- "docs/cmd/_global.md"
+
+## 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
+
+=== "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"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    CheckInComment  Created               ID    IsCurrentVersion  Length  Size   Url                                               VersionLabel
+    --------------  --------------------  ----  ----------------  ------  -----  ------------------------------------------------  ------------
+                    2022-10-30T12:03:06Z  512   false             18898   18898  _vti_history/512/Shared Documents/Document.docx   1.0
+    ```
+
+=== "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
+    ```

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

@@ -0,0 +1,58 @@
+# spo file version remove
+
+Removes a specific version of a specified file
+
+## Usage
+
+```sh
+m365 spo file version remove [options]
+```
+
+## Options
+
+`-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-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.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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.md

@@ -0,0 +1,58 @@
+# spo file version restore
+
+Restores a specific version of a specified file
+
+## Usage
+
+```sh
+m365 spo file version restore [options]
+```
+
+## Options
+
+`-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-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.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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-list.md

@@ -16,6 +16,9 @@ m365 spo folder list [options]
 `-p, --parentFolderUrl <parentFolderUrl>`
 : Site-relative URL of the parent folder
 
+`-r, --recursive`
+: Set to retrieve nested folders
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
@@ -25,3 +28,45 @@ Gets list of folders under a parent folder with site-relative url _/Shared Docum
 ```sh
 m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'
 ```
+
+Gets recursive list of folders under a specific folder on a specific site
+
+```sh
+m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --recursive
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [  
+      {
+        "Exists": true,
+        "IsWOPIEnabled": false,
+        "ItemCount": 9,
+        "Name": "Folder A",
+        "ProgID": null,
+        "ServerRelativeUrl": "/Shared Documents/Folder A",
+        "TimeCreated": "2022-04-26T12:30:56Z",
+        "TimeLastModified": "2022-04-26T12:50:14Z",
+        "UniqueId": "20523746-971b-4488-aa6d-b45d645f61c5",
+        "WelcomePage": ""
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Name     ServerRelativeUrl
+    -------  -------------------------
+    Folder A /Shared Documents/Folder A
+    ```
+
+=== "CSV"
+
+    ```csv
+    Name,ServerRelativeUrl
+    Folder A,/Shared Documents/Folder A
+    ```

package/docs/docs/cmd/spo/folder/folder-roleassignment-add.md

@@ -0,0 +1,59 @@
+# spo folder roleassignment add
+
+Adds a role assignment from the specified folder.
+
+## Usage
+
+```sh
+m365 spo folder roleassignment add [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder is located.
+
+`-f, --folderUrl <folderUrl>`
+: The server- or site-relative URL of the folder.
+
+`--principalId [principalId]`
+: The SharePoint principal id. It may be either an user id or group id for which the role assignment will be addd. Specify either upn, groupName or principalId but not multiple.
+
+`--upn [upn]`
+: The upn/email of the user. Specify either upn, groupName or principalId but not multiple.
+
+`--groupName [groupName]`
+: The Azure AD or SharePoint group name. Specify either upn, groupName or principalId but not multiple.
+
+`--roleDefinitionId [roleDefinitionId]`
+: ID of the role definition. Specify either roleDefinitionId or roleDefinitionName but not both.
+
+`--roleDefinitionName [roleDefinitionName]`
+: The name of the role definition. E.g. 'Contribute', 'Read'. Specify either roleDefinitionId or roleDefinitionName but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Add the role assignment to the specified folder based on the group name and role definition name.
+
+```sh
+m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl  "/Shared Documents/FolderPermission" --groupName "saleGroup" --roleDefinitionName "Edit"
+```
+
+Add the role assignment to the specified folder based on the principal Id and role definition id
+
+```sh
+m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --principalId 2 --roleDefinitionId 1073741827 
+```
+
+Add the role assignment to the specified folder based on the upn and role definition name
+
+```sh
+m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --upn "test@contoso.onmicrosoft.com" --roleDefinitionName "Edit"
+```
+Add the role assignment to the root folder based on the upn and role definition name
+
+```sh
+m365 spo folder roleassignment add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents" --upn "test@contoso.onmicrosoft.com" --roleDefinitionName "Edit"
+```

package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md

@@ -37,3 +37,9 @@ Break the inheritance of a folder with a specified server-relative URL. It will
 ```sh
 m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --clearExistingPermissions --confirm
 ```
+
+Break the inheritance of the specified root folder for the library with a specified server-relative URL. It will clear the existing permissions of the root folder. It will **not** prompt for confirmation before breaking the inheritance.
+
+```sh
+m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --clearExistingPermissions --confirm
+```

package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md

@@ -34,3 +34,9 @@ Reset inheritance of folder with server-relative url _/sites/project-x/Shared Do
 ```sh
 m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents/TestFolder" --confirm
 ```
+
+Reset inheritance of the specified root folder for the library with the server-relative url _/sites/project-x/Shared Documents located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
+
+```sh
+m365 spo folder roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "/sites/project-x/Shared Documents" --confirm
+```

package/docs/docs/cmd/spo/hubsite/hubsite-connect.md

@@ -0,0 +1,62 @@
+# spo hubsite connect
+
+Connect a hub site to a parent hub site
+
+## Usage
+
+```sh
+m365 spo hubsite connect [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the hub site. Specify either `id`, `title` or `url` but not multiple.
+
+`-t, --title [title]`
+: Title of the hub site. Specify either `id`, `title` or `url` but not multiple.
+
+`-u, --url [url]`
+: Absolute or server-relative URL of the hub site. Specify either `id`, `title` or `url` but not multiple.
+
+`--parentId [parentId]`
+: ID of the parent hub site. Specify either `parentId`, `parentTitle` or `parentUrl` but not multiple.
+
+`--parentTitle [parentTitle]`
+: Title of the parent hub site. Specify either `parentId`, `parentTitle` or `parentUrl` but not multiple.
+
+`--parentUrl [parentUrl]`
+: Absolute or server-relative URL of the parent hub site. Specify either `parentId`, `parentTitle` or `parentUrl` but not multiple.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
+
+To connect a regular site to a hub site, use command [spo site hubsite connect](../site/site-hubsite-connect.md).
+
+## Examples
+
+Connect a specific hub site to specific parent hub site by ID
+
+```sh
+m365 spo hubsite connect --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --parentId 637ed2ea-b65b-4a4b-a3d7-ad86953224a4
+```
+
+Connect a specific hub site to specific parent hub site by URL
+
+```sh
+m365 spo hubsite connect --url https://contoso.sharepoint.com/sites/project-x --parentUrl https://contoso.sharepoint.com/sites/projects
+```
+
+Connect a specific hub site with title to a parent hub site with ID
+
+```sh
+m365 spo hubsite connect --title "My hub site" --parentId 637ed2ea-b65b-4a4b-a3d7-ad86953224a4
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/hubsite/hubsite-data-get.md

@@ -20,9 +20,6 @@ m365 spo hubsite data get [options]
 
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
-
 By default, the hub site data is returned from the server's cache. To refresh the data with the latest updates, use the `-f, --forceRefresh` option. Use this option, if you just made changes and need to see them right
 away.
 

package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md

@@ -0,0 +1,58 @@
+# spo hubsite disconnect
+
+Disconnect a hub site from its parent hub site
+
+## Usage
+
+```sh
+m365 spo hubsite disconnect [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the hub site. Specify either `id`, `title` or `url` but not multiple.
+
+`-t, --title [title]`
+: Title of the hub site. Specify either `id`, `title` or `url` but not multiple.
+
+`-u, --url [url]`
+: Absolute or server-relative URL of the hub site. Specify either `id`, `title` or `url` but not multiple.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
+
+To disconnect a regular site from a hub site, use command [spo site hubsite disconnect](../site/site-hubsite-disconnect.md).
+
+If the specified id doesn't point to a valid hub site, you will get a ResourceNotFoundException error.
+
+## Examples
+
+Disconnect a specific hub site with id from its parent hub site
+
+```sh
+m365 spo hubsite disconnect --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
+```
+
+Disconnect a specific hub site with url from its parent hub site
+
+```sh
+m365 spo hubsite disconnect --url https://contoso.sharepoint.com/sites/project-x
+```
+
+Disconnect a specific hub site with title from its parent hub site
+
+```sh
+m365 spo hubsite disconnect --title "My hub site"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/hubsite/hubsite-register.md

@@ -17,8 +17,8 @@ m365 spo hubsite register [options]
 
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 If the specified site collection is already registered as a hub site, you will get a `This site is already a HubSite.` error.
 

package/docs/docs/cmd/spo/hubsite/hubsite-rights-grant.md

@@ -21,13 +21,10 @@ m365 spo hubsite rights grant [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 ## Examples
 

package/docs/docs/cmd/spo/hubsite/hubsite-rights-revoke.md

@@ -21,13 +21,10 @@ m365 spo hubsite rights revoke [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 ## Examples
 

package/docs/docs/cmd/spo/hubsite/hubsite-set.md

@@ -24,13 +24,10 @@ m365 spo hubsite set [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 If the specified `id` doesn't refer to an existing hub site, you will get an `Unknown Error` error.
 

package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md

@@ -20,8 +20,8 @@ m365 spo hubsite unregister [options]
 
 ## Remarks
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+!!! important
+    To use this command you must be a Global or SharePoint administrator.
 
 If the specified site collection is not registered as a hub site, you will get a `hubSiteId` error.