purview retentionevent remove

Delete a retention event

Usage

m365 purview retentionevent remove [options]

Options

-i, --id <id>

The Id of the retention event.

-f, --force

Don't prompt for confirmation to remove the retention event.

-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 http://jmespath.org/ for more information and examples.

-o, --output [output]

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

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Examples

Delete a retention event by id

m365 purview retentionevent remove --id c37d695e-d581-4ae9-82a0-9364eba4291e

Remarks

caution

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.

Response

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 on event-based retention here