@pnp/cli-microsoft365 6.2.0 → 6.3.0-beta.1336e33

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

@@ -0,0 +1,132 @@
+# purview retentionevent get
+
+Get a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a retention event by id
+
+```sh
+m365 purview retentionevent get --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## 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)
+
+
+## Response
+
+=== "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"
+            }
+        }
+    }
+    ```
+
+=== "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    
+    ```
+
+=== "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"}}
+    ```
+
+=== "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"}}
+    ```

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

@@ -0,0 +1,107 @@
+# purview retentionevent list
+
+Get a list of retention events
+
+## Usage
+
+```sh
+m365 purview retentionevent list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a list of retention events
+
+```sh
+m365 purview retentionevent list
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+!!! attention
+    This command currently does not support app only permissions.
+
+## 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.
+
+## Response
+
+
+=== "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"
+          }
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName            eventTriggerDateTime
+    ------------------------------------  ---------------------  --------------------
+    7248cfa8-c03a-4ec1-49a4-08db05edc686  Contract xyz expired  2023-02-03T13:51:40Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,isInUse
+    7248cfa8-c03a-4ec1-49a4-08db05edc686,Contract xyz expired,2023-02-03T13:51:40Z
+    ```
+
+=== "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"}}
+    ```

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

@@ -0,0 +1,42 @@
+# purview retentionevent remove
+
+Delete a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent remove [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event.
+
+`--confirm`
+: Don't prompt for confirmation to remove the retention event.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Delete a retention event by id
+
+```sh
+m365 purview retentionevent remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+## 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)
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,106 @@
+# purview retentioneventtype add
+
+Create a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype add [options]
+```
+
+## Options
+
+`-n, --displayName <displayName>`
+: The display name of the event type.
+
+`-d, --description [description]`
+: A description for the event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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.'
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## 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)
+
+## Response
+
+=== "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": "Mathijs Verbeeck"
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": null,
+            "displayName": "Mathijs Verbeeck"
+          }
+        }
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdBy           : {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    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":"Mathijs Verbeeck"}}
+    lastModifiedDateTime: 2023-01-31T20:40:40Z
+    ```
+
+=== "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"":""Mathijs Verbeeck""}}","{""user"":{""id"":null,""displayName"":""Mathijs Verbeeck""}}"
+    ```
+
+=== "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":"Mathijs Verbeeck"}}
+    lastModifiedBy | {"user":{"id":null,"displayName":"Mathijs Verbeeck"}}
+    ```

package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md

@@ -0,0 +1,100 @@
+# purview retentioneventtype get
+
+Get a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a retention event type by id
+
+```sh
+m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+## 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)
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "displayName": "Test retention event type",
+      "description": "Description for the retention event type",
+      "createdDateTime": "2023-01-29T09:30:42Z",
+      "lastModifiedDateTime": "2023-01-29T09:30:42Z",
+      "id": "c37d695e-d581-4ae9-82a0-9364eba4291e",
+      "createdBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      },
+      "lastModifiedBy": {
+        "user": {
+          "id": null,
+          "displayName": "John Doe"
+        }
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdBy           : {"user":{"id":null,"displayName":"John Doe"}}
+    createdDateTime     : 2023-01-29T09:30:42Z
+    description         : Description for the retention event type
+    displayName         : Test retention event type
+    id                  : c37d695e-d581-4ae9-82a0-9364eba4291e
+    lastModifiedBy      : {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedDateTime: 2023-01-29T09:30:42Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    displayName,description,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
+    Test retention event type,Description for the retention event type,2023-01-29T09:30:42Z,2023-01-29T09:30:42Z,c37d695e-d581-4ae9-82a0-9364eba4291e,"{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}"
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentioneventtype get --id "c37d695e-d581-4ae9-82a0-9364eba4291e"
+
+    Date: 1/29/2023
+
+    ## Test retention event type (c37d695e-d581-4ae9-82a0-9364eba4291e)
+
+    Property | Value
+    ---------|-------
+    displayName | Test retention event type
+    description | Description for the retention event type
+    createdDateTime | 2023-01-29T09:30:42Z
+    lastModifiedDateTime | 2023-01-29T09:30:42Z
+    id | c37d695e-d581-4ae9-82a0-9364eba4291e
+    createdBy | {"user":{"id":null,"displayName":"John Doe"}}
+    lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}
+    ```

package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md

@@ -0,0 +1,97 @@
+# purview retentioneventtype list
+
+Get a list of retention event types
+
+## Usage
+
+```sh
+m365 purview retentioneventtype list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a list of retention event types
+
+```sh
+m365 purview retentioneventtype list
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+!!! attention
+    This command currently does not support app only permissions.
+
+## 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.
+
+## Response
+
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "displayName": "Contract Expiry",
+        "description": "",
+        "createdDateTime": "2023-02-02T15:47:54Z",
+        "lastModifiedDateTime": "2023-02-02T15:47:54Z",
+        "id": "81fa91bd-66cd-4c6c-b0cb-71f37210dc74",
+        "createdBy": {
+          "user": {
+            "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
+            "displayName": null
+          }
+        },
+        "lastModifiedBy": {
+          "user": {
+            "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
+            "displayName": null
+          }
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName            createdDateTime
+    ------------------------------------  ---------------------  --------------------
+    81fa91bd-66cd-4c6c-b0cb-71f37210dc74  Contract Expiry  2023-02-02T15:47:54Z
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,createdDateTime
+    81fa91bd-66cd-4c6c-b0cb-71f37210dc74,Contract Expiry,2023-02-02T15:47:54Z
+    ```
+
+=== "Markdown"
+
+    ```md
+    # purview retentioneventtype list
+
+    Date: 8/2/2023
+
+    ## Contract Expiry (81fa91bd-66cd-4c6c-b0cb-71f37210dc74)
+
+    Property | Value
+    ---------|-------
+    displayName | Contract Expiry
+    description | null
+    createdDateTime | 2023-02-02T15:47:54Z
+    lastModifiedDateTime | 2023-02-02T15:47:54Z
+    id | 81fa91bd-66cd-4c6c-b0cb-71f37210dc74
+    createdBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
+    lastModifiedBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
+    ```

package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md

@@ -0,0 +1,43 @@
+# purview retentioneventtype remove
+
+Delete a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype remove [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention event type.
+
+`--confirm`
+: Don't prompt for confirmation to remove the retention event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Delete a retention event type by id
+
+```sh
+m365 purview retentioneventtype remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## 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)
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md

@@ -0,0 +1,43 @@
+# purview retentioneventtype set
+
+Update a retention event type
+
+## Usage
+
+```sh
+m365 purview retentioneventtype set [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The id of the retention event type.
+
+`-d, --description [description]`
+: The new description of the event type.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Update the description of a retention event type
+
+```sh
+m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --description 'some extra information'
+```
+
+## Remarks
+
+!!! attention
+    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.
+
+!!! attention
+    This command currently only supports delegated permissions.
+
+## 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)
+
+## Response
+
+The command won't return a response on success.