@pnp/cli-microsoft365 6.0.0-beta.ff232be → 6.1.0-beta.11542c0

package/docs/docs/cmd/spo/list/list-remove.md

@@ -37,3 +37,7 @@ Remove the list with title _List 1_ located in site _https://contoso.sharepoint.
 ```sh
 m365 spo list remove --webUrl https://contoso.sharepoint.com/sites/project-x --title 'List 1'
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md

@@ -0,0 +1,65 @@
+# spo list retentionlabel ensure
+
+Sets a default retention label on the specified list or library.
+
+## Usage
+
+```sh
+m365 spo list retentionlabel ensure [options]
+```
+
+## Alias
+
+```sh
+m365 spo list label set [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the list is located.
+
+`--label <label>`
+: The label to set on the list.
+
+`-t, --listTitle [listTitle]`
+: The title of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`-l, --listId [listId]`
+: The ID of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the list on which to set the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+
+`--syncToItems`
+: Specify, to set the label on all existing items in the list.
+
+`--blockDelete`
+: (deprecated) Specify, to disallow deleting items in the list.
+
+`--blockEdit`
+: (deprecated) Specify, to disallow editing items in the list.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+A list retention label is a default label that will be applied to all new items in the list. If you specify `syncToItems`, it is also synced to existing items. 
+
+## Examples
+
+Sets retention label on the list with specified site-relative URL located in the specified site.
+
+```sh
+m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --label 'Some label'
+```
+
+Sets retention label and disables editing and deleting items on the list and all existing items for the list with specified title located in the specified site.
+
+```sh
+m365 spo list retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents' --label 'Some label' --blockEdit --blockDelete --syncToItems
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/list/list-retentionlabel-get.md

@@ -0,0 +1,118 @@
+# spo list retentionlabel get
+
+Gets the default retention label set on the specified list or library.
+
+## Usage
+
+```sh
+m365 spo list retentionlabel get [options]
+```
+
+## Alias
+
+```sh
+m365 spo list label get [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the list to get the label from is located.
+
+`-l, --listId [listId]`
+: ID of the list to get the label from. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
+
+`-t, --listTitle [listTitle]`
+: Title of the list to get the label from. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Gets retention label set on the list with specified title located in the specified site.
+
+```sh
+m365 spo list retentionlabel get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+Gets retention label set on the list with specified id located in the specified site.
+
+```sh
+m365 spo list retentionlabel get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+Gets retention label set on the list with specified server relative url located in the specified site.
+
+```sh
+m365 spo list retentionlabel get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+Gets retention label set on the list with specified site-relative URL located in the specified site.
+
+```sh
+m365 spo list retentionlabel get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "AcceptMessagesOnlyFromSendersOrMembers": false,
+      "AccessType": null,
+      "AllowAccessFromUnmanagedDevice": null,
+      "AutoDelete": false,
+      "BlockDelete": false,
+      "BlockEdit": false,
+      "ContainsSiteLabel": false,
+      "DisplayName": "Label A",
+      "EncryptionRMSTemplateId": null,
+      "HasRetentionAction": false,
+      "IsEventTag": false,
+      "Notes": null,
+      "RequireSenderAuthenticationEnabled": false,
+      "ReviewerEmail": null,
+      "SharingCapabilities": null,
+      "SuperLock": false,
+      "TagDuration": 0,
+      "TagId": "4d535433-2a7b-40b0-9dad-8f0f8f3b3841",
+      "TagName": "Sensitive",
+      "TagRetentionBasedOn": null
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    AcceptMessagesOnlyFromSendersOrMembers: false
+    AccessType                            : null
+    AllowAccessFromUnmanagedDevice        : null
+    AutoDelete                            : false
+    BlockDelete                           : false
+    BlockEdit                             : false
+    ContainsSiteLabel                     : false
+    DisplayName                           : Label A
+    EncryptionRMSTemplateId               : null
+    HasRetentionAction                    : false
+    IsEventTag                            : false
+    Notes                                 : null
+    RequireSenderAuthenticationEnabled    : false
+    ReviewerEmail                         : null
+    SharingCapabilities                   : null
+    SuperLock                             : false
+    TagDuration                           : 0
+    TagId                                 : 4d535433-2a7b-40b0-9dad-8f0f8f3b3841
+    TagName                               : Sensitive
+    TagRetentionBasedOn                   : null
+    ```
+
+=== "CSV"
+
+    ```csv
+    AcceptMessagesOnlyFromSendersOrMembers,AccessType,AllowAccessFromUnmanagedDevice,AutoDelete,BlockDelete,BlockEdit,ContainsSiteLabel,DisplayName,EncryptionRMSTemplateId,HasRetentionAction,IsEventTag,Notes,RequireSenderAuthenticationEnabled,ReviewerEmail,SharingCapabilities,SuperLock,TagDuration,TagId,TagName,TagRetentionBasedOn
+    false,,,false,false,false,false,Label A,,false,false,,false,,,false,0,4d535433-2a7b-40b0-9dad-8f0f8f3b3841,Sensitive,
+    ```

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

@@ -0,0 +1,82 @@
+# spo list roleassignment add
+
+Adds a role assignment to list permissions
+
+## Usage
+
+```sh
+m365 spo list roleassignment add [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the list is located.
+
+`-i, --listId [listId]`
+: ID of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
+
+`-t, --listTitle [listTitle]`
+: Title of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Relative URL of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
+
+`--principalId [principalId]`
+: SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--upn [upn]`
+: Upn/email of user to assign role to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--groupName [groupName]`
+: Enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--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
+
+add role assignment to list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition id _1073741829_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --principalId 11 --roleDefinitionId 1073741829
+```
+
+add role assignment to list _0CD891EF-AFCE-4E55-B836-FCE03286CCCF_ located in site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition id _1073741829_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "0CD891EF-AFCE-4E55-B836-FCE03286CCCF" --principalId 11 --roleDefinitionId 1073741829
+```
+
+add role assignment to list _sites/documents_ located in site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition id _1073741829_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listUrl "sites/documents" --principalId 11 --roleDefinitionId 1073741829
+```
+
+add role assignment to list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_for upn _someaccount@tenant.onmicrosoft.com_ and role definition id _1073741829_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --upn "someaccount@tenant.onmicrosoft.com" --roleDefinitionId 1073741829
+```
+
+add role assignment to list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_for group _someGroup_ and role definition id _1073741829_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --groupName "someGroup" --roleDefinitionId 1073741829
+```
+
+add role assignment to list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition name _Full Control_
+
+```sh
+m365 spo list roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --principalId 11 --roleDefinitionName "Full Control"
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,61 @@
+# spo list roleassignment remove
+
+Removes a role assignment from list permissions
+
+## Usage
+
+```sh
+m365 spo list roleassignment remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the list is located.
+
+`-i, --listId [listId]`
+: ID of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
+
+`-t, --listTitle [listTitle]`
+: Title of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
+
+`--listUrl [listUrl]`
+: Relative URL of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.
+
+`--principalId [principalId]`
+: SharePoint ID of principal it may be either user id or group id you want to remove permissions. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--upn [upn]`
+: upn/email of user. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--groupName [groupName]`
+: enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--confirm`
+: Don't prompt for confirming removing the role assignment.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove roleassignment from list by title based on group name
+
+```sh
+m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listTitle "someList" --groupName "saleGroup"
+```
+
+Remove roleassignment from list by title based on principal Id
+
+```sh
+m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listTitle "Events" --principalId 2
+```
+
+Remove roleassignment from list by url based on principal Id
+
+```sh
+m365 spo list roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listUrl '/sites/contoso-sales/lists/Events' --principalId 2
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -11,17 +11,23 @@ m365 spo list roleinheritance break [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the list to retrieve is located
+: URL of the site where the list is located.
 
 `-i, --listId [listId]`
-: ID of the list to retrieve information for. Specify either id or title but not both
+: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
 
 `-t, --listTitle [listTitle]`
-: Title of the list to retrieve information for. Specify either id or title but not both
+: Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
 
 `-c, --clearExistingPermissions`
 : Flag if used clears all roles from the list
 
+`--confirm`
+: Do not prompt for confirmation before breaking role inheritance.
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -30,26 +36,36 @@ By default, when breaking permissions inheritance, the list will retain existing
 
 ## Examples
 
-Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Break inheritance of list by title in a specific site
 
 ```sh
 m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList"
 ```
 
-Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Break inheritance of list by id in a specific site
 
 ```sh
 m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991"
 ```
 
-Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions 
+Break inheritance of list by title located in a specific site and clearing the existing permissions
 
 ```sh
 m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --clearExistingPermissions
 ```
 
-Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
+Break inheritance of list by url in a specific site and clearing the existing permissions
+
+```sh
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listUrl '/sites/project-x/lists/events' --clearExistingPermissions
+```
+
+Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions without prompting for confirmation
 
 ```sh
-m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991" --clearExistingPermissions
+m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991" --clearExistingPermissions --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -11,26 +11,48 @@ m365 spo list roleinheritance reset [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the list is located
+: URL of the site where the list is located.
 
 `-i, --listId [listId]`
-: ID of the list. Specify either id or title but not both
+: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
 
 `-t, --listTitle [listTitle]`
-: Title of the list. Specify either id or title but not both
+: Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--confirm`
+: Do not prompt for confirmation before resetting role inheritance.
 
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Restore role inheritance of list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Restores role inheritance of a specific list by id in a specific site
 
 ```sh
 m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
 ```
 
-Restore role inheritance of list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
+Restores role inheritance of a specific list by title in a specific site
 
 ```sh
 m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test
 ```
+
+Restores role inheritance of a specific list by url in a specific site
+
+```sh
+m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/events'
+```
+
+Restores role inheritance of list a specific list by title without prompting for confirmation
+
+```sh
+m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test --confirm
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -10,14 +10,20 @@ m365 spo list set [options]
 
 ## Options
 
-`-i, --id <id>`
-: Id of the list to update
-
 `-u, --webUrl <webUrl>`
-: URL of the site where the list to update is located
+: URL of the site
+
+`--id [id]`
+: ID of the list. Specify either id, title or url but not multiple.
+
+`--title [title]`
+: Title of the list. Specify either id, title or url but not multiple.
 
-`-t, --title [title]`
-: The displayed title for the list
+`--url [url]`
+: Relative URL of the list. Specify either id, title or url but not multiple.
+
+`--newTitle [newTitle]`
+: New title for the list
 
 `--allowDeletion [allowDeletion]`
 : Boolean value specifying whether the list can be deleted. Valid values are `true,false`
@@ -221,6 +227,16 @@ Enable content types and versioning in the list with id _3EA5A977-315E-4E25-8B0F
 m365 spo list set --webUrl https://contoso.sharepoint.com/sites/project-x --id 3EA5A977-315E-4E25-8B0F-E4F949BF6B8F --contentTypesEnabled true --enableVersioning true --majorVersionLimit 50 --majorWithMinorVersionsLimit 100
 ```
 
+Update the Title of a list retrieved by it's original Title
+
+```sh
+m365 spo list set --webUrl https://contoso.sharepoint.com/sites/project-x --title Documents --newTitle 'Different Title'
+```
+
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - SPList Class Members information: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.list_members.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.list_members.aspx)