@pnp/cli-microsoft365 6.1.0-beta.1da0a1d → 6.1.0-beta.73ca1bf

package/docs/docs/cmd/cli/completion/completion-pwsh-update.md

@@ -21,9 +21,13 @@ This commands updates the list of commands and their options used by command com
 Update list of commands for PowerShell command completion
 
 ```powershell
-cli completion pwsh update
+m365 cli completion pwsh update
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - Command completion: [https://pnp.github.io/cli-microsoft365/user-guide/completion/](https://pnp.github.io/cli-microsoft365/user-guide/completion/)

package/docs/docs/cmd/cli/completion/completion-sh-setup.md

@@ -17,9 +17,29 @@ m365 cli completion sh setup [options]
 Set up command completion for Zsh, Bash or Fish
 
 ```powershell
-cli completion sh setup
+m365 cli completion sh setup
 ```
 
+## Response
+
+=== "JSON"
+
+    ```json
+    "Command completion successfully registered. Restart your shell to load the completion"
+    ```
+
+=== "Text"
+
+    ```text
+    Command completion successfully registered. Restart your shell to load the completion
+    ```
+
+=== "CSV"
+
+    ```csv
+    Command completion successfully registered. Restart your shell to load the completion
+    ```
+
 ## More information
 
 - Command completion: [https://pnp.github.io/cli-microsoft365/user-guide/completion/](https://pnp.github.io/cli-microsoft365/user-guide/completion/)

package/docs/docs/cmd/cli/completion/completion-sh-update.md

@@ -24,6 +24,10 @@ Update list of commands for Zsh, Bash and Fish command completion
 m365 cli completion sh update
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - Command completion: [https://pnp.github.io/cli-microsoft365/user-guide/completion/](https://pnp.github.io/cli-microsoft365/user-guide/completion/)

package/docs/docs/cmd/cli/config/config-get.md

@@ -29,6 +29,28 @@ Get the output configured for CLI for Microsoft 365
 m365 cli config get --key output
 ```
 
+## Response
+
+When retrieving the `output` key, responses will look like this:
+
+=== "JSON"
+
+    ```json
+    "json"
+    ```
+
+=== "Text"
+
+    ```text
+    json
+    ```
+
+=== "CSV"
+
+    ```csv
+    json
+    ```
+
 ## More information
 
 - [Configuring the CLI for Microsoft 365](../../../user-guide/configuring-cli.md)

package/docs/docs/cmd/cli/config/config-reset.md

@@ -31,6 +31,10 @@ Reset all configuration settings to default
 m365 cli config reset
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - [Configuring the CLI for Microsoft 365](../../../user-guide/configuring-cli.md)

package/docs/docs/cmd/cli/config/config-set.md

@@ -34,6 +34,10 @@ Configure the default CLI output to JSON
 m365 cli config set --key output --value json
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - [Configuring the CLI for Microsoft 365](../../../user-guide/configuring-cli.md)

package/docs/docs/cmd/planner/plan/plan-set.md

@@ -0,0 +1,144 @@
+# planner plan set
+
+Updates a Microsoft Planner plan
+
+## Usage
+
+```sh
+m365 planner plan set [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the plan. Specify either `id` or `title` but not both.
+
+`-t, --title [title]`
+: Title of the plan. Specify either `id` or `title` but not both.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the Group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+
+`--newTitle [newTitle]`
+: New title of the plan.
+
+`--shareWithUserIds [shareWithUserIds]`
+: The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
+
+`--shareWithUserNames [shareWithUserNames]`
+: The comma-separated UPNs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+This command allows using unknown options. 
+
+`--category1 [category1]`
+: New label for a category. Define the category key within your option to update the related label. Category 1 to 25 are available. E.g., `--category4`, `--category12`.
+
+## Examples
+
+Updates a Microsoft Planner plan title to New Title
+
+```sh
+m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --newTitle 'New Title'
+```
+
+Share a Microsoft Planner plan owned by the group, with the users
+
+```sh
+m365 planner plan set --title 'Plan Title' --ownerGroupName 'My Group' --shareWithUserNames 'user1@contoso.com,user2@contoso.com'
+```
+
+Updates a Microsoft Planner plan category labels
+
+```sh
+m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --category25 'Urgent'
+```
+
+## More information
+
+- Update plannerPlan: [https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http](https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http)
+- plannerPlanDetails resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0)
+- plannerCategoryDescriptions resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0)
+
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+      "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "title": "My Planner Plan",
+      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+        },
+        "application": {
+          "displayName": null,
+          "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      },
+      "container": {
+        "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "type": "group",
+        "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+      },
+      "sharedWith": {
+        "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
+        "6463a5ce-2119-4198-9f2a-628761df4a62": true
+      },
+      "categoryDescriptions": {
+        "category1": null,
+        "category2": null,
+        "category3": null,
+        "category4": null,
+        "category5": null,
+        "category6": null,
+        "category7": null,
+        "category8": null,
+        "category9": null,
+        "category10": null,
+        "category11": null,
+        "category12": null,
+        "category13": null,
+        "category14": null,
+        "category15": null,
+        "category16": null,
+        "category17": null,
+        "category18": null,
+        "category19": null,
+        "category20": null,
+        "category21": null,
+        "category22": null,
+        "category23": null,
+        "category24": null,
+        "category25": null
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdDateTime: 2015-03-30T18:36:49.2407981Z
+    id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+    title          : My Planner Plan
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```
+

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

@@ -0,0 +1,123 @@
+# pp chatbot get
+
+Get information about the specified chatbot
+
+## Usage
+
+```sh
+pp chatbot get [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i, --id [id]`
+: The id of the chatbot. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The name of the chatbot. Specify either `id` or `name` but not both.
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a specific chatbot in a specific environment based on name
+
+```sh
+m365 pp chatbot get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Chatbot"
+```
+
+Get a specific chatbot in a specific environment based on name as admin
+
+```sh
+m365 pp chatbot get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Chatbot" --asAdmin
+```
+
+Get a specific chatbot in a specific environment based on id
+
+```sh
+m365 pp chatbot get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893"
+```
+
+Get a specific chatbot in a specific environment based on id as admin
+
+```sh
+m365 pp chatbot get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893" --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "authenticationtrigger": 0,
+      "_owningbusinessunit_value": "6da087c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "statuscode": 1,
+      "createdon": "2022-11-19T10:42:22Z",
+      "statecode": 0,
+      "schemaname": "new_bot_23f5f58697fd43d595eb451c9797a53d",
+      "_ownerid_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "overwritetime": "1900-01-01T00:00:00Z",
+      "name": "CLI 365 Chatbot",
+      "solutionid": "fd140aae-4df4-11dd-bd17-0019b9312238",
+      "ismanaged": false,
+      "versionnumber": 1421457,
+      "language": 1033,
+      "_modifiedby_value": "5f91d7a7-5f46-494a-80fa-5c18b0221351",
+      "_modifiedonbehalfby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "modifiedon": "2022-11-19T10:42:24Z",
+      "componentstate": 0,
+      "botid": "3a081d91-5ea8-40a7-8ac9-abbaa3fcb893",
+      "_createdby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "componentidunique": "cdcd6496-e25d-4ad1-91cf-3f4d547fdd23",
+      "authenticationmode": 1,
+      "_owninguser_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+      "accesscontrolpolicy": 0,
+      "runtimeprovider": 0,
+      "_publishedby_value": "John Doe",
+      "authenticationconfiguration": null,
+      "authorizedsecuritygroupids": null,
+      "overriddencreatedon": null,
+      "applicationmanifestinformation": null,
+      "importsequencenumber": null,
+      "synchronizationstatus": null,
+      "template": null,
+      "_providerconnectionreferenceid_value": null,
+      "configuration": null,
+      "utcconversiontimezonecode": null,
+      "publishedon": "2022-11-19T10:43:24Z",
+      "_createdonbehalfby_value": null,
+      "iconbase64": null,
+      "supportedlanguages": null,
+      "_owningteam_value": null,
+      "timezoneruleversionnumber": null,
+      "iscustomizable": {
+        "Value": true,
+        "CanBeChanged": true,
+        "ManagedPropertyLogicalName": "iscustomizableanddeletable"
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    botid      : 3a081d91-5ea8-40a7-8ac9-abbaa3fcb893
+    createdon  : 2022-11-19T10:42:22Z
+    modifiedon : 2022-11-19T10:42:24Z
+    name       : CLI 365 Chatbot
+    publishedon: 2022-11-19T10:43:24Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    name,botid,publishedon,createdon,modifiedon
+    CLI 365 Chatbot,3a081d91-5ea8-40a7-8ac9-abbaa3fcb893,2022-11-19T10:43:24Z,2022-11-19T10:42:22Z,2022-11-19T10:42:24Z
+    ```

package/docs/docs/cmd/pp/chatbot/chatbot-remove.md

@@ -0,0 +1,52 @@
+# pp chatbot remove
+
+Removes the specified chatbot
+
+## Usage
+
+```sh
+m365 pp chatbot remove [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i, --id [id]`
+: The id of the chatbot. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The name of the chatbot. Specify either `id` or `name` but not both.
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the specified Microsoft Power Platform chatbot owned by the currently signed-in user based on name
+
+```sh
+m365 pp chatbot remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Chatbot Name"
+```
+
+Removes the specified Microsoft Power Platform chatbot owned by the currently signed-in user based on id without confirmation
+
+```sh
+m365 pp chatbot remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 9d9a13d0-6255-ed11-bba2-000d3adf774e --confirm
+```
+
+Removes the specified Microsoft Power Platform chatbot owned by another user based on name
+
+```sh
+m365 pp chatbot remove --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name "Chatbot Name" --asAdmin
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,90 @@
+# pp dataverse table row list
+
+Lists table rows for the given Dataverse table
+
+## Usage
+
+```sh
+pp dataverse table row list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment
+
+`--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
+
+`--asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all table rows for the given environment based on the entity set name
+
+```sh
+m365 pp dataverse table row list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --entitySetName "cr6c3_accounts"
+```
+
+List all table rows for the given environment based on the table name
+
+```sh
+m365 pp dataverse table row list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --tableName "cr6c3_account"
+```
+
+List all table rows for the given environment based on the entity set name as Admin
+
+```sh
+m365 pp dataverse table row list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --entitySetName "cr6c3_accounts" --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "cr6c3_accountsid": "95c80273-3764-ed11-9561-000d3a4bbea4",
+        "_owningbusinessunit_value": "6da087c1-1c4d-ed11-bba1-000d3a2caf7f",
+        "statecode": 0,
+        "statuscode": 1,
+        "_createdby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+        "_ownerid_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+        "modifiedon": "2022-11-14T16:14:45Z",
+        "_owninguser_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+        "_modifiedby_value": "5fa787c1-1c4d-ed11-bba1-000d3a2caf7f",
+        "versionnumber": 1413873,
+        "createdon": "2022-11-14T16:14:45Z",
+        "cr6c3_name": "Column1 value",
+        "overriddencreatedon": null,
+        "importsequencenumber": null,
+        "_modifiedonbehalfby_value": null,
+        "utcconversiontimezonecode": null,
+        "_createdonbehalfby_value": null,
+        "_owningteam_value": null,
+        "timezoneruleversionnumber": null
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    cr6c3_accountsid                       _owningbusinessunit_value             statecode  statuscode  _createdby_value                      _ownerid_value                        modifiedon            _owninguser_value                     _modifiedby_value                     versionnumber  createdon             cr6c3_name      overriddencreatedon  importsequencenumber  _modifiedonbehalfby_value  utcconversiontimezonecode  _createdonbehalfby_value  _owningteam_value  timezoneruleversionnumber
+    ------------------------------------  ------------------------------------  ---------  ----------  ------------------------------------  ------------------------------------  --------------------  ------------------------------------  ------------------------------------  -------------  --------------------  ----------      -------------------  --------------------  -------------------------  -------------------------  ------------------------  -----------------  -------------------------
+    95c80273-3764-ed11-9561-000d3a4bbea4  6da087c1-1c4d-ed11-bba1-000d3a2caf7f  0          1           5fa787c1-1c4d-ed11-bba1-000d3a2caf7f  5fa787c1-1c4d-ed11-bba1-000d3a2caf7f  2022-11-14T16:14:45Z  5fa787c1-1c4d-ed11-bba1-000d3a2caf7f  5fa787c1-1c4d-ed11-bba1-000d3a2caf7f  1413873        2022-11-14T16:14:45Z  Column1 value   null                 null                  null                       null                       null                      null               null
+    ```
+
+=== "CSV"
+
+    ```csv
+    cr6c3_accountsid,_owningbusinessunit_value,statecode,statuscode,_createdby_value,_ownerid_value,modifiedon,_owninguser_value,_modifiedby_value,versionnumber,createdon,cr6c3_name,overriddencreatedon,importsequencenumber,_modifiedonbehalfby_value,utcconversiontimezonecode,_createdonbehalfby_value,_owningteam_value,timezoneruleversionnumber
+    95c80273-3764-ed11-9561-000d3a4bbea4,6da087c1-1c4d-ed11-bba1-000d3a2caf7f,0,1,5fa787c1-1c4d-ed11-bba1-000d3a2caf7f,5fa787c1-1c4d-ed11-bba1-000d3a2caf7f,2022-11-14T16:14:45Z,5fa787c1-1c4d-ed11-bba1-000d3a2caf7f,5fa787c1-1c4d-ed11-bba1-000d3a2caf7f,1413873,2022-11-14T16:14:45Z,Column1 value,,,,,,,
+    ```

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/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.