Microsoft Purview · Schema

RetentionEvent

A retention event that triggers event-based retention

ComplianceData CatalogData ClassificationData GovernanceData Loss PreventionInformation Protection

Properties

Name Type Description
id string
displayName string
description string
eventTriggerDateTime string
eventQueries array
retentionEventType object
eventStatus object
createdDateTime string
lastModifiedDateTime string
createdBy object
lastModifiedBy object
View JSON Schema on GitHub

JSON Schema

microsoft-purview-retentionevent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RetentionEvent",
  "title": "RetentionEvent",
  "type": "object",
  "description": "A retention event that triggers event-based retention",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "displayName": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "eventTriggerDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "eventQueries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "queryType": {
            "type": "string"
          },
          "query": {
            "type": "string"
          }
        }
      }
    },
    "retentionEventType": {
      "$ref": "#/components/schemas/RetentionEventType"
    },
    "eventStatus": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            },
            "message": {
              "type": "string"
            }
          }
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "error",
            "success",
            "unknownFutureValue"
          ]
        }
      }
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "lastModifiedDateTime": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "createdBy": {
      "$ref": "#/components/schemas/IdentitySet"
    },
    "lastModifiedBy": {
      "$ref": "#/components/schemas/IdentitySet"
    }
  }
}