@pnp/cli-microsoft365 6.3.0-beta.fee5cdb → 6.4.0-beta.006c079

package/docs/docs/cmd/planner/task/task-reference-add.md

@@ -43,3 +43,49 @@ Add a new reference with the url _https://www.microsoft.com_ and with the type E
 ```sh
 m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --type "Excel"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "https%3A//microsoft%2Ecom": {
+        "alias": null,
+        "type": null,
+        "previewPriority": "8585269190192498871PB",
+        "lastModifiedDateTime": "2023-01-25T23:05:26.24332Z",
+        "lastModifiedBy": {
+          "user": {
+            "displayName": null,
+            "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
+          }
+        }
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```txt
+    https%3A//microsoft%2Ecom: {"alias":null,"type":null,"previewPriority":"8585269190192498871PB","lastModifiedDateTime":"2023-01-25T23:05:26.24332Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
+    ```
+
+=== "CSV"
+
+    ```csv
+    https%3A//microsoft%2Ecom
+    "{""alias"":null,""type"":null,""previewPriority"":""8585269190192498871PB"",""lastModifiedDateTime"":""2023-01-25T23:05:26.24332Z"",""lastModifiedBy"":{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""}}}"
+    ```
+
+=== "Markdown"
+
+    ```md
+    # planner task reference add --taskId "OopX1ANphEu7Lm4-0tVtl5cAFRGQ" --url "https://microsoft.com"
+
+    Date: 4/2/2023
+
+    Property | Value
+    ---------|-------
+    https%3A//microsoft%2Ecom | {"alias":null,"type":null,"previewPriority":"8585269190192498871PB;","lastModifiedDateTime":"2023-01-25T23:05:26.24332Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
+    ```

package/docs/docs/cmd/planner/task/task-reference-list.md

@@ -22,3 +22,49 @@ Retrieve the references of the specified planner task
 ```sh
 m365 planner task reference list --taskId uBk5fK_MHkeyuPYlCo4OFpcAM
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "https%3A//microsoft%2Ecom": {
+        "alias": null,
+        "type": null,
+        "previewPriority": "8585269191724168649Pp",
+        "lastModifiedDateTime": "2023-01-25T23:02:53.107589Z",
+        "lastModifiedBy": {
+          "user": {
+            "displayName": null,
+            "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
+          }
+        }
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```txt
+    https%3A//microsoft%2Ecom: {"alias":null,"type":null,"previewPriority":"8585269191724168649Pp","lastModifiedDateTime":"2023-01-25T23:02:53.107589Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
+    ```
+
+=== "CSV"
+
+    ```csv
+    https%3A//microsoft%2Ecom
+    "{""alias"":null,""type"":null,""previewPriority"":""8585269191724168649Pp"",""lastModifiedDateTime"":""2023-01-25T23:02:53.107589Z"",""lastModifiedBy"":{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""}}}"
+    ```
+
+=== "Markdown"
+
+    ```md
+    # planner task reference list --taskId "OopX1ANphEu7Lm4-0tVtl5cAFRGQ"
+
+    Date: 4/2/2023
+
+    Property | Value
+    ---------|-------
+    https%3A//microsoft%2Ecom | {"alias":null,"type":null,"previewPriority":"8585269191724168649Pp;","lastModifiedDateTime":"2023-01-25T23:02:53.107589Z","lastModifiedBy":{"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"}}}
+    ```

package/docs/docs/cmd/planner/task/task-reference-remove.md

@@ -37,3 +37,7 @@ Removes a reference with the alias _Parker_ from the Planner task with the id _2
 ```sh
 m365 planner task reference remove --alias "Parker" --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/planner/task/task-remove.md

@@ -76,3 +76,7 @@ Removes the Microsoft Planner task with title _My Task_ in the bucket with name
 ```sh
 m365 planner task remove --title "My Task" --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupId "00000000-0000-0000-0000-000000000000"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/planner/task/task-set.md

@@ -103,6 +103,236 @@ Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50%
 m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"  --percentComplete 50 --appliedCategories "category1,category3"
 ```
 
+## Response
+
+### Standard response
+
+=== "JSON"
+
+    ```json
+    {
+      "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
+      "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
+      "title": "Important task",
+      "orderHint": "8585269241124027581",
+      "assigneePriority": "",
+      "percentComplete": 50,
+      "startDateTime": "2023-01-20T00:00:00Z",
+      "createdDateTime": "2023-01-25T21:39:33.0748226Z",
+      "dueDateTime": "2023-02-15T00:00:00Z",
+      "hasDescription": false,
+      "previewType": "automatic",
+      "completedDateTime": null,
+      "completedBy": null,
+      "referenceCount": 0,
+      "checklistItemCount": 0,
+      "activeChecklistItemCount": 0,
+      "conversationThreadId": null,
+      "priority": 5,
+      "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
+        },
+        "application": {
+          "displayName": null,
+          "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
+        }
+      },
+      "appliedCategories": {},
+      "assignments": {}
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    activeChecklistItemCount: 0
+    appliedCategories       : {}
+    assigneePriority        :
+    assignments             : {}
+    bucketId                : vncYUXCRBke28qMLB-d4xJcACtNz
+    checklistItemCount      : 0
+    completedBy             : null
+    completedDateTime       : null
+    conversationThreadId    : null
+    createdBy               : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
+    createdDateTime         : 2023-01-25T21:44:10.6044385Z
+    dueDateTime             : 2023-02-15T00:00:00Z
+    hasDescription          : false
+    id                      : D-ys8Ef4kEuwYG4r68Um3pcAAe9M
+    orderHint               : 8585269238348731422
+    percentComplete         : 50
+    planId                  : oUHpnKBFekqfGE_PS6GGUZcAFY7b
+    previewType             : automatic
+    priority                : 5
+    referenceCount          : 0
+    references              : {}
+    startDateTime           : 2023-01-20T00:00:00Z
+    title                   : Important task
+    ```
+
+=== "CSV"
+
+    ```csv
+    planId,bucketId,title,orderHint,assigneePriority,percentComplete,startDateTime,createdDateTime,dueDateTime,hasDescription,previewType,completedDateTime,completedBy,referenceCount,checklistItemCount,activeChecklistItemCount,conversationThreadId,priority,id,createdBy,appliedCategories,assignments
+    oUHpnKBFekqfGE_PS6GGUZcAFY7b,vncYUXCRBke28qMLB-d4xJcACtNz,Important task,8585269237867589640,,50,2023-01-20T00:00:00Z,2023-01-25T21:44:58.7186167Z,2023-02-15T00:00:00Z,,automatic,,,0,0,0,,5,D-ys8Ef4kEuwYG4r68Um3pcAAe9M,"{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""},""application"":{""displayName"":null,""id"":""31359c7f-bd7e-475c-86db-fdb8c937548e""}}",{},{}
+    ```
+
+=== "Markdown"
+
+    ```md
+    # planner task set --id "D-ys8Ef4kEuwYG4r68Um3pcAAe9M" --startDateTime "2023-01-20" --dueDateTime "2023-02-15" --percentComplete "50" --title "Important task"
+
+    Date: 25/1/2023
+
+    ## Important task (D-ys8Ef4kEuwYG4r68Um3pcAAe9M)
+
+    Property | Value
+    ---------|-------
+    planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
+    bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
+    title | Important task
+    orderHint | 8585269235419217847
+    assigneePriority |
+    percentComplete | 50
+    startDateTime | 2023-01-20T00:00:00Z
+    createdDateTime | 2023-01-25T21:49:03.555796Z
+    dueDateTime | 2023-02-15T00:00:00Z
+    hasDescription | false
+    previewType | automatic
+    completedDateTime | null
+    completedBy | null
+    referenceCount | 0
+    checklistItemCount | 0
+    activeChecklistItemCount | 0
+    conversationThreadId | null
+    priority | 5
+    id | D-ys8Ef4kEuwYG4r68Um3pcAAe9M
+    createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
+    appliedCategories | {}
+    assignments | {}
+    ```
+
+### `description`, `previewType` response
+
+=== "JSON"
+
+    ```json
+    {
+      "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
+      "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
+      "title": "Important task",
+      "orderHint": "8585269241124027581",
+      "assigneePriority": "",
+      "percentComplete": 50,
+      "startDateTime": "2023-01-20T00:00:00Z",
+      "createdDateTime": "2023-01-25T21:39:33.0748226Z",
+      "dueDateTime": "2023-02-15T00:00:00Z",
+      "hasDescription": true,
+      "previewType": "automatic",
+      "completedDateTime": null,
+      "completedBy": null,
+      "referenceCount": 0,
+      "checklistItemCount": 0,
+      "activeChecklistItemCount": 0,
+      "conversationThreadId": null,
+      "priority": 5,
+      "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
+        },
+        "application": {
+          "displayName": null,
+          "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
+        }
+      },
+      "appliedCategories": {},
+      "assignments": {},
+      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
+      "references": {},
+      "checklist": {}
+    }
+    ```
+
+=== "Text"
+
+    ```txt
+    activeChecklistItemCount: 0
+    appliedCategories       : {}
+    assigneePriority        :
+    assignments             : {}
+    bucketId                : vncYUXCRBke28qMLB-d4xJcACtNz
+    checklist               : {}
+    checklistItemCount      : 0
+    completedBy             : null
+    completedDateTime       : null
+    conversationThreadId    : null
+    createdBy               : {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
+    createdDateTime         : 2023-01-25T21:44:10.6044385Z
+    description             : Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+    dueDateTime             : 2023-02-15T00:00:00Z
+    hasDescription          : true
+    id                      : D-ys8Ef4kEuwYG4r68Um3pcAAe9M
+    orderHint               : 8585269238348731422
+    percentComplete         : 50
+    planId                  : oUHpnKBFekqfGE_PS6GGUZcAFY7b
+    previewType             : automatic
+    priority                : 5
+    referenceCount          : 0
+    references              : {}
+    startDateTime           : 2023-01-20T00:00:00Z
+    title                   : Important task
+    ```
+
+=== "CSV"
+
+    ```csv
+    planId,bucketId,title,orderHint,assigneePriority,percentComplete,startDateTime,createdDateTime,dueDateTime,hasDescription,previewType,completedDateTime,completedBy,referenceCount,checklistItemCount,activeChecklistItemCount,conversationThreadId,priority,id,createdBy,appliedCategories,assignments,description,references,checklist
+    oUHpnKBFekqfGE_PS6GGUZcAFY7b,vncYUXCRBke28qMLB-d4xJcACtNz,Important task,8585269237867589640,,50,2023-01-20T00:00:00Z,2023-01-25T21:44:58.7186167Z,2023-02-15T00:00:00Z,1,automatic,,,0,0,0,,5,D-ys8Ef4kEuwYG4r68Um3pcAAe9M,"{""user"":{""displayName"":null,""id"":""b2091e18-7882-4efe-b7d1-90703f5a5c65""},""application"":{""displayName"":null,""id"":""31359c7f-bd7e-475c-86db-fdb8c937548e""}}",{},{},"Lorem ipsum dolor sit amet, consectetur adipiscing elit.",{},{}
+    ```
+
+=== "Markdown"
+
+    ```md
+    # planner task set --id "D-ys8Ef4kEuwYG4r68Um3pcAAe9M" --title "Important task" --description "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
+
+    Date: 25/1/2023
+
+    ## Important task (D-ys8Ef4kEuwYG4r68Um3pcAAe9M)
+
+    Property | Value
+    ---------|-------
+    planId | oUHpnKBFekqfGE\_PS6GGUZcAFY7b
+    bucketId | vncYUXCRBke28qMLB-d4xJcACtNz
+    title | Important task
+    orderHint | 8585269235419217847
+    assigneePriority |
+    percentComplete | 50
+    startDateTime | 2023-01-20T00:00:00Z
+    createdDateTime | 2023-01-25T21:49:03.555796Z
+    dueDateTime | 2023-02-15T00:00:00Z
+    hasDescription | true
+    previewType | automatic
+    completedDateTime | null
+    completedBy | null
+    referenceCount | 0
+    checklistItemCount | 0
+    activeChecklistItemCount | 0
+    conversationThreadId | null
+    priority | 5
+    id | D-ys8Ef4kEuwYG4r68Um3pcAAe9M
+    createdBy | {"user":{"displayName":null,"id":"b2091e18-7882-4efe-b7d1-90703f5a5c65"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
+    appliedCategories | {}
+    assignments | {}
+    description | Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+    references | {}
+    checklist | {}
+    ```
+
 ## Additional information
 
 - Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)

package/docs/docs/cmd/planner/tenant/tenant-settings-list.md

@@ -26,3 +26,58 @@ Lists the Microsoft Planner settings of the tenant
 ```sh
 m365 planner tenant settings list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "1",
+      "isPlannerAllowed": true,
+      "allowCalendarSharing": true,
+      "allowTenantMoveWithDataLoss": false,
+      "allowTenantMoveWithDataMigration": false,
+      "allowRosterCreation": true,
+      "allowPlannerMobilePushNotifications": true
+    }
+    ```
+
+=== "Text"
+
+    ```txt
+    allowCalendarSharing               : true
+    allowPlannerMobilePushNotifications: true
+    allowRosterCreation                : true
+    allowTenantMoveWithDataLoss        : false
+    allowTenantMoveWithDataMigration   : false
+    isPlannerAllowed                   : true
+    ```
+
+=== "CSV"
+
+    ```csv
+    isPlannerAllowed,allowCalendarSharing,allowTenantMoveWithDataLoss,allowTenantMoveWithDataMigration,allowRosterCreation,allowPlannerMobilePushNotifications
+    1,1,,,1,1
+    ```
+
+=== "Markdown"
+
+    ```md
+    # planner tenant settings list
+
+    Date: 4/2/2023
+
+    ## 1
+
+    Property | Value
+    ---------|-------
+    id | 1
+    isPlannerAllowed | true
+    allowCalendarSharing | true
+    allowTenantMoveWithDataLoss | false
+    allowTenantMoveWithDataMigration | false
+    allowRosterCreation | true
+    allowPlannerMobilePushNotifications | true
+    disallowedSharedWithContainerTypes | []
+    ```

package/docs/docs/cmd/planner/tenant/tenant-settings-set.md

@@ -54,3 +54,58 @@ Enable Microsoft Planner but disallow roster plans to be created
 ```sh
 m365 planner tenant settings set --isPlannerAllowed true --allowRosterCreation false
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "1",
+      "isPlannerAllowed": true,
+      "allowCalendarSharing": true,
+      "allowTenantMoveWithDataLoss": false,
+      "allowTenantMoveWithDataMigration": false,
+      "allowRosterCreation": true,
+      "allowPlannerMobilePushNotifications": true
+    }
+    ```
+
+=== "Text"
+
+    ```txt
+    allowCalendarSharing               : true
+    allowPlannerMobilePushNotifications: true
+    allowRosterCreation                : true
+    allowTenantMoveWithDataLoss        : false
+    allowTenantMoveWithDataMigration   : false
+    isPlannerAllowed                   : true
+    ```
+
+=== "CSV"
+
+    ```csv
+    isPlannerAllowed,allowCalendarSharing,allowTenantMoveWithDataLoss,allowTenantMoveWithDataMigration,allowRosterCreation,allowPlannerMobilePushNotifications
+    1,1,,,1,1
+    ```
+
+=== "Markdown"
+
+    ```md
+    # planner tenant settings list
+
+    Date: 4/2/2023
+
+    ## 1
+
+    Property | Value
+    ---------|-------
+    id | 1
+    isPlannerAllowed | true
+    allowCalendarSharing | true
+    allowTenantMoveWithDataLoss | false
+    allowTenantMoveWithDataMigration | false
+    allowRosterCreation | true
+    allowPlannerMobilePushNotifications | true
+    disallowedSharedWithContainerTypes | []
+    ```

package/docs/docs/cmd/pp/card/card-get.md

@@ -97,7 +97,7 @@ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --
       },
       "owninguser":{
         "azureactivedirectoryobjectid":"78637d62-e872-4dc9-b7c1-bd161e631682",
-        "fullname":"# Nico",
+        "fullname":"# John Doe",
         "systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e",
         "ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"
       }
@@ -167,5 +167,5 @@ m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --
     publishsourceid | null
     timezoneruleversionnumber | null
     iscustomizable | {"Value":true,"CanBeChanged":true,"ManagedPropertyLogicalName":"iscustomizableanddeletable"}
-    owninguser | {"azureactivedirectoryobjectid":"78ccf530-bbf0-47e4-aae6-da5f8c6fb142","fullname":"# Nico","systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e","ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"}
+    owninguser | {"azureactivedirectoryobjectid":"78ccf530-bbf0-47e4-aae6-da5f8c6fb142","fullname":"# John Doe","systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e","ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"}
     ```

package/docs/docs/cmd/pp/card/card-list.md

@@ -80,7 +80,7 @@ m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" -
         },
         "owninguser":{
           "azureactivedirectoryobjectid":"78637d62-e872-4dc9-b7c1-bd161e631682",
-          "fullname":"# Nico",
+          "fullname":"# John Doe",
           "systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e",
           "ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"
         }
@@ -149,5 +149,5 @@ m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" -
     publishsourceid | null
     timezoneruleversionnumber | null
     iscustomizable | {"Value":true,"CanBeChanged":true,"ManagedPropertyLogicalName":"iscustomizableanddeletable"}
-    owninguser | {"azureactivedirectoryobjectid":"78ccf530-bbf0-47e4-aae6-da5f8c6fb142","fullname":"# Nico","systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e","ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"}
+    owninguser | {"azureactivedirectoryobjectid":"78ccf530-bbf0-47e4-aae6-da5f8c6fb142","fullname":"# John Doe","systemuserid":"4f175d04-b952-ed11-bba2-000d3adf774e","ownerid":"4f175d04-b952-ed11-bba2-000d3adf774e"}
     ```

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

@@ -0,0 +1,149 @@
+# purview retentionevent add
+
+Create a retention event
+
+## Usage
+
+```sh
+m365 purview retentionevent add [options]
+```
+
+## Options
+
+`-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.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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.
+
+## 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'
+```
+
+## 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": "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"
+        }
+      }
+    }
+    ```
+
+=== "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 
+    ```
+
+=== "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""}}"
+    ```
+
+=== "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"}}
+    ```