@pnp/cli-microsoft365 6.0.0-beta.566a6b8 → 6.0.0-beta.5bdba89

package/docs/docs/cmd/pa/environment/environment-list.md

@@ -24,3 +24,112 @@ List Microsoft Power Apps environments in the current tenant
 ```sh
 m365 pa environment list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id":"/providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d",
+        "name":"Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d",
+        "location":"europe",
+        "type":"Microsoft.PowerApps/environments",
+        "properties":{
+          "azureRegionHint":"westeurope",
+          "displayName":"contoso (default) (org6633049a)",
+          "createdTime":"2020-03-12T13:39:17.9876946Z",
+          "createdBy":{
+            "id":"SYSTEM",
+            "displayName":"SYSTEM",
+            "type":"NotSpecified"
+          },
+          "provisioningState":"Succeeded",
+          "creationType":"DefaultTenant",
+          "environmentSku":"Default",
+          "environmentType":"Production",
+          "isDefault":true,
+          "runtimeEndpoints":{
+            "microsoft.BusinessAppPlatform":"https://europe.api.bap.microsoft.com",
+            "microsoft.CommonDataModel":"https://europe.api.cds.microsoft.com",
+            "microsoft.PowerApps":"https://europe.api.powerapps.com",
+            "microsoft.PowerAppsAdvisor":"https://europe.api.advisor.powerapps.com",
+            "microsoft.PowerVirtualAgents":"https://powervamg.eu-il109.gateway.prod.island.powerapps.com",
+            "microsoft.ApiManagement":"https://management.EUROPE.azure-apihub.net",
+            "microsoft.Flow":"https://emea.api.flow.microsoft.com"
+          },
+          "linkedEnvironmentMetadata":{
+            "type":"Dynamics365Instance",
+            "resourceId":"5041ef46-5a1c-4a0f-a185-6bb49b5c6686",
+            "friendlyName":"contoso (default)",
+            "uniqueName":"unq5041ef465a1c4a0fa1856bb49b5c6",
+            "domainName":"org6633049a",
+            "version":"9.2.22101.00168",
+            "instanceUrl":"https://org6633049a.crm4.dynamics.com/",
+            "instanceApiUrl":"https://org6633049a.api.crm4.dynamics.com",
+            "baseLanguage":1033,
+            "instanceState":"Ready",
+            "createdTime":"2021-10-08T09:50:41.283Z",
+            "modifiedTime":"2022-10-29T14:04:14.0720726Z",
+            "hostNameSuffix":"crm4.dynamics.com",
+            "bapSolutionId":"00000001-0000-0000-0001-00000000009b",
+            "creationTemplates":[
+              "D365_CDS"
+            ],
+            "webApiVersion":"v9.0",
+            "platformSku":"Standard"
+          },
+          "retentionPeriod":"P7D",
+          "lifecycleAuthority":"Environment",
+          "states":{
+            "management":{
+              "id":"NotSpecified"
+            },
+            "runtime":{
+              "runtimeReasonCode":"NotSpecified",
+              "requestedBy":{
+                "displayName":"SYSTEM",
+                "type":"NotSpecified"
+              },
+              "id":"Enabled"
+            }
+          },
+          "updateCadence":{
+            "id":"Frequent"
+          },
+          "connectedGroups":[],
+          "protectionStatus":{
+            "keyManagedBy":"Microsoft"
+          },
+          "trialScenarioType":"None",
+          "cluster":{
+            "category":"Prod",
+            "number":"109",
+            "uriSuffix":"eu-il109.gateway.prod.island",
+            "geoShortName":"EU",
+            "environment":"Prod"
+          },
+          "governanceConfiguration":{
+            "protectionLevel":"Basic"
+          }
+        },
+        "displayName":"contoso (default) (org6633049a)"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    displayName                             name
+    --------------------------------------- --------------------------------------------
+    environmentName (default) (org6633050c) Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e
+    ```
+
+=== "CSV"
+
+    ```csv
+    name,displayName
+    Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,environmentName (default) (org6633050c)
+    ```

package/docs/docs/cmd/pa/pcf/pcf-init.md

@@ -43,6 +43,10 @@ Initialize the PowerApps Component Framework for a Dataset component
 m365 pa pcf init --namespace yourNamespace --name yourCustomFieldComponent --template Dataset
 ```
 
+## Response
+
+The response is a custom message which will show the location where the component framework has been created and a message to remind you to run `npm install` in the directory.
+
 ## More information
 
 - Create and build a custom component: [https://docs.microsoft.com/en-us/powerapps/developer/component-framework/create-custom-controls-using-pcf](https://docs.microsoft.com/en-us/powerapps/developer/component-framework/create-custom-controls-using-pcf)

package/docs/docs/cmd/pa/solution/solution-init.md

@@ -32,6 +32,11 @@ Initializes a CDS solution project using _yourPublisherName_ as publisher name a
 m365 pa solution init --publisherName yourPublisherName --publisherPrefix ypn
 ```
 
+## Response
+
+The response is a custom message which will show the location where the solution has been created and a message to remind you to have a look at the publisher information and solution name in the `Solution.xml` file.
+
+
 ## More information
 
 - Create and build a custom component: [https://docs.microsoft.com/en-us/powerapps/developer/component-framework/create-custom-controls-using-pcf](https://docs.microsoft.com/en-us/powerapps/developer/component-framework/create-custom-controls-using-pcf)

package/docs/docs/cmd/pa/solution/solution-reference-add.md

@@ -29,6 +29,10 @@ Adds a reference inside the CDS Solution project in the current directory to the
 m365 pa solution reference add --projectPath ./projects/ExampleProject
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - Create and build a custom component: [https://docs.microsoft.com/en-us/powerapps/developer/component-framework/create-custom-controls-using-pcf](https://docs.microsoft.com/en-us/powerapps/developer/component-framework/create-custom-controls-using-pcf)

package/docs/docs/cmd/planner/bucket/bucket-add.md

@@ -43,3 +43,32 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
 ```sh
 m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "name": "My Planner Bucket",
+      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "orderHint": "8585363889524958496",
+      "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id       : ttEB_Uj690STdR3GC1MIDZgANq1U
+    name     : My Planner Bucket
+    orderHint: 8585363889524958496
+    planId   : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-get.md

@@ -55,3 +55,32 @@ Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40f
 ```sh
 m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "name": "My Planner Bucket",
+      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "orderHint": "8585363889524958496",
+      "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id       : ttEB_Uj690STdR3GC1MIDZgANq1U
+    name     : My Planner Bucket
+    orderHint: 8585363889524958496
+    planId   : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-list.md

@@ -37,3 +37,33 @@ Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Gro
 ```sh
 m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "name": "My Planner Bucket",
+        "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+        "orderHint": "8585363889524958496",
+        "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                            name               planId                        orderHint
+    ----------------------------  -----------------  ----------------------------  -------------------
+    ttEB_Uj690STdR3GC1MIDZgANq1U  My Planner Bucket  xqQg5FS2LkCp935s-FIFm2QAFkHM  8585363889524958496
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-remove.md

@@ -58,3 +58,7 @@ Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_
 ```sh
 m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -55,3 +55,7 @@ Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ own
 ```sh
 m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -50,3 +50,126 @@ Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Plan
 ```sh
 m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
 ```
+
+## Response
+
+### Standard 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"
+      }
+    }
+    ```
+
+=== "Text"
+
+    ``` text
+    createdDateTime: 2015-03-30T18:36:49.2407981Z
+    id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+    title          : My Planner Plan
+    ```
+
+=== "CSV"
+
+    ``` text
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```
+
+### `shareWithUserIds`, `shareWithUserNames` response
+
+When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ. 
+
+=== "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/planner/plan/plan-get.md

@@ -16,17 +16,11 @@ m365 planner plan get [options]
 `-t, --title [title]`
 : Title of the plan. Specify either `id` or `title` but not both.
 
-`--planId [planId]`
-: (deprecated. Use `id` instead) ID of the plan. Specify either `planId` or `planTitle` but not both.
-
-`---planTitle [planTitle]`
-: (deprecated. Use `title` instead) Title of the plan. Specify either `planId` or `planTitle` but not both.
-
 `--ownerGroupId [ownerGroupId]`
-: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` or the deprecated `planTitle`.
+: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
 
 `--ownerGroupName [ownerGroupName]`
-: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` or the deprecated `planTitle`.
+: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -49,3 +43,78 @@ Returns the Microsoft Planner plan with title _MyPlan_ for Group _My Planner Gro
 ```sh
 m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
 ```
+
+## 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/planner/plan/plan-list.md

@@ -31,3 +31,48 @@ Returns a list of Microsoft Planner plans for Group _My Planner Group_
 ```sh
 m365 planner plan list --ownerGroupName "My Planner Group"
 ```
+
+## 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"
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                            title            createdDateTime               owner
+    ----------------------------  ---------------  ----------------------------  ------------------------------------
+    xqQg5FS2LkCp935s-FIFm2QAFkHM  My Planner Plan  2015-03-30T18:36:49.2407981Z  ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```
+
+=== "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/planner/plan/plan-remove.md

@@ -46,3 +46,7 @@ Removes the Microsoft Planner plan with title _My Plan_ in group with name _My P
 ```sh
 m365 planner plan remove --title "My Plan" --ownerGroupName "My Planner Group" --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/planner/task/task-checklistitem-list.md

@@ -21,4 +21,4 @@ Lists the checklist items of a Planner task.
 
 ```sh
 m365 planner task checklistitem list --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
-```
+```

package/docs/docs/cmd/planner/task/task-get.md

@@ -22,9 +22,6 @@ m365 planner task details get [options]
 `-t, --title [title]`
 : Title of the task. Specify either `id` or `title` but not both.
 
-`--taskId [taskId]`
-: (deprecated. Use `id` instead) ID of the task.
-
 `--bucketId [bucketId]`
 : ID of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
 

package/docs/docs/cmd/planner/task/task-reference-add.md

@@ -42,4 +42,4 @@ Add a new reference with the url _https://www.microsoft.com_ and with the type E
 
 ```sh
 m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --type "Excel"
-```
+```

package/docs/docs/cmd/pp/card/card-clone.md

@@ -0,0 +1,77 @@
+# pp card clone
+
+Clones a specific Microsoft Power Platform card in the specified Power Platform environment
+
+## Usage
+
+```sh
+pp card clone [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`--newName <newName>`
+: The name of the new card.
+
+`-i, --id [id]`
+: The id of the card. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The name of the card. Specify either `id` or `name` but not both.
+
+`-a, --asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Clones a specific card in a specific environment based on name.
+
+```sh
+m365 pp card clone --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card" --newName "CLI 365 new Card"
+```
+
+Clones a specific card in a specific environment based on name as admin.
+
+```sh
+m365 pp card clone --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card" --newName "CLI 365 new Card" --asAdmin 
+```
+
+Clones a specific card in a specific environment based on id.
+
+```sh
+m365 pp card clone --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa" --newName "CLI 365 new Card"
+```
+
+Clones a specific card in a specific environment based on id as admin.
+
+```sh
+m365 pp card clone --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa" --newName "CLI 365 new Card" --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "CardIdClone": "80cff342-ddf1-4633-aec1-6d3d131b29e0"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    CardIdClone: 80cff342-ddf1-4633-aec1-6d3d131b29e0
+    ```
+
+=== "CSV"
+
+    ```csv
+    CardIdClone
+    80cff342-ddf1-4633-aec1-6d3d131b29e0
+    ```