@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.bb31388

package/docs/docs/cmd/flow/flow-remove.mdx

@@ -0,0 +1,67 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# flow remove
+
+Removes the specified Power Automate flow
+
+## Usage
+
+```sh
+m365 flow remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-n, --name <name>`
+: The name of the Power Automate flow to remove
+
+`-e, --environmentName <environmentName>`
+: The name of the environment to which the flow belongs
+
+`--asAdmin`
+: Set, to remove the flow as admin
+
+`--confirm`
+: Don't prompt for confirmation
+```
+
+<Global />
+
+## Remarks
+
+By default, the command will try to remove a Power Automate flow you own. If you want to remove a Flow owned by another user, use the `asAdmin` flag.
+
+If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
+
+If the Power Automate flow with the name you specified doesn't exist, you will get the `Error: Resource 'abc' does not exist in environment 'xyz'` error.
+
+## Examples
+
+Removes the specified Power Automate flow owned by the currently signed-in user
+
+```sh
+m365 flow remove --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d
+```
+
+Removes the specified Power Automate flow owned by the currently signed-in user without confirmation
+
+```sh
+m365 flow remove --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --confirm
+```
+
+Removes the specified Power Automate flow owned by another user
+
+```sh
+m365 flow remove --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --asAdmin
+```
+
+Removes the specified Power Automate flow owned by another user without confirmation
+
+```sh
+m365 flow remove --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --asAdmin --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/flow/owner/owner-ensure.mdx

@@ -0,0 +1,65 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# flow owner ensure
+
+Assigns/updates permissions to a Power Automate flow
+
+## Usage
+
+```sh
+m365 flow owner ensure [options]
+```
+
+## Options
+
+```md defintion-list
+`-e, --environmentName <environmentName>`
+: The name of the environment.
+
+`-f, --flowName <flowName>`
+: The name of the Power Automate flow.
+
+`--userId [userId]`
+: The ID of the user. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--userName [userName]`
+: User principal name of the user. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--groupId [groupId]`
+: The ID of the group. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--groupName [groupName]`
+: The name of the group. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--roleName <roleName>`
+: Access level for the user on the flow. Valid options are `CanView` or `CanEdit`.
+
+`--asAdmin`
+: Run the command as admin.
+```
+
+<Global />
+
+## Examples
+
+Assign owner permissions to a specific Power Automate flow for a user with ID
+
+```sh
+m365 flow owner ensure --userId 5c241023-2ba5-4ea8-a516-a2481a3e6c51 --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --roleName CanEdit
+```
+
+Assign owner permissions to a specific Power Automate flow for a user with UPN
+
+```sh
+m365 flow owner ensure --userName "john.doe@contoso.com" --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --roleName CanEdit
+```
+
+Assign owner permissions to a specific Power Automate flow for a group
+
+```sh
+m365 flow owner ensure --groupId 8d4d9f32-1ab0-4f81-9054-efbb1759e8e6 --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --roleName CanEdit
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/flow/owner/owner-list.mdx

@@ -0,0 +1,104 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# flow owner list
+
+Lists all owners of a Power Automate flow
+
+## Usage
+
+```sh
+m365 flow owner list [options]
+```
+
+## Options
+
+```md defintion-list
+`-e, --environmentName <environmentName>`
+: The name of the environment.
+
+`-f, --flowName <flowName>`
+: The name of the Power Automate flow.
+
+`--asAdmin`
+: Run the command as admin.
+```
+
+<Global />
+
+## Examples
+
+Gets the owners by the name of the Power Automate flow within a specified environment
+
+```sh
+m365 flow owner list --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72
+```
+
+Gets the owners by the name of the Power Automate flow within a specified environment with admin privileges
+
+```sh
+m365 flow owner list --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --asAdmin
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "name": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+      "id": "/providers/Microsoft.ProcessSimple/environments/Default-c5a5d746-3520-453f-8a69-780f8e44917e/flows/72f2be4a-78c1-4220-a048-dbf557296a72/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+      "type": "/providers/Microsoft.ProcessSimple/environments/flows/permissions",
+      "properties": {
+        "roleName": "Owner",
+        "permissionType": "Principal",
+        "principal": {
+          "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+          "type": "User"
+        }
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  roleName  id                                    type
+  --------  ------------------------------------  ----
+  Owner     fe36f75e-c103-410b-a18a-2bf6df06ac3a  User
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  roleName,id,type
+  Owner,fe36f75e-c103-410b-a18a-2bf6df06ac3a,User
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # flow owner list --environmentName "Default-c5a5d746-3520-453f-8a69-780f8e44917e" --flowName "72f2be4a-78c1-4220-a048-dbf557296a72"
+
+  Date: 25/02/2023
+
+  ## fe36f75e-c103-410b-a18a-2bf6df06ac3a (/providers/Microsoft.ProcessSimple/environments/Default-c5a5d746-3520-453f-8a69-780f8e44917e/flows/72f2be4a-78c1-4220-a048-dbf557296a72/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a)
+
+  Property | Value
+  ---------|-------
+  name | fe36f75e-c103-410b-a18a-2bf6df06ac3a
+  id | /providers/Microsoft.ProcessSimple/environments/Default-c5a5d746-3520-453f-8a69-780f8e44917e/flows/72f2be4a-78c1-4220-a048-dbf557296a72/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a
+  type | /providers/Microsoft.ProcessSimple/environments/flows/permissions
+  properties | {"roleName":"Owner","permissionType":"Principal","principal":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","type":"User"}}
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/flow/owner/owner-remove.mdx

@@ -0,0 +1,71 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# flow owner remove
+
+Removes owner permissions to a Power Automate flow
+
+## Usage
+
+```sh
+m365 flow owner remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-e, --environmentName <environmentName>`
+: The name of the environment.
+
+`-f, --flowName <flowName>`
+: The name of the Power Automate flow.
+
+`--userId [userId]`
+: The ID of the user. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--userName [userName]`
+: User principal name of the user. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--groupId [groupId]`
+: The ID of the group. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--groupName [groupName]`
+: The name of the group. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--asAdmin`
+: Run the command as admin.
+
+`--confirm`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Remove owner permissions from a specific Power Automate flow for a user by ID without prompting for confirmation
+
+```sh
+m365 flow owner remove --userId 5c241023-2ba5-4ea8-a516-a2481a3e6c51 --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --confirm
+```
+
+Remove owner permissions from a specific Power Automate flow for a user by UPN as admin
+
+```sh
+m365 flow owner remove --userName john.doe@contoso.com --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --asAdmin
+```
+
+Remove owner permissions from a specific Power Automate flow for a group by ID
+
+```sh
+m365 flow owner remove --groupId 5c241023-2ba5-4ea8-a516-a2481a3e6c51 --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72
+```
+
+Remove owner permissions from a specific Power Automate flow for a group by name as admin
+
+```sh
+m365 flow owner remove --groupName "Test group" --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --asAdmin
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/flow/run/run-cancel.mdx

@@ -0,0 +1,52 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# flow run cancel
+
+Cancels a specific run for the specified flow
+
+## Usage
+
+```sh
+m365 flow run cancel [options]
+```
+
+## Options
+
+```md defintion-list
+`-n, --name <name>`
+: The name of the run to cancel
+
+`-f, --flowName <flowName>`
+: The name of the flow to cancel the run for
+
+`-e, --environmentName <environmentName>`
+: The name of the environment where the flow is located
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
+
+If the flow with the name you specified doesn't exist, you will get the `The caller with object id 'abc' does not have permission for connection 'xyz' under Api 'shared_logicflows'.` error.
+
+If the run with the name you specified doesn't exist, you will get the `The workflow 'xyz' run 'abc' could not be found.` error.
+
+## Examples
+
+Cancel the given run of the specified flow
+
+```sh
+m365 flow run cancel --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --name 08586653536760200319026785874CU62
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/flow/run/run-get.mdx

@@ -0,0 +1,235 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# flow run get
+
+Gets information about a specific run of the specified Power Automate flow
+
+## Usage
+
+```sh
+m365 flow run get [options]
+```
+
+## Options
+
+```md defintion-list
+`-n, --name <name>`
+: The name of the run to get information about
+
+`-f, --flowName <flowName>`
+: The name of the Power Automate flow for which to retrieve information
+
+`-e, --environmentName <environmentName>`
+: The name of the environment where the flow is located
+
+`--includeTriggerInformation`
+: If specified, include information about the trigger details
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
+
+If the Microsoft Flow with the name you specified doesn't exist, you will get the `The caller with object id 'abc' does not have permission for connection 'xyz' under Api 'shared_logicflows'.` error.
+
+If the run with the name you specified doesn't exist, you will get the `The provided workflow run name is not valid.` error.
+
+If the option `includeTriggerInformation` is specified, but the trigger does not contain an outputsLink such as for example with a `Recurrence` trigger, this option will be ignored.
+
+## Examples
+
+Get information about the given run of the specified Power Automate flow
+
+```sh
+m365 flow run get --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --name 08586653536760200319026785874CU62
+```
+
+Get information about the given run of the specified Power Automate flow including trigger information
+
+```sh
+m365 flow run get --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --name 08586653536760200319026785874CU62 --includeTriggerInformation
+```
+
+## Response
+
+### Standard response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "name": "08585329112602833828909892130CU17",
+    "id": "/providers/Microsoft.ProcessSimple/environments/Default-de348bc7-1aeb-4406-8cb3-97db021cadb4/flows/170fb67e-a514-4d84-8727-582022bd13a9/runs/08585329112602833828909892130CU17",
+    "type": "Microsoft.ProcessSimple/environments/flows/runs",
+    "properties": {
+      "startTime": "2022-11-17T14:33:45.2763872Z",
+      "status": "Running",
+      "correlation": {
+        "clientTrackingId": "08585329112602833829909892130CU00"
+      },
+      "trigger": {
+        "name": "When_a_new_response_is_submitted",
+        "inputsLink": {
+          "uri": "https://prod-08.centralindia.logic.azure.com:443/workflows/f7bf8f6b5c494e63bfc21b54087a596e/runs/08585329112602833828909892130CU17/contents/TriggerInputs?api-version=2016-06-01&se=2022-11-17T18%3A00%3A00.0000000Z&sp=%2Fruns%2F08585329112602833828909892130CU17%2Fcontents%2FTriggerInputs%2Fread&sv=1.0&sig=",
+          "contentVersion": "6ZrBBE+MJg7IvhMgyJLMmA==",
+          "contentSize": 349,
+          "contentHash": {
+            "algorithm": "md5",
+            "value": "6ZrBBE+MJg7IvhMgyJLMmA=="
+          }
+        },
+        "outputsLink": {
+          "uri": "https://prod-08.centralindia.logic.azure.com:443/workflows/f7bf8f6b5c494e63bfc21b54087a596e/runs/08585329112602833828909892130CU17/contents/TriggerOutputs?api-version=2016-06-01&se=2022-11-17T18%3A00%3A00.0000000Z&sp=%2Fruns%2F08585329112602833828909892130CU17%2Fcontents%2FTriggerOutputs%2Fread&sv=1.0&sig=",
+          "contentVersion": "Z/4a8tfYygNAR1xpc44iww==",
+          "contentSize": 493,
+          "contentHash": {
+            "algorithm": "md5",
+            "value": "Z/4a8tfYygNAR1xpc44iww=="
+          }
+        },
+        "startTime": "2022-11-17T14:33:45.1914506Z",
+        "endTime": "2022-11-17T14:33:45.1914506Z",
+        "originHistoryName": "08585329112602833829909892130CU00",
+        "correlation": {
+          "clientTrackingId": "08585329112602833829909892130CU00"
+        },
+        "status": "Succeeded"
+      }
+    },
+    "startTime": "2022-11-17T14:33:45.2763872Z",
+    "endTime": "",
+    "status": "Running",
+    "triggerName": "When_a_new_response_is_submitted"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  endTime    : 2023-03-04T09:05:22.5880202Z
+  name       : 08585236861638480597867166179CU104
+  startTime  : 2023-03-04T09:05:21.8066368Z
+  status     : Succeeded
+  triggerName: When_an_email_is_flagged_(V4)
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  name,startTime,endTime,status,triggerName
+  08585236861638480597867166179CU104,2023-03-04T09:05:21.8066368Z,2023-03-04T09:05:22.5880202Z,Succeeded,When_an_email_is_flagged_(V4)
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # flow run get --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --name 08586653536760200319026785874CU62
+
+  Date: 04/03/2023
+
+  ## 08586653536760200319026785874CU62 (/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/5923cb07-ce1a-4a5c-ab81-257ce820109a/runs/08586653536760200319026785874CU62)
+
+  Property | Value
+  ---------|-------
+  name | 08586653536760200319026785874CU62
+  id | /providers/Microsoft.ProcessSimple/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/flows/c3c707b5-fefd-4f7a-a96c-b8e0d5ca3cc1/runs/08585208964855963748594654409CU47
+  type | Microsoft.ProcessSimple/environments/flows/runs
+  startTime | 2023-03-04T09:05:21.8066368Z
+  endTime | 2023-03-04T09:05:22.5880202Z
+  status | Succeeded
+  triggerName | When\_an\_email\_is\_flagged\_(V4)
+  ```
+
+  </TabItem>
+</Tabs>
+
+### `includeTriggerInformation` response
+
+When using the option `includeTriggerInformation`, the response for the json-output will differ.
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "name": "08585236861638480597867166179CU104",
+    "id": "/providers/Microsoft.ProcessSimple/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/flows/24335774-daf6-4183-acb7-f5155c2cd2fe/runs/08585236861638480597867166179CU104",
+    "type": "Microsoft.ProcessSimple/environments/flows/runs",
+    "properties": {
+      "startTime": "2023-03-04T09:05:21.8066368Z",
+      "endTime": "2023-03-04T09:05:22.5880202Z",
+      "status": "Succeeded",
+      "correlation": {
+        "clientTrackingId": "08585236861638480598867166179CU131"
+      },
+      "trigger": {
+        "name": "When_an_email_is_flagged_(V4)",
+        "inputsLink": {
+          "uri": "https://prod-130.westeurope.logic.azure.com:443/workflows/3ebadb794f6641e0b7f4fda131cdfb0b/runs/08585236861638480597867166179CU104/contents/TriggerInputs?api-version=2016-06-01&se=2023-03-04T14%3A00%3A00.0000000Z&sp=%2Fruns%2F08585236861638480597867166179CU104%2Fcontents%2FTriggerInputs%2Fread&sv=1.0&sig=",
+          "contentVersion": "2v/VLXFrKV6JvwSdcN7aHg==",
+          "contentSize": 343,
+          "contentHash": {
+            "algorithm": "md5",
+            "value": "2v/VLXFrKV6JvwSdcN7aHg=="
+          }
+        },
+        "outputsLink": {
+          "uri": "https://prod-130.westeurope.logic.azure.com:443/workflows/3ebadb794f6641e0b7f4fda131cdfb0b/runs/08585236861638480597867166179CU104/contents/TriggerOutputs?api-version=2016-06-01&se=2023-03-04T14%3A00%3A00.0000000Z&sp=%2Fruns%2F08585236861638480597867166179CU104%2Fcontents%2FTriggerOutputs%2Fread&sv=1.0&sig=",
+          "contentVersion": "AHZEeWNlQ0bLe48yDmpzrQ==",
+          "contentSize": 3478,
+          "contentHash": {
+            "algorithm": "md5",
+            "value": "AHZEeWNlQ0bLe48yDmpzrQ=="
+          }
+        },
+        "startTime": "2023-03-04T09:05:21.6192576Z",
+        "endTime": "2023-03-04T09:05:21.7442626Z",
+        "scheduledTime": "2023-03-04T09:05:21.573561Z",
+        "originHistoryName": "08585236861638480598867166179CU131",
+        "correlation": {
+          "clientTrackingId": "08585236861638480598867166179CU131"
+        },
+        "code": "OK",
+        "status": "Succeeded"
+      }
+    },
+    "startTime": "2023-03-04T09:05:21.8066368Z",
+    "endTime": "2023-03-04T09:05:22.5880202Z",
+    "status": "Succeeded",
+    "triggerName": "When_an_email_is_flagged_(V4)",
+    "triggerInformation": {
+      "from": "john@contoso.com",
+      "toRecipients": "doe@contoso.com",
+      "subject": "Dummy email",
+      "body": "<html><head>\r\\\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"></head><body><p>This is dummy content</p></body></html>",
+      "importance": "normal",
+      "bodyPreview": "This is dummy content",
+      "hasAttachments": false,
+      "id": "AAMkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgBGAAAAAAC6jQfUzacTSIHqMw2yacnUBwBiOC8xvYmdT6G2E_hLMK5kAAAAAAEMAABiOC8xvYmdT6G2E_hLMK5kAALUqy81AAA=",
+      "internetMessageId": "<DB7PR03MB5018879914324FC65695809FE1AD9@DB7PR03MB5018.eurprd03.prod.outlook.com>",
+      "conversationId": "AAQkADgzN2Q1NThiLTI0NjYtNGIxYS05MDdjLTg1OWQxNzgwZGM2ZgAQAMqP9zsK8a1CnIYEgHclLTk=",
+      "receivedDateTime": "2023-03-01T15:06:57+00:00",
+      "isRead": false,
+      "attachments": [],
+      "isHtml": true
+    }
+  }
+  ```
+
+  </TabItem>
+</Tabs>
+