Skip to main content

purview retentioneventtype get

Get a retention event type


m365 purview retentioneventtype get [options]


-i, --id <id>

The Id of the retention event type.

-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 options.

--query [query]

JMESPath query string. See for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.


Runs command with verbose logging.


Runs command with debug logging.



This command is based on an API that is currently in preview and is subject to change once the API reached general availability.


Get a retention event type by id.

m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e


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

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