OrganizationConfig-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 OrganizationConfig-Endpunkt in der Exchange Online Admin-API ruft organization Einstellungen für E-Mail-Infos und einige andere zugehörige Dienstkonfigurationen ab.

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>/OrganizationConfig

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-OrganizationConfig"
  }
}

Paginierung

Paginierung ist nicht verfügbar. Das Cmdlet Get-OrganizationConfig gibt ein einzelnes organization configuration-Objekt zurück.

Unterstützte Cmdlets und Parameter

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

Über den REST-Endpunkt sind keine Parameter für das Cmdlet Get-OrganizationConfig verfügbar.

Übersicht über die Antwort

Hinweis

Während der Vorschau enthält der Endpunkt die vollständige Ausgabe des Cmdlets Get-OrganizationConfig 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 Get-OrganizationConfig-Antwort ist ein einzelnes JSON-Objekt, das die Einstellungen auf organization-Ebene darstellt. Die folgenden Eigenschaften werden zurückgegeben:

  • Name: Exchange-Anzeigename für das Konfigurationsobjekt der organization (es gibt nur eines in einer organization).
  • Identität: Kanonische Identität, die von Exchange verwendet wird (spiegelt häufig den Namenswert wider ).
  • ID: Dienstbezeichner für das Konfigurationsobjekt "organization".
  • GUID: Stabile GUID des Konfigurationsobjekts der organization.
  • MailTipsAllTipsEnabled: Gibt an, ob E-Mail-Infos für alle Tipps aktiviert sind. Der Standardwert ist True.
  • MailTipsExternalRecipientsTipsEnabled: Gibt an, ob E-Mail-Infos für externe Empfänger angezeigt werden. Der Standardwert ist False.
  • MailTipsLargeAudienceThreshold: Schwellenwert für große Zielgruppen, der sich auf das Verhalten von MailTips auswirkt. Der Standardwert ist 25.

Beispiele

  • Beispiel 1:

    Dieses Beispiel gibt die organization-weite Konfiguration zurück, einschließlich E-MailInfo-Einstellungen und der wichtigsten Featureflags.

    POST /adminapi/v2.0/<TenantID>/OrganizationConfig HTTP/1.1
    Host: outlook.office365.com
    Authorization: Bearer <auth token>
    Content-Type: application/json
    X-AnchorMailbox: <Routing Hint>
    
    {
      "CmdletInput": {
        "CmdletName": "Get-OrganizationConfig"
      }
    }