@pnp/cli-microsoft365 6.1.0-beta.c68d208 → 6.1.0-beta.d7b6439

package/docs/docs/cmd/spo/group/group-member-add.md

@@ -20,10 +20,13 @@ m365 spo group member add [options]
 : Name of the SharePoint Group to which the user needs to be added, specify either `groupId` or `groupName`
 
 `--userName [userName]`
-: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
+: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName`, `email` or `userId`
 
 `--email [email]`
-: User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
+: User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName`, `email` or `userId`
+
+`--userId [userId]`
+: The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Id's have to be comma separated. Specify either `userName`, `email` or `userId`
 
 --8<-- "docs/cmd/_global.md"
 
@@ -33,26 +36,75 @@ For the `--userName` or `--email` options you can specify multiple values by sep
 
 ## Examples
 
-Add a user with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Add a user with the userName parameter to a SharePoint group with the groupId parameter
 
 ```sh
 m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
 ```
 
-Add multiple users by name to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Add multiple users with the userName parameter to a SharePoint group with the groupId parameter
 
 ```sh
 m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
 ```
 
-Add a user with email _Alex.Wilber@contoso.com_ to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Add a user with the email parameter to a SharePoint group with the groupName parameter
 
 ```sh
 m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com"
 ```
 
-Add multiple users by email to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Add multiple users with the email parameter to a SharePoint group with the groupName parameter
 
 ```sh
 m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
 ```
+
+Add a user with the userId parameter to a SharePoint group with the groupId parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userId 5
+```
+
+Add multiple users with the userId parameter to a SharePoint group with the groupId parameter
+
+```sh
+m365 spo group member add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userId "5,12"
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "AllowedRoles": [
+          0
+        ],
+        "CurrentRole": 0,
+        "DisplayName": "John Doe",
+        "Email": "john.doe@contoso.onmicrosoft.com",
+        "InvitationLink": null,
+        "IsUserKnown": true,
+        "Message": null,
+        "Status": true,
+        "User": "i:0#.f|membership|john.doe@contoso.onmicrosoft.com"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    DisplayName  Email
+    -----------  ---------------------------------
+    John Doe     john.doe@contoso.onmicrosoft.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    DisplayName,Email
+    John Doe,john.doe@contoso.onmicrosoft.com
+    ```

package/docs/docs/cmd/spo/group/group-member-remove.md

@@ -11,29 +11,45 @@ m365 spo group member remove [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the SharePoint group is available
+: URL of the site where the SharePoint group is available.
 
 `--groupId [groupId]`
-: Id of the SharePoint group from which the user has to be removed. Specify either `groupName` or `groupId`, but not both
+: Id of the SharePoint group from which the user has to be removed. Specify either `groupName` or `groupId`, but not both.
 
 `--groupName  [groupName]`
-: Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both
+: Name of the SharePoint group from which user has to be removed. Specify either `groupName` or `groupId`, but not both.
 
-`--userName <userName>`
-: The UPN of the user that needs to be removed (user principal name, eg. megan.bowen@contoso.com)
+`--userName [userName]`
+: The UPN (user principal name, eg. megan.bowen@contoso.com) of the user that needs to be removed. Specify either `userName`, `email`, or `userId`, but not multiple.
+
+`--email [email]`
+: The email of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
+
+`--userId [userId]`
+: The user Id (Id of the site user, eg. 14) of the user to remove as a member. Specify either `userName`, `email`, or `userId`, but not multiple.
 
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
 
-Remove a user from SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Remove a user from a SharePoint group by userName.
 
 ```sh
 m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
 ```
 
-Remove a user from SharePoint group with Name _Site A Visitors_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
+Remove a user from a SharePoint group by email.
+
+```sh
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --email "Alex.Wilber@contoso.com"
+```
+
+Remove a user from a SharePoint group by id.
 
 ```sh
-m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userName "Alex.Wilber@contoso.com"
+m365 spo group member remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userId 14
 ```
+
+## 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/listitem/listitem-remove.md

@@ -11,16 +11,16 @@ m365 spo listitem remove [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: URL of the site where the list to remove is located
+: 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 added. Specify either `listTitle`, `listId` or `listUrl`
+: 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 added. Specify either `listTitle`, `listId` or `listUrl`
+: 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`
@@ -35,19 +35,19 @@ m365 spo listitem remove [options]
 
 ## Examples
 
-Remove the list item with ID _1_ from list with ID  _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
+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 with ID _1_ from list with title _List 1_ located in site _https://contoso.sharepoint.com/sites/project-x_
+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 with a specific ID from a list retrieved by server-relative URL located in a specific site
+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

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

@@ -0,0 +1,55 @@
+# 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.

package/docs/docs/cmd/spo/site/site-appcatalog-list.md

@@ -0,0 +1,55 @@
+# spo site appcatalog list
+
+List all site collection app catalogs within the tenant
+
+## Usage
+
+```sh
+m365 spo site appcatalog list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you need to have at least read permissions on the SharePoint root site.
+
+## Examples
+
+List all site collection app catalogs within the tenant
+
+```sh
+m365 spo site appcatalog list
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "AbsoluteUrl": "https://contoso.sharepoint.com/sites/site1",
+        "ErrorMessage": "Success",
+        "SiteID": "9798e615-b586-455e-8486-84913f492c49"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    AbsoluteUrl                                          SiteID
+    ---------------------------------------------------  ------------------------------------
+    https://contoso.sharepoint.com/sites/site1           9798e615-b586-455e-8486-84913f492c49
+    ```
+
+=== "CSV"
+
+    ```csv
+    AbsoluteUrl,SiteID
+    https://contoso.sharepoint.com/sites/site1,9798e615-b586-455e-8486-84913f492c49
+    ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "6.1.0-beta.c68d208",
+  "version": "6.1.0-beta.d7b6439",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",

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

@@ -1,65 +0,0 @@
-# spo list retentionlabel set
-
-Sets a default retention label on the specified list or library.
-
-## Usage
-
-```sh
-m365 spo list retentionlabel set [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 only one of `listTitle`, `listId` or `listUrl`
-
-`-l, --listId [listId]`
-: The ID of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
-
-`--listUrl [listUrl]`
-: Server- or web-relative URL of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
-
-`--syncToItems`
-: Specify, to set the label on all existing items in the list
-
-`--blockDelete`
-: Specify, to disallow deleting items in the list
-
-`--blockEdit`
-: 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 "Some label" on the list _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo list retentionlabel set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --label 'Some label'
-```
-
-Sets retention label "Some label" and disables editing and deleting items on the list and all existing items for list for list _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo list retentionlabel set --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.