Skip to content

Commit 84d95b6

Browse files
Learn Build Service GitHub AppLearn Build Service GitHub App
Learn Build Service GitHub App
authored and
Learn Build Service GitHub App
committed
Merging changes synced from https://github.com/microsoftgraph/microsoft-graph-docs (branch live)
2 parents 15279ef + 615eca8 commit 84d95b6

File tree

134 files changed

+3443
-627
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

134 files changed

+3443
-627
lines changed

api-reference/beta/api/agreement-get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
2424
<!-- { "blockType": "permissions", "name": "agreement_get" } -->
2525
[!INCLUDE [permissions-table](../includes/permissions/agreement-get-permissions.md)]
2626

27-
[!INCLUDE [rbac-tou-apis](../includes/rbac-for-apis/rbac-tou-apis.md)]
27+
[!INCLUDE [rbac-tou-security-reader-apis](../includes/rbac-for-apis/rbac-tou-security-reader-apis.md)]
2828

2929
## HTTP request
3030
<!-- { "blockType": "ignored" } -->

api-reference/beta/api/agreement-list-acceptances.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2323
<!-- { "blockType": "permissions", "name": "agreement_list_acceptances" } -->
2424
[!INCLUDE [permissions-table](../includes/permissions/agreement-list-acceptances-permissions.md)]
2525

26+
[!INCLUDE [rbac-tou-security-reader-apis](../includes/rbac-for-apis/rbac-tou-security-reader-apis.md)]
27+
2628
## HTTP request
2729

2830
<!-- {

api-reference/beta/api/agreement-list-files.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2323
<!-- { "blockType": "permissions", "name": "agreement_list_files" } -->
2424
[!INCLUDE [permissions-table](../includes/permissions/agreement-list-files-permissions.md)]
2525

26+
[!INCLUDE [rbac-tou-security-reader-apis](../includes/rbac-for-apis/rbac-tou-security-reader-apis.md)]
27+
2628

2729
## HTTP request
2830

api-reference/beta/api/agreement-post-files.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2323
<!-- { "blockType": "permissions", "name": "agreement_post_files" } -->
2424
[!INCLUDE [permissions-table](../includes/permissions/agreement-post-files-permissions.md)]
2525

26+
[!INCLUDE [rbac-tou-apis](../includes/rbac-for-apis/rbac-tou-apis.md)]
27+
2628
## HTTP request
2729

2830
<!-- {

api-reference/beta/api/agreementfile-get.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2323
<!-- { "blockType": "permissions", "name": "agreementfile_get" } -->
2424
[!INCLUDE [permissions-table](../includes/permissions/agreementfile-get-permissions.md)]
2525

26+
[!INCLUDE [rbac-tou-security-reader-apis](../includes/rbac-for-apis/rbac-tou-security-reader-apis.md)]
27+
2628
## HTTP request
2729

2830
<!-- {

api-reference/beta/api/agreementfile-list-localizations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2323
<!-- { "blockType": "permissions", "name": "agreementfile_list_localizations" } -->
2424
[!INCLUDE [permissions-table](../includes/permissions/agreementfile-list-localizations-permissions.md)]
2525

26+
[!INCLUDE [rbac-tou-security-reader-apis](../includes/rbac-for-apis/rbac-tou-security-reader-apis.md)]
27+
2628
## HTTP request
2729

2830
<!-- {

api-reference/beta/api/industrydata-industrydatarun-start.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,7 @@ Start a new [industryDataRun](../resources/industrydata-industrydatarun.md). Ind
2222

2323
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).
2424

25-
<!-- {
26-
"blockType": "permissions",
27-
"name": "industrydata_industrydatarun_start"
28-
}
29-
-->
25+
<!-- { "blockType": "permissions", "name": "industrydata_industrydatarun_start" } -->
3026
[!INCLUDE [permissions-table](../includes/permissions/industrydata-industrydatarun-start-permissions.md)]
3127

3228
## HTTP request

api-reference/beta/api/security-ediscoverycase-list-tags.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,6 @@ Choose the permission or permissions marked as least privileged for this API. Us
2525

2626
## HTTP request
2727

28-
<!-- {
29-
"blockType": "ignored"
30-
}
31-
-->
3228
``` http
3329
GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/tags
3430
```
@@ -47,14 +43,15 @@ If successful, this method returns a `200 OK` response code and a collection of
4743
## Examples
4844

4945
### Request
50-
The following example shows a request.
46+
The following example shows a request that lists tags.
5147

52-
# [HTTP](#tab/http)
48+
# [HTTP](#tab/http)
5349
<!-- {
5450
"blockType": "request",
5551
"name": "list_ediscoveryreviewtag_and_properties"
5652
}
5753
-->
54+
5855
``` http
5956
GET https://graph.microsoft.com/beta/security/cases/ediscoveryCases/58399dff-cebe-478f-b1af-d3227f1fd645/tags
6057
```

api-reference/beta/api/security-ediscoveryreviewset-addtoreviewset.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Namespace: microsoft.graph.security
1313

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

16-
Start the process of adding a collection from Microsoft 365 services to a [review set](../resources/security-ediscoveryreviewset.md). After the operation is created, you can get the status of the operation by retrieving the `Location` parameter from the response headers. The location provides a URL that will return a [Add to review set operation](../resources/security-ediscoveryaddtoreviewsetoperation.md).
16+
Start the process of adding a collection from Microsoft 365 services to a [review set](../resources/security-ediscoveryreviewset.md). After the operation is created, you can get the status of the operation by retrieving the `Location` parameter from the response headers. The location provides a URL that returns an [Add to review set operation](../resources/security-ediscoveryaddtoreviewsetoperation.md).
1717

1818

1919
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
@@ -47,14 +47,11 @@ The following table shows the parameters that can be used with this action.
4747

4848
|Parameter|Type|Description|
4949
|:---|:---|:---|
50-
|search|[microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md)|The ID of the eDiscovery search you'd like to add to the review set.|
51-
|additionalDataOptions|additionalDataOptions|The options for adding items to reviewSet.|
52-
53-
### additionalDataOptions values
54-
|Name|Description|
55-
|:---|:---|
56-
|allVersions|include all versions of a sharepoint document matching the source collection query. Caution: SharePoint versions can significantly increase the volume of items |
57-
|linkedFiles|include linked files that were shared in outlook, teams, or yammer messages by attaching a link to the file.|
50+
| additionalDataOptions |[microsoft.graph.security.additionalDataOptions](../resources/security-ediscoveryaddtoreviewsetoperation.md#additionaldataoptions-values)|The options to add items to the review set. The possible values are: `allVersions`, `linkedFiles`, `unknownFutureValue`, `advancedIndexing`, `listAttachments`, `htmlTranscripts`, `messageConversationExpansion`, `locationsWithoutHits`, `allItemsInFolder`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `advancedIndexing`, `listAttachments`, `htmlTranscripts`, `messageConversationExpansion`, `locationsWithoutHits`, `allItemsInFolder`. The `locationsWithoutHits` and `advancedIndexing` values are only considered if **itemsToIncude** is set to `partiallyIndexed`.|
51+
| cloudAttachmentVersion | microsoft.graph.security.cloudAttachmentVersion | Specifies the number of cloud attachment versions to collect. The possible values are: `latest`, `recent10`, `recent100`, `all`, `unknownFutureValue`. The default value is `latest`. |
52+
| documentVersion | microsoft.graph.security.documentVersion | Specifies the number of document versions to collect. The possible values are: `latest`, `recent10`, `recent100`, `all`, `unknownFutureValue`. The default value is `latest`.|
53+
| itemsToInclude | [microsoft.graph.security.itemsToInclude](../resources/security-ediscoveryaddtoreviewsetoperation.md#itemstoinclude-values) | The items to include in the review set. The possible values are: `searchHits`, `partiallyIndexed`, `unknownFutureValue`. |
54+
| search|[microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md)|The ID of the eDiscovery search you'd like to add to the review set.|
5855

5956
## Response
6057

api-reference/beta/api/security-ediscoveryreviewset-export.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Namespace: microsoft.graph.security
1313

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

16-
Initiate an export from a **reviewSet**. For details, see [Export documents from a review set in eDiscovery (Premium)](/microsoft-365/compliance/export-documents-from-review-set).
16+
Initiate an export from a **reviewSet**. For more information, see [Export documents from a review set in eDiscovery (Premium)](/microsoft-365/compliance/export-documents-from-review-set).
1717

1818

1919
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
@@ -48,15 +48,15 @@ The following table shows the parameters that can be used with this action.
4848
|Parameter|Type|Description|
4949
|:---|:---|:---|
5050
|description|String| Description of the export. |
51-
|exportOptions|String|Specifies options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`. The `fileInfo` member is deprecated and has stopped returning data. The summary and load file are always included.|
52-
|exportStructure|String| Options that control file structure and packaging of the export. Possible values are: `none`, `directory`, `pst`.|
51+
|exportOptions|[microsoft.graph.security.exportOptions](../resources/security-ediscoveryexportoperation.md#exportoptions-values)|Bitwise options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`, `unknownFutureValue`, `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizedPartitionSize`. Use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `splitSource`, `includeFolderAndPath`, `friendlyName`, `condensePaths`, `optimizePartitionSize`. The `fileInfo` member is deprecated and stopped returning data. The summary and load files are always included. If `originalFiles` isn't selected, only the `tags` member is considered. |
52+
|exportStructure|[microsoft.graph.security.exportFileStructure](../resources/security-ediscoveryexportoperation.md#exportfilestructure-values)| Bitwise options that control file structure and packaging of the export. Possible values are: `none`, `directory`, `pst`, `unknownFutureValue`, `msg`. Use the `Prefer: include-unknown-enum-members` request header to get the following value from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `msg`. If `directory` is selected, the format is `msg`, and the export options `splitSource`, `includeFolderAndPath`, and `friendlyName` are disregarded.|
5353
|outputName|String| Name of the export. Required. |
54-
|azureBlobContainer (deprecated)|String| When you export to your own Azure storage account, the value is the container URL. The **azureBlobContainer** property is deprecated and has stopped returning data. |
55-
|azureBlobToken (deprecated)|String| When you export to your own Azure storage account, SAS token for the container URL. The **azureBlobToken** property is deprecated and has stopped returning data. |
54+
|azureBlobContainer (deprecated)|String| When you export to your own Azure storage account, the value is the container URL. The **azureBlobContainer** property is deprecated and stopped returning data. |
55+
|azureBlobToken (deprecated)|String| When you export to your own Azure storage account, SAS token for the container URL. The **azureBlobToken** property is deprecated and stopped returning data. |
5656

5757
## Response
5858

59-
If the export has started successfully, this action returns a `202 Accepted` response code. The response also contains a `Location` header, which contains the location of the [Export operation](../resources/security-ediscoveryexportoperation.md) that was created to handle the export.
59+
If the export started successfully, this action returns a `202 Accepted` response code. The response also contains a `Location` header, which contains the location of the [Export operation](../resources/security-ediscoveryexportoperation.md) that was created to handle the export.
6060

6161
## Examples
6262

api-reference/beta/api/security-ediscoveryreviewsetquery-export.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ The following table shows the parameters that can be used with this action.
4949
|Parameter|Type|Description|
5050
|:---|:---|:---|
5151
|description|String| Description of the export. |
52-
|exportOptions|String|Specifies options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo` (deprecated), `tags`. The `fileInfo` member is deprecated and has stopped returning data. The summary and load file are always included.|
53-
|exportStructure|String| Options that control file structure and packaging of the export. Possible values are: `none`, `directory`, `pst`.|
52+
|exportOptions|[microsoft.graph.security.exportOptions](../resources/security-ediscoveryexportoperation.md#exportoptions-values)|Bitwise options that control the format of the export. Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo` (deprecated), `tags`. The `fileInfo` member is deprecated and has stopped returning data. The summary and load files are always included.|
53+
|exportStructure|[microsoft.graph.security.exportFileStructure](../resources/security-ediscoveryexportoperation.md#exportfilestructure-values)| Options that control file structure and packaging of the export. Possible values are: `none`, `directory`, `pst`, `unknownFutureValue`, `msg`. Use the `Prefer: include-unknown-enum-members` request header to get the following value from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `msg`.|
5454
|outputName|String| Name of the export. Required. |
5555
|azureBlobContainer (deprecated) |String| When you export to your own Azure storage account, the value is the container URL. The **azureBlobContainer** property is deprecated and has stopped returning data. |
5656
|azureBlobToken (deprecated) |String| When you export to your own Azure storage account, SAS token for the container URL. The **azureBlobToken** property is deprecated and has stopped returning data. |

api-reference/beta/api/security-ediscoveryreviewtag-ashierarchy.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ Don't supply a request body for this method.
4646
If successful, this function returns a `200 OK` response code and a [microsoft.graph.security.ediscoveryReviewTag](../resources/security-ediscoveryreviewtag.md) collection in the response body.
4747

4848
## Examples
49-
50-
### Request
51-
The following example shows a request.
49+
### Example 1: Retrieve child tags of a specific eDiscovery review tag
50+
#### Request
51+
The following example shows a request that retrieves child tags.
5252

5353
# [HTTP](#tab/http)
5454
<!-- {
@@ -94,7 +94,7 @@ GET https://graph.microsoft.com/beta/security/cases/ediscoveryCases/58399dff-ceb
9494

9595
---
9696

97-
### Response
97+
#### Response
9898
The following example shows the response.
9999
>**Note:** The response object shown here might be shortened for readability.
100100
<!-- {
@@ -198,3 +198,37 @@ Content-Type: application/json
198198
}
199199
```
200200

201+
### Example 2: Retrieve child tags of a specific eDiscovery review tag
202+
#### Request
203+
The following example shows a request to retrieve child tags
204+
<!-- {
205+
"blockType": "request",
206+
"name": "ediscoveryreviewtagthis.childtags"
207+
}
208+
-->
209+
210+
``` http
211+
GET https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b6f72954-c7d0-414c-ad50-00167216cb03/tags/318f79767abf4b8fab4d8e37b3174c5a/childTags
212+
```
213+
214+
#### Response
215+
The following example shows the response.
216+
<!-- {
217+
"blockType": "response",
218+
"truncated": true,
219+
"@odata.type": "Collection(microsoft.graph.security.ediscoveryReviewTag)"
220+
}
221+
-->
222+
``` http
223+
HTTP/1.1 200 OK
224+
Content-Type: application/json
225+
226+
{
227+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.security.ediscoveryReviewTag)",
228+
"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET security/cases/ediscoveryCases('<guid>')/tags('<guid>')/childTags?$select=childSelectability",
229+
"value": []
230+
}
231+
```
232+
233+
234+

api-reference/beta/api/security-ediscoverysearch-estimatestatistics.md

Lines changed: 16 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -38,63 +38,40 @@ POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySear
3838
|Name|Description|
3939
|:---|:---|
4040
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
41+
|Content-Type|application/json. Required.|
4142

4243
## Request body
43-
Don't supply a request body for this method.
44+
45+
In the request body, supply a JSON representation of the parameters.
46+
47+
The following table lists the parameters that you can use with this action.
48+
49+
| Parameter | Type | Description |
50+
|:---|:---|:---|
51+
| statisticsOptions | [microsoft.graph.security.statisticsOptions](../resources/security-ediscoveryestimateoperation.md#statisticsoptions-values) | Bitwise options that specify the statistics to generate. The possible values are: `includeRefiners`, `includeQueryStats`, `includeUnindexedStats`, `advancedIndexing`, `locationsWithoutHits`, `unknownFutureValue`. The `advancedIndexing` and `locationsWithoutHits` values are only considered if `includeUnindexedStats` is set.|
4452

4553
## Response
4654

47-
If the estimate is started successfully, this action returns a `202 Accepted` response code.
48-
The response will also contain a `Location` header, which contains the location of the [microsoft.graph.security.estimateStatisticsOperation](../resources/security-ediscoveryestimateoperation.md) that was created to handle the estimate. Check the status of the estimate operation by making a GET request to the location.
55+
If the estimate is started successfully, this action returns a `202 Accepted` response code. The response contains a `Location` header, which contains the location of the [microsoft.graph.security.estimateStatisticsOperation](../resources/security-ediscoveryestimateoperation.md) that was created to handle the estimate. Check the status of the estimate operation by making a GET request to the value of the `Location` header.
4956

5057
## Examples
5158

5259
### Request
5360
The following example shows a request.
5461

55-
# [HTTP](#tab/http)
5662
<!-- {
5763
"blockType": "request",
5864
"name": "ediscoverysearchthis.estimatestatistics"
5965
}
6066
-->
6167
``` http
6268
POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/searches/c61a5860-d634-4d14-aea7-d82b6f4eb7af/estimatestatistics
63-
```
64-
65-
# [C#](#tab/csharp)
66-
[!INCLUDE [sample-code](../includes/snippets/csharp/ediscoverysearchthisestimatestatistics-csharp-snippets.md)]
67-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
68-
69-
# [CLI](#tab/cli)
70-
[!INCLUDE [sample-code](../includes/snippets/cli/ediscoverysearchthisestimatestatistics-cli-snippets.md)]
71-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
72-
73-
# [Go](#tab/go)
74-
[!INCLUDE [sample-code](../includes/snippets/go/ediscoverysearchthisestimatestatistics-go-snippets.md)]
75-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
76-
77-
# [Java](#tab/java)
78-
[!INCLUDE [sample-code](../includes/snippets/java/ediscoverysearchthisestimatestatistics-java-snippets.md)]
79-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
69+
Content-Type: application/json
8070
81-
# [JavaScript](#tab/javascript)
82-
[!INCLUDE [sample-code](../includes/snippets/javascript/ediscoverysearchthisestimatestatistics-javascript-snippets.md)]
83-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
84-
85-
# [PHP](#tab/php)
86-
[!INCLUDE [sample-code](../includes/snippets/php/ediscoverysearchthisestimatestatistics-php-snippets.md)]
87-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
88-
89-
# [PowerShell](#tab/powershell)
90-
[!INCLUDE [sample-code](../includes/snippets/powershell/ediscoverysearchthisestimatestatistics-powershell-snippets.md)]
91-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
92-
93-
# [Python](#tab/python)
94-
[!INCLUDE [sample-code](../includes/snippets/python/ediscoverysearchthisestimatestatistics-python-snippets.md)]
95-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
96-
97-
---
71+
{
72+
"statisticsOptions": "includeRefiners, includeQueryStats, includeUnindexedStats, advancedIndexing, locationsWithoutHits"
73+
}
74+
```
9875

9976
### Response
10077
The following example shows the response.
@@ -105,5 +82,5 @@ The following example shows the response.
10582
}
10683
-->
10784
``` http
108-
HTTP/1.1 204 No Content
85+
HTTP/1.1 202 Accepted
10986
```

0 commit comments

Comments
 (0)