retentionLabel 资源类型

命名空间：microsoft.graph.security

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示出于合规性和治理目的，组织如何在电子邮件或文档) (项目级别管理其数据，包括是否保留或删除项目以及保留时间。

组织可以对需要不同保留设置的不同类型的内容使用保留标签。 例如，他们可以将保留标签应用于税单和支持文档，以便在法律要求的期限内保留这些标签。

组织可以根据上次修改或创建日期等因素，使用保留期和操作配置保留标签。 它们还可以通过指定可在 事件发生时触发保留的事件 来启动不同的保留期。

有关保留标签的工作原理、何时使用它们以及 Microsoft Purview 如何支持保留标签以允许你配置保留和删除设置的详细信息，请参阅 了解保留策略和保留标签。

方法

方法	返回类型	说明
列出 retentionLabels	microsoft.graph.security.retentionLabel 集合	获取 retentionLabel 对象及其属性的列表。
创建 retentionLabel	microsoft.graph.security.retentionLabel	创建新的 retentionLabel 对象。
获取 retentionLabel	microsoft.graph.security.retentionLabel	读取 retentionLabel 对象的属性和关系。
更新 retentionLabel	microsoft.graph.security.retentionLabel	更新 retentionLabel 对象的属性。
删除 retentionLabel	无	删除 retentionLabel 对象。
列表 retentionEventType	microsoft.graph.security.retentionEventType 集合	从 exapnd eventType 导航属性获取 retentionEventType 资源。
添加 retentionEventType	microsoft.graph.security.retentionEventType	通过在创建标签时添加相关的 odata 属性来添加 eventType。

属性

属性	类型	说明
actionAfterRetentionPeriod	microsoft.graph.security.actionAfterRetentionPeriod	指定在 retentionDuration 属性指定的时间段到期后对标记的文档执行的操作。 可能的值包括 none、delete、startDispositionReview、unknownFutureValue。
behaviorDuringRetentionPeriod	microsoft.graph.security.behaviorDuringRetentionPeriod	指定具有此标签的文档在保留期内的行为方式。 可能的值包括 doNotRetain、retain、retainAsRecord、retainAsRegulatoryRecord、unknownFutureValue。
createdBy	microsoft.graph.identitySet	表示创建 retentionLabel 的用户。
createdDateTime	DateTimeOffset	表示创建 retentionLabel 的日期和时间。
descriptionForAdmins	String	为管理员提供标签信息。可选。
descriptionForUsers	String	为用户提供标签信息。 可选。
displayName	String	定义标签名称的唯一字符串。
id	String	retentionLabel 的唯一 ID。 实体。
isInUse	布尔值	指定当前是否正在使用标签。
lastModifiedBy	microsoft.graph.identitySet	上次修改 retentionLabel 的用户。
lastModifiedDateTime	DateTimeOffset	修改 retentionLabel 的最近日期时间。
retentionDuration	microsoft.graph.security.retentionDuration	指定保留内容的天数。
retentionTrigger	microsoft.graph.security.retentionTrigger	指定是从内容创建日期、标记日期还是上次修改日期计算保留持续时间。 可能的值包括 dateLabeled、dateCreated、dateModified、dateOfEvent、unknownFutureValue。
defaultRecordBehavior	microsoft.graph.security.defaultRecordBehavior	指定记录标签在创建时处于锁定或解锁状态。可能的值为： startLocked、 startUnlocked、 unknownFutureValue。
labelToBeApplied	String	指定要在当前标签的保留期结束后自动应用的替换标签。

关系

关系	类型	说明
dispositionReviewStages	microsoft.graph.security.dispositionReviewStage 集合	将保留期结束时的操作选为“dispositionReview”时，dispositionReviewStages 将指定一组顺序阶段，每个阶段中至少有一个审阅者。
retentionEventType	microsoft.graph.security.retentionEventType	表示与保留事件关联的类型。
描述 符	microsoft.graph.security.filePlanDescriptor	表示现用值，这些值提供更多选项，以提高需要标记的内容的可管理性和组织性。

JSON 表示形式

下面是资源的 JSON 表示形式。

{
  "@odata.type": "#microsoft.graph.security.retentionLabel",
  "id": "String (identifier)",
  "displayName": "String",
  "behaviorDuringRetentionPeriod": "String",
  "actionAfterRetentionPeriod": "String",
  "retentionTrigger": "String",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDuration"
  },
  "isInUse": "Boolean",
  "descriptionForAdmins": "String",
  "descriptionForUsers": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "labelToBeApplied": "String",
  "defaultRecordBehavior": "String"
}