retentionEvent resource type

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

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.

Methods

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

Properties

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.
eventPropagationResults	microsoft.graph.security.eventPropagationResult collection	Represents the success status of a created event and additional information.
eventQueries	microsoft.graph.security.eventQuery collection	Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.
eventStatus	microsoft.graph.security.retentionEventStatus	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.

Relationships

Relationship	Type	Description
retentionEventType	microsoft.graph.security.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 JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.security.retentionEvent",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "eventQueries": [
    {
      "@odata.type": "microsoft.graph.security.eventQuery"
    }
  ],
  "eventTriggerDateTime": "String (timestamp)",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "eventPropagationResults": [
    {
      "@odata.type": "microsoft.graph.security.eventPropagationResult"
    }
  ],
  "eventStatus": {
    "@odata.type": "microsoft.graph.security.retentionEventStatus"
  },
  "lastStatusUpdateDateTime": "String (timestamp)"
}