Skip to main content

purview retentioneventtype set

Update a retention event type


m365 purview retentioneventtype set [options]


-i, --id <id>

The id of the retention event type.

-d, --description [description]

The new description of the 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 a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.


Update the description of a retention event type

m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --description 'some extra information'


The command won't return a response on success.

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