@pnp/cli-microsoft365 6.1.0-beta.a927083 → 6.1.0-beta.d3a109a

package/docs/docs/cmd/pp/solution/solution-publisher-add.md

@@ -0,0 +1,49 @@
+# pp solution publisher add
+
+Adds a specified publisher in a given environment
+
+## Usage
+
+```sh
+m365 pp solution publisher add [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-n, --name <name>`
+: The unique name of the publisher.
+
+`--displayName <displayName>`
+: The friendly name of the publisher.
+
+`--prefix <prefix>`
+: The prefix of the publisher.
+
+`--choiceValuePrefix <choiceValuePrefix>`
+: The choice value prefix of the publisher.
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Add a specific publisher in a specific environment
+
+```sh
+m365 pp solution publisher add --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "Contoso" --displayName "Contoso" --prefix "new" --choiceValuePrefix 10000
+```
+
+Adds a specific publisher in a specific environment as Admin
+
+```sh
+m365 pp solution publisher add --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "Contoso" --displayName "Contoso" --prefix "new" --choiceValuePrefix 10000 --asAdmin
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pp/solution/solution-publisher-remove.md

@@ -1,4 +1,4 @@
-# solution remove
+# pp solution publisher remove
 
 Removes the specified publisher in the specified Power Platform environment
 

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md

@@ -0,0 +1,81 @@
+# purview retentionlabel list
+
+Get a list of retention labels
+
+## Usage
+
+```sh
+m365 purview retentionlabel list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a list of retention labels
+
+```sh
+m365 purview retentionlabel list
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+## Response
+
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "displayName": "Some label",
+        "descriptionForAdmins": "",
+        "descriptionForUsers": null,
+        "isInUse": true,
+        "retentionTrigger": "dateCreated",
+        "behaviorDuringRetentionPeriod": "retainAsRecord",
+        "actionAfterRetentionPeriod": "delete",
+        "createdDateTime": "2022-11-03T10:28:15Z",
+        "lastModifiedDateTime": "2022-11-03T10:28:15Z",
+        "labelToBeApplied": null,
+        "defaultRecordBehavior": "startLocked",
+        "id": "dc67203a-6cca-4066-b501-903401308f98",
+        "retentionDuration": {
+          "days": 365
+        },
+        "createdBy": {
+          "user": {
+            "id": "b52ffd35-d6fe-4b70-86d8-91cc01d76333",
+            "displayName": null
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": "b52ffd35-d6fe-4b70-86d8-91cc01d76333",
+            "displayName": null
+          }
+        },
+        "dispositionReviewStages": []
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName     isInUse
+    ------------------------------------  --------------  --------
+    dc67203a-6cca-4066-b501-903401308f98  Some label      true
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,isInUse
+    dc67203a-6cca-4066-b501-903401308f98,Some label,true
+    ```

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md

@@ -0,0 +1,36 @@
+# purview retentionlabel remove
+
+Delete a retention label
+
+## Usage
+
+```sh
+m365 purview retentionlabel remove [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention label.
+
+`--confirm`
+: Don't prompt for confirming to remove the label.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Delete a retention label
+
+```sh
+m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md

@@ -0,0 +1,63 @@
+# purview retentionlabel set
+
+Update a retention label
+
+## Usage
+
+```sh
+m365 purview retentionlabel set [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention label.
+
+`--behaviorDuringRetentionPeriod [behaviorDuringRetentionPeriod]`
+: Specifies how the behavior of a document with this label should be during the retention period. Allowed values: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`.
+
+`--actionAfterRetentionPeriod [actionAfterRetentionPeriod]`
+: Specifies the action to take on a document with this label applied after the retention period. Allowed values: `none`, `delete`, `startDispositionReview`.
+
+`--retentionDuration [retentionDuration]`
+: The number of days to retain the content.
+
+`-t, --retentionTrigger [retentionTrigger]`
+: Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. Allowed values: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`.
+
+`--defaultRecordBehavior [defaultRecordBehavior]`
+: Specifies the locked or unlocked state of a record label when it is created. Allowed values: `startLocked`, `startUnlocked`.
+
+`--descriptionForUsers [descriptionForUsers]`
+: The label information for the user.
+
+`--descriptionForAdmins [descriptionForAdmins]`
+: The label information for the admin.
+
+`--labelToBeApplied [labelToBeApplied]`
+: Specifies the replacement label to be applied automatically after the retention period of the current label ends.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Update a retention label so that it retains documents as records and deletes them after one year.
+
+```sh
+m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --behaviorDuringRetentionPeriod retainAsRecord --actionAfterRetentionPeriod delete --retentionDuration 365
+```
+
+Update a retention label so that it retains documents as regulatory records and starts a disposition review one year after the last modification date.
+
+```sh
+m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --behaviorDuringRetentionPeriod retainAsRegulatoryRecord --actionAfterRetentionPeriod startDispositionReview --retentionDuration 365 --retentionTrigger dateModified
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/search/externalconnection/externalconnection-add.md

@@ -41,3 +41,7 @@ Adds a new external connection with a limited number of authorized apps
 ```sh
 m365 search externalconnection add --id MyApp --name "Test" --description "Test" --authorizedAppIds  "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/search/externalconnection/externalconnection-get.md

@@ -31,3 +31,41 @@ Get the External Connection by its name
 ```sh
 m365 search externalconnection get --name "Test"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "CLITest",
+      "name": "CLI-Test",
+      "description": "CLI Test",
+      "state": "draft",
+      "configuration": {
+        "authorizedApps": [
+          "31359c7f-bd7e-475c-86db-fdb8c937548e"
+        ],
+        "authorizedAppIds": [
+          "31359c7f-bd7e-475c-86db-fdb8c937548e"
+        ]
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    configuration: {"authorizedApps":["31359c7f-bd7e-475c-86db-fdb8c937548e"],"authorizedAppIds":["31359c7f-bd7e-475c-86db-fdb8c937548e"]}
+    description  : CLI Test
+    id           : CLITest
+    name         : CLI-Test
+    state        : draft
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,description,state,configuration
+    CLITest,CLI-Test,CLI Test,draft,"{""authorizedApps"":[""31359c7f-bd7e-475c-86db-fdb8c937548e""],""authorizedAppIds"":[""31359c7f-bd7e-475c-86db-fdb8c937548e""]}"
+    ```

package/docs/docs/cmd/search/externalconnection/externalconnection-list.md

@@ -19,3 +19,41 @@ List external connections defined in Microsoft Search
 ```sh
 m365 search externalconnection list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id": "CLITest",
+        "name": "CLI-Test",
+        "description": "CLI Test",
+        "state": "draft",
+        "configuration": {
+          "authorizedApps": [
+            "31359c7f-bd7e-475c-86db-fdb8c937548e"
+          ],
+          "authorizedAppIds": [
+            "31359c7f-bd7e-475c-86db-fdb8c937548e"
+          ]
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id       name      state
+    -------  --------  -----
+    CLITest  CLI-Test  draft
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,state
+    CLITest,CLI-Test,draft
+    ```

package/docs/docs/cmd/search/externalconnection/externalconnection-remove.md

@@ -38,3 +38,7 @@ Removes external connection with name _Test_. Will NOT prompt for confirmation b
 ```sh
 m365 search externalconnection remove --name "Test" --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/search/externalconnection/externalconnection-schema-add.md

@@ -0,0 +1,31 @@
+# search externalconnection schema add
+
+This command allows the administrator to add a schema to a specific external connection for use in Microsoft Search.
+
+## Usage
+
+```sh
+m365 search externalconnection schema add [options]
+```
+
+## Options
+
+`-i, --externalConnectionId  <externalConnectionId>`
+: ID of the External Connection.
+
+`-s, --schema [schema]`
+: The schema object to be added.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Adds a new schema to a specific external connection.
+
+```sh
+m365 search externalconnection schema add --externalConnectionId 'CliConnectionId' --schema '{"baseType":"microsoft.graph.externalItem","properties":[{"name":"ticketTitle","type":"String","isSearchable":"true","isRetrievable":"true","labels":["title"]},{"name":"priority","type":"String","isQueryable":"true","isRetrievable":"true","isSearchable":"false"},{"name":"assignee","type":"String","isRetrievable":"true"}]}'
+```
+
+## Response
+
+The command won't return a response on success.

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/list/{list-label-get.md → list-retentionlabel-get.md}

@@ -1,11 +1,17 @@
-# spo list label get
+# spo list retentionlabel get
 
-Gets label set on the specified list
+Gets the default retention label set on the specified list or library.
 
 ## Usage
 
 ```sh
-m365 spo list label get  [options]
+m365 spo list retentionlabel get [options]
+```
+
+## Alias
+
+```sh
+m365 spo list label get [options]
 ```
 
 ## Options
@@ -26,28 +32,28 @@ m365 spo list label get  [options]
 
 ## Examples
 
-Gets label set on the list with specified title located in the specified site.
+Gets retention label set on the list with specified title located in the specified site.
 
 ```sh
-m365 spo list label get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-Gets label set on the list with specified id located in the specified site.
+Gets retention label set on the list with specified id located in the specified site.
 
 ```sh
-m365 spo list label get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-Gets label set on the list with specified server relative url located in the specified site.
+Gets retention label set on the list with specified server relative url located in the specified site.
 
 ```sh
-m365 spo list label get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-Gets label set on the list with specified site-relative URL located in the specified site.
+Gets retention label set on the list with specified site-relative URL located in the specified site.
 
 ```sh
-m365 spo list label get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
 ## Response