domaine : forceDelete

Article
10/26/2024

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Supprimez un domaine à l’aide d’une opération asynchrone.

Avant d’effectuer cette opération, vous devez mettre à jour ou supprimer toutes les références à Exchange en tant que service d’approvisionnement.

Les actions suivantes sont effectuées dans le cadre de cette opération :

Renomme l’UPN, EmailAddress et ProxyAddress des utilisateurs avec des références au domaine supprimé.
Renomme emailAddress des groupes avec des références au domaine supprimé.
Renomme l’identificateurUris des applications avec des références au domaine supprimé.
Si le nombre d’objets à renommer est supérieur à 1 000, une erreur est retournée.
Si l’une des applications à renommer est une application multilocataire, une erreur est retournée.

Une fois la suppression du domaine terminée, les opérations d’API pour le domaine supprimé retournent un code de réponse HTTP 404. Pour vérifier la suppression d’un domaine, vous pouvez effectuer un domaine get. Si le domaine a été supprimé avec succès, un code de réponse HTTP 404 est retourné dans la réponse.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Domain.ReadWrite.All	Non disponible.
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Domain.ReadWrite.All	Non disponible.

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. L’administrateur de noms de domaine est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

POST /domains/{id}/forceDelete

Pour l’{id}, spécifiez le domaine avec son nom de domaine complet.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json

Corps de la demande

Dans le corps de la demande, indiquez un objet JSON avec les paramètres suivants.

Paramètre	Type	Description
disableUserAccounts	Boolean	Option permettant de désactiver les comptes d’utilisateur renommés. Si un compte d’utilisateur est désactivé, l’utilisateur n’est pas autorisé à se connecter. `true` (par défaut) : les comptes d’utilisateur renommés dans le cadre de cette opération sont désactivés. `false` - Les comptes d’utilisateur renommés dans le cadre de cette opération ne sont pas désactivés.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK.

Exemple

Demande

POST https://graph.microsoft.com/beta/domains/contoso.com/forceDelete
Content-type: application/json

{
  "disableUserAccounts": true
}


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

// Dependencies
using Microsoft.Graph.Beta.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);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).



mgc-beta domains force-delete post --domain-id {domain-id} --body '{\
  "disableUserAccounts": true\
}\
'

Importante



// 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"
	  graphdomains "github.com/microsoftgraph/msgraph-beta-sdk-go/domains"
	  //other-imports
)

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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Domains().ByDomainId("domain-id").ForceDelete().Post(context.Background(), requestBody, nil)

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

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

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const forceDelete = {
  disableUserAccounts: true
};

await client.api('/domains/contoso.com/forceDelete')
	.version('beta')
	.post(forceDelete);

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Domains\Item\ForceDelete\ForceDeletePostRequestBody;


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

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

$graphServiceClient->domains()->byDomainId('domain-id')->forceDelete()->post($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	disableUserAccounts = $true
}

Invoke-MgBetaForceDomainDelete -DomainId $domainId -BodyParameter $params

Importante


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.domains.item.force_delete.force_delete_post_request_body import ForceDeletePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ForceDeletePostRequestBody(
	disable_user_accounts = True,
)

await graph_client.domains.by_domain_id('domain-id').force_delete.post(request_body)

Importante

Réponse

HTTP/1.1 200 OK

Partager via

domaine : forceDelete

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Ressources supplémentaires