@pnp/cli-microsoft365 6.0.0-beta.27b9708 → 6.0.0-beta.291f17c

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

@@ -0,0 +1,54 @@
+# spo file roleinheritance break
+
+Breaks inheritance of a file. Keeping existing permissions is the default behavior.
+
+## Usage
+
+```sh
+m365 spo file roleinheritance break [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located
+
+`--fileUrl [fileUrl]`
+: The 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
+
+`-c, --clearExistingPermissions`
+: Clear all existing permissions from the file
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Break the inheritance of a file with a specific id (UniqueId).
+
+```sh
+m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
+```
+
+Break the inheritance of a file with a specific id (UniqueId) and clear all existing permissions.
+
+```sh
+m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --clearExistingPermissions
+```
+
+Break the inheritance of a file with a specific server-relative URL.
+
+```sh
+m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx"
+```
+
+Break the inheritance of a file with a specific server-relative URL and clear all existing permissions.
+
+```sh
+m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --clearExistingPermissions
+```

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

@@ -0,0 +1,39 @@
+# spo file roleinheritance reset
+
+Restores the role inheritance of a file
+
+## Usage
+
+```sh
+m365 spo file roleinheritance reset [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located
+
+`--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`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Reset inheritance of file with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo file roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
+```
+
+Reset inheritance of file with server-relative url _/sites/project-x/documents/Test1_.docx located in site _https://contoso.sharepoint.com/sites/project-x_. It will **not** prompt for confirmation before resetting.
+
+```sh
+m365 spo file roleinheritance reset --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --confirm
+```

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
+    Created               ID    IsCurrentVersion  VersionLabel
+    --------------------  ----  ----------------  ------------
+    2022-10-30T12:03:06Z  512   false             1.0
+    ```
+
+=== "CSV"
+
+    ```csv
+    Created,ID,IsCurrentVersion,VersionLabel
+    2022-10-30T12:03:06Z,512,false,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-get.md

@@ -13,8 +13,14 @@ m365 spo folder get [options]
 `-u, --webUrl <webUrl>`
 : The URL of the site where the folder is located
 
-`-f, --url <url>`
-: Site-relative URL of the folder
+`-f, --url [url]`
+: The server-relative URL of the folder to retrieve. Specify either `folderUrl` or `id` but not both
+
+`-i, --id [id]`
+: The UniqueId (GUID) of the folder to retrieve. Specify either `url` or `id` but not both
+
+`--withPermissions`
+: Set if you want to return associated roles and permissions of the folder. 
 
 --8<-- "docs/cmd/_global.md"
 
@@ -22,10 +28,24 @@ m365 spo folder get [options]
 
 If no folder exists at the specified URL, you will get a `Please check the folder URL. Folder might not exist on the specified URL` error.
 
+If root level folder is passed, you will get a `Please ensure the specified folder URL or folder Id does not refer to a root folder. Use \'spo list get\' with withPermissions instead' error.` Please use the command 'spo list get'.
+
 ## Examples
 
-Get folder properties for folder with site-relative url _'/Shared Documents'_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Get folder properties for folder with server-relative url _'/Shared Documents'_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --url "/Shared Documents"
+```
+
+Get folder properties for folder with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --id "b2307a39-e878-458b-bc90-03bc578531d6"
+```
+
+Get folder properties for folder with server-relative url _'/Shared Documents/Test1'_ located in site _https://contoso.sharepoint.com/sites/test
 
 ```sh
-m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents'
+m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/test --url "Shared Documents/Test1" --withPermissions
 ```

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-roleassignment-remove.md

@@ -0,0 +1,57 @@
+# spo folder roleassignment remove
+
+Removes a role assignment from the specified folder.
+
+## Usage
+
+```sh
+m365 spo folder roleassignment remove [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 removed. 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.
+
+`--confirm`
+: Don't prompt for confirmation when removing the role assignment.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove roleassignment from folder based on group name
+
+```sh
+m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl  "/Shared Documents/FolderPermission" --groupName "saleGroup"
+```
+
+Remove the role assignment from the specified folder based on the principal id.
+
+```sh
+m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --principalId 2
+```
+
+Remove the role assignment from the specified folder based on the principal id without prompting for removal confirmation.
+
+```sh
+m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --principalId 2 --confirm
+```
+
+Remove the role assignment from the specified folder based on the upn.
+
+```sh
+m365 spo folder roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --folderUrl "/Shared Documents/FolderPermission" --upn "test@contoso.onmicrosoft.com"
+```

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

@@ -0,0 +1,45 @@
+# spo folder roleinheritance break
+
+Breaks the role inheritance of a folder.
+
+## Usage
+
+```sh
+m365 spo folder roleinheritance break [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the folder is located.
+
+`-f, --folderUrl <folderUrl>`
+: The site-relative URL or server-relative URL of the folder.
+
+`-c, --clearExistingPermissions`
+: Clear all existing permissions from the folder.
+
+`--confirm`
+: Don't prompt for confirmation to breaking role inheritance of the folder.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Break the inheritance of a folder with a specified site-relative URL.
+
+```sh
+m365 spo folder roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --folderUrl "Shared Documents/TestFolder"
+```
+
+Break the inheritance of a folder with a specified server-relative URL. It will clear the existing permissions of the 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/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
+```