@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.6a23aba

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

@@ -0,0 +1,173 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# flow run list
+
+Lists runs of the specified Microsoft Flow
+
+## Usage
+
+```sh
+m365 flow run list [options]
+```
+
+## Options
+
+```md definition-list
+`-f, --flowName <flowName>`
+: The name of the Microsoft Flow to retrieve the runs for
+
+`-e, --environmentName <environmentName>`
+: The name of the environment to which the flow belongs
+
+`--status [status]` 
+: Filter the results to only flow runs with a given status: `Succeeded`, `Running`, `Failed` or `Cancelled`. By default all flow runs are listed.
+
+`--triggerStartTime [triggerStartTime]`
+: Time indicating the inclusive start of a time range of flow runs to return. This should be defined as a valid ISO 8601 string (2021-12-16T18:28:48.6964197Z).
+
+`--triggerEndTime [triggerEndTime]`
+: Time indicating the exclusive end of a time range of flow runs to return. This should be defined as a valid ISO 8601 string (2021-12-16T18:28:48.6964197Z).
+
+`--sharingStatus [sharingStatus]`
+: List a specific type of flows. Valid values: `ownedByMe`, `personal`, `sharedWithMe`, `all`. Defaults to `ownedByMe`. Don't specify this option when using asAdmin.
+
+`--asAdmin`
+: Run the command as admin. Use this flag when targeting flows you don't own.
+```
+
+<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.
+
+## Examples
+
+List runs of the specified Microsoft Flow
+
+```sh
+m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a
+```
+
+List runs of the specified Microsoft Flow with a specific status
+
+```sh
+m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --status Running
+```
+
+List runs of the specified Microsoft Flow between a specific time range
+
+```sh
+m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --triggerStartTime 2023-01-21T18:19:00Z --triggerEndTime 2023-01-22T00:00:00Z
+```
+
+List runs of the specified Microsoft Flow owned by another user
+
+```sh
+m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --asAdmin
+```
+
+## 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=jmdMRWvY7uGoxTmqd3_a2bJtegXuVyuKTKKUVLiwh38",
+            "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=Y3qqjuWrrcQJrmF7uvm6LVzQy5w-dNOFWJ8Yt8khXvA",
+            "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",
+      "status": "Running"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  name                               startTime                     status
+  ---------------------------------  ----------------------------  ---------
+  08585329112602833828909892130CU17  2022-11-17T14:33:45.2763872Z  Running
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  name,startTime,status
+  08585329112602833828909892130CU17,2022-11-17T14:33:45.2763872Z,Running
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # flow run list --environmentName "Default-de348bc7-1aeb-4406-8cb3-97db021cadb4" --flowName "08585329112602833828909892130CU17"
+
+  Date: 1/3/2023
+
+  ## 08585329112602833828909892130CU17 (/providers/Microsoft.ProcessSimple/environments/Default-de348bc7-1aeb-4406-8cb3-97db021cadb4/flows/170fb67e-a514-4d84-8727-582022bd13a9/runs/08585329112602833828909892130CU17)
+
+  Property | Value
+  ---------|-------
+  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=jmdMRWvY7uGoxTmqd3_a2bJtegXuVyuKTKKUVLiwh38","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=Y3qqjuWrrcQJrmF7uvm6LVzQy5w-dNOFWJ8Yt8khXvA","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
+  status | Running
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,61 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# flow run resubmit
+
+Resubmits a specific flow run for the specified Microsoft Flow
+
+## Usage
+
+```sh
+m365 flow run resubmit [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name <name>`
+: The name of the run to resubmit
+
+`-f, --flowName <flowName>`
+: The name of the flow to resubmit the run for
+
+`-e, --environmentName <environmentName>`
+: The name of the environment where the Flow is located
+
+`--confirm`
+: Don't prompt for confirmation
+```
+
+<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 workflow 'xyz' run 'abc' could not be found.` error.
+
+## Examples
+
+Resubmits a specific flow run for the specified Microsoft Flow
+
+```sh
+m365 flow run resubmit --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --name 08586653536760200319026785874CU62
+```
+
+Resubmits a specific flow run for the specified Microsoft Flow without prompting for confirmation
+
+```sh
+m365 flow run resubmit --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --name 08586653536760200319026785874CU62 --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/graph/changelog/changelog-list.mdx

@@ -0,0 +1,122 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# graph changelog list
+
+Gets an overview of specific API-level changes in Microsoft Graph v1.0 and beta
+
+## Usage
+
+```sh
+m365 graph changelog list [options]
+```
+
+## Options
+
+```md definition-list
+`-v, --versions [versions]`
+: Comma-separated list of versions to show changes for. `Beta`, `v1.0`. When no version is selected all versions are returned.
+
+`-c, --changeType [changeType]`
+: Change type to show changes for. `Addition`, `Change`, `Deletion`. When no changeType is selected all change types are returned.
+
+`-s, --services [services]`
+: Comma-separated list of services to show changes for. `Applications`, `Calendar`, `Change notifications`, `Cloud communications`, `Compliance`, `Cross-device experiences`, `Customer booking`, `Device and app management`, `Education`, `Files`, `Financials`, `Groups`, `Identity and access`, `Mail`, `Notes`, `Notifications`, `People and workplace intelligence`, `Personal contacts`, `Reports`, `Search`, `Security`, `Sites and lists`, `Tasks and plans`, `Teamwork`, `To-do tasks`, `Users`, `Workbooks and charts`. When no service is selected all services are returned.
+
+`--startDate [startDate]`
+: The startdate used to query for changes. Supported date format is `YYYY-MM-DD`. When no date is specified all changes are returned.
+
+`--endDate [endDate]`
+: The enddate used to query for changes. Supported date format is `YYYY-MM-DD`. When no date is specified all changes are returned.
+```
+
+<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.
+
+:::
+
+## Examples
+
+Get all changes within Microsoft Graph.
+
+```sh
+m365 graph changelog list
+```
+
+Get all changes within Microsoft Graph for the services _Groups_ and _Users_.
+
+```sh
+m365 graph changelog list --services 'Groups,Users'
+```
+
+Get all changes within Microsoft Graph that happend between _2021-01-01_ and _2021-05-01_.
+
+```sh
+m365 graph changelog list --startDate '2021-01-01' --endDate '2021-05-01'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "guid": "2693683c-f49a-4715-a649-edadd3f54aadv1.0",
+      "category": "v1.0",
+      "title": "Teamwork and communications",
+      "description": "Added the **chatMessageActions** enumeration type.\r\\\nAdded the [chatMessageHistoryItem](https://learn.microsoft.com/en-us/graph/api/resources/chatMessageHistoryItem?view=graph-rest-1.0) resource type.\r\\\nAdded the **messageHistory** property to the [chatMessage](https://learn.microsoft.com/en-us/graph/api/resources/chatMessage?view=graph-rest-1.0) resource.\r\\\n",
+      "pubDate": "2023-05-18T23:04:05.000Z"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  category  title                        description
+  --------  ---------------------------  ----------------------------------------------
+  v1.0      Teamwork and communications  Added the chatMessageActions enumeration type.
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  guid,category,title,description
+  2693683c-f49a-4715-a649-edadd3f54aadv1.0,v1.0,Teamwork and communications,"Added the **chatMessageActions** enumeration type.
+  Added the [chatMessageHistoryItem](https://learn.microsoft.com/en-us/graph/api/resources/chatMessageHistoryItem?view=graph-rest-1.0) resource type.
+  Added the **messageHistory** property to the [chatMessage](https://learn.microsoft.com/en-us/graph/api/resources/chatMessage?view=graph-rest-1.0) resource.
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # graph changelog list 
+
+  Date: 2023-05-22
+
+  ## Teamwork and communications
+
+  Property | Value
+  ---------|-------
+  guid | 2693683c-f49a-4715-a649-edadd3f54aadv1.0
+  category | v1.0
+  title | Teamwork and communications
+  description | Added the \*\*chatMessageActions\*\* enumeration type.
+  <br>Added the [chatMessageHistoryItem](https://learn.microsoft.com/en-us/graph/api/resources/chatMessageHistoryItem?view=graph-rest-1.0) resource type.
+  <br>Added the \*\*messageHistory\*\* property to the [chatMessage](https://learn.microsoft.com/en-us/graph/api/resources/chatMessage?view=graph-rest-1.0) resource.
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/graph/schemaextension/schemaextension-add.mdx

@@ -0,0 +1,139 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# graph schemaextension add
+
+Creates a Microsoft Graph schema extension
+
+## Usage
+
+```sh
+m365 graph schemaextension add [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The unique identifier for the schema extension definition
+
+`-d, --description [description]`
+: Description of the schema extension
+
+`--owner <owner>`
+: The Id ID the Azure AD application that is the owner of the schema extension
+
+`-t, --targetTypes <targetTypes>`
+: Comma-separated list of Microsoft Graph resource types the schema extension targets
+
+`-p, --properties`
+: The collection of property names and types that make up the schema extension definition formatted as a JSON string
+```
+
+<Global />
+
+## Remarks
+
+To create a schema extension, you have to specify a unique ID for the schema extension. You can assign a value in one of two ways:
+
+- concatenate the name of one of your verified domains with a name for the schema extension to form a unique string in this format, `{domainName}_{schemaName}`, eg. `contoso_mySchema`.
+
+    NOTE: Only verified domains under the following top-level domains are supported: .com, .net, .gov, .edu or .org.
+
+- Provide a schema name, and let Microsoft Graph use that schema name to complete the id assignment in this format: `ext{8-random-alphanumeric-chars}_{schema-name}`, eg. `extkvbmkofy_mySchema`.
+
+The schema extension ID cannot be changed after creation.
+
+The schema extension owner is the ID of the Azure AD application that is the owner of the schema extension. Once set, this property is read-only and cannot be changed.
+
+The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list
+
+:::caution Escaping JSON in PowerShell
+
+When using the `--properties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
+
+:::
+
+## Examples
+
+Create a schema extension
+
+```sh
+m365 graph schemaextension add --id MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties '[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]'
+```
+
+Create a schema extension with a verified domain
+
+```sh
+m365 graph schemaextension add --id contoso_MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties '[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "extb4lob7o4_MySchemaExtension",
+    "description": "My Schema Extension",
+    "targetTypes": [
+      "Group"
+    ],
+    "status": "InDevelopment",
+    "owner": "19b5bd1f-3d5e-404a-80f5-ca840b40a082",
+    "properties": [
+      {
+        "name": "myProp1",
+        "type": "Integer"
+      },
+      {
+        "name": "myProp2",
+        "type": "String"
+      }
+    ]
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  description: My Schema Extension
+  id         : extuf4mntoy_MySchemaExtension
+  owner      : 19b5bd1f-3d5e-404a-80f5-ca840b40a082
+  properties : [{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]
+  status     : InDevelopment
+  targetTypes: ["Group"]
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,description,status,owner
+  extlywhx1h4_MySchemaExtension,My Schema Extension,InDevelopment,19b5bd1f-3d5e-404a-80f5-ca840b40a082
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # graph schemaextension add --id "MySchemaExtension" --description "My Schema Extension" --targetTypes "Group" --owner "19b5bd1f-3d5e-404a-80f5-ca840b40a082" --properties "[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]"
+
+  Date: 2023-05-22
+
+  ## extnevl1fo8_MySchemaExtension
+
+  Property | Value
+  ---------|-------
+  id | extnevl1fo8\_MySchemaExtension
+  description | My Schema Extension
+  status | InDevelopment
+  owner | 19b5bd1f-3d5e-404a-80f5-ca840b40a082
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/graph/schemaextension/schemaextension-get.mdx

@@ -0,0 +1,104 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# graph schemaextension get
+
+Gets the properties of the specified schema extension definition
+
+## Usage
+
+```sh
+m365 graph schemaextension get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The unique identifier for the schema extension definition
+```
+
+<Global />
+
+## Remarks
+
+To get properties of a schema extension definition, you have to pass the ID of the schema
+extension.
+
+## Examples
+
+Gets properties of a schema extension definition with ID domain_myExtension
+
+```sh
+m365 graph schemaextension get --id domain_myExtension 
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "extuf4mntoy_MySchemaExtension",
+    "description": "My Schema Extension",
+    "targetTypes": [
+      "Group"
+    ],
+    "status": "InDevelopment",
+    "owner": "19b5bd1f-3d5e-404a-80f5-ca840b40a082",
+    "properties": [
+      {
+        "name": "myProp1",
+        "type": "Integer"
+      },
+      {
+        "name": "myProp2",
+        "type": "String"
+      }
+    ]
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  description: My Schema Extension
+  id         : extuf4mntoy_MySchemaExtension
+  owner      : 19b5bd1f-3d5e-404a-80f5-ca840b40a082
+  properties : [{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]
+  status     : InDevelopment
+  targetTypes: ["Group"]
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,description,status,owner
+  extuf4mntoy_MySchemaExtension,My Schema Extension,InDevelopment,19b5bd1f-3d5e-404a-80f5-ca840b40a082
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # graph schemaextension get --id "extuf4mntoy_MySchemaExtension"
+
+  Date: 2023-05-22
+
+  ## extuf4mntoy_MySchemaExtension
+
+  Property | Value
+  ---------|-------
+  id | extuf4mntoy\_MySchemaExtension
+  description | My Schema Extension
+  status | InDevelopment
+  owner | 19b5bd1f-3d5e-404a-80f5-ca840b40a082
+  ```
+
+  </TabItem>
+</Tabs>
+