domínio: forceDelete

Namespace: microsoft.graph

Exclua um domínio usando uma operação de longa execução assíncrona.

Antes de executar essa operação, você deve atualizar ou remover quaisquer referências ao Exchange como o serviço de provisionamento.

As seguintes ações são executadas como parte desta operação:

• Atualizações as userPrincipalNamepropriedades , maile proxyAddresses de users com referências ao domínio excluído para usar o domínio onmicrosoft.com inicial.

• Atualizações a mail propriedade de groups com referências ao domínio excluído para usar o domínio onmicrosoft.com inicial.

• Atualizações a identifierUris propriedade de applications com referências ao domínio excluído para usar o domínio onmicrosoft.com inicial.

• Se o número de objetos a serem renomeado for maior que 1000, um erro será retornado.

• Se um dos applications a ser renomeado for um aplicativo multilocatário, um erro será retornado.

Após a conclusão da exclusão de domínio, as operações de API para o domínio excluído retornam um código HTTP 404 status. Para verificar a exclusão de um domínio, você pode executar uma operação de domínio get .

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	Domain.ReadWrite.All	Indisponível.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Aplicativo	Domain.ReadWrite.All	Indisponível.

A conta de trabalho ou de estudante precisa pertencer ao menos à função Administrador de Nomes de DomínioMicrosoft Entra.

Solicitação HTTP

POST /domains/{id}/forceDelete

Para {id}, especifique o domínio com seu nome de domínio totalmente qualificado.

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json

Corpo da solicitação

Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.

Parâmetro	Tipo	Descrição
disableUserAccounts	Boolean	Opção para desabilitar contas de usuário renomeados. Se uma conta de usuário estiver desabilitada, o usuário não poderá entrar. Se definido como true usuários atualizados como parte dessa operação, serão desabilitados. O valor padrão é true.

Corpo da resposta

Se for bem-sucedido, esse método retornará HTTP/1.1 204 OK status código.

Exemplo

Solicitação

HTTP

POST https://graph.microsoft.com/v1.0/domains/{id}/forceDelete
Content-type: application/json

{
  "disableUserAccounts": true
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Domains.Item.ForceDelete;

var requestBody = new ForceDeletePostRequestBody
{
	DisableUserAccounts = true,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Domains["{domain-id}"].ForceDelete.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.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc domains force-delete post --domain-id {domain-id} --body '{\
  "disableUserAccounts": true\
}\
'

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphdomains "github.com/microsoftgraph/msgraph-sdk-go/domains"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphdomains.NewForceDeletePostRequestBody()
disableUserAccounts := true
requestBody.SetDisableUserAccounts(&disableUserAccounts) 

graphClient.Domains().ByDomainId("domain-id").ForceDelete().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.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.domains.item.forcedelete.ForceDeletePostRequestBody forceDeletePostRequestBody = new com.microsoft.graph.domains.item.forcedelete.ForceDeletePostRequestBody();
forceDeletePostRequestBody.setDisableUserAccounts(true);
graphClient.domains().byDomainId("{domain-id}").forceDelete().post(forceDeletePostRequestBody);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const forceDelete = {
  disableUserAccounts: true
};

await client.api('/domains/{id}/forceDelete')
	.post(forceDelete);

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\ForceDeletePostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new ForceDeletePostRequestBody();
$requestBody->setDisableUserAccounts(true);

$graphServiceClient->domains()->byDomainId('domain-id')->forceDelete()->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.

PowerShell

Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
	disableUserAccounts = $true
}

Invoke-MgForceDomainDelete -DomainId $domainId -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.

Python

from msgraph import GraphServiceClient
from msgraph.generated.domains.item.force_delete.force_delete_post_request_body import ForceDeletePostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = ForceDeletePostRequestBody(
	disable_user_accounts = True,
)

await graph_client.domains.by_domain_id('domain-id').force_delete.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

HTTP/1.1 204 OK