legalHold 资源类型
Namespace：microsoft.graph.ediscovery
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
表示法定保留。 法定保留是与电子数据展示案例关联的保留。 不应将法定保留与保留保留混淆，保留保留用于控制Microsoft 365 内容的保留策略。 电子数据展示法律保留用于无限期地保留内容，用于诉讼、内部调查和其他需要保护内容免受删除的法律诉讼。 有关详细信息，请参阅 管理高级电子数据展示中的保留
继承自 entity。
Methods
| 方法 | 返回类型 | Description |
|---|---|---|
| List | microsoft.graph.ediscovery.legalHold 集合 | 获取 legalHold 对象及其属性的列表。 |
| 创建 | microsoft.graph.ediscovery.legalHold | 创建新的 legalHold 对象。 |
| Get | microsoft.graph.ediscovery.legalHold | 读取 legalHold 对象的属性和关系。 |
| 更新 | microsoft.graph.ediscovery.legalHold | 更新 legalHold 对象的属性。 |
| 删除 | None | 删除 legalHold 对象。 |
| 列出网站源 | microsoft.graph.ediscovery.siteSource 集合 | 获取与法定保留关联的 siteSource 对象列表。 |
| 创建站点源 | microsoft.graph.ediscovery.siteSource | 创建新的 siteSource 对象。 |
| 列出用户源 | microsoft.graph.ediscovery.userSource 集合 | 获取与法定保留关联的 userSource 对象列表。 |
| 创建用户源 | microsoft.graph.ediscovery.userSource | 创建新的 userSource 对象。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| contentQuery | String | KQL 查询，指定要保留在指定位置的内容。 若要了解详细信息，请参阅 内容搜索和电子数据展示的关键字查询和搜索条件。 若要将所有内容保存在指定位置，请将 contentQuery 留空。 |
| createdBy | identitySet | 创建法定保留的用户。 |
| createdDateTime | DateTimeOffset | 法定保留的创建日期和时间。 |
| 说明 | String | 法定保留说明。 |
| displayName | String | 法定保留的显示名称。 |
| 错误 | 字符串集合 | 列出放置保留时发生的任何错误。 |
| id | String | 电子数据展示事例的 ID。 只读。 继承自 entity。 |
| isEnabled | Boolean | 指示是否启用保留并主动保存内容。 |
| lastModifiedBy | identitySet | 上次修改法定保留的用户。 |
| lastModifiedDateTime | DateTimeOffset | 上次修改法定保留的日期和时间。 |
| status | microsoft.graph.ediscovery.legalHoldStatus | 法定保留的状态。 可取值为：Pending、Error、Success、UnknownFutureValue。 |
legalHoldStatus 值
| 成员 | 说明 |
|---|---|
| Pending | 保留分发过程正在进行中。 |
| 错误 | 应用保留时出错。 有关详细信息，请参阅 legalHold 对象的 errors 属性。 |
| 成功 | 保留已成功应用，并且正在保存指定内容。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| siteSources | microsoft.graph.ediscovery.siteSource 集合 | 与法定保留关联的 SharePoint 网站的数据源实体。 |
| userSources | microsoft.graph.ediscovery.userSource 集合 | 法定保留的数据源实体。 这是邮箱和 OneDrive for Business 站点的容器。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"@odata.type": "#microsoft.graph.ediscovery.legalHold",
"id": "String (identifier)",
"description": "String",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "String (timestamp)",
"isEnabled": "Boolean",
"status": "String",
"contentQuery": "String",
"errors": [
"String"
],
"displayName": "String",
"createdDateTime": "String (timestamp)"
}