@pnp/cli-microsoft365 6.1.0-beta.fd67be0 → 6.2.0-beta.01dcbcb

package/docs/docs/cmd/pp/dataverse/dataverse-table-row-remove.md

@@ -0,0 +1,61 @@
+# pp dataverse table row remove
+
+Removes a row from a dataverse table in a given environment.
+
+## Usage
+
+```sh
+pp dataverse table row remove [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment to remove a row from a table from.
+
+`-i, --id <id>`
+: The id of the row to remove.
+
+`--entitySetName [entitySetName]`
+: The entity set name of the table. Specify either `entitySetName` or `tableName` but not both
+
+`--tableName [tableName]`
+: The name of the table. Specify either `entitySetName` or `tableName` but not both
+
+`--confirm`
+: Don't prompt for confirmation
+
+`--asAdmin`
+: Set, to remove the row from the dataverse table as admin for environments you are not a member of.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes a row from a dataverse table in a given environment
+
+```sh
+m365 pp dataverse table row remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --tableName "aadusers" --id "21d01cf4-356c-ed11-9561-000d3a4bbea4"
+```
+
+Removes a row from a dataverse table in a given environment as Admin
+
+```sh
+m365 pp dataverse table row remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --tableName "aadusers" --id "21d01cf4-356c-ed11-9561-000d3a4bbea4" --asAdmin
+```
+
+Removes a row from a dataverse table in a given environment without prompting for confirmation
+
+```sh
+m365 pp dataverse table row remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --tableName "aadusers" --id "21d01cf4-356c-ed11-9561-000d3a4bbea4" --confirm
+```
+
+Removes a row from a dataverse table in a given environment based on the entity set name without prompting for confirmation
+
+```sh
+m365 pp dataverse table row remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --entitySetName "cr6c3_accounts" --id "21d01cf4-356c-ed11-9561-000d3a4bbea4" --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pp/environment/environment-get.md

@@ -10,11 +10,13 @@ m365 pp environment get [options]
 
 ## Options
 
-`-n, --name <name>`
-: The name of the environment to get information about
+`-n, --name [name]`
+: The name of the environment. When not specified, the default environment is retrieved.
 
 `--asAdmin`
-: Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
+: Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
 
 ## Remarks
 
@@ -37,6 +39,12 @@ Get information as admin about the Power Platform environment by name
 m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
 ```
 
+Get information about the default Power Platform environment
+
+```sh
+m365 pp environment get
+```
+
 ## Response
 
 === "JSON"

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-get.md

@@ -0,0 +1,95 @@
+# purview retentionlabel get
+
+Get a retention label
+
+## Usage
+
+```sh
+m365 purview retentionlabel get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention label.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a retention label
+
+```sh
+m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## 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": "TEST LABEL",
+      "descriptionForAdmins": "",
+      "descriptionForUsers": "",
+      "isInUse": false,
+      "retentionTrigger": "dateCreated",
+      "behaviorDuringRetentionPeriod": "retain",
+      "actionAfterRetentionPeriod": "delete",
+      "createdDateTime": "2022-12-12T15:14:53Z",
+      "lastModifiedDateTime": "2022-12-12T15:43:06Z",
+      "labelToBeApplied": "",
+      "defaultRecordBehavior": "startLocked",
+      "id": "5c8af2e2-b489-4fa0-9c16-180180245ac8",
+      "retentionDuration": {
+        "days": 100
+      },
+      "createdBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      },
+      "lastModifiedBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      },
+      "dispositionReviewStages": []
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    actionAfterRetentionPeriod   : delete
+    behaviorDuringRetentionPeriod: retain
+    createdBy                    : {"user":{"id":null,"displayName":"John Doe"}}
+    createdDateTime              : 2022-12-12T15:14:53Z
+    defaultRecordBehavior        : startLocked
+    descriptionForAdmins         :
+    descriptionForUsers          :
+    displayName                  : TEST LABEL
+    dispositionReviewStages      : []
+    id                           : 5c8af2e2-b489-4fa0-9c16-180180245ac8
+    isInUse                      : false
+    labelToBeApplied             :
+    lastModifiedBy               : {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedDateTime         : 2022-12-12T15:43:06Z
+    retentionDuration            : {"days":100}
+    retentionTrigger             : dateCreated
+    ```
+
+=== "CSV"
+
+    ```csv
+    displayName,descriptionForAdmins,descriptionForUsers,isInUse,retentionTrigger,behaviorDuringRetentionPeriod,actionAfterRetentionPeriod,createdDateTime,lastModifiedDateTime,labelToBeApplied,defaultRecordBehavior,id,retentionDuration,createdBy,lastModifiedBy,dispositionReviewStages
+    TEST LABEL,,,,dateCreated,retain,delete,2022-12-12T15:14:53Z,2022-12-12T15:43:06Z,,startLocked,5c8af2e2-b489-4fa0-9c16-180180245ac8,"{""days"":100}","{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}",[]
+    ```

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-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/file/file-sharinglink-list.md

@@ -0,0 +1,97 @@
+# spo file sharinglink list
+
+Lists all the sharing links of a specific file
+
+## Usage
+
+```sh
+m365 spo file sharinglink list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located.
+
+`-f, --fileUrl [fileUrl]`
+: The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List sharing links of a file by id
+
+```sh
+m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234
+```
+
+List sharing links of a file by url
+
+```sh
+m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl "/sites/demo/shared documents/document.docx"
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id": "2a021f54-90a2-4016-b3b3-5f34d2e7d932",
+        "roles": [
+          "read"
+        ],
+        "hasPassword": false,
+        "grantedToIdentitiesV2": [
+          {
+            "user": {
+              "displayName": "John Doe",
+              "email": "john@contoso.onmicrosoft.com",
+              "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a"
+            },
+            "siteUser": {
+              "displayName": "John Doe",
+              "email": "john@contoso.onmicrosoft.com",
+              "id": "9",
+              "loginName": "i:0#.f|membership|john@contoso.onmicrosoft.com"
+            }
+          }
+        ],
+        "grantedToIdentities": [ 
+          {
+            "user": {
+              "displayName": "John Doe",
+              "email": "john@contoso.onmicrosoft.com",
+              "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a"
+            }
+          }
+        ],
+        "link": {
+          "scope": "anonymous",
+          "type": "view",
+          "webUrl": "https://contoso.sharepoint.com/:b:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A",
+          "preventsDownload": false
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    roles  link
+    ------------------------------------  -----  -----------------------------------------------------------------------------------------------------------
+    2a021f54-90a2-4016-b3b3-5f34d2e7d932  read   https://contoso.sharepoint.com/:b:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,roles,link
+    2a021f54-90a2-4016-b3b3-5f34d2e7d932,read,https://contoso.sharepoint.com/:b:/s/demo/EY50lub3559MtRKfj2hrZqoBWnHOpGIcgi4gzw9XiWYJ-A
+    ```

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
+    ```