@pnp/cli-microsoft365 6.0.0-beta.ff232be → 6.1.0-beta.11542c0

package/docs/docs/cmd/booking/business/business-list.md

@@ -0,0 +1,55 @@
+# booking business list
+
+Lists all Microsoft Bookings businesses that are created for the tenant.
+
+## Usage
+
+```sh
+m365 booking business list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Returns a list of all Microsoft Bookings businesses that are created for the tenant.
+
+```sh
+m365 booking business list
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id": "Accounting@8b7jz1.onmicrosoft.com",
+        "displayName": "Accounting"
+      },
+      {
+        "id": "BestShop@8b7jz1.onmicrosoft.com",
+        "displayName": "Best Shop"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                 displayName
+    ---------------------------------  -----------
+    Accounting@8b7jz7.onmicrosoft.com  Accounting
+    BestShop@8b7jz7.onmicrosoft.com    Best Shop
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName
+    Accounting@8b7jz7.onmicrosoft.com,Accounting
+    BestShop@8b7jz7.onmicrosoft.com,Best Shop
+    ```

package/docs/docs/cmd/cli/cli-consent.md

@@ -30,3 +30,23 @@ Consent permissions to the Yammer API
 ```sh
 m365 cli consent --service yammer
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    "To consent permissions for executing yammer commands, navigate in your web browser to https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&scope=https%3A%2F%2Fapi.yammer.com%2Fuser_impersonation"
+    ```
+
+=== "Text"
+
+    ```text
+    To consent permissions for executing yammer commands, navigate in your web browser to https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&scope=https%3A%2F%2Fapi.yammer.com%2Fuser_impersonation
+    ```
+
+=== "CSV"
+
+    ```csv
+    To consent permissions for executing yammer commands, navigate in your web browser to https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&scope=https%3A%2F%2Fapi.yammer.com%2Fuser_impersonation
+    ```

package/docs/docs/cmd/cli/cli-doctor.md

@@ -23,3 +23,53 @@ Retrieve diagnostic information
 ```sh
 m365 cli doctor
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "os": {
+        "platform": "win32",
+        "version": "Windows 10 Pro",
+        "release": "10.0.19045"
+      },
+      "cliVersion": "6.1.0",
+      "nodeVersion": "v16.13.0",
+      "cliAadAppId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
+      "cliAadAppTenant": "common",
+      "authMode": "DeviceCode",
+      "cliEnvironment": "",
+      "cliConfig": {
+        "output": "json",
+        "showHelpOnFailure": false
+      },
+      "roles": [],
+      "scopes": [
+        "AllSites.FullControl"
+      ]
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    authMode       : DeviceCode
+    cliAadAppId    : 31359c7f-bd7e-475c-86db-fdb8c937548e
+    cliAadAppTenant: common
+    cliConfig      : {"output":"json","showHelpOnFailure":false}
+    cliEnvironment :
+    cliVersion     : 6.1.0
+    nodeVersion    : v16.13.0
+    os             : {"platform":"win32","version":"Windows 10 Pro","release":"10.0.19045"}
+    roles          : []
+    scopes         : ["AllSites.FullControl"]
+    ```
+
+=== "CSV"
+
+    ```csv
+    os,cliVersion,nodeVersion,cliAadAppId,cliAadAppTenant,authMode,cliEnvironment,cliConfig,roles,scopes
+    "{""platform"":""win32"",""version"":""Windows 10 Pro"",""release"":""10.0.19045""}",6.1.0,v16.13.0,31359c7f-bd7e-475c-86db-fdb8c937548e,common,DeviceCode,,"{""output"":""json"",""showHelpOnFailure"":false}",[],"[""AllSites.FullControl""]"
+    ```

package/docs/docs/cmd/cli/cli-issue.md

@@ -32,3 +32,23 @@ Suggest a new command
 ```sh
 m365 cli issue --type command
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    "https://aka.ms/cli-m365/new-command"
+    ```
+
+=== "Text"
+
+    ```text
+    https://aka.ms/cli-m365/new-command
+    ```
+
+=== "CSV"
+
+    ```csv
+    https://aka.ms/cli-m365/new-command
+    ```

package/docs/docs/cmd/cli/cli-reconsent.md

@@ -20,6 +20,26 @@ Get the URL to open in the browser to re-consent CLI for Microsoft 365 permissio
 m365 cli reconsent
 ```
 
+## Response
+
+=== "JSON"
+
+    ```json
+    "To re-consent the PnP Microsoft 365 Management Shell Azure AD application navigate in your web browser to https://login.microsoftonline.com/common/oauth2/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&prompt=admin_consent"
+    ```
+
+=== "Text"
+
+    ```text
+    To re-consent the PnP Microsoft 365 Management Shell Azure AD application navigate in your web browser to https://login.microsoftonline.com/common/oauth2/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&prompt=admin_consent
+    ```
+
+=== "CSV"
+
+    ```csv
+    To re-consent the PnP Microsoft 365 Management Shell Azure AD application navigate in your web browser to https://login.microsoftonline.com/common/oauth2/authorize?client_id=31359c7f-bd7e-475c-86db-fdb8c937548e&response_type=code&prompt=admin_consent
+    ```
+
 ## More information
 
 - Re-consent the PnP Microsoft 365 Management Shell Azure AD application: [https://pnp.github.io/cli-microsoft365/user-guide/connecting-office-365/#re-consent-the-pnp-office-365-management-shell-azure-ad-application](https://pnp.github.io/cli-microsoft365/user-guide/connecting-office-365/#re-consent-the-pnp-office-365-management-shell-azure-ad-application)

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

@@ -24,9 +24,13 @@ This commands updates the list of commands and their options used by command com
 Write the list of commands for Clink (cmder) command completion to a file named `m365.lua` in the current directory
 
 ```powershell
-cli completion clink update > m365.lua
+m365 cli completion clink update > m365.lua
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
-- Command completion: [https://pnp.github.io/cli-microsoft365/concepts/completion/](https://pnp.github.io/cli-microsoft365/concepts/completion/)
+- 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-pwsh-setup.md

@@ -26,9 +26,13 @@ If the specified profile path doesn't exist, the CLI will try to create it.
 Set up command completion for PowerShell using the profile from the profile variable
 
 ```powershell
-cli completion pwsh setup --profile $profile
+m365 cli completion pwsh setup --profile $profile
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
-- Command completion: [https://pnp.github.io/cli-microsoft365/concepts/completion/](https://pnp.github.io/cli-microsoft365/concepts/completion/)
+- 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-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/concepts/completion/](https://pnp.github.io/cli-microsoft365/concepts/completion/)
+- 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/concepts/completion/](https://pnp.github.io/cli-microsoft365/concepts/completion/)
+- 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/concepts/completion/](https://pnp.github.io/cli-microsoft365/concepts/completion/)
+- 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/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/context/context-remove.md

@@ -0,0 +1,34 @@
+# context remove
+
+Removes the CLI for Microsoft 365 context in the current working folder
+
+## Usage
+
+```sh
+m365 context remove [options]
+```
+
+## Options
+
+`--confirm`
+: Don't prompt for confirmation to remove the context
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes the CLI for Microsoft 365 context in the current working folder
+
+```sh
+m365 context remove
+```
+
+Removes the CLI for Microsoft 365 context in the current working folder and does not prompt for confirmation before deleting.
+
+```sh
+m365 context remove --confirm
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -29,3 +29,103 @@ Get information about the Microsoft Flow environment named _Default-d87a7535-dd3
 ```sh
 m365 flow environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
 ```
+
+## Response
+
+### Standard response
+
+=== "JSON"
+
+    ```json
+    {
+      "name": "Default-d87a7535-dd31-4437-bfe1-95340acd55c5",
+      "location": "india",
+      "type": "Microsoft.ProcessSimple/environments",
+      "id": "/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5",
+      "properties": {
+        "displayName": "contoso (default)",
+        "createdTime": "2019-12-21T18:32:11.8708704Z",
+        "createdBy": {
+          "id": "SYSTEM",
+          "displayName": "SYSTEM",
+          "type": "NotSpecified"
+        },
+        "provisioningState": "Succeeded",
+        "creationType": "DefaultTenant",
+        "environmentSku": "Default",
+        "environmentType": "NotSpecified",
+        "states": {
+          "management": {
+            "id": "NotSpecified"
+          },
+          "runtime": {
+            "runtimeReasonCode": "NotSpecified",
+            "requestedBy": {
+              "displayName": "SYSTEM",
+              "type": "NotSpecified"
+            },
+            "id": "Enabled"
+          }
+        },
+        "isDefault": true,
+        "isPayAsYouGoEnabled": false,
+        "azureRegionHint": "centralindia",
+        "runtimeEndpoints": {
+          "microsoft.BusinessAppPlatform": "https://india.api.bap.microsoft.com",
+          "microsoft.CommonDataModel": "https://india.api.cds.microsoft.com",
+          "microsoft.PowerApps": "https://india.api.powerapps.com",
+          "microsoft.PowerAppsAdvisor": "https://india.api.advisor.powerapps.com",
+          "microsoft.PowerVirtualAgents": "https://powervamg.in-il101.gateway.prod.island.powerapps.com",
+          "microsoft.ApiManagement": "https://management.INDIA.azure-apihub.net",
+          "microsoft.Flow": "https://india.api.flow.microsoft.com"
+        },
+        "linkedEnvironmentMetadata": {
+          "type": "NotSpecified",
+          "resourceId": "3aa550bf-52ac-42fc-98f7-5d1833c1501c",
+          "friendlyName": "contoso (default)",
+          "uniqueName": "orgfc80770f",
+          "domainName": "orgfc80770f",
+          "version": "9.2.22105.00154",
+          "instanceUrl": "https://orgfc80770f.crm8.dynamics.com/",
+          "instanceApiUrl": "https://orgfc80770f.api.crm8.dynamics.com",
+          "baseLanguage": 1033,
+          "instanceState": "Ready",
+          "createdTime": "2019-12-25T15:46:14.433Z"
+        },
+        "environmentFeatures": {
+          "isOpenApiEnabled": false
+        },
+        "cluster": {
+          "category": "Prod",
+          "number": "101",
+          "uriSuffix": "in-il101.gateway.prod.island",
+          "geoShortName": "IN",
+          "environment": "Prod"
+        },
+        "governanceConfiguration": {
+          "protectionLevel": "Basic"
+        }
+      },
+      "displayName": "contoso (default)"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    azureRegionHint  : centralindia
+    displayName      : contoso (default)
+    environmentSku   : Default
+    id               : /providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5
+    isDefault        : true
+    location         : india
+    name             : Default-d87a7535-dd31-4437-bfe1-95340acd55c5
+    provisioningState: Succeeded
+    ```
+
+=== "CSV"
+
+    ```csv
+    name,id,location,displayName,provisioningState,environmentSku,azureRegionHint,isDefault
+    Default-d87a7535-dd31-4437-bfe1-95340acd55c5,/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5,india,contoso (default),Succeeded,Default,centralindia,1  
+    ```

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

@@ -24,3 +24,100 @@ List Microsoft Flow environments in the current tenant
 ```sh
 m365 flow environment list
 ```
+
+## Response
+
+### Standard response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "name": "d87a7535-dd31-4437-bfe1-95340acd55c5",
+        "location": "india",
+        "type": "Microsoft.ProcessSimple/environments",
+        "id": "/providers/Microsoft.ProcessSimple/environments/d87a7535-dd31-4437-bfe1-95340acd55c5",
+        "properties": {
+          "displayName": "Contoso Environment",
+          "createdTime": "2021-07-28T15:36:00.9624176Z",
+          "createdBy": {
+            "id": "SYSTEM",
+            "displayName": "SYSTEM",
+            "type": "NotSpecified"
+          },
+          "provisioningState": "Succeeded",
+          "creationType": "Developer",
+          "environmentSku": "Developer",
+          "environmentType": "NotSpecified",
+          "states": {
+            "management": {
+              "id": "NotSpecified"
+            },
+            "runtime": {
+              "runtimeReasonCode": "NotSpecified",
+              "requestedBy": {
+                "displayName": "SYSTEM",
+                "type": "NotSpecified"
+              },
+              "id": "Enabled"
+            }
+          },
+          "isDefault": false,
+          "isPayAsYouGoEnabled": false,
+          "azureRegionHint": "centralindia",
+          "runtimeEndpoints": {
+            "microsoft.BusinessAppPlatform": "https://india.api.bap.microsoft.com",
+            "microsoft.CommonDataModel": "https://india.api.cds.microsoft.com",
+            "microsoft.PowerApps": "https://india.api.powerapps.com",
+            "microsoft.PowerAppsAdvisor": "https://india.api.advisor.powerapps.com",
+            "microsoft.PowerVirtualAgents": "https://powervamg.in-il101.gateway.prod.island.powerapps.com",
+            "microsoft.ApiManagement": "https://management.INDIA.azure-apihub.net",
+            "microsoft.Flow": "https://india.api.flow.microsoft.com"
+          },
+          "linkedEnvironmentMetadata": {
+            "type": "NotSpecified",
+            "resourceId": "03ebcb5d-f16a-45ad-b326-ed1b5df98bc8",
+            "friendlyName": "Contoso Environment",
+            "uniqueName": "unq03ebcb5df16a45adb326ed1b5df98",
+            "domainName": "orgfc80770f",
+            "version": "9.2.22105.00154",
+            "instanceUrl": "https://orgfc80770f.crm8.dynamics.com/",
+            "instanceApiUrl": "https://orgfc80770f.api.crm8.dynamics.com",
+            "baseLanguage": 1033,
+            "instanceState": "Ready",
+            "createdTime": "2021-07-28T15:36:08.093Z"
+          },
+          "environmentFeatures": {
+            "isOpenApiEnabled": false
+          },
+          "cluster": {
+            "category": "Prod",
+            "number": "101",
+            "uriSuffix": "in-il101.gateway.prod.island",
+            "geoShortName": "IN",
+            "environment": "Prod"
+          },
+          "governanceConfiguration": {
+            "protectionLevel": "Basic"
+          }
+        },
+        "displayName": "Contoso Environment"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    name                                          displayName
+    --------------------------------------------  -------------------------------
+    d87a7535-dd31-4437-bfe1-95340acd55c5          Contoso Environment
+    ```
+
+=== "CSV"
+
+    ```csv
+    name,displayName
+    d87a7535-dd31-4437-bfe1-95340acd55c5,Contoso Environment
+    ```

package/docs/docs/cmd/flow/flow-disable.md

@@ -11,13 +11,13 @@ m365 flow disable [options]
 ## Options
 
 `-n, --name <name>`
-: The name of the Power Automate flow to disable
+: The name of the Power Automate flow to disable.
 
-`-e, --environment <environment>`
-: The name of the environment for which to disable Power Automate flow
+`-e, --environmentName <environmentName>`
+: The name of the environment for which to disable Power Automate flow.
 
 `--asAdmin`
-: Set, to disable the flow as admin
+: Set, to disable the flow as admin.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -37,11 +37,15 @@ If the Power Automate flow with the name you specified doesn't exist, you will g
 Disables Power Automate flow owned by the currently signed-in user
 
 ```sh
-m365 flow disable --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d
+m365 flow disable --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d
 ```
 
 Disables Power Automate flow owned by another user
 
 ```sh
-m365 flow disable --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --asAdmin
+m365 flow disable --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --asAdmin
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/flow/flow-enable.md

@@ -13,7 +13,7 @@ m365 flow enable [options]
 `-n, --name <name>`
 : The name of the Power Automate flow to enable
 
-`-e, --environment <environment>`
+`-e, --environmentName <environmentName>`
 : The name of the environment for which to enable Power Automate
 
 `--asAdmin`
@@ -45,3 +45,7 @@ Enables Power Automate flow owned by another user
 ```sh
 m365 flow enable --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --asAdmin
 ```
+
+## Response
+
+The command won't return a response on success.