@pnp/cli-microsoft365 6.0.0-beta.cd80a69 → 6.0.0-beta.d557a48

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

@@ -35,3 +35,315 @@ List all Microsoft Power Platform environments
 ```sh
 m365 pp environment list --asAdmin
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id":"/providers/Microsoft.BusinessAppPlatform/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d",
+        "type":"Microsoft.BusinessAppPlatform/environments",
+        "location":"europe",
+        "name":"Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d",
+        "properties":{
+          "tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d",
+          "azureRegion":"northeurope",
+          "displayName":"contoso (default)",
+          "createdTime":"2020-03-12T13:39:17.9876946Z",
+          "createdBy":{
+            "id":"SYSTEM",
+            "displayName":"SYSTEM",
+            "type":"NotSpecified"
+          },
+          "provisioningState":"Succeeded",
+          "creationType":"DefaultTenant",
+          "environmentSku":"Default",
+          "isDefault":true,
+          "clientUris":{
+            "admin":"https://admin.powerplatform.microsoft.com/environments/environment/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/hub",
+            "maker":"https://make.powerapps.com/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/home"
+          },
+          "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"
+          },
+          "databaseType":"CommonDataService",
+          "linkedEnvironmentMetadata":{
+            "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",
+            "backgroundOperationsState":"Enabled",
+            "scaleGroup":"EURCRMLIVESG644",
+            "platformSku":"Standard"
+          },
+          "trialScenarioType":"None",
+          "retentionPeriod":"P7D",
+          "states":{
+            "management":{
+              "id":"NotSpecified"
+            },
+            "runtime":{
+              "runtimeReasonCode":"NotSpecified",
+              "requestedBy":{
+                "displayName":"SYSTEM",
+                "type":"NotSpecified"
+              },
+              "id":"Enabled"
+            }
+          },
+          "updateCadence":{
+            "id":"Frequent"
+          },
+          "retentionDetails":{
+            "retentionPeriod":"P7D",
+            "backupsAvailableFromDateTime":"2022-10-23T23:27:16.8059564Z"
+          },
+          "protectionStatus":{
+            "keyManagedBy":"Microsoft"
+          },
+          "cluster":{
+            "category":"Prod",
+            "number":"109",
+            "uriSuffix":"eu-il109.gateway.prod.island",
+            "geoShortName":"EU",
+            "environment":"Prod"
+          },
+          "connectedGroups":[
+            
+          ],
+          "lifecycleOperationsEnforcement":{
+            "allowedOperations":[
+              {
+                "type":{
+                  "id":"Backup"
+                }
+              },
+              {
+                "type":{
+                  "id":"Edit"
+                }
+              },
+              {
+                "type":{
+                  "id":"Enable"
+                }
+              },
+              {
+                "type":{
+                  "id":"Disable"
+                }
+              },
+              {
+                "type":{
+                  "id":"EnableGovernanceConfiguration"
+                }
+              }
+            ],
+            "disallowedOperations":[
+              {
+                "type":{
+                  "id":"Provision"
+                },
+                "reason":{
+                  "message":"Provision cannot be performed because there is no linked CDS instance or the CDS instance version is not supported."
+                }
+              },
+              {
+                "type":{
+                  "id":"Unlock"
+                },
+                "reason":{
+                  "message":"Unlock cannot be performed because there is no linked CDS instance or the CDS instance version is not supported."
+                }
+              },
+              {
+                "type":{
+                  "id":"Convert"
+                },
+                "reason":{
+                  "message":"Convert cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"Copy"
+                },
+                "reason":{
+                  "message":"Copy cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"Delete"
+                },
+                "reason":{
+                  "message":"Delete cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"Promote"
+                },
+                "reason":{
+                  "message":"Promote cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"Recover"
+                },
+                "reason":{
+                  "message":"Recover cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"Reset"
+                },
+                "reason":{
+                  "message":"Reset cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"Restore"
+                },
+                "reason":{
+                  "message":"Restore cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"UpdateProtectionStatus"
+                },
+                "reason":{
+                  "message":"UpdateProtectionStatus cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"NewCustomerManagedKey"
+                },
+                "reason":{
+                  "message":"NewCustomerManagedKey cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"RotateCustomerManagedKey"
+                },
+                "reason":{
+                  "message":"RotateCustomerManagedKey cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"RevertToMicrosoftKey"
+                },
+                "reason":{
+                  "message":"RevertToMicrosoftKey cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"NewNetworkInjection"
+                },
+                "reason":{
+                  "message":"NewNetworkInjection cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"SwapNetworkInjection"
+                },
+                "reason":{
+                  "message":"SwapNetworkInjection cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"RevertNetworkInjection"
+                },
+                "reason":{
+                  "message":"RevertNetworkInjection cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"NewIdentity"
+                },
+                "reason":{
+                  "message":"NewIdentity cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"SwapIdentity"
+                },
+                "reason":{
+                  "message":"SwapIdentity cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"RevertIdentity"
+                },
+                "reason":{
+                  "message":"RevertIdentity cannot be performed on environment of type Default."
+                }
+              },
+              {
+                "type":{
+                  "id":"DisableGovernanceConfiguration"
+                },
+                "reason":{
+                  "message":"DisableGovernanceConfiguration cannot be performed on Power Platform environment because of the governance configuration."
+                }
+              },
+              {
+                "type":{
+                  "id":"UpdateGovernanceConfiguration"
+                },
+                "reason":{
+                  "message":"UpdateGovernanceConfiguration cannot be performed on Power Platform environment because of the governance configuration."
+                }
+              }
+            ]
+          },
+          "governanceConfiguration":{
+            "protectionLevel":"Basic"
+          }
+        },
+        "displayName":"contoso (default)"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    displayName                             name
+    --------------------------------------- --------------------------------------------
+    environmentName (default) (org6633050c) Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e
+    ```
+
+=== "CSV"
+
+    ```csv
+    name,displayName
+    Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d,contoso (default)
+    ```

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

@@ -0,0 +1,56 @@
+# pp gateway get
+
+Get information about the specified gateway
+
+## Usage
+
+```sh
+m365 pp gateway get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the Gateway.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get information about the specified gateway.
+
+```sh
+m365 pp gateway get --id 1f69e798-5852-4fdd-ab01-33bb14b6e934
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id":"22660b34-31b3-4744-a99c-5e154458a784",
+      "gatewayId":0,
+      "name":"Contoso Gateway",
+      "type":"Resource",
+      "publicKey":{
+        "exponent":"AQAB",
+        "modulus":"okJBN8MJyaVkjfkN75B6OgP7RYiC3KFMFaky9KqqudqiTOcZPRXlsG+emrbnnBpFzw7ywe4gWtUGnPCqy01RKeDZrFA3QfkVPJpH28OWfrmgkMQNsI4Op2uxwEyjnJAyfYxIsHlpevOZoDKpWJgV+sH6MRf/+LK4hN3vNJuWKKpf90rNwjipnYMumHyKVkd4Vssc9Ftsu4Samu0/TkXzUkyje5DxMF2ZK1Nt2TgItBcpKi4wLCP4bPDYYaa9vfOmBlji7U+gwuE5bjnmjazFljQ5sOP0VdA0fRoId3+nI7n1rSgRq265jNHX84HZbm2D/Pk8C0dElTmYEswGPDWEJQ=="
+      },
+      "gatewayAnnotation":"{\"gatewayContactInformation\":[\"admin@contoso.onmicrosoft.com\"],\"gatewayVersion\":\"3000.122.8\",\"gatewayWitnessString\":\"{\\\"EncryptedResult\\\":\\\"UyfEqNSy0e9S4D0m9oacPyYhgiXLWusCiKepoLudnTEe68iw9qEaV6qNqTbSKlVUwUkD9KjbnbV0O3vU97Q/KTJXpw9/1SiyhpO+JN1rcaL51mPjyQo0WwMHMo2PU3rdEyxsLjkJxJZHTh4+XGB/lQ==\\\",\\\"IV\\\":\\\"QxCYjHEl8Ab9i78ZBYpnDw==\\\",\\\"Signature\\\":\\\"upVXK3DvWdj5scw8iUDDilzQz1ovuNgeuXRpmf0N828=\\\"}\",\"gatewayMachine\":\"SPFxDevelop\",\"gatewaySalt\":\"rA1M34AdgdCbOYQMvo/izA==\",\"gatewayWitnessStringLegacy\":null,\"gatewaySaltLegacy\":null,\"gatewayDepartment\":null,\"gatewayVirtualNetworkSubnetId\":null}"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id  : 22660b34-31b3-4744-a99c-5e154458a784    
+    name: Contoso Gateway 
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name
+    22660b34-31b3-4744-a99c-5e154458a784,Contoso Gateway
+    ```

package/docs/docs/cmd/pp/gateway/gateway-list.md

@@ -19,3 +19,38 @@ List gateways for which the user is an admin
 ```sh
 m365 pp gateway list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id":"22660b34-31b3-4744-a99c-5e154458a784",
+        "gatewayId":0,
+        "name":"Contoso Gateway",
+        "type":"Resource",
+        "publicKey":{
+          "exponent":"AQAB",
+          "modulus":"okJBN8MJyaVkjfkN75B6OgP7RYiC3KFMFaky9KqqudqiTOcZPRXlsG+emrbnnBpFzw7ywe4gWtUGnPCqy01RKeDZrFA3QfkVPJpH28OWfrmgkMQNsI4Op2uxwEyjnJAyfYxIsHlpevOZoDKpWJgV+sH6MRf/+LK4hN3vNJuWKKpf90rNwjipnYMumHyKVkd4Vssc9Ftsu4Samu0/TkXzUkyje5DxMF2ZK1Nt2TgItBcpKi4wLCP4bPDYYaa9vfOmBlji7U+gwuE5bjnmjazFljQ5sOP0VdA0fRoId3+nI7n1rSgRq265jNHX84HZbm2D/Pk8C0dElTmYEswGPDWEJQ=="
+        },
+        "gatewayAnnotation":"{\"gatewayContactInformation\":[\"admin@contoso.onmicrosoft.com\"],\"gatewayVersion\":\"3000.122.8\",\"gatewayWitnessString\":\"{\\\"EncryptedResult\\\":\\\"UyfEqNSy0e9S4D0m9oacPyYhgiXLWusCiKepoLudnTEe68iw9qEaV6qNqTbSKlVUwUkD9KjbnbV0O3vU97Q/KTJXpw9/1SiyhpO+JN1rcaL51mPjyQo0WwMHMo2PU3rdEyxsLjkJxJZHTh4+XGB/lQ==\\\",\\\"IV\\\":\\\"QxCYjHEl8Ab9i78ZBYpnDw==\\\",\\\"Signature\\\":\\\"upVXK3DvWdj5scw8iUDDilzQz1ovuNgeuXRpmf0N828=\\\"}\",\"gatewayMachine\":\"SPFxDevelop\",\"gatewaySalt\":\"rA1M34AdgdCbOYQMvo/izA==\",\"gatewayWitnessStringLegacy\":null,\"gatewaySaltLegacy\":null,\"gatewayDepartment\":null,\"gatewayVirtualNetworkSubnetId\":null}"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                   name
+    ------------------------------------ ---------------
+    22660b34-31b3-4744-a99c-5e154458a784 Contoso Gateway
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name
+    22660b34-31b3-4744-a99c-5e154458a784,Contoso Gateway
+    ```

package/docs/docs/cmd/pp/managementapp/managementapp-add.md

@@ -48,3 +48,26 @@ Register Azure AD application named _My app_ as a management application for the
 ```sh
 m365 pp managementapp add --name "My app"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "applicationId":"31359c7f-bd7e-475c-86db-fdb8c937548e"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    applicationId: 31359c7f-bd7e-475c-86db-fdb8c937548e
+    ```
+
+=== "CSV"
+
+    ```csv
+    applicationId
+    31359c7f-bd7e-475c-86db-fdb8c937548e
+    ```

package/docs/docs/cmd/pp/managementapp/managementapp-list.md

@@ -19,3 +19,30 @@ Lists management applications for Power Platform
 ```sh
 m365 pp managementapp list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "applicationId":"31359c7f-bd7e-475c-86db-fdb8c937548e"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    applicationId
+    ------------------------------------
+    31359c7f-bd7e-475c-86db-fdb8c937548e
+    ```
+
+=== "CSV"
+
+    ```csv
+    applicationId
+    31359c7f-bd7e-475c-86db-fdb8c937548e
+    ```

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

@@ -0,0 +1,86 @@
+# pp solution get
+
+Gets a specific solution in a given environment.
+
+## Usage
+
+```sh
+m365 pp solution get [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i --id [id]`
+: The ID of the solution. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The unique name (not the display name) of the solution. 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
+
+Gets a specific solution in a specific environment based on name
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default"
+```
+
+Gets a specific solution in a specific environment based on name as Admin
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default" --asAdmin
+```
+
+Gets a specific solution in a specific environment based on id
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e"
+```
+
+Gets a specific solution in a specific environment based on id as Admin
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e" --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "solutionid": "fd140aaf-4df4-11dd-bd17-0019b9312238",
+      "uniquename": "Default",
+      "version": "1.0",
+      "installedon": "2021-10-01T21:29:10Z",
+      "solutionpackageversion": null,
+      "friendlyname": "Default Solution",
+      "versionnumber": 860055,
+      "publisherid": {
+        "friendlyname": "Default Publisher for org6633049a",
+        "publisherid": "d21aab71-79e7-11dd-8874-00188b01e34f"
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    publisher : Default Publisher for org6633049a
+    uniquename: Default
+    version   : 1.0
+    ```
+
+=== "CSV"
+
+    ```csv
+    uniquename,version,publisher
+    Default,1.0,Default Publisher for org6633049a
+    ```

package/docs/docs/cmd/pp/solution/solution-list.md

@@ -31,3 +31,40 @@ List all solutions in a specific environment as Admin
 ```sh
 m365 pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "solutionid": "00000001-0000-0000-0001-00000000009b",
+        "uniquename": "Crc00f1",
+        "version": "1.0.0.0",
+        "installedon": "2021-10-01T21:54:14Z",
+        "solutionpackageversion": null,
+        "friendlyname": "Common Data Services Default Solution",
+        "versionnumber": 860052,
+        "publisherid": {
+          "friendlyname": "CDS Default Publisher",
+          "publisherid": "00000001-0000-0000-0000-00000000005a"
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    uniquename  version    publisher
+    ----------  ---------  ---------------------
+    Crc00f1     1.0.0.0    CDS Default Publisher
+    ```
+
+=== "CSV"
+
+    ```csv
+    uniquename,version,publisher
+    Crc00f1,1.0.0.0,CDS Default Publisher
+    ```

package/docs/docs/cmd/pp/tenant/tenant-settings-list.md

@@ -24,3 +24,65 @@ Lists the global Power Platform settings of the tenant
 ```sh
 m365 pp tenant settings list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "walkMeOptOut": false,
+      "disableNPSCommentsReachout": false,
+      "disableNewsletterSendout": false,
+      "disableEnvironmentCreationByNonAdminUsers": false,
+      "disablePortalsCreationByNonAdminUsers": false,
+      "disableSurveyFeedback": false,
+      "disableTrialEnvironmentCreationByNonAdminUsers": false,
+      "disableCapacityAllocationByEnvironmentAdmins": false,
+      "disableSupportTicketsVisibleByAllUsers": false,
+      "powerPlatform": {
+        "search": {
+          "disableDocsSearch": false,
+          "disableCommunitySearch": false,
+          "disableBingVideoSearch": false
+        },
+        "teamsIntegration": {
+          "shareWithColleaguesUserLimit": 10000
+        },
+        "powerApps": {
+          "disableShareWithEveryone": false,
+          "enableGuestsToMake": false,
+          "disableMembersIndicator": false
+        },
+        "environments": {},
+        "governance": {
+          "disableAdminDigest": false,
+          "allowDeveloperEnvironmentProvisioning": false
+        },
+        "licensing": {
+          "disableBillingPolicyCreationByNonAdminUsers": false
+        },
+        "powerPages": {}
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    disableCapacityAllocationByEnvironmentAdmins  : false
+    disableEnvironmentCreationByNonAdminUsers     : false
+    disableNPSCommentsReachout                    : false
+    disablePortalsCreationByNonAdminUsers         : false
+    disableSupportTicketsVisibleByAllUsers        : false
+    disableSurveyFeedback                         : false
+    disableTrialEnvironmentCreationByNonAdminUsers: false
+    walkMeOptOut                                  : false
+    ```
+
+=== "CSV"
+
+    ```csv
+    disableCapacityAllocationByEnvironmentAdmins,disableEnvironmentCreationByNonAdminUsers,disableNPSCommentsReachout,disablePortalsCreationByNonAdminUsers,disableSupportTicketsVisibleByAllUsers,disableSurveyFeedback,disableTrialEnvironmentCreationByNonAdminUsers,walkMeOptOut
+    false,false,false,false,false,false,false,false
+    ```

package/docs/docs/cmd/spfx/project/project-rename.md

@@ -16,20 +16,7 @@ m365 spfx project rename [options]
 `--generateNewId`
 : Generate a new solution ID for the project
 
-`-h, --help`
-: output usage information
-
-`--query [query]`
-: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
-
-`-o, --output [output]`
-: Output type. `json,text,csv,md`. Default `json`
-
-`--verbose`
-: Runs command with verbose logging
-
-`--debug`
-: Runs command with debug logging
+--8<-- "docs/cmd/_global.md"
 
 !!! important
     Run this command in the folder where the project that you want to rename is located.