Namespace: microsoft.graph.security
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Update the properties of an ediscoveryCaseSettings 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.ReadWrite.All |
Not available. |
Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
Application |
eDiscovery.ReadWrite.All |
Not available. |
HTTP request
PATCH /security/cases/ediscoveryCases/{ediscoveryCaseId}/settings
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.
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/beta/security/cases/ediscoveryCases/{ediscoveryCaseId}/settings
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.security.ediscoveryCaseSettings",
"redundancyDetection": {
"@odata.type": "microsoft.graph.security.redundancyDetectionSettings"
},
"topicModeling": {
"@odata.type": "microsoft.graph.security.topicModelingSettings"
},
"ocr": {
"@odata.type": "microsoft.graph.security.ocrSettings"
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.Security;
var requestBody = new EdiscoveryCaseSettings
{
OdataType = "#microsoft.graph.security.ediscoveryCaseSettings",
RedundancyDetection = new RedundancyDetectionSettings
{
OdataType = "microsoft.graph.security.redundancyDetectionSettings",
},
TopicModeling = new TopicModelingSettings
{
OdataType = "microsoft.graph.security.topicModelingSettings",
},
Ocr = new OcrSettings
{
OdataType = "microsoft.graph.security.ocrSettings",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Cases.EdiscoveryCases["{ediscoveryCase-id}"].Settings.PatchAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
//other-imports
)
requestBody := graphmodelssecurity.NewEdiscoveryCaseSettings()
redundancyDetection := graphmodelssecurity.NewRedundancyDetectionSettings()
requestBody.SetRedundancyDetection(redundancyDetection)
topicModeling := graphmodelssecurity.NewTopicModelingSettings()
requestBody.SetTopicModeling(topicModeling)
ocr := graphmodelssecurity.NewOcrSettings()
requestBody.SetOcr(ocr)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
settings, err := graphClient.Security().Cases().EdiscoveryCases().ByEdiscoveryCaseId("ediscoveryCase-id").Settings().Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.models.security.EdiscoveryCaseSettings ediscoveryCaseSettings = new com.microsoft.graph.beta.models.security.EdiscoveryCaseSettings();
ediscoveryCaseSettings.setOdataType("#microsoft.graph.security.ediscoveryCaseSettings");
com.microsoft.graph.beta.models.security.RedundancyDetectionSettings redundancyDetection = new com.microsoft.graph.beta.models.security.RedundancyDetectionSettings();
redundancyDetection.setOdataType("microsoft.graph.security.redundancyDetectionSettings");
ediscoveryCaseSettings.setRedundancyDetection(redundancyDetection);
com.microsoft.graph.beta.models.security.TopicModelingSettings topicModeling = new com.microsoft.graph.beta.models.security.TopicModelingSettings();
topicModeling.setOdataType("microsoft.graph.security.topicModelingSettings");
ediscoveryCaseSettings.setTopicModeling(topicModeling);
com.microsoft.graph.beta.models.security.OcrSettings ocr = new com.microsoft.graph.beta.models.security.OcrSettings();
ocr.setOdataType("microsoft.graph.security.ocrSettings");
ediscoveryCaseSettings.setOcr(ocr);
com.microsoft.graph.models.security.EdiscoveryCaseSettings result = graphClient.security().cases().ediscoveryCases().byEdiscoveryCaseId("{ediscoveryCase-id}").settings().patch(ediscoveryCaseSettings);
const options = {
authProvider,
};
const client = Client.init(options);
const ediscoveryCaseSettings = {
'@odata.type': '#microsoft.graph.security.ediscoveryCaseSettings',
redundancyDetection: {
'@odata.type': 'microsoft.graph.security.redundancyDetectionSettings'
},
topicModeling: {
'@odata.type': 'microsoft.graph.security.topicModelingSettings'
},
ocr: {
'@odata.type': 'microsoft.graph.security.ocrSettings'
}
};
await client.api('/security/cases/ediscoveryCases/{ediscoveryCaseId}/settings')
.version('beta')
.update(ediscoveryCaseSettings);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Security\EdiscoveryCaseSettings;
use Microsoft\Graph\Beta\Generated\Models\Security\RedundancyDetectionSettings;
use Microsoft\Graph\Beta\Generated\Models\Security\TopicModelingSettings;
use Microsoft\Graph\Beta\Generated\Models\Security\OcrSettings;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new EdiscoveryCaseSettings();
$requestBody->setOdataType('#microsoft.graph.security.ediscoveryCaseSettings');
$redundancyDetection = new RedundancyDetectionSettings();
$redundancyDetection->setOdataType('microsoft.graph.security.redundancyDetectionSettings');
$requestBody->setRedundancyDetection($redundancyDetection);
$topicModeling = new TopicModelingSettings();
$topicModeling->setOdataType('microsoft.graph.security.topicModelingSettings');
$requestBody->setTopicModeling($topicModeling);
$ocr = new OcrSettings();
$ocr->setOdataType('microsoft.graph.security.ocrSettings');
$requestBody->setOcr($ocr);
$result = $graphServiceClient->security()->cases()->ediscoveryCases()->byEdiscoveryCaseId('ediscoveryCase-id')->settings()->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Security
$params = @{
"@odata.type" = "#microsoft.graph.security.ediscoveryCaseSettings"
redundancyDetection = @{
"@odata.type" = "microsoft.graph.security.redundancyDetectionSettings"
}
topicModeling = @{
"@odata.type" = "microsoft.graph.security.topicModelingSettings"
}
ocr = @{
"@odata.type" = "microsoft.graph.security.ocrSettings"
}
}
Update-MgBetaSecurityCaseEdiscoveryCaseSetting -EdiscoveryCaseId $ediscoveryCaseId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.security.ediscovery_case_settings import EdiscoveryCaseSettings
from msgraph_beta.generated.models.security.redundancy_detection_settings import RedundancyDetectionSettings
from msgraph_beta.generated.models.security.topic_modeling_settings import TopicModelingSettings
from msgraph_beta.generated.models.security.ocr_settings import OcrSettings
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EdiscoveryCaseSettings(
odata_type = "#microsoft.graph.security.ediscoveryCaseSettings",
redundancy_detection = RedundancyDetectionSettings(
odata_type = "microsoft.graph.security.redundancyDetectionSettings",
),
topic_modeling = TopicModelingSettings(
odata_type = "microsoft.graph.security.topicModelingSettings",
),
ocr = OcrSettings(
odata_type = "microsoft.graph.security.ocrSettings",
),
)
result = await graph_client.security.cases.ediscovery_cases.by_ediscovery_case_id('ediscoveryCase-id').settings.patch(request_body)
Response
The following example shows the response.
HTTP/1.1 204 No Content