Domänenressourcentyp

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

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-Mail, Websites, Authentifizierung usw. aktivieren.

So ordnen Sie einem Mandanten eine Domäne zu:

  1. Ordnen Sie eine Domäne einem Mandanten zu.

  2. Rufen Sie die Domänenüberprüfungseinträge ab. Fügen Sie der Zonendatei der Domäne mithilfe der Domänenregistrierungsstelle oder der DNS-Serverkonfiguration die Details des Überprüfungseintrags hinzu.

  3. Überprüfen Sie den Besitz der Domäne. Dadurch wird die Domäne überprüft und die isVerified -Eigenschaft auf truefestgelegt.

  4. Geben Sie die unterstützten Dienste an, die Sie für die Domäne verwenden möchten.

  5. 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 den Konfigurationsdatensatz mithilfe der Domänenregistrierungsstelle oder der DNS-Serverkonfiguration zur Zonendatei der Domäne hinzu.

Methoden

Methode Rückgabetyp Beschreibung
Domäne abrufen domain Lesen von 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 Dient zum Abrufen einer Liste von Verzeichnisobjekten mit einem Verweis auf die Domäne.
serviceConfigurationRecords auflisten domainDnsRecord-Auflistung Dient zum Abrufen einer Liste von Domänen-DNS-Einträgen für die Domänenkonfiguration.
VerificationDnsRecords auflisten domainDnsRecord-Auflistung Dient zum Abrufen einer Liste von Dns-Domäneneinträgen für die Domänenüberprüfung.
Domäne aktualisieren domain Aktualisiert eine 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.
Domäne überprüfen domain Überprüft den Besitz der Domäne.
Domäne höher stufen Boolesch Höherstufen einer überprüften Unterdomäne zur Stammdomäne.

Eigenschaften

Eigenschaft Typ Beschreibung
Authenticationtype Zeichenfolge 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 Azure AD die Benutzerauthentifizierung durchführt. Federated gibt an, dass die Authentifizierung mit einem Identitätsanbieter verbunden ist, z. B. dem lokalen Active Directory des Mandanten über Active Directory-Verbunddienste. Diese Eigenschaft ist schreibgeschützt und lässt keine Nullwerte zu.
availabilityStatus Zeichenfolge Diese Eigenschaft ist immer null , außer wenn die Überprüfungsaktion verwendet wird. Wenn die Überprüfungsaktion verwendet wird, wird eine Domänenentität in der Antwort 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, nicht nullfähig, eindeutig.
isAdminManaged Boolesch Der Wert der Eigenschaft ist false , wenn die DNS-Datensatzverwaltung der Domäne an Microsoft 365 delegiert wurde. Andernfalls ist trueder Wert . Lässt keine Nullwerte zu.
isDefault Boolean true wenn dies die Standarddomäne ist, die für die Benutzererstellung verwendet wird. Es gibt nur eine Standarddomäne pro Unternehmen. Lässt keine Nullwerte zu.
isInitial Boolean true wenn dies die anfängliche Domäne ist, die von Microsoft Online Services (companyname.onmicrosoft.com) erstellt wurde. Es gibt nur eine anfängliche Domäne pro Unternehmen. Lässt keine Nullwerte zu.
isRoot Boolesch true wenn es sich bei der Domäne um eine überprüfte Stammdomäne handelt. Andernfalls, false wenn es sich bei der Domäne um eine Unterdomäne handelt oder nicht überprüft wird. Lässt keine Nullwerte zu.
isVerified Boolesch true wenn die Domänenbesitzüberprüfung abgeschlossen wurde. Lässt keine Nullwerte zu.
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 einen oder mehrere der folgenden Werte enthalten0``1: Email, , Sharepoint, OfficeCommunicationsOnline``EmailInternalRelayOnly,SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune. Zu den Werten, die Sie mithilfe der Graph-API hinzufügen/entfernen können, gehören: Email, OfficeCommunicationsOnline, Yammer. Lässt keine NULL-Werte zu.
state domainState Status asynchroner Vorgänge, die für die Domäne geplant sind.

Beziehungen

Beziehungen zwischen einer Domäne und anderen Objekten im Verzeichnis, z. B. überprüfungseinträge und Dienstkonfigurationsdatensätze, werden über Navigationseigenschaften verfügbar gemacht. Sie können diese Beziehungen lesen, indem Sie in Ihren Anforderungen auf diese Navigationseigenschaften abzielen.

Beziehung Typ Beschreibung
domainNameReferences directoryObject collection Die Objekte wie Benutzer und Gruppen, die auf die Domänen-ID verweisen. Schreibgeschützt, Nullwerte zulassend. Unterstützt $expand und $filter durch den OData-Typ der zurückgegebenen Objekte. Zum Beispiel /domains/{domainId}/domainNameReferences/microsoft.graph.user und /domains/{domainId}/domainNameReferences/microsoft.graph.group.
serviceConfigurationRecords domainDnsRecord-Auflistung DNS-Einträge, die der Kunde der DNS-Zonendatei der Domäne hinzufügt, bevor die Domäne von Microsoft Online-Diensten verwendet werden kann. Schreibgeschützt, Nullwerte zulassend. Unterstützt $expand.
verificationDnsRecords domainDnsRecord-Auflistung DNS-Einträge, die der Kunde der DNS-Zonendatei der Domäne hinzufügt, bevor der Kunde die Überprüfung des Domänenbesitzes mit Azure AD abschließen kann. Schreibgeschützt, Nullwerte zulassend. Unterstützt $expand.
federationConfiguration internalDomainFederation Domäneneinstellungen, die vom Kunden beim Verbund mit Azure AD konfiguriert wurden. Unterstützt $expand.

JSON-Darstellung

Es folgt eine JSON-Darstellung der 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"]
}