AcceptedDomain-Endpunkt in der Exchange Online Admin API

Hinweis

Die in diesem Artikel beschriebenen Features befinden sich derzeit in der Vorschauphase, sind nicht in allen Organisationen verfügbar und können sich ändern.

Der AcceptedDomain-Endpunkt in der Exchange Online Admin-API ruft die Liste der akzeptierten Domänen ab, die für den organization konfiguriert sind. Dieser Endpunkt gibt eine Auflistung von Domänenobjekten mit wichtigen Eigenschaftswerten für jede Domäne zurück.

Typische Anwendungsfälle sind:

  • Listen Sie akzeptierte Domänen für die Nachrichtenflusskonfiguration auf.
  • Überprüfen Sie die Eigenschaftswerte für jede konfigurierte Domäne.

Die Exchange Online Admin-API bietet eine REST-basierte Möglichkeit, bestimmte PowerShell-Cmdlets auszuführen und ältere Exchange-Webdienstszenarien (Exchange Web Services, EWS) zu ersetzen. Weitere Informationen finden Sie unter Übersicht über die Exchange Online Admin-API.

Endpunkt-URL

POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/AcceptedDomain

Tipp

Verwenden Sie die Basis-URL für Ihre Umgebung, wie unter Unterstützte Umgebungen und Basis-URLs beschrieben.

Modell anfordern

Header

Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <routing hint>

Informationen zu X-AnchorMailbox-Werten finden Sie unter X-AnchorMailbox-Routinghinweis.

Body

{
  "CmdletInput": {
    "CmdletName": "Get-AcceptedDomain",
    "Parameters": {
      "Identity": "<domain name>",           // optional
      "ResultSize": <Integer | "Unlimited">  // optional (pagination)
    }
  }
}

Paginierung

Der Parameter "ResultSize" steuert die Paginierung. Standardmäßig werden bis zu 1.000 Ergebnisse zurückgegeben.

Wenn weitere Ergebnisse verfügbar sind, enthält die Antwort eine @odata.nextLink Eigenschaft mit einer Fortsetzungs-URL. Um die nächste Seite abzurufen, senden Sie eine neue POST-Anforderung an die URL mit @odata.nextLink demselben Text.

Eigenschaftsauswahl

Dieser Endpunkt unterstützt den $select Abfrageparameter, um nur bestimmte Eigenschaften in der Antwort zurückzugeben. Zum Beispiel:

POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/AcceptedDomain?$select=DomainName,Default

Unterstützte Cmdlets und Parameter

Das unterstützte Cmdlet für diesen Endpunkt ist Get-AcceptedDomain. Jedes andere Cmdlet im Textkörper dieses Endpunkts führt zu einem Fehler.

Nur die in der folgenden Tabelle beschriebenen Parameter sind über den REST-Endpunkt verfügbar:

Parameter Erforderlich Typ Beschreibung
Identität Optional Zeichenfolge Gibt die akzeptierte Domäne an, über die Informationen abgerufen werden sollen. Gültige Werte sind der Domänenname (z. B. contoso.com) oder die GUID. Wenn er ausgelassen wird und ResultSize unterliegt, gibt das Cmdlet alle akzeptierten Domänen zurück.
ResultSize Optional Ganzzahl oder Zeichenfolge Begrenzt die Anzahl der zurückgegebenen Ergebnisse. Gültige Werte sind eine ganze Zahl (z. B. 10) oder der Wert "Unlimited".

Übersicht über die Antwort

Hinweis

Während der Vorschau enthält der Endpunkt die vollständige Ausgabe des Cmdlets Get-AcceptedDomain in der API-Antwort . Während des Übergangs zur öffentlichen Version wird die Antwort auf die in diesem Abschnitt aufgeführten Kerneigenschaften beschränkt sein (Eigenschaften, die für das EWS-äquivalente Szenario erforderlich sind). Es wird empfohlen, nur die in diesem Abschnitt aufgeführten Eigenschaften zu verwenden. Wir dokumentieren alle Änderungen an den verfügbaren Eigenschaften.

Die Antwort ist ein JSON-Array akzeptierter Domänenobjekte. Jedes Objekt enthält Domänenkonfigurations- und Metadateninformationen. Zu den zurückgegebenen Eigenschaften gehören:

  • Domänenname: Der vollqualifizierte Domänenname (FQDN). Beispiel: "contoso.com".
  • AdminDisplayName: Optionale Bezeichnung für die Domäne.
  • DomainType: Domänenmodus für das E-Mail-Routing. Beispiel: Authoritative, InternalRelay, oder ExternalRelay.
  • Name: Eindeutiger Exchange-Anzeigename für das akzeptierte Domänenobjekt.
  • ID: Dienstbezeichner für das Objekt.
  • Identität: Kanonische Identität, die von Exchange verwendet wird. Spiegelt häufig den Namenswert wider. Wird in Verwaltungsvorgängen verwendet.
  • GUID: Globally Unique Identifier des akzeptierten Domänenobjekts.

Beispiele

  • Beispiel 1: Alle akzeptierten Domänen anzeigen:

    In diesem Beispiel werden maximal 1.000 akzeptierte Domänen abgerufen, die für die organization konfiguriert sind, da der Parameter "ResultSize" nicht verwendet wird.

    POST /adminapi/v2.0/<TenantID>/AcceptedDomain HTTP/1.1
Host: outlook.office365.com
Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <Routing Hint>

{
  "CmdletInput": {
    "CmdletName": "Get-AcceptedDomain"
  }
}

  • Beispiel 2: Einschränken von Ergebnissen mithilfe von ResultSize:

    Dieses Beispiel schränkt die Ergebnisse auf eine akzeptierte Domäne ein, indem der Parameter "ResultSize" auf den Wert 1 festgelegt wird.

    POST /adminapi/v2.0/<TenantID>/AcceptedDomain HTTP/1.1
Host: outlook.office365.com
Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <Routing Hint>

{
  "CmdletInput": {
    "CmdletName": "Get-AcceptedDomain",
    "Parameters": {
      "ResultSize": 1
    }
  }
}

  • Beispiel 3: Abrufen von Ergebnissen für eine bestimmte akzeptierte Domäne:

    In diesem Beispiel werden Details für die angegebene contoso.com akzeptierte Domäne abgerufen.

    POST /adminapi/v2.0/<TenantID>/AcceptedDomain HTTP/1.1
Host: outlook.office365.com
Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <Routing Hint>

{
  "CmdletInput": {
    "CmdletName": "Get-AcceptedDomain",
    "Parameters": {
      "Identity": "contoso.com"
    }
  }
}
  • Zuletzt aktualisiert um