Skip to content

purview retentionevent list

Get a list of retention events

Usage

m365 purview retentionevent list [options]

Options

-h, --help [help]
Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is full.
--query [query]
JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
Output type. json,text,csv,md. Default json
--verbose
Runs command with verbose logging
--debug
Runs command with debug logging

Examples

Get a list of retention events

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

[
  {
    "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"
      }
    }
  }
]

id                                    displayName            eventTriggerDateTime
------------------------------------  ---------------------  --------------------
7248cfa8-c03a-4ec1-49a4-08db05edc686  Contract xyz expired  2023-02-03T13:51:40Z

id,displayName,isInUse
7248cfa8-c03a-4ec1-49a4-08db05edc686,Contract xyz expired,2023-02-03T13:51:40Z

# 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"}}