Namespace: microsoft.graph.security
Exclua itens de caixa de correio do Exchange ou mensagens do Microsoft Teams contidas em uma pesquisa de Descoberta Eletrônica.
Você pode coletar e limpar as seguintes categorias de conteúdo do Teams:
-
Chats 1:1 do Teams - Mensagens de Chat, postagens e anexos compartilhados em uma conversa do Teams entre duas pessoas. Os chats 1:1 do Teams também são chamados de conversas.
-
Chats em grupo do Teams - Mensagens de Chat, postagens e anexos compartilhados em uma conversa do Teams entre três ou mais pessoas. Também chamado de chats 1:N ou conversas em grupo.
-
Canais do Teams - Mensagens de Chat, postagens, respostas e anexos compartilhados em um canal padrão do Teams.
-
Canais privados - Postagens de mensagens, respostas e anexos compartilhados em um canal privado do Teams.
-
Canais compartilhados - Postagens de mensagens, respostas e anexos compartilhados em um canal compartilhado do Teams.
Observação: Essa solicitação limpa no máximo 100 itens por local. Quando purgeType está definido como ou recoverablepermanentlyDelete e purgeAreas é definido como teamsMessages, as mensagens do Teams são excluídas permanentemente.
Para obter mais informações sobre como limpar mensagens do Teams, consulte:
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global |
Governo dos EUA L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
| Tipo de permissão |
Permissões menos privilegiadas |
Permissões com privilégios mais elevados |
| Delegado (conta corporativa ou de estudante) |
eDiscovery.ReadWrite.All |
Indisponível. |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Application |
eDiscovery.ReadWrite.All |
Indisponível. |
Importante
Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função com suporte do Microsoft Purview por meio de uma das seguintes opções:
-
Gestão da Organização. Permite que os membros executem a remoção em massa de dados que correspondam aos critérios de uma pesquisa.
Essa é a opção menos privilegiada para limpeza de dados.
A função Pesquisar e Limpar é necessária para excluir permanentemente as mensagens de email que correspondam aos critérios de pesquisa. Essa função está disponível apenas para membros do grupo de funções Gerenciamento da Organização e deve ser usada com extremo cuidado, pois os dados excluídos não podem ser recuperados.
Para obter mais informações sobre permissões e funções da Descoberta Eletrônica, consulte Atribuir permissões na Descoberta Eletrônica.
Solicitação HTTP
POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySearchId}/purgeData
Corpo da solicitação
No corpo da solicitação, forneça uma representação JSON dos parâmetros.
A tabela a seguir mostra os parâmetros que você pode usar com essa ação.
| Parâmetro |
Tipo |
Descrição |
| purgeAreas |
microsoft.graph.security.purgeAreas |
Opção para definir os locais a serem incluídos no escopo da ação de limpeza. Os valores possíveis são: mailboxes, teamsMessages, unknownFutureValue. |
| purgeType |
microsoft.graph.security.purgeType |
Opções que controlam se a ação é exclusão reversível ou exclusão irreversível. Os valores possíveis são: recoverable, unknownFutureValue, permanentlyDelete. |
Resposta
Se tiver êxito, esta ação retornará um código de resposta 202 Accepted.
Se a operação de limpeza de dados for iniciada com êxito, essa ação retornará um código de 202 Accepted resposta. A resposta também contém um Location cabeçalho, que contém o local da operação Limpar dados que foi criada para confirmar a limpeza. Para marcar o status da operação de limpeza de dados, faça uma solicitação GET para a URL de localização.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
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);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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);
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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();
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
Import-Module Microsoft.Graph.Security
$params = @{
purgeType = "recoverable"
purgeAreas = "teamsMessages"
}
Clear-MgSecurityCaseEdiscoveryCaseSearchData -EdiscoveryCaseId $ediscoveryCaseId -EdiscoverySearchId $ediscoverySearchId -BodyParameter $params
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do 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)
Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 202 Accepted