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

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

@@ -1,179 +0,0 @@
-# spo listitem list
-
-Gets a list of items from the specified list
-
-## Usage
-
-```sh
-m365 spo listitem list [options]
-```
-
-## Options
-
-`-u, --webUrl <webUrl>`
-: URL of the site from which the item should be retrieved.
-
-`-l, --listId [listId]`
-: ID of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
-
-`-t, --listTitle [listTitle]`
-: Title of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
-
-`--listUrl [listUrl]`
-: Server- or site-relative URL of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
-
-`-q, --camlQuery [camlQuery]`
-: CAML query to use to query the list of items with.
-
-`-f, --fields [fields]`
-: Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested. Specify `camlQuery` or `fields` but not both.
-
-`-l, --filter [filter]`
-: OData filter to use to query the list of items with. Specify `camlQuery` or `filter` but not both.
-
-`-s, --pageSize [pageSize]`
-: Number of list items to return. Specify `camlQuery` or `pageSize` but not both. The default value is 5000.
-
-`-n, --pageNumber [pageNumber]`
-: Page number to return if `pageSize` is specified (first page is indexed as value of 0).
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-This command retrieves all items in the list, even if there are more than 5000. Use the `pageSize` and `pageNumber` options if you only want a specific amount of items. When using a CAML query, include a `RowLimit`-node to get all items. If you run into list view threshold exceptions, remove any Query-conditions or filters and also include a `RowLimit`-node.
-
-`pageNumber` is specified as a 0-based index. A value of `2` returns the third page of items.
-
-If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
-
-## Examples
-
-Get all items from a list named Demo List
-
-```sh
-m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x
-```
-
-Get all items from a list with ID _935c13a0-cc53-4103-8b48-c1d0828eaa7f_
-
-```sh
-m365 spo listitem list --listId 935c13a0-cc53-4103-8b48-c1d0828eaa7f --webUrl https://contoso.sharepoint.com/sites/project-x
-```
-
-Get all items from list named _Demo List_. For each item, retrieve the value of the _ID_, _Title_ and _Modified_ fields
-
-```sh
-m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
-```
-
-Get all items from list named _Demo List_. For each item, retrieve the value of the _ID_, _Title_, _Modified_ fields, and the value of lookup field _Company_
-
-```sh
-m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified,Company/Title"
-```
-
-From a list named _Demo List_ get all items with title _Demo list item_ using an OData filter
-
-```sh
-m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --filter "Title eq 'Demo list item'"
-```
-
-From a list named _Demo List_ get the first 100 items
-
-```sh
-m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 100 --pageNumber 0
-```
-
-From a list named _Demo List_ get the second batch of 10 items
-
-```sh
-m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 1
-```
-
-Get all items from a list by server-relative URL
-
-```sh
-m365 spo listitem list --listUrl /sites/project-x/documents --webUrl https://contoso.sharepoint.com/sites/project-x
-```
-
-From a list named _Demo List_ get all items with title _Demo list item_ using a CAML query
-
-```sh
-m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View><Query><Where><Eq><FieldRef Name='Title' /><Value Type='Text'>Demo list item</Value></Eq></Where></Query><RowLimit Paged='TRUE'>5000</RowLimit></View>"
-```
-
-From a library named _Demo Library_ with 5000+ files and folders, get all items recursively without running into a list view threshold exception, using a CAML query
-
-```sh
-m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View Scope='RecursiveAll'><Query></Query><ViewFields><FieldRef Name='Title'/></ViewFields><RowLimit Paged='TRUE'>5000</RowLimit></View>"
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "FileSystemObjectType": 0,
-        "Id": 236,
-        "ServerRedirectedEmbedUri": null,
-        "ServerRedirectedEmbedUrl": "",
-        "ContentTypeId": "0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803",
-        "Title": "Test",
-        "Modified": "2022-11-16T21:00:03Z",
-        "Created": "2022-11-16T20:56:31Z",
-        "AuthorId": 10,
-        "EditorId": 10,
-        "OData__UIVersionString": "6.0",
-        "Attachments": true,
-        "GUID": "cac57513-e870-4e7a-9f23-f4ea10e14f4e",
-        "ComplianceAssetId": null,
-        "OData__vti_ItemDeclaredRecord": null
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    Id   Title
-    ---  -----
-    236  Test
-    ```
-
-=== "CSV"
-
-    ```csv
-    FileSystemObjectType,Id,ServerRedirectedEmbedUri,ServerRedirectedEmbedUrl,ContentTypeId,Title,Modified,Created,AuthorId,EditorId,OData__UIVersionString,Attachments,GUID,ComplianceAssetId,OData__vti_ItemDeclaredRecord
-    0,236,,,0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803,Test,2022-11-16T21:00:03Z,2022-11-16T20:56:31Z,10,10,6.0,1,cac57513-e870-4e7a-9f23-f4ea10e14f4e,,
-    ```
-
-=== "Markdown"
-
-    ```md
-    # spo listitem list --webUrl "https://contoso.sharepoint.com" --listTitle "My List"
-
-    Date: 2/20/2023
-
-    ## Demo Item (147)
-
-    Property | Value
-    ---------|-------
-    FileSystemObjectType | 0
-    Id | 236
-    ServerRedirectedEmbedUri | null
-    ServerRedirectedEmbedUrl |
-    ContentTypeId | 0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803
-    Title | Test
-    ComplianceAssetId | null
-    Modified | 2022-11-16T21:00:03Z
-    Created | 2022-11-16T20:56:31Z
-    AuthorId | 10
-    EditorId | 10
-    OData\_\_UIVersionString | 6.0
-    Attachments | false
-    GUID | cac57513-e870-4e7a-9f23-f4ea10e14f4e
-    OData__vti_ItemDeclaredRecord | null
-    ```

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

@@ -1,101 +0,0 @@
-# spo listitem record declare
-
-Declares the specified list item as a record
-
-## Usage
-
-```sh
-m365 spo listitem record declare [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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
-
-=== "JSON"
-
-    ```json
-    {
-      "SchemaVersion": "15.0.0.0",
-      "LibraryVersion": "16.0.23102.12004",
-      "ErrorInfo": null,
-      "TraceCorrelationId": "064779a0-d05b-5000-843d-c36803e58f12"
-    }
-    ```
-
-=== "Text"
-
-    ```text
-    ErrorInfo         : null
-    LibraryVersion    : 16.0.23102.12004
-    SchemaVersion     : 15.0.0.0
-    TraceCorrelationId: 0a4779a0-c0ca-5000-d29d-4321a1739425
-    ```
-
-=== "CSV"
-
-    ```csv
-    SchemaVersion,LibraryVersion,ErrorInfo,TraceCorrelationId
-    15.0.0.0,16.0.23102.12004,,0d4779a0-609c-5000-843d-c98e4764c937
-    ```
-
-=== "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
-    ```

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

@@ -1,52 +0,0 @@
-# spo listitem record lock
-
-Locks the list item record
-
-## Usage
-
-```sh
-m365 spo listitem record lock [options]
-```
-
-## Options
-
-`-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`
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,52 +0,0 @@
-# spo listitem record undeclare
-
-Undeclares list item as a record
-
-## Usage
-
-```sh
-m365 spo listitem record undeclare [options]
-```
-
-## Options
-
-`-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`
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,52 +0,0 @@
-# spo listitem record unlock
-
-Unlocks the list item record
-
-## Usage
-
-```sh
-m365 spo listitem record unlock [options]
-```
-
-## Options
-
-`-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`
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,58 +0,0 @@
-# spo listitem remove
-
-Removes the specified list item
-
-## Usage
-
-```sh
-m365 spo listitem remove [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,71 +0,0 @@
-# spo listitem retentionlabel ensure
-
-Apply a retention label to a list item
-
-## Usage
-
-```sh
-m365 spo listitem retentionlabel ensure [options]
-```
-
-## Options
-
-`-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.
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,55 +0,0 @@
-# spo listitem retentionlabel remove
-
-Clears the retention label from a list item
-
-## Usage
-
-```sh
-m365 spo listitem retentionlabel remove [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.