Domänenressourcentyp
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Stellt eine Domäne dar, die dem Mandanten zugeordnet ist.
Verwenden Sie Domänenvorgänge, um domänen einem Mandanten zuzuordnen, den Domänenbesitz zu überprüfen und unterstützte Dienste zu konfigurieren. Domänenvorgänge ermöglichen Es Registrierungsstellen, die Domänenzuordnung für Dienste wie Microsoft 365 zu automatisieren. Beispielsweise kann eine Registrierungsstelle im Rahmen der Domänenregistrierung eine Vanity-Domäne für E-Mails, Websites, Authentifizierung usw. aktivieren.
So ordnen Sie eine Domäne einem Mandanten zu:
Zuordnen einer Domäne zu einem Mandanten.
Rufen Sie die Domänenüberprüfungsdatensätze ab. Fügen Sie die Details des Überprüfungsdatensatzes mithilfe der Domänenregistrierungsstelle oder DNS-Serverkonfiguration zur Zonendatei der Domäne hinzu.
Überprüfen Sie den Besitz der Domäne. Dadurch wird die Domäne überprüft und die isVerified-Eigenschaft auf
true
festgelegt.Geben Sie die unterstützten Dienste an, die Sie mit der Domäne verwenden möchten.
Konfigurieren Sie unterstützte Dienste, indem Sie eine Liste der Datensätze abrufen, die zum Aktivieren von Diensten für die Domäne erforderlich sind. Fügen Sie die Details des Konfigurationsdatensatzes mithilfe der Domänenregistrierungsstelle oder dns-Serverkonfiguration zur Zonendatei der Domäne hinzu.
Methoden
Methode | Rückgabetyp | Beschreibung |
---|---|---|
Domäne abrufen | domain | Liest Eigenschaften und Beziehungen eines Domänenobjekts. |
Domäne erstellen | domain | Fügt eine Domäne zum Mandanten hinzu. |
Domäne auflisten | domain | Rufen Sie alle Domänen ab, die mit dem Mandanten verknüpft sind. |
DomainNameReference auflisten | directoryObject collection | Rufen Sie eine Liste von Verzeichnisobjekten mit einem Verweis auf die Domäne ab. |
Auflisten von serviceConfigurationRecords | domainDnsRecord-Sammlung | Rufen Sie eine Liste der DNS-Domäneneinträge für die Domänenkonfiguration ab. |
Auflisten von verificationDnsRecords | domainDnsRecord-Sammlung | Rufen Sie eine Liste der DNS-Domäneneinträge für die Domänenüberprüfung ab. |
Domäne aktualisieren | domain | Updates einer Domäne. |
Domäne löschen | Keine | Löscht eine Domäne. |
ForceDelete-Domäne | Keine | Löscht eine Domäne mithilfe eines asynchronen Vorgangs. |
Überprüfen der Domäne | domain | Überprüft den Besitz der Domäne. |
Domäne heraufstufen | Boolesch | Erhöhen Sie eine verifizierte Subdomäne zur Root-Domäne. |
Eigenschaften
Eigenschaft | Typ | Beschreibung |
---|---|---|
Authenticationtype | String | Gibt den konfigurierten Authentifizierungstyp für die Domäne an. Der Wert ist entweder Managed oder Federated . Managed gibt eine in der Cloud verwaltete Domäne an, in der Microsoft Entra ID die Benutzerauthentifizierung durchführt. Federated gibt an, dass die Authentifizierung mit einem Identitätsanbieter verbunden ist, z. B. dem lokales Active Directory des Mandanten über Active Directory-Verbunddienste (AD FS). Lässt keine NULL-Werte zu. Um diese Eigenschaft in delegierten Szenarien zu aktualisieren, muss der aufrufenden App die delegierte Berechtigung Directory.AccessAsUser.All zugewiesen werden. |
availabilityStatus | String | Diese Eigenschaft gilt immer null , außer wenn die Überprüfungsaktion verwendet wird. Wenn die Überprüfungsaktion verwendet wird, wird in der Antwort eine Domänenentität zurückgegeben. Die availabilityStatus-Eigenschaft der Domänenentität in der Antwort ist entweder AvailableImmediately oder EmailVerifiedDomainTakeoverScheduled . |
id | String | Der vollqualifizierte Name der Domäne. Schlüssel, unveränderlich, nullable, eindeutig. |
isAdminManaged | Boolesch | Der Wert der -Eigenschaft ist false , wenn die DNS-Eintragsverwaltung der Domäne an Microsoft 365 delegiert wird. Andernfalls ist true der Wert . Nullwerte nicht zulassen |
isDefault | Boolesch | true , wenn dies die Standarddomäne ist, die für die Benutzererstellung verwendet wird. Es gibt nur eine Standarddomäne pro Unternehmen. Nullwerte nicht zulassen |
isInitial | Boolesch | true , wenn dies die ursprüngliche Domäne ist, die von Microsoft Online Services (contoso.com) erstellt wurde. Es gibt nur eine anfängliche Domäne pro Unternehmen. Nullwerte nicht zulassen |
isRoot | Boolesch | true , wenn die Domäne eine überprüfte Stammdomäne ist. Andernfalls, false wenn die Domäne eine Unterdomäne oder nicht überprüft ist. Nullwerte nicht zulassen |
isVerified | Boolesch | true , wenn die Domäne die Überprüfung des Domänenbesitzes abgeschlossen hat. Nullwerte nicht zulassen |
passwordNotificationWindowInDays | Int32 | Gibt die Anzahl der Tage an, bevor ein Benutzer eine Benachrichtigung erhält, dass sein Kennwort abläuft. Wenn die Eigenschaft nicht festgelegt ist, wird ein Standardwert von 14 Tagen verwendet. |
passwordValidityPeriodInDays | Int32 | Gibt an, wie lange ein Kennwort gültig ist, bevor es geändert werden muss. Wenn die Eigenschaft nicht festgelegt ist, wird ein Standardwert von 90 Tagen verwendet. |
supportedServices | String collection | Die der Domäne zugewiesenen Funktionen. Kann , oder mehrere der folgenden Werte enthalten0 : Email , Sharepoint , EmailInternalRelayOnly , OfficeCommunicationsOnline SharePointDefaultDomain FullRedelegation SharePointPublic , OrgIdAuthentication Yammer , , . Intune 1 Die Werte, die Sie mithilfe der API hinzufügen oder entfernen können, sind: Email , OfficeCommunicationsOnline , Yammer . Lässt keine NULL-Werte zu. |
state | domainState | Status der für die Domäne geplanten asynchronen Vorgänge. |
Beziehungen
Beziehungen zwischen einer Domäne und anderen Objekten im Verzeichnis, z. B. deren Überprüfungsdatensätze und Dienstkonfigurationsdatensätze, werden über Navigationseigenschaften verfügbar gemacht. Sie können diese Beziehungen lesen, indem Sie diese Navigationseigenschaften in Ihren Anforderungen als Ziel festlegen.
Beziehung | Typ | Beschreibung |
---|---|---|
domainNameReferences | directoryObject collection | Die Objekte, z. B. Benutzer und Gruppen, die auf die Domänen-ID verweisen. Schreibgeschützt, Nullable. Unterstützt $expand und $filter vom OData-Typ der zurückgegebenen Objekte. Beispiel: /domains/{domainId}/domainNameReferences/microsoft.graph.user und /domains/{domainId}/domainNameReferences/microsoft.graph.group . |
serviceConfigurationRecords | domainDnsRecord-Sammlung | DNS-Einträge, die der Kunde der DNS-Zonendatei der Domäne hinzufügt, bevor die Domäne von Microsoft-Onlinediensten verwendet werden kann. Schreibgeschützt, Nullable. Unterstützt $expand . |
verificationDnsRecords | domainDnsRecord-Sammlung | DNS-Einträge, die der Kunde der DNS-Zonendatei der Domäne hinzufügt, bevor der Kunde die Überprüfung des Domänenbesitzes mit Microsoft Entra ID abschließen kann. Schreibgeschützt, Nullable. Unterstützt $expand . |
federationConfiguration | internalDomainFederation | Domäneneinstellungen, die vom Kunden konfiguriert werden, wenn sie mit Microsoft Entra ID verbunden sind. Unterstützt $expand . |
JSON-Darstellung
Die folgende JSON-Darstellung zeigt den Ressourcentyp.
{
"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"]
}
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für