@pnp/cli-microsoft365 7.2.0 → 7.3.0-beta.01256d2

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/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 />

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

@@ -17,9 +17,6 @@ m365 outlook report mailboxusagestorage [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/skype/report/report-activitycounts.mdx

@@ -17,8 +17,6 @@ m365 skype report activitycounts [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/skype/report/report-activityusercounts.mdx

@@ -17,9 +17,6 @@ m365 skype 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/skype/report/report-activityuserdetail.mdx

@@ -20,9 +20,6 @@ m365 skype 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/spo/report/report-activityfilecounts.mdx

@@ -17,9 +17,6 @@ m365 spo 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/spo/report/report-activitypages.mdx

@@ -17,9 +17,6 @@ m365 spo report activitypages [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/spo/report/report-activityusercounts.mdx

@@ -17,9 +17,6 @@ m365 spo 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/spo/report/report-activityuserdetail.mdx

@@ -20,9 +20,6 @@ m365 spo report activityuserdetail [options]
 
 `-p, --period [period]`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`. Specify either `date` or `period`, but not both.
-
-`--outputFile [outputFile]`
-: Path to the file where the Microsoft Teams device usage by user report should be stored in.
 ```
 
 <Global />

package/docs/docs/cmd/spo/report/report-siteusagedetail.mdx

@@ -20,9 +20,6 @@ m365 spo report siteusagedetail [options]
 
 `-p, --period [period]`
 : The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`. Specify either `date` or `period`, but not both.
-
-`--outputFile [outputFile]`
-: Path to the file where the report should be stored in.
 ```
 
 <Global />

package/docs/docs/cmd/spo/report/report-siteusagefilecounts.mdx

@@ -17,9 +17,6 @@ m365 spo report siteusagefilecounts [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/spo/report/report-siteusagepages.mdx

@@ -17,9 +17,6 @@ m365 spo report siteusagepages [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/spo/report/report-siteusagesitecounts.mdx

@@ -17,9 +17,6 @@ m365 spo report siteusagesitecounts [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/spo/report/report-siteusagestorage.mdx

@@ -17,9 +17,6 @@ m365 spo report siteusagestorage [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 />