Skip to content

New Command: Create a Purview retention event type #4341

@martinlingstuyl

Description

@martinlingstuyl

Usage

m365 purview retentioneventtype add [options]

Description

Create a retention event type

Options

Option Description
-n, --displayName <displayName> The display name of the event type
-d, --description [description] A description for the event type

Examples

Create a retention event type contract expiry event

m365 purview retentioneventtype add --displayName 'contract expiry event' --description 'A retention event type to start a retention period based on the date that a contract expired.'

Additional Info

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

More information

Beta notice

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

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

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions