Update ediscoveryHoldPolicy
Namespace: microsoft.graph.security
Update the properties of an ediscoveryHoldPolicy object.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | eDiscovery.Read.All | eDiscovery.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | eDiscovery.Read.All | eDiscovery.ReadWrite.All |
HTTP request
PATCH /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId}
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.
The following table specifies the properties that can be updated.
Property | Type | Description |
---|---|---|
contentQuery | String | KQL query that specifies content to be held in the specified locations. To learn more, see Keyword queries and search conditions for eDiscovery. To hold all content in the specified locations, don't provide a value for the contentQuery property. Optional. |
description | String | The description of the legal hold policy. Optional. |
Response
If successful, this method returns a 204 No Content
response code.
Examples
Request
The following example shows a request.
PATCH https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalholds/783c3ea4-d474-4051-9c13-08707ce8c8b6
{
"description": "updated description",
"contentQuery": "updated kql query"
}
Response
The following example shows the response.
HTTP/1.1 204 No Content