@pnp/cli-microsoft365 6.0.0-beta.443926a → 6.0.0-beta.48a730d

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

@@ -14,10 +14,13 @@ m365 spo field set [options]
 : Absolute URL of the site where the field is located
 
 `--listId [listId]`
-: ID of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
+: ID of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
 
 `--listTitle [listTitle]`
-: Title of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
+: Title of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
 
 `-i, --id [id]`
 : ID of the field to update. Specify `id` or `title` but not both
@@ -25,9 +28,6 @@ m365 spo field set [options]
 `-t, --title [title]`
 : Title or internal name of the field to update. Specify `id` or `title` but not both
 
-`-n, --name [name]`
-: (deprecated. Use `title` instead) Title or internal name of the field to update. Specify `id` or `name` but not both
-
 `--updateExistingLists`
 : Set, to push the update to existing lists. Otherwise, the changes will apply to new lists only
 
@@ -37,6 +37,9 @@ m365 spo field set [options]
 
 Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
 
+!!! warning "Escaping JSON in PowerShell"
+    When updating column formatting for a field with the `--CustomFormatter` option, it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
+
 ## Examples
 
 Update the title of the site column specified by its internal name and push changes to existing lists
@@ -51,8 +54,14 @@ Update the title of the list column specified by its ID
 m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'My column'
 ```
 
+Update the description of a column specified by the ID on a list retrieved by the URL
+
+```sh
+m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Description 'My column Description'
+```
+
 Update column formatting of the specified list column
 
 ```sh
-m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}`'
+m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
 ```

package/docs/docs/cmd/spo/file/file-checkin.md

@@ -13,11 +13,11 @@ m365 spo file checkin [options]
 `-u, --webUrl <webUrl>`
 : The URL of the site where the file is located
 
-`-f, --fileUrl [fileUrl]`
-: The server-relative URL of the file to retrieve. Specify either `fileUrl` or `id` but not both
+`-f, --url [url]`
+: The server-relative URL of the file to retrieve. Specify either `url` or `id` but not both
 
 `-i, --id [id]`
-: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `id` but not both
+: The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both
 
 `-t, --type [type]`
 : Type of the check in. Available values `Minor,Major,Overwrite`. Default is Major
@@ -38,17 +38,17 @@ m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --
 Checks in file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx'
+m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
 ```
 
 Checks in minor version of file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx' --type Minor
+m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --type Minor
 ```
 
 Checks in file _/sites/project-x/documents/Test1.docx_ with comment located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx' --comment 'approved'
+m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --comment 'approved'
 ```

package/docs/docs/cmd/spo/file/file-checkout.md

@@ -13,11 +13,11 @@ m365 spo file checkout [options]
 `-u, --webUrl <webUrl>`
 : The URL of the site where the file is located
 
-`-f, --fileUrl [fileUrl]`
-: The server-relative URL of the file to retrieve. Specify either `fileUrl` or `id` but not both
+`-f, --url [url]`
+: The server-relative URL of the file to retrieve. Specify either `url` or `id` but not both
 
 `-i, --id [id]`
-: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `id` but not both
+: The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both
 
 --8<-- "docs/cmd/_global.md"
 
@@ -32,5 +32,5 @@ m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x -
 Checks out file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx'
+m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
 ```

package/docs/docs/cmd/spo/file/file-rename.md

@@ -0,0 +1,43 @@
+# spo file rename
+
+Renames a file
+
+## Usage
+
+```sh
+m365 spo file rename [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`-s, --sourceUrl <sourceUrl>`
+: Site-relative URL of the file to rename
+
+`-t, --targetFileName <targetFileName>`
+: New file name of the file
+
+`--force`
+: If a file already exists with target file name, it will be moved to the recycle bin. If omitted, the rename operation will be canceled if a file already exists with the specified file name
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If you try to rename a file without the `--force` flag and a file with this name already exists, the operation will be cancelled.
+
+## Examples
+
+Renames a file with server-relative URL _/Shared Documents/Test1.docx_ located in site _<https://contoso.sharepoint.com/sites/project-x>_ to _Test2.docx_
+
+```sh
+m365 spo file rename --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl '/Shared Documents/Test1.docx' --targetFileName 'Test2.docx'
+```
+
+Renames a file with server-relative URL _/Shared Documents/Test1.docx_ located in site _<https://contoso.sharepoint.com/sites/project-x>_ to _Test2.docx_. If the file with the target file name already exists, this file will be moved to the recycle bin
+
+```sh
+m365 spo file rename --webUrl https://contoso.sharepoint.com/sites/project-x --sourceUrl '/Shared Documents/Test1.docx' --targetFileName 'Test2.docx' --force
+```

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

@@ -0,0 +1,57 @@
+# spo file roleassignment add
+
+Adds a role assignment to the specified file.
+
+## Usage
+
+```sh
+m365 spo file roleassignment add [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
+
+`--principalId [principalId]`
+: The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either upn, groupName or principalId.
+
+`--upn [upn]`
+: upn/email of user to assign role to. Specify either upn, groupName or principalId.
+
+`--groupName [groupName]`
+: The group name of Azure AD or SharePoint group. Specify either upn, groupName or principalId.
+
+`--roleDefinitionId [roleDefinitionId]`
+: ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both
+
+`--roleDefinitionName [roleDefinitionName]`
+: Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either roleDefinitionId or roleDefinitionName but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Adds a role assignment to a file with a specified id. It will use a principal id and a specific role definition id.
+
+```sh
+m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 11 --roleDefinitionId 1073741829
+```
+
+Adds a role assignment to a file with a specified site-relative URL for a specific upn and a role definition name.
+
+```sh
+m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "Shared Documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Full Control"
+```
+
+Adds a role assignment to a file with a specified server-relative URL the for a specific group  and a role definition name.
+
+```sh
+m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Read"
+```

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

@@ -0,0 +1,54 @@
+# spo file roleassignment remove
+
+Removes a role assignment from a file.
+
+## Usage
+
+```sh
+m365 spo file roleassignment remove [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.
+
+`--principalId [principalId]`
+: The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, or `principalId`.
+
+`--upn [upn]`
+: Upn/email of the user. Specify either `upn`, `groupName`, or `principalId`.
+
+`--groupName [groupName]`
+: The group name of an Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId`.
+
+`--confirm [confirm]`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove a role assignment by principal id from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 2
+```
+
+Remove a role assignment by upn from a file by url
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileUrl "/sites/contoso-sales/documents/Test1.docx" --upn "user1@contoso.onmicrosoft.com"
+```
+
+Remove a role assignment by group name from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --groupName "saleGroup"
+```

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-sharinginfo-get.md

@@ -10,14 +10,14 @@ m365 spo file sharinginfo get [options]
 
 ## Options
 
-`-w, --webUrl <webUrl>`
+`-u, --webUrl <webUrl>`
 : The URL of the site where the file is located
 
-`-u, --url [url]`
-: The server-relative URL of the file for which to build the report. Specify either `url` or `id` but not both
+`-f, --fileUrl [fileUrl]`
+: The server-relative URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both
 
-`-i, --id [id]`
-: The UniqueId (GUID) of the file for which to build the report. Specify either `url` or `id` but not both
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both
 
 --8<-- "docs/cmd/_global.md"
 
@@ -26,11 +26,11 @@ m365 spo file sharinginfo get [options]
 Get file sharing information report for the file with server-relative url _/sites/M365CLI/Shared Documents/SharedFile.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --url "/sites/M365CLI/Shared Documents/SharedFile.docx"
+m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl "/sites/M365CLI/Shared Documents/SharedFile.docx"
 ```
 
 Get file sharing information report for file with id (UniqueId) _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --id "b2307a39-e878-458b-bc90-03bc578531d6"
+m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
 ```

package/docs/docs/cmd/spo/folder/folder-get.md

@@ -13,8 +13,11 @@ m365 spo folder get [options]
 `-u, --webUrl <webUrl>`
 : The URL of the site where the folder is located
 
-`-f, --folderUrl <folderUrl>`
-: 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
 
 --8<-- "docs/cmd/_global.md"
 
@@ -24,8 +27,14 @@ If no folder exists at the specified URL, you will get a `Please check the folde
 
 ## 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 --folderUrl '/Shared Documents'
+m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/project-x --id "b2307a39-e878-458b-bc90-03bc578531d6"
 ```

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

@@ -13,7 +13,7 @@ m365 spo folder remove [options]
 `-u, --webUrl <webUrl>`
 : The URL of the site where the folder to be deleted is located
 
-`-f, --folderUrl <folderUrl>`
+`-f, --url <url>`
 : Site-relative URL of the folder to delete
 
 `--recycle`
@@ -33,11 +33,11 @@ The `spo folder remove` command will remove folder only if it is empty. If the f
 Removes a folder with site-relative URL _/Shared Documents/My Folder_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl '/Shared Documents/My Folder'
+m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder'
 ```
 
 Moves a folder with site-relative URL _/Shared Documents/My Folder_ located in site _https://contoso.sharepoint.com/sites/project-x_ to the site recycle bin
 
 ```sh
-m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl '/Shared Documents/My Folder' --recycle
+m365 spo folder remove --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder' --recycle
 ```

package/docs/docs/cmd/spo/folder/folder-rename.md

@@ -13,7 +13,7 @@ m365 spo folder rename [options]
 `-u, --webUrl <webUrl>`
 : The URL of the site where the folder to be renamed is located
 
-`-f, --folderUrl <folderUrl>`
+`-f, --url <url>`
 : Site-relative URL of the folder (including the folder)
 
 `-n, --name`
@@ -26,5 +26,5 @@ m365 spo folder rename [options]
 Renames a folder with site-relative URL _/Shared Documents/My Folder 1_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo folder rename --webUrl https://contoso.sharepoint.com/sites/project-x --folderUrl '/Shared Documents/My Folder 1' --name 'My Folder 2'
+m365 spo folder rename --webUrl https://contoso.sharepoint.com/sites/project-x --url '/Shared Documents/My Folder 1' --name 'My Folder 2'
 ```

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
+```