使用 Microsoft Graph 记录管理 API

重要

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

Microsoft Purview 记录管理 API 可帮助组织管理数据的保留和删除，以满足其法律义务和合规性法规，并通过定期处置不再需要保留的项目来提高效率。

记录管理解决方案是 Microsoft Purview 合规中心的一部分。

管理保留标签

许多组织需要管理其数据，以符合行业法规和内部策略，降低诉讼或安全漏洞的风险，并让其员工有效且敏捷地共享当前且与其相关的知识。 管理数据通常涉及适当保留或删除不同类型的内容。

可以使用 保留标签 为 Microsoft 365 内容配置保留和删除设置。 例如，可以设置从标记内容时开始的保留期，并且可以在保留期结束时将处置评审设置为操作。

此外，可以使用 文件计划描述符 来补充保留标签并改进 Microsoft 365 内容的可管理性和组织性。 文件计划描述符的示例包括 颁发机构、 引文和 部门。

触发现有标签的事件

某些方案要求在特定事件（例如员工离开组织、合同即将到期或会计年度结束）时为某些文档启动保留期。

可以通过将 retentionTrigger 属性dateOfEvent设置为 并将标签与 retentionEventType 资源关联，使用 retentionLabel 资源来支持基于事件的保留。 retentionEvent 也与 retentionEventType 相关联。 发生触发事件时，只有应用了该保留标签的内容才会在指定的保留期内保留。

例如：在组织中，当员工离职时，雇佣记录必须保留 5 年。 在员工启动时，使用 retentionLabel 和 retentionEvent API 对每个员工记录执行以下操作：

1. 应用配置如下的 retentionLabel ：
   • “人员信息”的显示名称
   • 1827 天的 保留期 (5 年)
   • 侦听名为“员工离职”的 retentionEventType
2. 定义一个 retentionEvent， 其中包含名为“Employee departure”的同一 retentionEventType ，并作为其 eventQuery 集合的一 Asset ID 部分，将员工 ID 值作为与事件关联的 ID 信息。

当 ID 为 1234 的员工离开 Contoso 时，会在 HR 管理系统中更新信息。 员工离职可以使用“员工离职”事件类型触发 retentionEvent 的新实例，并作为其 eventQueries 属性的一部分，触发具有“AssetID：1234”查询字符串的 eventQuery 。 这样，使用“人员信息”保留标签且与员工 ID 1234 关联的员工记录项即可从员工离职事件之日起开始其 5 年的保留期。

实体

记录管理 API 包括以下关键实体。

名称	类型	用例
标签	microsoft.graph.security.retentionLabel	包含可在期限结束时应用于项的保留设置和操作。
文件计划描述符	microsoft.graph.securty.fileplandescriptor	表示一组可选描述符，用于补充保留标签并提高组织的可管理性。
保留事件	microsoft.graph.security.retentionEvent	表示基于事件的保留的触发器，其中保留期在事件发生后开始。
保留事件类型	microsoft.graph.security.retentionEventType	表示相同类型的保留事件的单个组。