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

package/docs/docs/cmd/spo/listitem/listitem-record-declare.mdx

@@ -0,0 +1,115 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo listitem record declare
+
+Declares the specified list item as a record
+
+## Usage
+
+```sh
+m365 spo listitem record declare [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the list is located
+
+`-l, --listId [listId]`
+: The ID of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
+
+`-t, --listTitle [listTitle]`
+: The title of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
+
+`-i, --listItemId <listItemId>`
+: The ID of the list item to declare as record
+
+`-d, --date [date]`
+: Record declaration date in ISO format. eg. 2019-12-31
+```
+
+<Global />
+
+## Examples
+
+Declare a document with id _1_ as a record in list with title _Demo List_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --listItemId 1
+```
+
+Declare a document with id _1_ as a record in list with id _ea8e1109-2013-1a69-bc05-1403201257fc_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listId ea8e1109-2013-1a69-bc05-1403201257fc --listItemId 1
+```
+
+Declare a document with id _1_ as a record with record declaration date _March 14, 2012_ in list with title _Demo List_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --listItemId 1 --date 2012-03-14
+```
+
+Declare a document with a specific id as a record with a record declaration date a list retrieved by server-relative URL located in a specific site
+
+```sh
+m365 spo listitem record declare --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/Demo List' --listItemId 1 --date 2013-09-03
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "SchemaVersion": "15.0.0.0",
+    "LibraryVersion": "16.0.23102.12004",
+    "ErrorInfo": null,
+    "TraceCorrelationId": "064779a0-d05b-5000-843d-c36803e58f12"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ErrorInfo         : null
+  LibraryVersion    : 16.0.23102.12004
+  SchemaVersion     : 15.0.0.0
+  TraceCorrelationId: 0a4779a0-c0ca-5000-d29d-4321a1739425
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  SchemaVersion,LibraryVersion,ErrorInfo,TraceCorrelationId
+  15.0.0.0,16.0.23102.12004,,0d4779a0-609c-5000-843d-c98e4764c937
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo listitem record declare --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "Demo List" --listItemId "1" --date "2012-03-14"
+  
+  Date: 2/20/2023
+
+  Property | Value
+  ---------|-------
+  SchemaVersion | 15.0.0.0
+  LibraryVersion | 16.0.23102.12004
+  ErrorInfo | null
+  TraceCorrelationId | 064779a0-d05b-5000-843d-c36803e58f12
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/listitem/listitem-record-lock.mdx

@@ -0,0 +1,56 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem record lock
+
+Locks the list item record
+
+## Usage
+
+```sh
+m365 spo listitem record lock [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: The url of the web
+
+`--listItemId <listItemId>`
+: ID of the list item that should be locked
+
+`--listId [listId]`
+: ID of the list. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listTitle [listTitle]`
+: 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`
+```
+
+<Global />
+
+## Examples
+
+Locks the list item record in a given site based on the list id
+
+```sh
+m365 spo listitem record lock --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1
+```
+
+Locks the list item record in a given site based on the list title
+
+```sh
+m365 spo listitem record lock --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
+```
+
+Locks the list item record in a given site based on the server relative list url
+
+```sh
+m365 spo listitem record lock --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-record-undeclare.mdx

@@ -0,0 +1,56 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem record undeclare
+
+Undeclares list item as a record
+
+## Usage
+
+```sh
+m365 spo listitem record undeclare [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the list is located
+
+`-i, --listItemId <listItemId>`
+: ID of the list item to be undeclared as a record.
+
+`-l, --listId [listId]`
+: The ID of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
+
+`-t, --listTitle [listTitle]`
+: The title of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list where the item is located. Specify either `listTitle`, `listId` or `listUrl`
+```
+
+<Global />
+
+## Examples
+
+Undeclare the list item as a record with ID _1_ from list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x
+
+```sh_
+spo listitem record undeclare --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1
+```
+
+Undeclare the list item as a record with ID _1_ from list with title _List 1_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem record undeclare --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
+```
+
+Undeclare a list item with a specific id as a record from a list retrieved by server-relative URL located in a specific site
+
+```sh
+m365 spo listitem record undeclare --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/Lists 1' --id 1
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-record-unlock.mdx

@@ -0,0 +1,56 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem record unlock
+
+Unlocks the list item record
+
+## Usage
+
+```sh
+m365 spo listitem record unlock [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: The url of the web
+
+`--listItemId <listItemId>`
+: ID of the list item that should be unlocked
+
+`--listId [listId]`
+: ID of the list. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listTitle [listTitle]`
+: 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`
+```
+
+<Global />
+
+## Examples
+
+Unlocks the list item record in a given site based on the list id
+
+```sh
+m365 spo listitem record unlock --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1
+```
+
+Unlocks the list item record in a given site based on the list title
+
+```sh
+m365 spo listitem record unlock --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
+```
+
+Unlocks the list item record in a given site based on the server relative list url
+
+```sh
+m365 spo listitem record unlock --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-remove.mdx

@@ -0,0 +1,62 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem remove
+
+Removes the specified list item
+
+## Usage
+
+```sh
+m365 spo listitem remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the list item to remove is located
+
+`-i, --id <id>`
+: The ID of the list item to remove.
+
+`-l, --listId [listId]`
+: ID of the list where the item should be removed. Specify either `listTitle`, `listId` or `listUrl`
+
+`-t, --listTitle [listTitle]`
+: Title of the list where the item should be removed. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
+
+`--recycle`
+: Recycle the list item
+
+`--confirm`
+: Don't prompt for confirming removing the list item
+```
+
+<Global />
+
+## Examples
+
+Remove the list item located in a given site based on the list id
+
+```sh
+m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --id 1
+```
+
+Remove the list item located in a given site based on the list title
+
+```sh
+m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --id 1
+```
+
+Remove the list item located in a given site based on the server-relative list url
+
+```sh
+m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --id 1
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx

@@ -0,0 +1,75 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem retentionlabel ensure
+
+Apply a retention label to a list item
+
+## Usage
+
+```sh
+m365 spo listitem retentionlabel ensure [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the retentionlabel from a listitem to apply is located
+
+`--listItemId <listItemId>`
+: The ID of the list item for which the retention label should be applied.
+
+`--listId [listId]`
+: ID of the list where the retention label should be applied. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listTitle [listTitle]`
+: Title of the list where the retention label should be applied. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
+
+`-n, --name [name]`
+: The name of the retention label. Specify either `name` or `id`.
+
+`-i, --id [id]`
+: The id of the retention label. Specify either `name` or `id`.
+
+`-a, --assetId [assetId]`
+: A Compliance Asset Id to set on the item when it's labeled. See below for more information.
+```
+
+<Global />
+
+## Remarks
+
+The `--assetId` option has to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
+
+## Examples
+
+Applies a retention label to a list item in a given site based on the list id and label name
+
+```sh
+m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1 --name 'Some label'
+```
+
+Applies a retention label to a list item in a given site based on the list title and label id
+
+```sh
+m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1 --id '7a621a91-063b-461b-aff6-d713d5fb23eb'
+```
+
+Applies a retention label to a list item in a given site based on the server relative list url
+
+```sh
+m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1 --name 'Some label'
+```
+
+Applies a retention label to a list item in a given site based on the server relative list url and updates the Asset Id field
+
+```sh
+m365 spo listitem retentionlabel ensure --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1 --name 'Some label' --assetId 'XYZ'
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx

@@ -0,0 +1,59 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem retentionlabel remove
+
+Clears the retention label from a list item
+
+## Usage
+
+```sh
+m365 spo listitem retentionlabel remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the retentionlabel from a listitem to remove is located
+
+`-i, --listItemId <listItemId>`
+: The ID of the list item for which the retention label should be removed.
+
+`-l, --listId [listId]`
+: ID of the list where the retention label should be removed. Specify either `listTitle`, `listId` or `listUrl`
+
+`-t, --listTitle [listTitle]`
+: Title of the list where the retention label should be removed. Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
+
+`--confirm`
+: Don't prompt for confirming removing the retention label from a list item
+```
+
+<Global />
+
+## Examples
+
+Removes the retention label from a list item in a given site based on the list id
+
+```sh
+m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 1
+```
+
+Removes the retention label from a list item in a given site based on the list title
+
+```sh
+m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --listItemId 1
+```
+
+Removes the retention label from a list item in a given site based on the server relative list url
+
+```sh
+m365 spo listitem retentionlabel remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --listItemId 1
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx

@@ -0,0 +1,89 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem roleassignment add
+
+Adds a role assignment to a listitem.
+
+## Usage
+
+```sh
+m365 spo listitem roleassignment add [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the listitem is located
+
+`--listId [listId]`
+: ID of the list. Specify either listId, listTitle or listUrl but not multiple.
+
+`--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.
+
+`--listItemId <listItemId>`
+: Id of the listitem to assign the role to.
+
+`--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
+```
+
+<Global />
+
+## Examples
+
+Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition id.
+
+```sh
+m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --principalId 11 --roleDefinitionId 1073741829
+```
+
+Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition id.
+
+```sh
+m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "0CD891EF-AFCE-4E55-B836-FCE03286CCCF" --listItemId 1 --principalId 11 --roleDefinitionId 1073741829
+```
+
+Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition id.
+
+```sh
+m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listUrl "sites/documents" --listItemId 1 --principalId 11 --roleDefinitionId 1073741829
+```
+
+Add role assignment to specified listitem in specified list located in specified site for specified upn and specified role definition id.
+
+```sh
+m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --upn "someaccount@tenant.onmicrosoft.com" --roleDefinitionId 1073741829
+```
+
+Add role assignment to specified listitem in specified list located in specified site for specified group and specified role definition id.
+
+```sh
+m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --groupName "someGroup" --roleDefinitionId 1073741829
+```
+
+Add role assignment to specified listitem in specified list located in specified site for specified principal id and specified role definition name.
+
+```sh
+m365 spo listitem roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --listItemId 1 --principalId 11 --roleDefinitionName "Full Control"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx

@@ -0,0 +1,75 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo listitem roleassignment remove
+
+Removes a role assignment from a listitem.
+
+## Usage
+
+```sh
+m365 spo listitem roleassignment remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the listitem 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.
+
+`--listItemId <listItemId>`
+: Id of the listitem to remove the role from.
+
+`--principalId [principalId]`
+: SharePoint ID of principal it may be either user id or group id we 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.
+```
+
+<Global />
+
+## Examples
+
+Remove roleassignment from listitem getting list by title based on group name
+
+```sh
+m365 spo listitem roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listTitle "someList" --listItemId 1 --groupName "saleGroup"
+```
+
+Remove roleassignment from listitem getting list by title based on principal Id
+
+```sh
+m365 spo listitem roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listTitle "Events" --listItemId 1 --principalId 2
+```
+
+Remove roleassignment from listitem getting list by url based on principal Id
+
+```sh
+m365 spo listitem roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listUrl '/sites/contoso-sales/lists/Events' --listItemId 1 --principalId 2
+```
+
+
+Remove roleassignment from listitem getting list by url based on principal Id without prompting for confirmation
+
+```sh
+m365 spo listitem roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --listUrl '/sites/contoso-sales/lists/Events' --listItemId 1 --principalId 2 --confirm
+```
+
+## Response
+
+The command won't return a response on success.