type de ressource de domaine
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 .
Représente un domaine associé au locataire.
Utilisez les opérations de domaine pour associer des domaines à un locataire, vérifier la propriété du domaine et configurer les services pris en charge. Utilisez les opérations de domaine pour associer des domaines à un locataire, vérifier la propriété du domaine et configurer les services pris en charge. La vérification d’un domaine via Microsoft Graph ne configure pas le domaine à utiliser avec Office 365 services comme Exchange. La configuration complète du domaine pour qu’il fonctionne avec les produits Microsoft 365 peut nécessiter des étapes supplémentaires. Pour plus d’informations, consultez Configuration de l’administrateur Microsoft 365.
Pour associer un domaine à un locataire :
Associer un domaine à un locataire.
Récupérez les enregistrements de vérification de domaine. Ajoutez les détails de l’enregistrement de vérification au fichier de zone du domaine à l’aide du bureau d’enregistrement de domaines ou de la configuration du serveur DNS (Domain Name System).
Vérifiez la propriété du domaine et définissez la propriété isVerified sur
true.Indiquez les services pris en charge que vous prévoyez d’utiliser avec le domaine.
Configurez les services pris en charge en récupérant une liste d’enregistrements nécessaires pour activer les services pour le domaine. Ajoutez les détails de l’enregistrement de configuration au fichier de zone du domaine à l’aide du bureau d’enregistrement de domaines ou de la configuration du serveur DNS.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| List | domain | Récupérer tous les domaines liés au locataire. |
| Create | domain | Ajoutez un domaine au locataire. |
| Obtenir | domain | Lit les propriétés et les relations d’un objet de domaine. |
| Mettre à jour | domain | Mettre à jour un domaine. |
| Supprimer | Aucun | Supprimer un domaine. |
| Forcer la suppression | Aucun | Supprimez un domaine à l’aide d’une opération asynchrone. |
| Vérifier | domain | Valider la propriété du domaine. |
| Promote | Boolean | Promouvoir un sous-domaine vérifié dans le domaine racine. |
| Obtenir le domaine racine | Obtient le domaine racine d’un sous-domaine. | |
| Répertorier les références de nom de domaine | collection directoryObject | Récupérez une liste d’objets d’annuaire avec une référence au domaine. |
| Répertorier les enregistrements de configuration de service | collection domainDnsRecord | Récupérez une liste d’enregistrements DNS de domaine pour la configuration du domaine. |
| Répertorier les enregistrements DNS de vérification | collection domainDnsRecord | Récupérez une liste d’enregistrements DNS de domaine pour la vérification du domaine. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| authenticationType | String | Indique le type d’authentification configuré pour le domaine. La valeur est ou ManagedFederated.
Managedindique un domaine géré dans le cloud où Microsoft Entra ID effectue l’authentification utilisateur.
Federatedindique que l’authentification est fédérée avec un fournisseur d’identité tel que le Active Directory local du locataire via Services ADFS. Ne pouvant accepter la valeur null. Pour mettre à jour cette propriété dans les scénarios délégués, l’application appelante doit se voir attribuer l’autorisation déléguée Directory.AccessAsUser.All . |
| availabilityStatus | String | Cette propriété est toujours null utilisée, sauf lorsque l’action de vérification est utilisée. Lorsque l’action de vérification est utilisée, une entité de domaine est retournée dans la réponse. La propriété availabilityStatus de l’entité de domaine dans la réponse est ou AvailableImmediatelyEmailVerifiedDomainTakeoverScheduled. |
| id | String | Nom complet du domaine. Clé, immuable, non nullable, unique. |
| isAdminManaged | Boolean | La valeur de la propriété est false si la gestion des enregistrements DNS du domaine est déléguée à Microsoft 365. Sinon, la valeur est true. Ne pouvant accepter la valeur null. |
| isDefault | Boolean |
true pour le domaine par défaut utilisé pour la création d’utilisateurs. Il n’existe qu’un seul domaine par défaut par entreprise. Ne pouvant accepter la valeur null. |
| isInitial | Boolean |
true pour le domaine initial créé par Microsoft Online Services. Par exemple : contoso.onmicrosoft.com. Il n’y a qu’un seul domaine initial par entreprise. Ne pouvant accepter la valeur null. |
| isRoot | Boolean |
true si le domaine est un domaine racine vérifié. Sinon, false si le domaine est un sous-domaine ou non vérifié. Ne pouvant accepter la valeur null. |
| isVerified | Boolean |
true pour les domaines vérifiés. Ne pouvant accepter la valeur null. |
| passwordNotificationWindowInDays | Int32 | Spécifie le nombre de jours avant qu’un utilisateur ne reçoive une notification d’expiration de mot de passe. 14 jours par défaut. |
| passwordValidityPeriodInDays | Int32 | Spécifie la durée pendant laquelle un mot de passe est valide avant qu’il ne soit modifié. 90 jours par défaut. |
| supportedServices | String collection | Fonctionnalités affectées au domaine. Peut inclure 0, 1, ou plusieurs des valeurs suivantes : Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline,SharePointDefaultDomainFullRedelegation , SharePointPublic, OrgIdAuthentication, Yammer, , , Intune. CustomUrlDomain Les valeurs que vous pouvez ajouter ou supprimer à l’aide de l’API sont les suivantes : Email, OfficeCommunicationsOnline, Yammeret CustomUrlDomain. Ne pouvant accepter la valeur null. Pour plus d’informations sur CustomUrlDomain, consultez Domaines d’URL personnalisés dans les locataires externes. |
| state | domainState | État des opérations asynchrones planifiées pour le domaine. |
Relations
Les relations entre un domaine et d’autres objets dans le répertoire, tels que ses enregistrements de vérification et ses enregistrements de configuration de service, sont exposées via les propriétés de navigation. Vous pouvez lire ces relations en ciblant ces propriétés de navigation dans vos requêtes.
| Relation | Type | Description |
|---|---|---|
| domainNameReferences | collection directoryObject | Objets tels que les utilisateurs et les groupes qui référencent l’ID de domaine. En lecture seule, nullable. Ne prend pas en charge $expand. Prise en charge $filter par le type OData d’objets retournés. Par exemple, /domains/{domainId}/domainNameReferences/microsoft.graph.user et /domains/{domainId}/domainNameReferences/microsoft.graph.group. |
| serviceConfigurationRecords | collection domainDnsRecord | Les enregistrements DNS que le client ajoute au fichier de zone DNS du domaine avant que le domaine puisse être utilisé par les services Microsoft Online. En lecture seule, nullable. Ne prend pas en charge $expand. |
| verificationDnsRecords | collection domainDnsRecord | Enregistrements DNS que le client ajoute au fichier de zone DNS du domaine avant que le client ne puisse effectuer la vérification de la propriété du domaine avec Microsoft Entra ID. En lecture seule, nullable. Ne prend pas en charge $expand. |
| federationConfiguration | internalDomainFederation | Paramètres de domaine configurés par le client lorsqu’ils sont fédérés avec Microsoft Entra ID. Ne prend pas en charge $expand. |
| rootDomain | domain | Domaine racine d’un sous-domaine. En lecture seule, nullable. Prend en charge $expand. |
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"authenticationType": "String",
"availabilityStatus": "String",
"id": "String (identifier)",
"isAdminManaged": true,
"isDefault": true,
"isInitial": true,
"isRoot": true,
"isVerified": true,
"passwordNotificationWindowInDays": 14,
"passwordValidityPeriodInDays": 90,
"state": {"@odata.type": "microsoft.graph.domainState"},
"supportedServices": ["String"]
}