@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.148279d

package/docs/docs/cmd/purview/retentionevent/retentionevent-add.mdx

@@ -0,0 +1,161 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# purview retentionevent add
+
+Create a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --displayName <displayName>`
+: The display name of the event
+
+`-e, --eventTypeName [eventTypeName]`
+: Name of the event type associated with the event. Specify either `eventTypeId` or `eventTypeName` but not both.
+
+`-i, --eventTypeId [eventTypeId]`
+: Id of the event type associated with the event. Specify either `eventTypeId` or `eventTypeName` but not both.
+
+`-d, --description [description]`
+: A description for the event
+
+`--triggerDateTime [triggerDateTime]`
+: Optional time when the event should be triggered.
+
+`-a, --assetIds [assetIds]`
+: The Asset IDs for items in SharePoint and OneDrive that are related to this event. Only items that have labels associated with the event type you chose will be retained. Specify `assetIds` and/or `keywords`, but at least one.
+
+`-k, --keywords [keywords]`
+: The keywords for items in Exchange that are related to this event. Only items that have labels associated with the event type you chose will be retained. Specify `assetIds` and/or `keywords`, but at least one.
+```
+
+<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
+
+Create a retention event to start retention at the end of 2022 for all employee documents that have been labeled and have the Asset ID _EmployeeNr1234_
+
+```sh
+m365 purview retentionevent add --displayName 'Employee information expiration' --description 'Employee documents expired due to offboarding' --eventTypeName 'CustomRetentionTime' --triggerDateTime '2022-12-31' --assetIds 'ComplianceAssetId:EmployeeNr1234'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "displayName": "Event display name",
+    "description": "Event description",
+    "eventTriggerDateTime": "2023-04-02T15:47:54Z",
+    "lastStatusUpdateDateTime": "0001-01-01T00:00:00Z",
+    "createdDateTime": "2023-02-20T18:53:05Z",
+    "lastModifiedDateTime": "2023-02-20T18:53:05Z",
+    "id": "9f5c1a04-8f7a-4bff-e400-08db1373b324",
+    "eventQueries": [
+      {
+        "queryType": "files",
+        "query": "filesQuery,filesQuery1"
+      },
+      {
+        "queryType": "messages",
+        "query": "messagesQuery,messagesQuery1"
+      }
+    ],
+    "eventStatus": {
+      "error": null,
+      "status": "pending"
+    },
+    "eventPropagationResults": [],
+    "createdBy": {
+      "user": {
+        "id": null,
+        "displayName": "John Doe"
+      }
+    },
+    "lastModifiedBy": {
+      "user": {
+        "id": null,
+        "displayName": "John Doe"
+      }
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdBy               : {"user":{"id":null,"displayName":"John Doe"}}
+  createdDateTime         : 2023-02-20T18:53:05Z
+  description             : Event description
+  displayName             : Event display name
+  eventPropagationResults : []
+  eventQueries            : [{"queryType":"files","query":"filesQuery,filesQuery1"},{"queryType":"messages","query":"messagesQuery,messagesQuery1"}]
+  eventStatus             : {"error":null,"status":"pending"}
+  eventTriggerDateTime    : 2023-04-02T15:47:54Z
+  id                      : 9f5c1a04-8f7a-4bff-e400-08db1373b324
+  lastModifiedBy          : {"user":{"id":null,"displayName":"John Doe"}}
+  lastModifiedDateTime    : 2023-02-20T18:53:05Z
+  lastStatusUpdateDateTime: 0001-01-01T00:00:00Z 
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  displayName,description,eventTriggerDateTime,lastStatusUpdateDateTime,createdDateTime,lastModifiedDateTime,id,eventQueries,eventStatus,eventPropagationResults,createdBy,lastModifiedBy
+  Event display name,Event description,2023-04-02T15:47:54Z,0001-01-01T00:00:00Z,2023-02-20T18:53:05Z,2023-02-20T18:53:05Z,9f5c1a04-8f7a-4bff-e400-08db1373b324,"[{""queryType"":""files"",""query"":""filesQuery,filesQuery1""},{""queryType"":""messages"",""query"":""messagesQuery,messagesQuery1""}]","{""error"":null,""status"":""pending""}",[],"{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}"
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # purview retentionevent add --displayName "Event display name" --eventType "Event Type" --description "Event description" --triggerDateTime "2023-04-02T15:47:54Z" --assetIds "filesQuery,filesQuery1" --keywords "messagesQuery,messagesQuery1"
+
+  Date: 20/2/2023
+
+  ## Event display name (9f5c1a04-8f7a-4bff-e400-08db1373b324)
+
+  Property | Value
+  ---------|-------
+  displayName | Event display name
+  description | Event description
+  eventTriggerDateTime | 2023-04-02T15:47:54Z
+  lastStatusUpdateDateTime | 0001-01-01T00:00:00Z
+  createdDateTime | 2023-02-20T18:53:05Z
+  lastModifiedDateTime | 2023-02-20T18:53:05Z
+  id | 9f5c1a04-8f7a-4bff-e400-08db1373b324
+  eventQueries | [{"queryType":"files","query":"filesQuery,filesQuery1"},{"queryType":"messages","query":"messagesQuery,messagesQuery1"}]
+  eventStatus | {"error":null,"status":"pending"}
+  eventPropagationResults | []
+  createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+  lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
+
+[Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)

package/docs/docs/cmd/purview/retentionevent/retentionevent-get.mdx

@@ -0,0 +1,144 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# purview retentionevent get
+
+Get a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The Id of the retention event.
+```
+
+<Global />
+
+## Examples
+
+Get a retention event by id
+
+```sh
+m365 purview retentionevent get --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## 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.
+
+:::
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+      "displayName": "Contract xyz expired",
+      "description": "The retention period for documents related to Contract xyz started because the contract expired.",
+      "eventTriggerDateTime": "2023-02-01T09:16:37Z",
+      "lastStatusUpdateDateTime": "2023-02-01T09:21:15Z",
+      "createdDateTime": "2023-02-01T09:17:40Z",
+      "lastModifiedDateTime": "2023-02-01T09:17:40Z",
+      "id": "c37d695e-d581-4ae9-82a0-9364eba4291e",
+      "eventQueries": [
+          {
+              "queryType": "files",
+              "query": "1234"
+          },
+          {
+              "queryType": "messages",
+              "query": "Terminate"
+          }
+      ],
+      "eventStatus": {
+          "error": null,
+          "status": "success"
+      },
+      "eventPropagationResults": [
+          {
+              "serviceName": "SharePoint",
+              "location": null,
+              "status": "none",
+              "statusInformation": null
+          }
+      ],
+      "createdBy": {
+          "user": {
+              "id": null,
+              "displayName": "John Doe"
+          }
+      },
+      "lastModifiedBy": {
+          "user": {
+              "id": null,
+              "displayName": "John Doe"
+          }
+      }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdBy               : {"user":{"id":null,"displayName":"John Doe"}}
+  createdDateTime         : 2023-02-01T09:17:40Z
+  description             : The retention period for documents related to Contract xyz started because the contract expired.
+  displayName             : Contract xyz expired    
+  eventTriggerDateTime    : 2023-02-01T09:16:37Z
+  id                      : c37d695e-d581-4ae9-82a0-9364eba4291e
+  lastModifiedBy          : {"user":{"id":null,"displayName":"John Doe"}}
+  lastModifiedDateTime    : 2023-02-01T09:17:40Z
+  lastStatusUpdateDateTime: 2023-02-01T09:21:15Z    
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  displayName,description,eventTriggerDateTime,lastStatusUpdateDateTime,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
+  Contract xyz expired,The retention period for documents related to Contract xyz started because the contract expired.,2023-02-01T09:16:37Z,2023-02-01T09:21:15Z,2023-02-01T09:17:40Z,2023-02-01T09:17:40Z,c37d695e-d581-4ae9-82a0-9364eba4291e,{"user":{"id":null,"displayName":"John Doe"}},{"user":{"id":null,"displayName":"John Doe"}}
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # purview retentionevent get --id "c37d695e-d581-4ae9-82a0-9364eba4291e"
+
+  Date: 2/1/2023
+
+  ## Contract xyz expired (c37d695e-d581-4ae9-82a0-9364eba4291e)
+
+  Property | Value
+  ---------|-------
+  displayName | Contract xyz expired
+  description | The retention period for documents related to Contract xyz started because the contract expired.
+  eventTriggerDateTime | 2023-02-01T09:16:37Z
+  lastStatusUpdateDateTime: 2023-02-01T09:21:15Z
+  createdDateTime | 2023-02-01T09:17:40Z
+  lastModifiedDateTime | 2023-02-01T09:17:40Z
+  id | c37d695e-d581-4ae9-82a0-9364eba4291e
+  createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+  lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
+
+[Read more on event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)

package/docs/docs/cmd/purview/retentionevent/retentionevent-list.mdx

@@ -0,0 +1,117 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# purview retentionevent list
+
+Get a list of retention events
+
+## Usage
+
+```sh
+m365 purview retentionevent list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+Get a list of retention events
+
+```sh
+m365 purview retentionevent list
+```
+
+## Remarks
+
+:::caution
+
+This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "displayName": "Contract xyz expired",
+      "description": null,
+      "eventTriggerDateTime": "2023-02-03T13:51:40Z",
+      "eventStatus": null,
+      "lastStatusUpdateDateTime": null,
+      "createdDateTime": "2023-02-03T13:51:40Z",
+      "lastModifiedDateTime": "2023-02-03T13:51:40Z",
+      "id": "7248cfa8-c03a-4ec1-49a4-08db05edc686",
+      "eventQueries": [],
+      "eventPropagationResults": [],
+      "createdBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      },
+      "lastModifiedBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                    displayName            eventTriggerDateTime
+  ------------------------------------  ---------------------  --------------------
+  7248cfa8-c03a-4ec1-49a4-08db05edc686  Contract xyz expired  2023-02-03T13:51:40Z
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,displayName,isInUse
+  7248cfa8-c03a-4ec1-49a4-08db05edc686,Contract xyz expired,2023-02-03T13:51:40Z
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # purview retentionevent list
+
+  Date: 3/2/2023
+
+  ## Contract xyz expired (7248cfa8-c03a-4ec1-49a4-08db05edc686)
+
+  Property | Value
+  ---------|-------
+  displayName | Contract xyz expired
+  description | null
+  eventTriggerDateTime | 2023-02-03T13:51:40Z
+  eventStatus | null
+  lastStatusUpdateDateTime | null
+  createdDateTime | 2023-02-03T13:51:40Z
+  lastModifiedDateTime | 2023-02-03T13:51:40Z
+  id | 7248cfa8-c03a-4ec1-49a4-08db05edc686
+  eventQueries | []
+  eventPropagationResults | []
+  createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+  lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.

package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.mdx

@@ -0,0 +1,49 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# purview retentionevent remove
+
+Delete a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent remove [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The Id of the retention event.
+
+`--confirm`
+: Don't prompt for confirmation to remove the retention event.
+```
+
+<Global />
+
+## Examples
+
+Delete a retention event by id
+
+```sh
+m365 purview retentionevent remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## Remarks
+
+:::caution
+
+This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+## Response
+
+The command won't return a response on success.
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created.
+
+[Read more on event-based retention here](https://learn.microsoft.com/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)

package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.mdx

@@ -0,0 +1,119 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# purview retentioneventtype add
+
+Create a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --displayName <displayName>`
+: The display name of the event type.
+
+`-d, --description [description]`
+: A description for the event type.
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+## Examples
+
+Create a retention event type *Contract Expiry*.
+
+```sh
+m365 purview retentioneventtype add --displayName 'Contract Expiry' --description 'A retention event type to start a retention period based on the date that a contract expired.'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    {
+      "displayName": "Contract Expiry",
+      "description": "A retention event type to start a retention period based on the date that a contract expired.",
+      "createdDateTime": "2023-01-31T20:33:33Z",
+      "lastModifiedDateTime": "2023-01-31T20:33:33Z",
+      "id": "f15d2493-7ad2-4185-a3f6-9580542490a0",
+      "createdBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      },
+      "lastModifiedBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      }
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdBy           : {"user":{"id":null,"displayName":"John Doe"}}
+  createdDateTime     : 2023-01-31T20:40:40Z
+  description         : A retention event type to start a retention period based on the date that a contract expired.
+  displayName         : Contract Expiry
+  id                  : 806cb481-4cc6-47c3-af26-26d64f6e7aab
+  lastModifiedBy      : {"user":{"id":null,"displayName":"John Doe"}}
+  lastModifiedDateTime: 2023-01-31T20:40:40Z
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  displayName,description,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
+  Contract Expiry,A retention event type to start a retention period based on the date that a contract expired.,2023-01-31T20:53:23Z,2023-01-31T20:53:23Z,b430ae4c-1e26-422f-9544-67df3abfb200,"{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}"
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # purview retentioneventtype add --displayName "Contract Expiry" --description "A retention event type to start a retention period based on the date that a contract expired."
+
+  Date: 31/01/2023
+
+  ## Contract Expiry (ca0e1f8d-4e42-4a81-be85-022502d70c4e)
+
+  Property | Value
+  ---------|-------
+  displayName | Contract Expiry
+  description | A retention event type to start a retention period based on the date that a contract expired.
+  createdDateTime | 2023-01-31T20:55:35Z
+  lastModifiedDateTime | 2023-01-31T20:55:35Z
+  id | ca0e1f8d-4e42-4a81-be85-022502d70c4e
+  createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+  lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)