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. Verwenden Sie Domänenvorgänge, um domänen einem Mandanten zuzuordnen, den Domänenbesitz zu überprüfen und unterstützte Dienste zu konfigurieren. Durch die Überprüfung einer Domäne über Microsoft Graph wird die Domäne nicht für die Verwendung mit Office 365 Diensten wie Exchange konfiguriert. Die vollständige Konfiguration der Domäne für die Verwendung mit Microsoft 365-Produkten erfordert möglicherweise zusätzliche Schritte. Weitere Informationen finden Sie unter Microsoft 365-Administratoreinrichtung.
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 der Zonendatei der Domäne mithilfe der Domänenregistrierungsstelle oder dns-Serverkonfiguration (Domain Name System) hinzu.
Überprüfen Sie den Besitz der Domäne, und legen Sie die isVerified-Eigenschaft auf fest
true.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 |
|---|---|---|
| List | domain | Rufen Sie alle Domänen ab, die mit dem Mandanten verknüpft sind. |
| Create | domain | Fügen Sie dem Mandanten eine Domäne hinzu. |
| Get | domain | Liest Eigenschaften und Beziehungen eines Domänenobjekts. |
| Update | domain | Aktualisieren einer Domäne. |
| Löschen | Keine | Löschen sie eine Domäne. |
| Löschen erzwingen | Keine | Löschen sie eine Domäne mithilfe eines asynchronen Vorgangs. |
| Überprüfen | domain | Überprüfen Sie den Besitz der Domäne. |
| Höher stufen | Boolesch | Erhöhen Sie eine verifizierte Subdomäne zur Root-Domäne. |
| Stammdomäne abrufen | Ruft die Stammdomäne einer Unterdomäne ab. | |
| Domänennamenverweise auflisten | directoryObject collection | Rufen Sie eine Liste von Verzeichnisobjekten mit einem Verweis auf die Domäne ab. |
| Auflisten von Dienstkonfigurationsdatensätzen | domainDnsRecord-Sammlung | Rufen Sie eine Liste der DNS-Domäneneinträge für die Domänenkonfiguration ab. |
| DNS-Einträge zur Überprüfung auflisten | domainDnsRecord-Sammlung | Rufen Sie eine Liste der DNS-Domäneneinträge für die Domänenüberprüfung ab. |
Eigenschaften
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| authenticationType | Zeichenfolge | Gibt den konfigurierten Authentifizierungstyp für die Domäne an. Der Wert ist entweder Managed oder Federated.
Managedgibt eine in der Cloud verwaltete Domäne an, in der Microsoft Entra ID die Benutzerauthentifizierung durchführt.
Federatedgibt 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 | Zeichenfolge | 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 | Zeichenfolge | 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 trueder Wert . Lässt keine NULL-Werte zu. |
| isDefault | Boolesch |
true für die Standarddomäne, die für die Benutzererstellung verwendet wird. Es gibt nur eine Standarddomäne pro Unternehmen. Lässt keine NULL-Werte zu. |
| isInitial | Boolesch |
true für die anfängliche Domäne, die von Microsoft Online Services erstellt wurde. Beispiel: contoso.onmicrosoft.com. Es gibt nur eine anfängliche Domäne pro Unternehmen. Lässt keine NULL-Werte zu. |
| 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. Lässt keine NULL-Werte zu. |
| isVerified | Boolesch |
true für überprüfte Domänen. Lässt keine NULL-Werte zu. |
| passwordNotificationWindowInDays | Int32 | Gibt die Anzahl der Tage an, bevor ein Benutzer eine Kennwortablaufbenachrichtigung erhält. Standardmäßig 14 Tage. |
| passwordValidityPeriodInDays | Int32 | Gibt an, wie lange ein Kennwort gültig ist, bevor es geändert werden muss. Standardmäßig 90 Tage. |
| supportedServices | String collection | Die der Domäne zugewiesenen Funktionen. Kann , oder mehrere der folgenden Werte enthalten0: Email, , Sharepoint, EmailInternalRelayOnlyOfficeCommunicationsOnline, ,SharePointDefaultDomainFullRedelegation , OrgIdAuthentication. SharePointPublicCustomUrlDomainYammerIntune1 Die Werte, die Sie mithilfe der API hinzufügen oder entfernen können, sind: Email, OfficeCommunicationsOnline, Yammerund CustomUrlDomain. Lässt keine NULL-Werte zu. Weitere Informationen zu CustomUrlDomainfinden Sie unter Benutzerdefinierte URL-Domänen in externen Mandanten. |
| 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.
$expand wird nicht unterstützt. Unterstützt $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.
$expand wird nicht unterstützt. |
| 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.
$expand wird nicht unterstützt. |
| federationConfiguration | internalDomainFederation | Domäneneinstellungen, die vom Kunden konfiguriert werden, wenn sie mit Microsoft Entra ID verbunden sind.
$expand wird nicht unterstützt. |
| rootDomain | domain | Stammdomäne einer Unterdomäne. Schreibgeschützt, Nullable. Unterstützt $expand. |
JSON-Darstellung
Die folgende JSON-Darstellung veranschaulicht 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"]
}