Skip to content

purview retentioneventtype list

Get a list of retention event types

Usage

m365 purview retentioneventtype list [options]

Options

-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

Get a list of retention event types

m365 purview retentioneventtype list

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.

Response

[
  {
    "displayName": "Contract Expiry",
    "description": "",
    "createdDateTime": "2023-02-02T15:47:54Z",
    "lastModifiedDateTime": "2023-02-02T15:47:54Z",
    "id": "81fa91bd-66cd-4c6c-b0cb-71f37210dc74",
    "createdBy": {
      "user": {
        "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
        "displayName": null
      }
    },
    "lastModifiedBy": {
      "user": {
        "id": "36155f4e-bdbd-4101-ba20-5e78f5fba9a9",
        "displayName": null
      }
    }
  }
]

id                                    displayName            createdDateTime
------------------------------------  ---------------------  --------------------
81fa91bd-66cd-4c6c-b0cb-71f37210dc74  Contract Expiry  2023-02-02T15:47:54Z

id,displayName,createdDateTime
81fa91bd-66cd-4c6c-b0cb-71f37210dc74,Contract Expiry,2023-02-02T15:47:54Z

# purview retentioneventtype list

Date: 8/2/2023

## Contract Expiry (81fa91bd-66cd-4c6c-b0cb-71f37210dc74)

Property | Value
---------|-------
displayName | Contract Expiry
description | null
createdDateTime | 2023-02-02T15:47:54Z
lastModifiedDateTime | 2023-02-02T15:47:54Z
id | 81fa91bd-66cd-4c6c-b0cb-71f37210dc74
createdBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}
lastModifiedBy | {"user":{"id":"36155f4e-bdbd-4101-ba20-5e78f5fba9a9","displayName":null}}