@pnp/cli-microsoft365 5.9.0 → 6.0.0-beta.063a75a

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.

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

@@ -13,7 +13,7 @@ m365 flow export [options]
 `-i, --id <id>`
 : The id of the Power Automate flow to export
 
-`-e, --environment <environment>`
+`-e, --environmentNameName <environmentName>`
 : The name of the environment for which to export the flow
 
 `-n, --packageDisplayName [packageDisplayName]`
@@ -50,23 +50,43 @@ If the Power Automate flow with the id you specified doesn't exist, you will get
 Export the specified Power Automate flow as a ZIP file
 
 ```sh
-m365 flow export --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d
+m365 flow export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d
 ```
 
 Export the specified Power Automate flow as a JSON file
 
 ```sh
-m365 flow export --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --format json
+m365 flow export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --format json
 ```
 
 Export the specified Power Automate flow as a ZIP file, specifying a Display Name of 'My flow name' to be embedded into the package
 
 ```sh
-m365 flow export --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName 'My flow name'
+m365 flow export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName 'My flow name'
 ```
 
 Export the specified Power Automate flow as a ZIP file with the filename 'MyFlow.zip' saved to the current directory
 
 ```sh
-m365 flow export --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --path './MyFlow.zip'
+m365 flow export --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --path './MyFlow.zip'
+```
+
+## Response
+
+When the specified Power Automate flow is exported as a ZIP file
+
+```text
+"./20221117t000000z816608b996494b328cf9f9794f160209_20221117124608.zip"
+```
+
+When the specified Power Automate flow is exported as a JSON file
+
+```text
+"./MyFlow.json"
+```
+
+When the specified Power Automate flow is exported by specifying a package display Name
+
+```text
+"./Myflowname_20221117125033.zip"
 ```

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

@@ -13,7 +13,7 @@ m365 flow get [options]
 `-n, --name <name>`
 : The name of the Power Automate flow to get information about
 
-`-e, --environment <environment>`
+`-e, --environmentName <environmentName>`
 : The name of the environment for which to retrieve available flows
 
 `--asAdmin`
@@ -37,11 +37,383 @@ If the Power Automate flow with the name you specified doesn't exist, you will g
 Get information about the specified Power Automate flow owned by the currently signed-in user
 
 ```sh
-m365 flow get --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d
+m365 flow get --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d
 ```
 
 Get information about the specified Power Automate flow owned by another user
 
 ```sh
-m365 flow get --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --asAdmin
+m365 flow get --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --asAdmin
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "name": "ca76d7b8-3b76-4050-8c03-9fb310ad172f",
+      "id": "/providers/Microsoft.ProcessSimple/environments/Default-00000000-0000-0000-0000-000000000000/flows/ca76d7b8-3b76-4050-8c03-9fb310ad172f",
+      "type": "Microsoft.ProcessSimple/environments/flows",
+      "properties": {
+        "apiId": "/providers/Microsoft.PowerApps/apis/shared_logicflows",
+        "displayName": "My Flow",
+        "userType": "Owner",
+        "definition": {
+          "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
+          "contentVersion": "1.0.0.0",
+          "parameters": {
+            "$connections": {
+              "defaultValue": {},
+              "type": "Object"
+            },
+            "$authentication": {
+              "defaultValue": {},
+              "type": "SecureObject"
+            }
+          },
+          "triggers": {
+            "When_a_file_is_created_in_a_folder": {
+              "recurrence": {
+                "frequency": "Minute",
+                "interval": 1
+              },
+              "metadata": {
+                "%252fComputer%2bVision%2bDemo": "/My Flow Demo",
+                "operationMetadataId": "2e0aa276-5536-4f67-a7b7-c1a37a91b8ca",
+                "%252fShared%2bDocuments": "/Shared Documents"
+              },
+              "type": "OpenApiConnection",
+              "inputs": {
+                "host": {
+                  "apiId": "/providers/Microsoft.PowerApps/apis/shared_sharepointonline",
+                  "connectionName": "shared_sharepointonline",
+                  "operationId": "OnNewFile"
+                },
+                "parameters": {
+                  "dataset": "https://contoso.sharepoint.com/sites/contosoHome",
+                  "folderId": "%252fShared%2bDocuments",
+                  "inferContentType": true
+                },
+                "authentication": "@parameters('$authentication')"
+              }
+            }
+          },
+          "actions": {
+            "Analyze_Image": {
+              "runAfter": {
+                "Initialize_variable": [
+                  "Succeeded"
+                ]
+              },
+              "metadata": {
+                "operationMetadataId": "82b95160-9c96-4507-ad8c-c688ea95c2b1"
+              },
+              "type": "OpenApiConnection",
+              "inputs": {
+                "host": {
+                  "apiId": "/providers/Microsoft.PowerApps/apis/shared_cognitiveservicescomputervision",
+                  "connectionName": "shared_cognitiveservicescomputervision",
+                  "operationId": "AnalyzeImageV2"
+                },
+                "parameters": {
+                  "format": "Image Content",
+                  "Image": "@triggerOutputs()?['body']"
+                },
+                "authentication": "@parameters('$authentication')"
+              }
+            },
+            "Compose": {
+              "runAfter": {
+                "Analyze_Image": [
+                  "Succeeded"
+                ]
+              },
+              "metadata": {
+                "operationMetadataId": "cbd09106-eb7a-4743-b553-8b11cd09a90c"
+              },
+              "type": "Compose",
+              "inputs": "@outputs('Analyze_Image')?['body/tags']"
+            },
+            "Initialize_variable": {
+              "runAfter": {},
+              "metadata": {
+                "operationMetadataId": "818f9da8-8ebf-4081-8d7b-8fe37470cd57"
+              },
+              "type": "InitializeVariable",
+              "inputs": {
+                "variables": [
+                  {
+                    "name": "FilePath",
+                    "type": "string",
+                    "value": "@{decodeUriComponent(decodeUriComponent(triggerOutputs()?['headers/x-ms-file-id']))}"
+                  }
+                ]
+              }
+            },
+            "Send_an_HTTP_request_to_SharePoint": {
+              "runAfter": {
+                "Compose": [
+                  "Succeeded"
+                ]
+              },
+              "metadata": {
+                "operationMetadataId": "0e9b2bf7-c52e-4b28-8351-2850a3373186"
+              },
+              "type": "OpenApiConnection",
+              "inputs": {
+                "host": {
+                  "apiId": "/providers/Microsoft.PowerApps/apis/shared_sharepointonline",
+                  "connectionName": "shared_sharepointonline",
+                  "operationId": "HttpRequest"
+                },
+                "parameters": {
+                  "dataset": "https://contoso.sharepoint.com/sites/contosoHome",
+                  "parameters/method": "GET",
+                  "parameters/uri": "_api/web/getFileByServerRelativeURL('@{concat('/sites/contosoHome/', variables('FilePath'))}')?$select=ListItemAllFields/ID&$expand=ListItemAllFields"
+                },
+                "authentication": "@parameters('$authentication')"
+              }
+            },
+            "Parse_JSON": {
+              "runAfter": {
+                "Send_an_HTTP_request_to_SharePoint": [
+                  "Succeeded"
+                ]
+              },
+              "metadata": {
+                "operationMetadataId": "7d758c3f-f603-44d0-94b6-26cb08590fb3"
+              },
+              "type": "ParseJson",
+              "inputs": {
+                "content": "@body('Send_an_HTTP_request_to_SharePoint')",
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "d": {
+                      "type": "object",
+                      "properties": {
+                        "__metadata": {
+                          "type": "object",
+                          "properties": {
+                            "id": {
+                              "type": "string"
+                            },
+                            "uri": {
+                              "type": "string"
+                            },
+                            "type": {
+                              "type": "string"
+                            }
+                          }
+                        },
+                        "ListItemAllFields": {
+                          "type": "object",
+                          "properties": {
+                            "__metadata": {
+                              "type": "object",
+                              "properties": {
+                                "id": {
+                                  "type": "string"
+                                },
+                                "uri": {
+                                  "type": "string"
+                                },
+                                "etag": {
+                                  "type": "string"
+                                },
+                                "type": {
+                                  "type": "string"
+                                }
+                              }
+                            },
+                            "Id": {
+                              "type": "integer"
+                            },
+                            "ID": {
+                              "type": "integer"
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            },
+            "Update_file_properties": {
+              "runAfter": {
+                "Parse_JSON": [
+                  "Succeeded"
+                ]
+              },
+              "metadata": {
+                "operationMetadataId": "c1a801a8-1f96-498a-a356-82c9d0dd8188"
+              },
+              "type": "OpenApiConnection",
+              "inputs": {
+                "host": {
+                  "apiId": "/providers/Microsoft.PowerApps/apis/shared_sharepointonline",
+                  "connectionName": "shared_sharepointonline",
+                  "operationId": "PatchFileItem"
+                },
+                "parameters": {
+                  "dataset": "https://contoso.sharepoint.com/sites/contosoHome",
+                  "table": "13e0b5a3-f626-4272-a73b-a3e84978199b",
+                  "id": "@body('Parse_JSON')?['d']?['ListItemAllFields']?['Id']",
+                  "item/CognitiveTags": "@join(outputs('Analyze_Image')?['body/description/tags'], ', ')"
+                },
+                "authentication": "@parameters('$authentication')"
+              }
+            }
+          },
+          "outputs": {}
+        },
+        "state": "Started",
+        "connectionReferences": {
+          "shared_cognitiveservicescomputervision": {
+            "connectionName": "shared-cognitiveserv-34d89cec-971e-41b6-8c79-247c97eecec5",
+            "source": "Embedded",
+            "id": "/providers/Microsoft.PowerApps/apis/shared_cognitiveservicescomputervision",
+            "displayName": "My Flow API",
+            "iconUri": "https://connectoricons-prod.azureedge.net/releases/v1.0.1549/1.0.1549.2680/cognitiveservicescomputervision/icon.png",
+            "brandColor": "#1267AE",
+            "tier": "Standard"
+          },
+          "shared_sharepointonline": {
+            "connectionName": "shared-sharepointonl-1c433d0f-a030-45eb-9795-8c2585f84781",
+            "source": "Embedded",
+            "id": "/providers/Microsoft.PowerApps/apis/shared_sharepointonline",
+            "displayName": "SharePoint",
+            "iconUri": "https://connectoricons-prod.azureedge.net/releases/v1.0.1610-greyhound-localization-RelayFix/1.0.1610.3091/sharepointonline/icon.png",
+            "brandColor": "#036C70",
+            "tier": "Standard"
+          }
+        },
+        "createdTime": "2022-06-20T15:13:24.5135728Z",
+        "lastModifiedTime": "2022-11-01T14:15:31.5790933Z",
+        "flowSuspensionReason": "None",
+        "environment": {
+          "name": "Default-00000000-0000-0000-0000-000000000000",
+          "type": "Microsoft.ProcessSimple/environments",
+          "id": "/providers/Microsoft.ProcessSimple/environments/Default-00000000-0000-0000-0000-000000000000"
+        },
+        "definitionSummary": {
+          "triggers": [
+            {
+              "type": "OpenApiConnection",
+              "swaggerOperationId": "OnNewFile",
+              "metadata": {
+                "%252fComputer%2bVision%2bDemo": "/My Flow Demo",
+                "operationMetadataId": "2e0aa276-5536-4f67-a7b7-c1a37a91b8ca",
+                "%252fShared%2bDocuments": "/Shared Documents"
+              }
+            }
+          ],
+          "actions": [
+            {
+              "type": "OpenApiConnection",
+              "swaggerOperationId": "AnalyzeImageV2",
+              "metadata": {
+                "operationMetadataId": "82b95160-9c96-4507-ad8c-c688ea95c2b1"
+              }
+            },
+            {
+              "type": "Compose",
+              "metadata": {
+                "operationMetadataId": "cbd09106-eb7a-4743-b553-8b11cd09a90c"
+              }
+            },
+            {
+              "type": "InitializeVariable",
+              "metadata": {
+                "operationMetadataId": "818f9da8-8ebf-4081-8d7b-8fe37470cd57"
+              }
+            },
+            {
+              "type": "OpenApiConnection",
+              "swaggerOperationId": "HttpRequest",
+              "metadata": {
+                "operationMetadataId": "0e9b2bf7-c52e-4b28-8351-2850a3373186"
+              }
+            },
+            {
+              "type": "ParseJson",
+              "metadata": {
+                "operationMetadataId": "7d758c3f-f603-44d0-94b6-26cb08590fb3"
+              }
+            },
+            {
+              "type": "OpenApiConnection",
+              "swaggerOperationId": "PatchFileItem",
+              "metadata": {
+                "operationMetadataId": "c1a801a8-1f96-498a-a356-82c9d0dd8188"
+              }
+            }
+          ]
+        },
+        "creator": {
+          "tenantId": "00000000-0000-0000-0000-000000000000",
+          "objectId": "e1251b10-1ba4-49e3-b35a-933e3f21772b",
+          "userId": "e1251b10-1ba4-49e3-b35a-933e3f21772b",
+          "userType": "ActiveDirectory"
+        },
+        "installationStatus": "NotApplicable",
+        "provisioningMethod": "FromDefinition",
+        "flowFailureAlertSubscribed": true,
+        "referencedResources": [
+          {
+            "service": "sharepoint",
+            "resource": {
+              "site": "https://contoso.sharepoint.com/sites/contosoHome"
+            },
+            "referencers": [
+              {
+                "referenceSourceType": "Triggers",
+                "operationId": "/providers/Microsoft.PowerApps/apis/shared_sharepointonline/apiOperations/OnNewFile"
+              },
+              {
+                "referenceSourceType": "Actions",
+                "operationId": "/providers/Microsoft.PowerApps/apis/shared_sharepointonline/apiOperations/HttpRequest"
+              }
+            ]
+          },
+          {
+            "service": "sharepoint",
+            "resource": {
+              "site": "https://contoso.sharepoint.com/sites/contosoHome",
+              "list": "13e0b5a3-f626-4272-a73b-a3e84978199b"
+            },
+            "referencers": [
+              {
+                "referenceSourceType": "Actions",
+                "operationId": "/providers/Microsoft.PowerApps/apis/shared_sharepointonline/apiOperations/PatchFileItem"
+              }
+            ]
+          }
+        ],
+        "isManaged": false
+      },
+      "displayName": "My Flow",
+      "description": "",
+      "triggers": "OpenApiConnection",
+      "actions": "OpenApiConnection-AnalyzeImageV2, Compose, InitializeVariable, OpenApiConnection-HttpRequest, ParseJson, OpenApiConnection-PatchFileItem"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    actions    : OpenApiConnection-AnalyzeImageV2, Compose, InitializeVariable, OpenApiConnection-HttpRequest, ParseJson, OpenApiConnection-PatchFileItem
+    description:
+    displayName: My Flow
+    name       : ca76d7b8-3b76-4050-8c03-9fb310ad172f
+    triggers   : OpenApiConnection
+    ```
+
+=== "CSV"
+
+    ```csv
+    name,displayName,description,triggers,actions
+    ca76d7b8-3b76-4050-8c03-9fb310ad172f,My Flow,,OpenApiConnection,"OpenApiConnection-AnalyzeImageV2, Compose, InitializeVariable, OpenApiConnection-HttpRequest, ParseJson, OpenApiConnection-PatchFileItem"
+    ```