Skip to content

New Command: Get a list of Purview retention event types #4334

@martinlingstuyl

Description

@martinlingstuyl

Usage

m365 purview retentioneventtype list [options]

Description

Get a list of retention event types

Options

None but global options

Examples

Get a list of retention event types

m365 purview retentioneventtype list

Additional Info

The following Graph endpoint can be used:
https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes

More information

Text output properties

Properties visible in text output mode should be: id, displayName, createdDateTime

Beta notice

The Graph endpoint that's used is in beta, so we should add a beta notice to the docs.

Azure AD

The command will need the Scope RecordsManagement.Read.All.

Try it out

You can try the endpoint by executing the following:

m365 request --url "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes"

More information

This section should be included in the documentation

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions