Obtenir un domaine

Article
04/09/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 .

Récupérer les propriétés et les relations de l’objet de domaine.

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.Read.All	Domain.ReadWrite.All, Directory.Read.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Domain.Read.All	Domain.ReadWrite.All, Directory.Read.All

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. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération.

Administrateur d’utilisateurs
Administrateur du support technique
Administrateur du service de prise en charge
Administrateur de facturation
Administrateur de boîtes aux lettres
Lecteurs d’annuaire
Rédacteurs d'annuaires
Administrateur de licence AdHoc
Administrateur de l'application
Lecteur de sécurité
Administrateur de sécurité
Administrateur de rôle privilégié
Administrateur de l'application cloud
Approbateur d’accès Customer LockBox
administrateur Dynamics 365
Administrateur Power BI
Administrateur Information Protection Azure
administrateur Analytique de bureau
Administrateur de licences
Administrateur Microsoft Managed Desktop
Administrateur d’authentification privilégié
Administrateur des communications Teams
Ingénieur de support des communications Teams
Administrateur d’authentification
Spécialiste du support des communications Teams
Administrateur Teams
Administrateur d’informations
Administrateur de conformité des données
Opérateur de sécurité
Administrateur Kaizala
Lecteur général
Utilisateur du Centre de gestion des licences en volume
Utilisateur du Centre de gestion des licences en volume
Administrateur de commerce moderne
utilisateur Microsoft Store pour Entreprises
Réviseur d’annuaire
Administrateur de noms de domaine
Utilisateurs
Utilisateur invité
Utilisateur invité restreint

Requête HTTP

GET /domains/{id}

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

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.

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

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse et un 200 OK objet de domaine dans le corps de la réponse.

Exemple

Demande

GET https://graph.microsoft.com/beta/domains/woodgrovedemo.com


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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Domains["{domain-id}"].GetAsync();

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 get --domain-id {domain-id}

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"
	  //other-imports
)


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

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Domain result = graphClient.domains().byDomainId("{domain-id}").get();

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

let domain = await client.api('/domains/woodgrovedemo.com')
	.version('beta')
	.get();

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


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


$result = $graphServiceClient->domains()->byDomainId('domain-id')->get()->wait();

Importante


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

Get-MgBetaDomain -DomainId $domainId

Importante


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.domains.by_domain_id('domain-id').get()

Importante

Réponse

Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#domains/$entity",
    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET domains('<key>')?$select=authenticationType,availabilityStatus",
    "authenticationType": "Managed",
    "availabilityStatus": null,
    "id": "woodgrovedemo.com",
    "isAdminManaged": true,
    "isDefault": true,
    "isInitial": true,
    "isRoot": true,
    "isVerified": true,
    "supportedServices": [
        "Email",
        "OfficeCommunicationsOnline",
        "CustomUrlDomain"
    ],
    "passwordValidityPeriodInDays": 2147483647,
    "passwordNotificationWindowInDays": 14,
    "state": null
}

Partager via

Obtenir un domaine

Autorisations

Requête HTTP

Paramètres facultatifs de la requête

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Ressources supplémentaires