retentionEvent resource type


Represents a trigger for event-based retention labels where start of the retention period is based on when a specific type of event occurs. To learn more about it, see Start retention when an event occurs.


Method Return type Description
List retentionEvents collection Get a list of the retentionEvent objects and their properties.
Create retentionEvent Create a new retentionEvent object.
Get retentionEvent Read the properties and relationships of a retentionEvent object.
Delete retentionEvent None Delete a retentionEvent object.
List retentionEventType collection Get the retentionEventType resources from the exapnd eventType navigation property.
Create retentionEventType Add eventType by adding the relevant odata property when creating an event.


Property Type Description
createdBy microsoft.graph.identitySet The user who created the retentionEvent.
createdDateTime DateTimeOffset The date time when the retentionEvent was created.
description String Optional information about the event.
displayName String Name of the event.
eventPropagationResult Represents the success status of a created event and additional information.
eventQueries collection Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.
retentionEventStatus collection Status of event propogation to the scoped locations after the event has been created.
eventTriggerDateTime DateTimeOffset Optional time when the event should be triggered.
id String Represents the unique ID of the user who created the retentionEvent. entity.
lastModifiedBy microsoft.graph.identitySet The user who last modified the retentionEvent.
lastModifiedDateTime DateTimeOffset The latest date time when the retentionEvent was modified.
lastStatusUpdateDateTime DateTimeOffset Last time the status of the event was updated.


Relationship Type Description
retentionEventType Specifies the event that will start the retention period for labels that use this event type when an event is created.

JSON representation

The following is a JSON representation of the resource.

  "@odata.type": "",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "eventQueries": [
      "@odata.type": ""
  "eventTriggerDateTime": "String (timestamp)",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  "lastModifiedDateTime": "String (timestamp)",
  "eventPropagationResults": [
      "@odata.type": ""
  "eventStatus": {
    "@odata.type": ""
  "lastStatusUpdateDateTime": "String (timestamp)"