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

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/context/context-init.md

@@ -0,0 +1,25 @@
+# context init
+
+Initiates CLI for Microsoft 365 context in the current working folder
+
+## Usage
+
+```sh
+m365 context init [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Initiates CLI for Microsoft 365 context in the current working folder
+
+```sh
+m365 context init
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -16,6 +16,8 @@ m365 pp environment get [options]
 `--asAdmin`
 : Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
 
+--8<-- "docs/cmd/_global.md"
+
 ## Remarks
 
 !!! attention

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/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/spfx/project/project-upgrade.md

@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
 
 ## Remarks
 
-The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.0).
+The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.16.1).
 
 This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.