Skip to content

Commit b0f8006

Browse files
LauragraLauragra
authored
Merge pull request #25460 from microsoftgraph/holddocs
Promoting eDiscovery Hold Policy APIs to v1.0
2 parents ca8a6f4 + 547dfbe commit b0f8006

30 files changed

+1038
-171
lines changed

‎api-reference/beta/api/security-ediscoverycase-post-legalholds.md

Lines changed: 2 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ You can specify the following properties when you create an **ediscoveryHoldPoli
4747
|:---|:---|:---|
4848
|displayName|String|The display name of the legal hold policy. Required.|
4949
|description|String|The description of the legal hold policy. Optional.|
50+
|contentQuery|String|KQL query that specifies content to be held in the specified locations. Optional. |
5051

5152
## Response
5253

@@ -57,7 +58,6 @@ If successful, this method returns a `201 Created` response code and an [microso
5758
### Request
5859
The following example shows a request.
5960

60-
# [HTTP](#tab/http)
6161
<!-- {
6262
"blockType": "request",
6363
"name": "create_ediscoveryholdpolicy_from_"
@@ -70,53 +70,10 @@ Content-Type: application/json
7070
{
7171
"displayName": "My legalHold with sources",
7272
"description": "Created from Graph API",
73-
"userSources@odata.bind": [
74-
{
75-
"@odata.type": "microsoft.graph.security.userSource",
76-
"email": "SalesTeam@contoso.com"
77-
}
78-
],
79-
"siteSources@odata.bind": [
80-
{
81-
"@odata.type": "microsoft.graph.security.siteSource",
82-
"site": {
83-
"webUrl": "https://m365x809305.sharepoint.com/sites/Design-topsecret"
84-
}
85-
}
86-
]
73+
"contentQuery": "KQL content query",
8774
}
8875
```
8976

90-
# [C#](#tab/csharp)
91-
[!INCLUDE [sample-code](../includes/snippets/csharp/create-ediscoveryholdpolicy-from--csharp-snippets.md)]
92-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
93-
94-
# [CLI](#tab/cli)
95-
[!INCLUDE [sample-code](../includes/snippets/cli/create-ediscoveryholdpolicy-from--cli-snippets.md)]
96-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
97-
98-
# [Java](#tab/java)
99-
[!INCLUDE [sample-code](../includes/snippets/java/create-ediscoveryholdpolicy-from--java-snippets.md)]
100-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
101-
102-
# [JavaScript](#tab/javascript)
103-
[!INCLUDE [sample-code](../includes/snippets/javascript/create-ediscoveryholdpolicy-from--javascript-snippets.md)]
104-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
105-
106-
# [PHP](#tab/php)
107-
[!INCLUDE [sample-code](../includes/snippets/php/create-ediscoveryholdpolicy-from--php-snippets.md)]
108-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
109-
110-
# [PowerShell](#tab/powershell)
111-
[!INCLUDE [sample-code](../includes/snippets/powershell/create-ediscoveryholdpolicy-from--powershell-snippets.md)]
112-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
113-
114-
# [Python](#tab/python)
115-
[!INCLUDE [sample-code](../includes/snippets/python/create-ediscoveryholdpolicy-from--python-snippets.md)]
116-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
117-
118-
---
119-
12077
### Response
12178
The following example shows the response.
12279
>**Note:** The response object shown here might be shortened for readability.

‎api-reference/beta/api/security-ediscoverycustodian-list-sitesources.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Namespace: microsoft.graph.security
1212

1313
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1414

15-
Get a list of the [siteSource](../resources/security-sitesource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md).
15+
Get a list of the [siteSource](../resources/security-sitesource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md) or [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md).
1616

1717
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
1818

@@ -30,6 +30,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
3030
-->
3131
``` http
3232
GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/custodians/{custodianId}/siteSources
33+
GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId}/userSources
3334
```
3435

3536
## Optional query parameters

‎api-reference/beta/api/security-ediscoverycustodian-list-usersources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Namespace: microsoft.graph.security
1212

1313
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1414

15-
Get a list of the [userSource](../resources/security-usersource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md).
15+
Get a list of the [userSource](../resources/security-usersource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md) or [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md).
1616

1717
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
1818

‎api-reference/beta/api/security-ediscoveryholdpolicy-post-sitesources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Namespace: microsoft.graph.security
1212

1313
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1414

15-
Create a new siteSource object.
15+
Create a new [siteSource](../resources/security-sitesource.md) object.
1616

1717
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
1818

‎api-reference/beta/api/security-ediscoveryholdpolicy-post-usersources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Namespace: microsoft.graph.security
1212

1313
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1414

15-
Create a new userSource object.
15+
Create a new [userSource](../resources/security-usersource.md) object.
1616

1717
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
1818

@@ -46,7 +46,7 @@ You can specify the following properties when you create a **userSource**.
4646
|Property|Type|Description|
4747
|:---|:---|:---|
4848
|email|String|SMTP address of the user.|
49-
|includedSources|microsoft.graph.security.sourceType|Specifies which sources are included in this group. Possible values are: `mailbox`, `site`.|
49+
|includedSources|microsoft.graph.security.sourceType|Specifies which sources are included in this group. Possible values are: `mailbox`, `site`. Only `mailbox` is applicable for user sources.|
5050

5151

5252
## Response
@@ -70,7 +70,7 @@ Content-Type: application/json
7070
7171
{
7272
"email": "admin@contoso.com",
73-
"includedSources": "mailbox, site"
73+
"includedSources": "mailbox"
7474
}
7575
```
7676

‎api-reference/beta/resources/security-ediscoveryholdpolicy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Represents a legal hold policy. Legal holds are holds that are tied to an eDisco
3636
|createdDateTime|DateTimeOffset|The date and time the legal hold was created. |
3737
|description|String| The legal hold description. |
3838
|displayName|String| The display name of the legal hold. |
39+
|contentQuery|String| KQL query that specifies content to be held in the specified locations. |
3940
|errors|String collection|Lists any errors that happened while placing the hold. |
4041
|id|String|The ID for the eDiscovery case. Read-only. Inherited from [entity](../resources/entity.md). |
4142
|isEnabled|Boolean|Indicates whether the hold is enabled and actively holding content. |

‎api-reference/v1.0/api/security-ediscoverycase-delete-legalholds.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: "Delete ediscoveryHoldPolicy"
3+
description: "Delete an ediscoveryHoldPolicy object."
4+
author: "SeunginLyu"
5+
ms.localizationpriority: medium
6+
ms.subservice: "ediscovery"
7+
doc_type: "apiPageType"
8+
---
9+
10+
# Delete ediscoveryHoldPolicy
11+
Namespace: microsoft.graph.security
12+
13+
Delete an [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object.
14+
15+
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
16+
17+
## Permissions
18+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
19+
20+
<!-- { "blockType": "permissions", "name": "security_ediscoverycase_delete_legalholds" } -->
21+
[!INCLUDE [permissions-table](../includes/permissions/security-ediscoverycase-delete-legalholds-permissions.md)]
22+
23+
## HTTP request
24+
25+
<!-- {
26+
"blockType": "ignored"
27+
}
28+
-->
29+
``` http
30+
DELETE /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId}
31+
```
32+
33+
## Request headers
34+
|Name|Description|
35+
|:---|:---|
36+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
37+
38+
## Request body
39+
Don't supply a request body for this method.
40+
41+
## Response
42+
43+
If successful, this method returns a `204 No Content` response code.
44+
45+
## Examples
46+
47+
### Request
48+
The following example shows a request.
49+
50+
<!-- {
51+
"blockType": "request",
52+
"name": "delete_ediscoveryholdpolicy"
53+
}
54+
-->
55+
``` http
56+
DELETE https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalholds/a4d3421d-b756-47ac-ad43-5d587c5dfe75/
57+
```
58+
59+
### Response
60+
The following example shows the response.
61+
<!-- {
62+
"blockType": "response",
63+
"truncated": true
64+
}
65+
-->
66+
``` http
67+
HTTP/1.1 204 No Content
68+
```

‎api-reference/v1.0/api/security-ediscoverycase-list-legalholds.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: "List ediscoveryHoldPolicies"
3+
description: "Get a list of the ediscoveryHoldPolicy objects and their properties."
4+
author: "SeunginLyu"
5+
ms.localizationpriority: medium
6+
ms.subservice: "ediscovery"
7+
doc_type: "apiPageType"
8+
---
9+
10+
# List ediscoveryHoldPolicies
11+
Namespace: microsoft.graph.security
12+
13+
Get a list of the [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) objects and their properties.
14+
15+
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
16+
17+
## Permissions
18+
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
19+
20+
<!-- { "blockType": "permissions", "name": "security_ediscoverycase_list_legalholds" } -->
21+
[!INCLUDE [permissions-table](../includes/permissions/security-ediscoverycase-list-legalholds-permissions.md)]
22+
23+
## HTTP request
24+
25+
<!-- {
26+
"blockType": "ignored"
27+
}
28+
-->
29+
``` http
30+
GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds
31+
```
32+
33+
## Optional query parameters
34+
This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
35+
36+
## Request headers
37+
|Name|Description|
38+
|:---|:---|
39+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
40+
41+
## Request body
42+
Don't supply a request body for this method.
43+
44+
## Response
45+
46+
If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) objects in the response body.
47+
48+
## Examples
49+
50+
### Request
51+
The following example shows a request.
52+
53+
<!-- {
54+
"blockType": "request",
55+
"name": "list_ediscoveryholdpolicy"
56+
}
57+
-->
58+
``` http
59+
GET https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalHolds
60+
```
61+
62+
---
63+
64+
### Response
65+
The following example shows the response.
66+
>**Note:** The response object shown here might be shortened for readability.
67+
<!-- {
68+
"blockType": "response",
69+
"truncated": true,
70+
"@odata.type": "Collection(microsoft.graph.security.ediscoveryHoldPolicy)"
71+
}
72+
-->
73+
``` http
74+
HTTP/1.1 200 OK
75+
Content-Type: application/json
76+
77+
{
78+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/legalHolds",
79+
"@odata.count": 2,
80+
"value": [
81+
{
82+
"isEnabled": false,
83+
"errors": [],
84+
"contentQuery": "",
85+
"description": null,
86+
"createdDateTime": "2022-05-23T01:09:53Z",
87+
"lastModifiedDateTime": "2022-05-23T02:36:26Z",
88+
"status": "pending",
89+
"id": "783c3ea4-d474-4051-9c13-08707ce8c8b6",
90+
"displayName": "CustodianHold-b0073e4e-4184-41c6-9eb7-8c8cc3e2288b",
91+
"createdBy": {
92+
"application": null,
93+
"user": {
94+
"id": "MOD Administrator",
95+
"displayName": null
96+
}
97+
},
98+
"lastModifiedBy": {
99+
"application": null,
100+
"user": {
101+
"id": "MOD Administrator",
102+
"displayName": null
103+
}
104+
}
105+
},
106+
{
107+
"isEnabled": false,
108+
"errors": [],
109+
"contentQuery": "",
110+
"description": null,
111+
"createdDateTime": "2022-05-23T02:09:27Z",
112+
"lastModifiedDateTime": "2022-05-23T02:41:26Z",
113+
"status": "pending",
114+
"id": "ff7e8841-b1ac-41f0-87c5-fa00da045ae0",
115+
"displayName": "NCDSHold-b0073e4e-4184-41c6-9eb7-8c8cc3e2288b",
116+
"createdBy": {
117+
"application": null,
118+
"user": {
119+
"id": "MOD Administrator",
120+
"displayName": null
121+
}
122+
},
123+
"lastModifiedBy": {
124+
"application": null,
125+
"user": {
126+
"id": "MOD Administrator",
127+
"displayName": null
128+
}
129+
}
130+
}
131+
]
132+
}
133+
```
134+

0 commit comments

Comments
 (0)