@pnp/cli-microsoft365 7.3.0-beta.73848f3 → 7.3.0-beta.ca3f7f5

package/docs/docs/cmd/external/connection/connection-doctor.mdx

@@ -0,0 +1,182 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# external connection doctor
+
+Checks if the external connection is correctly configured for use with a specified user experience in Microsoft 365
+
+## Usage
+
+```sh
+m365 external connection doctor [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the external connection to check.
+
+`--ux [ux]`
+: Microsoft 365 experience for which to check compatibility. Allowed values `copilot`, `search`, `all` (default)
+```
+
+<Global />
+
+## Remarks
+
+The `external connection doctor` command runs several automated checks to verify if an external connection is correctly configured for use with a user experience in Microsoft 365.
+
+Check|ID|UX|Type|Description
+-----|--|:--:|--|------------
+Required semantic labels|`copilotRequiredSemanticLabels`|Copilot|Required|Checks if the external connection schema has the required semantic labels configured: `title`, `url` and `iconUrl`
+Searchable properties|Copilot|`searchableProperties`|Required|Checks if the external connection schema has at least one searchable property
+Items have content ingested|`contentIngested`|Copilot|Required|Checks if external items have content ingested
+Connection configured for inline results|`enabledForInlineResults`|Copilot|Required (manual)|Check if the external connection is configured for inline results
+Items have activities recorded|`itemsHaveActivities`|Copilot|Recommended (manual)|Check if external items have activities recorded
+Meaningful connection name and description|`meaningfulNameAndDescription`|Copilot|Required (manual)|Check if the external connection has a meaningful name and description
+Semantic labels|`semanticLabels`|Search|Recommended|Checks if the external connection schema uses semantic labels
+Searchable properties|`searchableProperties`|Search|Recommended|Checks if the external connection schema has at least one searchable property
+Result types|`resultType`|Search|Recommended|Checks if the external connection has a result type configured
+Items have content ingested|`contentIngested`|Search|Recommended|Checks if external items have content ingested
+Items have activities recorded|`itemsHaveActivities`|Search|Recommended|Check if external items have activities recorded
+urlToItemResolver configured|`urlToItemResolver`|All|Recommended|Checks if the external connection has at least one urlToItemResolver configured
+
+Required checks must pass for the external connection to be compatible with the specified user experience. Recommended checks are optional, but recommended for optimal user experience.
+
+Some checks must be done manually, because there are no APIs available to verify the configuration automatically.
+
+When you check the compatibility with all UXs, and there are multiple checks with the same ID, the command will use the first matching check, following the order listed above.
+
+## Examples
+
+Checks if the external connection with the specified ID is correctly configured for use with Copilot for Microsoft 365.
+
+```sh
+m365 external connection doctor --id contosoproducts --ux copilot
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "loadExternalConnection",
+      "text": "Load connection",
+      "type": "required",
+      "status": "passed"
+    },
+    {
+      "id": "loadSchema",
+      "text": "Load schema",
+      "type": "required",
+      "status": "passed"
+    },
+    {
+      "id": "copilotRequiredSemanticLabels",
+      "text": "Required semantic labels",
+      "type": "required",
+      "errorMessage": "Missing label iconUrl",
+      "status": "failed"
+    },
+    {
+      "id": "searchableProperties",
+      "text": "Searchable properties",
+      "type": "required",
+      "status": "passed"
+    },
+    {
+      "id": "contentIngested",
+      "text": "Items have content ingested",
+      "type": "required",
+      "status": "passed"
+    },
+    {
+      "id": "enabledForInlineResults",
+      "text": "Connection configured for inline results",
+      "type": "required",
+      "status": "manual"
+    },
+    {
+      "id": "itemsHaveActivities",
+      "text": "Items have activities recorded",
+      "type": "recommended",
+      "status": "manual"
+    },
+    {
+      "id": "meaningfulNameAndDescription",
+      "text": "Meaningful connection name and description",
+      "type": "required",
+      "status": "manual"
+    },
+    {
+      "id": "urlToItemResolver",
+      "text": "urlToItemResolver configured",
+      "type": "recommended",
+      "status": "passed"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ✔ Load connection
+  ✔ Load schema
+  ✖ Required semantic labels: Missing label iconUrl
+  ✔ Searchable properties
+  ✔ Items have content ingested
+  ℹ Connection configured for inline results (manual)
+  ℹ Items have activities recorded (manual)
+  ℹ Meaningful connection name and description (manual)
+  ✔ urlToItemResolver configured
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,text,type,status,errorMessage
+  loadExternalConnection,Load connection,required,passed,
+  loadSchema,Load schema,required,passed,
+  copilotRequiredSemanticLabels,Required semantic labels,required,failed,Missing label iconUrl
+  searchableProperties,Searchable properties,required,passed,
+  contentIngested,Items have content ingested,required,passed,
+  enabledForInlineResults,Connection configured for inline results,required,manual,
+  itemsHaveActivities,Items have activities recorded,recommended,manual,
+  meaningfulNameAndDescription,Meaningful connection name and description,required,manual,
+  urlToItemResolver,urlToItemResolver configured,recommended,passed,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # external connection doctor --id "msgraphdocs" --ux "copilot"
+
+  Date: 11/23/2023
+
+  Check|Type|Status|Error message
+  :----|:--:|:----:|:------------
+  Load connection|required|passed|
+  Load schema|required|passed|
+  Required semantic labels|required|failed|Missing label iconUrl
+  Searchable properties|required|passed|
+  Items have content ingested|required|passed|
+  Connection configured for inline results|required|manual|
+  Items have activities recorded|recommended|manual|
+  Meaningful connection name and description|required|manual|
+  urlToItemResolver configured|recommended|passed|
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Microsoft Graph connector experiences: [https://learn.microsoft.com/graph/connecting-external-content-experiences](https://learn.microsoft.com/graph/connecting-external-content-experiences)

package/docs/docs/cmd/external/item/item-add.mdx

@@ -0,0 +1,145 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# external item add
+
+Creates external item
+
+## Usage
+
+```sh
+m365 external item add [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the item to create
+
+`--externalConnectionId <name>`
+: The ID of the external connection on which to create the item
+
+`--content <content>`
+: External item content
+
+`--contentType [contentType]`
+: Type of content to load. Allowed values: `text` (default), `html`
+
+`--acls <acls>`
+: List of permissions to set on the item, in the format `accessType1,type1,value1;accessType2,type2,value2`, eg. `grant,everyone,everyone`
+```
+<Global />
+
+## Remarks
+
+When creating an external item, the options you specify will map to the external item properties, eg. `--author "Steve"` will set the `author` property of the external item to `Steve`.
+
+If in your schema you have a multi-value property, to specify its value you need two things:
+
+- you need to separate multiple values using `;#`, eg. `--author "Steve;#Bill"`
+- you need to specify the type of the property as defined in the schema, eg. `--author@odata.type "Collection(String)"`
+
+When creating items you can specify one or more permissions that define who can access the external item. The format of the permissions is `accessType1,type1,value1;accessType2,type2,value2`, eg. `grant,everyone,everyone`.
+
+You can use the following access types:
+
+- `grant` - grants access to the specified users or groups
+- `deny` - denies access to the specified users or groups
+
+You can use the following types:
+
+- `everyone` - everyone
+- `group` - an Entra group
+- `user` - an Entra user
+- `everyoneExceptGuests` - everyone except external users
+- `externalGroup` - a group defined in the external system from which you're importing the content
+
+For more information about using these options, see the Microsoft Graph API documentation and documentation about Microsoft Graph connectors.
+
+## Examples
+
+Creates an external item with simple properties that everyone is allowed to access
+
+```sh
+m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors "Phil Harding" --acls "grant,everyone,everyone"
+```
+
+Creates an external item with multi-value properties accessible only to users from the specified Entra group
+
+```sh
+m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors@odata.type "Collection(String)" --authors "Phil Harding;#Steve Smith" --acls "grant,group,Super users"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "pnp-ensure-siteassets-library",
+    "acl": [
+      {
+        "type": "everyone",
+        "value": "everyone",
+        "accessType": "grant"
+      }
+    ],
+    "properties": {
+      "title": "Ensure the Site Assets Library is created",
+      "description": "Ensure that the Site Assets library is created.",
+      "authors": "Phil Harding"
+    },
+    "content": {
+      "value": "Ensure that the Site Assets library is created.",
+      "type": "text"
+    },
+    "activities": []
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  acl       : [{"type":"everyone","value":"everyone","accessType":"grant"}]
+  activities: []
+  content   : {"value":"Ensure that the Site Assets library is created.","type":"text"}
+  id        : pnp-ensure-siteassets-library
+  properties: {"title":"Ensure the Site Assets Library is created","description":"Ensure that the Site Assets library is created.","authors":"Phil Harding"}
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id
+  pnp-ensure-siteassets-library
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors "Phil Harding" --acls "grant,everyone,everyone"
+
+  Date: 2023-10-28
+
+  ## pnp-ensure-siteassets-library
+
+  Property | Value
+  ---------|-------
+  id | pnp-ensure-siteassets-library
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Microsoft Graph connectors access control list [https://learn.microsoft.com/graph/connecting-external-content-manage-items#access-control-list](https://learn.microsoft.com/graph/connecting-external-content-manage-items#access-control-list)
+- Create, update, and delete items added by your application via Microsoft Graph connectors [https://learn.microsoft.com/graph/connecting-external-content-manage-items](https://learn.microsoft.com/graph/connecting-external-content-manage-items)
+- Use external groups to manage permissions to Microsoft Graph connectors data sources [https://learn.microsoft.com/graph/connecting-external-content-external-groups](https://learn.microsoft.com/graph/connecting-external-content-external-groups)
+- Create externalItem [https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-put-items?view=graph-rest-1.0&tabs=http](https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-put-items?view=graph-rest-1.0&tabs=http)

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

@@ -23,7 +23,7 @@ m365 flow environment get [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -18,7 +18,7 @@ m365 flow environment list [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -27,7 +27,7 @@ m365 flow disable [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -27,7 +27,7 @@ m365 flow enable [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -42,7 +42,7 @@ m365 flow export [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -29,7 +29,7 @@ m365 flow get [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -32,7 +32,7 @@ m365 flow list [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -30,7 +30,7 @@ m365 flow run cancel [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -32,7 +32,7 @@ m365 flow run get [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -38,7 +38,7 @@ m365 flow run list [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -30,7 +30,7 @@ m365 flow run resubmit [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -35,7 +35,7 @@ m365 graph changelog list [options]
 
 ## Remarks
 
-:::caution
+:::warning
 
 This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
 

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

@@ -49,7 +49,7 @@ The schema extension owner is the ID of the Azure AD application that is the own
 
 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
+:::warning 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.
 

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

@@ -40,7 +40,7 @@ The lifecycle state of the schema extension. The initial state upon creation is
 Possible states transitions are from `InDevelopment` to `Available` and `Available` to `Deprecated`.
 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
+:::warning 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.
 

package/docs/docs/cmd/onedrive/report/report-activityfilecounts.mdx

@@ -17,9 +17,6 @@ m365 onedrive report activityfilecounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/onedrive/report/report-activityusercounts.mdx

@@ -17,9 +17,6 @@ m365 onedrive report activityusercounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/onedrive/report/report-activityuserdetail.mdx

@@ -20,9 +20,6 @@ m365 onedrive report activityuserdetail [options]
 
 `-d, --date [date]`
 : The date for which you would like to view the users who performed any activity. Supported date format is YYYY-MM-DD. Specify the date or period, but not both`
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/onedrive/report/report-usageaccountcounts.mdx

@@ -17,9 +17,6 @@ m365 onedrive report usageaccountcounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/onedrive/report/report-usageaccountdetail.mdx

@@ -20,9 +20,6 @@ m365 onedrive report usageaccountdetail [options]
 
 `-d, --date [date]`
 : The date for which you would like to view the users who performed any activity. Supported date format is YYYY-MM-DD. Specify the date or period, but not both`
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/onedrive/report/report-usagefilecounts.mdx

@@ -17,9 +17,6 @@ m365 onedrive report usagefilecounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/onedrive/report/report-usagestorage.mdx

@@ -17,9 +17,6 @@ m365 onedrive report usagestorage [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailactivitycounts.mdx

@@ -17,9 +17,6 @@ m365 outlook report mailactivitycounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailactivityusercounts.mdx

@@ -17,9 +17,6 @@ m365 outlook report mailactivityusercounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailactivityuserdetail.mdx

@@ -20,9 +20,6 @@ m365 outlook report mailactivityuserdetail [options]
 
 `-d, --date [date]`
 : The date for which you would like to view the users who performed any activity. Supported date format is YYYY-MM-DD. Specify the date or period, but not both
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailappusageappsusercounts.mdx

@@ -17,9 +17,6 @@ m365 outlook report mailappusageappsusercounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailappusageusercounts.mdx

@@ -17,9 +17,6 @@ m365 outlook report mailappusageusercounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailappusageuserdetail.mdx

@@ -20,9 +20,6 @@ m365 outlook report mailappusageuserdetail [options]
 
 `-d, --date [date]`
 : The date for which you would like to view the users who performed any activity. Supported date format is YYYY-MM-DD. Specify the date or period, but not both
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailappusageversionsusercounts.mdx

@@ -17,9 +17,6 @@ m365 outlook report mailappusageversionsusercounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailboxusagedetail.mdx

@@ -17,9 +17,6 @@ m365 outlook report mailboxusagedetail [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailboxusagemailboxcount.mdx

@@ -17,9 +17,6 @@ m365 outlook report mailboxusagemailboxcount [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />

package/docs/docs/cmd/outlook/report/report-mailboxusagequotastatusmailboxcounts.mdx

@@ -17,9 +17,6 @@ m365 outlook report mailboxusagequotastatusmailboxcounts [options]
 ```md definition-list
 `-p, --period <period>`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in
 ```
 
 <Global />