命名空间：microsoft.graph.security
删除电子 数据展示搜索中包含的 Exchange 邮箱项目或Microsoft Teams 邮件。
可以收集和清除以下类别的 Teams 内容：
-
Teams 1：1 聊天 - 在两个人之间的 Teams 对话中共享的聊天消息、帖子和附件。 Teams 1：1 聊天也称为 对话。
-
Teams 群组聊天 - 三个或更多人之间在 Teams 对话中共享的聊天消息、帖子和附件。 也称为 1：N 聊天或 组对话。
-
Teams 频道 - 在标准 Teams 频道中共享的聊天消息、帖子、回复和附件。
-
私人频道 - 在专用 Teams 频道中共享的消息帖子、回复和附件。
-
共享频道 - 共享 Teams 频道中共享的消息帖子、回复和附件。
注意： 此请求最多为每个位置清除 100 个项目。 当 purgeType 设置为 recoverable 或 permanentlyDelete 且 purgeAreas 设置为 teamsMessages时，Teams 消息将永久删除。
有关清除 Teams 消息的详细信息，请参阅：
此 API 可用于以下国家级云部署。
| 全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
| ✅ |
✅ |
✅ |
❌ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。
| 权限类型 |
最低特权权限 |
更高特权权限 |
| 委派（工作或学校帐户） |
eDiscovery.ReadWrite.All |
不可用。 |
| 委派（个人 Microsoft 帐户） |
不支持。 |
不支持。 |
| 应用程序 |
eDiscovery.ReadWrite.All |
不可用。 |
HTTP 请求
POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySearchId}/purgeData
| 名称 |
说明 |
| Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
在请求正文中，提供参数的 JSON 表示形式。
下表显示了可用于此作的参数。
| 参数 |
类型 |
说明 |
| purgeAreas |
microsoft.graph.security.purgeAreas |
用于定义清除作范围内的位置的选项。 可能的值包括 mailboxes、teamsMessages、unknownFutureValue。 |
| purgeType |
microsoft.graph.security.purgeType |
用于控制作是软删除还是硬删除的选项。 可能的值包括 recoverable、unknownFutureValue、permanentlyDelete。 |
响应
如果成功，此操作返回 202 Accepted 响应代码。
如果清除数据作成功启动，此作将 202 Accepted 返回响应代码。 响应还包含一个 Location 标头，该标头包含为提交清除而创建的 清除数据作 的位置。 若要检查清除数据作的状态，请向位置 URL 发出 GET 请求。
示例
请求
以下示例显示了一个请求。
POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/searches/c61a5860-d634-4d14-aea7-d82b6f4eb7af/purgeData
{
"purgeType": "recoverable",
"purgeAreas": "teamsMessages"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Security.Cases.EdiscoveryCases.Item.Searches.Item.MicrosoftGraphSecurityPurgeData;
using Microsoft.Graph.Models.Security;
var requestBody = new PurgeDataPostRequestBody
{
PurgeType = PurgeType.Recoverable,
PurgeAreas = PurgeAreas.TeamsMessages,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Security.Cases.EdiscoveryCases["{ediscoveryCase-id}"].Searches["{ediscoverySearch-id}"].MicrosoftGraphSecurityPurgeData.PostAsync(requestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphsecurity "github.com/microsoftgraph/msgraph-sdk-go/security"
graphmodelssecurity "github.com/microsoftgraph/msgraph-sdk-go/models/security"
//other-imports
)
requestBody := graphsecurity.NewPurgeDataPostRequestBody()
purgeType := graphmodels.RECOVERABLE_PURGETYPE
requestBody.SetPurgeType(&purgeType)
purgeAreas := graphmodels.TEAMSMESSAGES_PURGEAREAS
requestBody.SetPurgeAreas(&purgeAreas)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Security().Cases().EdiscoveryCases().ByEdiscoveryCaseId("ediscoveryCase-id").Searches().ByEdiscoverySearchId("ediscoverySearch-id").MicrosoftGraphSecurityPurgeData().Post(context.Background(), requestBody, nil)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.security.cases.ediscoverycases.item.searches.item.microsoftgraphsecuritypurgedata.PurgeDataPostRequestBody purgeDataPostRequestBody = new com.microsoft.graph.security.cases.ediscoverycases.item.searches.item.microsoftgraphsecuritypurgedata.PurgeDataPostRequestBody();
purgeDataPostRequestBody.setPurgeType(com.microsoft.graph.models.security.PurgeType.Recoverable);
purgeDataPostRequestBody.setPurgeAreas(EnumSet.of(com.microsoft.graph.models.security.PurgeAreas.TeamsMessages));
graphClient.security().cases().ediscoveryCases().byEdiscoveryCaseId("{ediscoveryCase-id}").searches().byEdiscoverySearchId("{ediscoverySearch-id}").microsoftGraphSecurityPurgeData().post(purgeDataPostRequestBody);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
const options = {
authProvider,
};
const client = Client.init(options);
const purgeData = {
purgeType: 'recoverable',
purgeAreas: 'teamsMessages'
};
await client.api('/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/searches/c61a5860-d634-4d14-aea7-d82b6f4eb7af/purgeData')
.post(purgeData);
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Security\Cases\EdiscoveryCases\Item\Searches\Item\MicrosoftGraphSecurityPurgeData\PurgeDataPostRequestBody;
use Microsoft\Graph\Generated\Models\Security\PurgeType;
use Microsoft\Graph\Generated\Models\Security\PurgeAreas;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PurgeDataPostRequestBody();
$requestBody->setPurgeType(new PurgeType('recoverable'));
$requestBody->setPurgeAreas(new PurgeAreas('teamsMessages'));
$graphServiceClient->security()->cases()->ediscoveryCases()->byEdiscoveryCaseId('ediscoveryCase-id')->searches()->byEdiscoverySearchId('ediscoverySearch-id')->microsoftGraphSecurityPurgeData()->post($requestBody)->wait();
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
Import-Module Microsoft.Graph.Security
$params = @{
purgeType = "recoverable"
purgeAreas = "teamsMessages"
}
Clear-MgSecurityCaseEdiscoveryCaseSearchData -EdiscoveryCaseId $ediscoveryCaseId -EdiscoverySearchId $ediscoverySearchId -BodyParameter $params
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.security.cases.ediscoverycases.item.searches.item.microsoft_graph_security_purge_data.purge_data_post_request_body import PurgeDataPostRequestBody
from msgraph.generated.models.purge_type import PurgeType
from msgraph.generated.models.purge_areas import PurgeAreas
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PurgeDataPostRequestBody(
purge_type = PurgeType.Recoverable,
purge_areas = PurgeAreas.TeamsMessages,
)
await graph_client.security.cases.ediscovery_cases.by_ediscovery_case_id('ediscoveryCase-id').searches.by_ediscovery_search_id('ediscoverySearch-id').microsoft_graph_security_purge_data.post(request_body)
有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。
响应
以下示例显示了相应的响应。
HTTP/1.1 202 Accepted