创建 legalHold
本文内容
命名空间:microsoft.graph.ediscovery
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
创建新的 legalHold 对象。
此 API 可用于以下国家级云部署 。
全局服务
美国政府 L4
美国政府 L5 (DOD)
由世纪互联运营的中国
✅
❌
❌
❌
权限
要调用此 API,需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限 。
权限类型
权限(从最低特权到最高特权)
委派(工作或学校帐户)
eDiscovery.Read.All、eDiscovery.ReadWrite.All
委派(个人 Microsoft 帐户)
不支持。
应用程序
不支持。
HTTP 请求
POST /compliance/ediscovery/cases/{caseId}/legalHolds
名称
说明
Authorization
持有者 {token}。 必填。 详细了解 身份验证和授权 。
Content-Type
application/json. 必需。
请求正文
在请求正文中,提供 legalHold 对象的 JSON 表示形式。
下表列出了创建 legalHold 时所需的属性。
属性
类型
说明
displayName
String
法定保留的显示名称。
响应
如果成功,此方法在 201 Created
响应正文中返回响应代码和 microsoft.graph.ediscovery.legalHold 对象。
示例
请求
POST https://graph.microsoft.com/beta/compliance/ediscovery/cases/{caseId}/legalHolds
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.ediscovery.legalHold",
"description": "String",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"isEnabled": "Boolean",
"status": "String",
"contentQuery": "String",
"errors": [
"String"
],
"displayName": "String"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models.Ediscovery;
using Microsoft.Graph.Beta.Models;
var requestBody = new LegalHold
{
OdataType = "#microsoft.graph.ediscovery.legalHold",
Description = "String",
CreatedBy = new IdentitySet
{
OdataType = "microsoft.graph.identitySet",
},
IsEnabled = boolean,
Status = LegalHoldStatus.Pending,
ContentQuery = "String",
Errors = new List<string>
{
"String",
},
DisplayName = "String",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Compliance.Ediscovery.Cases["{case-id}"].LegalHolds.PostAsync(requestBody);
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta compliance ediscovery cases legal-holds create --case-id {case-id} --body '{\
"@odata.type": "#microsoft.graph.ediscovery.legalHold",\
"description": "String",\
"createdBy": {\
"@odata.type": "microsoft.graph.identitySet"\
},\
"isEnabled": "Boolean",\
"status": "String",\
"contentQuery": "String",\
"errors": [\
"String"\
],\
"displayName": "String"\
}\
'
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodelsediscovery "github.com/microsoftgraph/msgraph-beta-sdk-go/models/ediscovery"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestBody := graphmodelsediscovery.NewLegalHold()
description := "String"
requestBody.SetDescription(&description)
createdBy := graphmodels.NewIdentitySet()
requestBody.SetCreatedBy(createdBy)
isEnabled := boolean
requestBody.SetIsEnabled(&isEnabled)
status := graphmodels.STRING_LEGALHOLDSTATUS
requestBody.SetStatus(&status)
contentQuery := "String"
requestBody.SetContentQuery(&contentQuery)
errors := []string {
"String",
}
requestBody.SetErrors(errors)
displayName := "String"
requestBody.SetDisplayName(&displayName)
legalHolds, err := graphClient.Compliance().Ediscovery().Cases().ByCaseId("case-id").LegalHolds().Post(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.ediscovery.LegalHold legalHold = new com.microsoft.graph.beta.models.ediscovery.LegalHold();
legalHold.setOdataType("#microsoft.graph.ediscovery.legalHold");
legalHold.setDescription("String");
IdentitySet createdBy = new IdentitySet();
createdBy.setOdataType("microsoft.graph.identitySet");
legalHold.setCreatedBy(createdBy);
legalHold.setIsEnabled(boolean);
legalHold.setStatus(com.microsoft.graph.beta.models.ediscovery.LegalHoldStatus.Pending);
legalHold.setContentQuery("String");
LinkedList<String> errors = new LinkedList<String>();
errors.add("String");
legalHold.setErrors(errors);
legalHold.setDisplayName("String");
com.microsoft.graph.models.ediscovery.LegalHold result = graphClient.compliance().ediscovery().cases().byCaseId("{case-id}").legalHolds().post(legalHold);
const options = {
authProvider,
};
const client = Client.init(options);
const legalHold = {
'@odata.type': '#microsoft.graph.ediscovery.legalHold',
description: 'String',
createdBy: {
'@odata.type': 'microsoft.graph.identitySet'
},
isEnabled: 'Boolean',
status: 'String',
contentQuery: 'String',
errors: [
'String'
],
displayName: 'String'
};
await client.api('/compliance/ediscovery/cases/{caseId}/legalHolds')
.version('beta')
.post(legalHold);
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\LegalHold;
use Microsoft\Graph\Generated\Models\IdentitySet;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new LegalHold();
$requestBody->setOdataType('#microsoft.graph.ediscovery.legalHold');
$requestBody->setDescription('String');
$createdBy = new IdentitySet();
$createdBy->setOdataType('microsoft.graph.identitySet');
$requestBody->setCreatedBy($createdBy);
$requestBody->setIsEnabled(boolean);
$requestBody->setStatus(new LegalHoldStatus('string'));
$requestBody->setContentQuery('String');
$requestBody->setErrors(['String', ]);
$requestBody->setDisplayName('String');
$result = $graphServiceClient->compliance()->ediscovery()->cases()->byCaseId('case-id')->legalHolds()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Compliance
$params = @{
"@odata.type" = "#microsoft.graph.ediscovery.legalHold"
description = "String"
createdBy = @{
"@odata.type" = "microsoft.graph.identitySet"
}
isEnabled = "Boolean"
status = "String"
contentQuery = "String"
errors = @(
"String"
)
displayName = "String"
}
New-MgBetaComplianceEdiscoveryCaseLegalHold -CaseId $caseId -BodyParameter $params
from msgraph import GraphServiceClient
from msgraph.generated.models.legal_hold import LegalHold
from msgraph.generated.models.identity_set import IdentitySet
graph_client = GraphServiceClient(credentials, scopes)
request_body = LegalHold(
odata_type = "#microsoft.graph.ediscovery.legalHold",
description = "String",
created_by = IdentitySet(
odata_type = "microsoft.graph.identitySet",
),
is_enabled = Boolean,
status = LegalHoldStatus.Pending,
content_query = "String",
errors = [
"String",
],
display_name = "String",
)
result = await graph_client.compliance.ediscovery.cases.by_case_id('case-id').legal_holds.post(request_body)
响应
注意: 为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.ediscovery.legalHold",
"id": "700cd868-d868-700c-68d8-0c7068d80c70",
"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)"
}