@pnp/cli-microsoft365 6.3.0-beta.c3dc921 → 6.3.0-beta.fee5cdb

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

@@ -0,0 +1,123 @@
+# purview auditlog list
+
+List audit logs within your tenant
+
+## Usage
+
+```sh
+m365 purview auditlog list [options]
+```
+
+## Options
+
+`--contentType <contentType>`
+: Content type of logs to retrieve. Possible values: `AzureActiveDirectory`, `Exchange`, `SharePoint`, `General`, `DLP`.
+
+`--startTime [startTime]`
+: Time indicating the **inclusive** start of a time range of content to return. This should be defined as a valid ISO 8601 string (2021-12-16T18:28:48.6964197Z). Start time cannot be more than 7 days in the past. Default value is 24h ago.
+
+`--endTime [endTime]`
+: Time indicating the **exclusive** end of a time range of content to return. This should be defined as a valid ISO 8601 string (2021-12-16T18:28:48.6964197Z). Default value is now.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    Before you can access audit log data, you must enable unified audit logging for your Microsoft 365 tenant. For instructions, check out the page [Turn auditing on or off](https://learn.microsoft.com/en-us/microsoft-365/compliance/audit-log-enable-disable).
+
+!!! important
+    When running this command for the first time for a certain content type, a subscription for this content type is created. It can take up to 12 hours for the first content blobs to become available for that subscription.
+
+!!! tip
+    Retrieving audit logs is an intensive process, especially for large or active tenants. In this case it may take some time to retrieve all audit logs. It can be useful to add the `--verbose` option to your command to view the command progress.
+
+When you specify a value for `contentType`, consider the following:
+
+- `AzureActiveDirectory` includes all Azure AD audit logs.
+- `Exchange` includes all Exchange audit logs.
+- `SharePoint` includes all SharePoint audit logs.
+- `General` includes all other workloads not included in the previous content types.
+- `DLP` DLP events only for all workloads.
+
+## Examples
+
+List all SharePoint audit logs for the past 24 hours
+
+```sh
+m365 purview auditlog list --contentType SharePoint
+```
+
+List all SharePoint audit logs within a specific time frame
+
+```sh
+m365 purview auditlog list --contentType SharePoint --startTime "2023-01-01T00:00:00Z" --endTime "2023-01-03T09:00:00Z"
+```
+
+Get all SharePoint audit logs within a specific time frame and save the logs to a file
+
+```sh
+m365 purview auditlog list --contentType SharePoint --startTime "2023-01-01T00:00:00Z" --endTime "2023-01-01T12:00:00Z" > auditLogs.json
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "AppAccessContext": {
+            "ClientAppId": "94bfad6e-a0b3-4eb9-8e2b-83eeb335de28",
+            "CorrelationId": "040d86a0-f096-5000-d4b4-baac627b75f3",
+            "UniqueTokenId": "5CVDGmrynkGYBkY-MPynAA"
+        },
+        "CreationTime": "2023-01-10T00:00:00",
+        "Id": "4d671836-c772-4169-55f9-08dae745c839",
+        "Operation": "ListItemViewed",
+        "OrganizationId": "6e40c2aa-0565-4013-b38c-d5e6f0c42993",
+        "RecordType": 36,
+        "UserKey": "i:0i.t|00000003-0000-0ff1-ce00-000000000000|app@sharepoint",
+        "UserType": 0,
+        "Version": 1,
+        "Workload": "SharePoint",
+        "ClientIP": "168.63.104.32",
+        "ObjectId": "https://contoso.sharepoint.com/sites/Project-x/Lists/cae414a1-ac65-4a90-844e-651d7a1e463d/305_.000",
+        "UserId": "john.doe@contoso.com",
+        "ApplicationId": "94bfad6e-a0b3-4eb9-8e2b-83eeb335de28",
+        "CorrelationId": "040d86a0-f096-5000-d4b4-baac627b75f3",
+        "EventSource": "SharePoint",
+        "ItemType": "ListItem",
+        "ListId": "cae414a1-ac65-4a90-844e-651d7a1e463d",
+        "ListItemUniqueId": "2d364471-4d27-4186-b139-072c8225ee4a",
+        "Site": "51f5a236-b2e5-4a6d-a81d-13d188610155",
+        "UserAgent": "NONISV|Contoso|ContosoApp/1.0",
+        "WebId": "38ab94aa-a904-4c2b-8467-4be0e457f97b",
+        "CustomizedDoclib": false,
+        "FromApp": false,
+        "ItemCount": 192,
+        "ListBaseTemplateType": "100",
+        "ListBaseType": "GenericList",
+        "ListColor": "",
+        "ListIcon": "",
+        "Source": "Unknown",
+        "TemplateTypeId": "",
+        "ListTitle": "cae414a1-ac65-4a90-844e-651d7a1e463d"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```txt
+    CreationTime         UserId                Operation       ObjectId                                                                                          
+    -------------------  --------------------  --------------  --------------------------------------------------------------------------------------------------
+    2023-01-10T00:00:00  john.doe@contoso.com  ListItemViewed  https://contoso.sharepoint.com/sites/Project-x/Lists/cae414a1-ac65-4a90-844e-651d7a1e463d/305_.000
+    ```
+
+=== "CSV"
+
+    ```csv
+    CreationTime,UserId,Operation,ObjectId
+    2023-01-10T00:00:00,john.doe@contoso.com,ListItemViewed,https://contoso.sharepoint.com/sites/Project-x/Lists/cae414a1-ac65-4a90-844e-651d7a1e463d/305_.000
+    ```

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 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.
+
+## 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,45 @@
+# 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.
+
+!!! 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/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,103 @@
+# 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.
+
+!!! 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": "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"}}
+    ```