Skip to content

purview retentioneventtype add

Create a retention event type

Usage

m365 purview retentioneventtype add [options]

Options

-n, --displayName <displayName>
The display name of the event type.
-d, --description [description]
A description for 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 full.
--query [query]
JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
Output type. json,text,csv,md. Default json
--verbose
Runs command with verbose logging
--debug
Runs command with debug logging

Examples

Create a retention event type Contract Expiry.

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

Remarks

Attention

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.

Attention

This command currently only supports delegated permissions.

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

Response

{
  {
    "displayName": "Contract Expiry",
    "description": "A retention event type to start a retention period based on the date that a contract expired.",
    "createdDateTime": "2023-01-31T20:33:33Z",
    "lastModifiedDateTime": "2023-01-31T20:33:33Z",
    "id": "f15d2493-7ad2-4185-a3f6-9580542490a0",
    "createdBy": {
      "user": {
        "id": null,
        "displayName": "John Doe"
      }
    },
    "lastModifiedBy": {
      "user": {
        "id": null,
        "displayName": "John Doe"
      }
    }
  }
}

createdBy           : {"user":{"id":null,"displayName":"John Doe"}}
createdDateTime     : 2023-01-31T20:40:40Z
description         : A retention event type to start a retention period based on the date that a contract expired.
displayName         : Contract Expiry
id                  : 806cb481-4cc6-47c3-af26-26d64f6e7aab
lastModifiedBy      : {"user":{"id":null,"displayName":"John Doe"}}
lastModifiedDateTime: 2023-01-31T20:40:40Z

displayName,description,createdDateTime,lastModifiedDateTime,id,createdBy,lastModifiedBy
Contract Expiry,A retention event type to start a retention period based on the date that a contract expired.,2023-01-31T20:53:23Z,2023-01-31T20:53:23Z,b430ae4c-1e26-422f-9544-67df3abfb200,"{""user"":{""id"":null,""displayName"":""John Doe""}}","{""user"":{""id"":null,""displayName"":""John Doe""}}"

# purview retentioneventtype add --displayName "Contract Expiry" --description "A retention event type to start a retention period based on the date that a contract expired."

Date: 31/01/2023

## Contract Expiry (ca0e1f8d-4e42-4a81-be85-022502d70c4e)

Property | Value
---------|-------
displayName | Contract Expiry
description | A retention event type to start a retention period based on the date that a contract expired.
createdDateTime | 2023-01-31T20:55:35Z
lastModifiedDateTime | 2023-01-31T20:55:35Z
id | ca0e1f8d-4e42-4a81-be85-022502d70c4e
createdBy | {"user":{"id":null,"displayName":"John Doe"}}
lastModifiedBy | {"user":{"id":null,"displayName":"John Doe"}}