DistributionGroupMember-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 DistributionGroupMember-Endpunkt in der Exchange Online Admin-API ruft die Mitglieder einer angegebenen Verteilergruppe ab. Der Endpunkt gibt eine Auflistung von Empfängerobjekten zurück, die die Gruppenmitgliedschaft und zugehörige Verzeichnisinformationen darstellen.

Typische Anwendungsfälle sind:

• Erweitern von Verteilerlisten für das E-Mail-Routing.
• Erweitern von Raumlisten, um eine Liste aller Mitglieder anzuzeigen.

Hinweis

Die Antwort dieses Endpunkts umfasst Mitglieder, die in Adresslisten ausgeblendet sind.

Die Exchange Online Admin-API bietet eine REST-basierte Möglichkeit zum Ausführen bestimmter PowerShell-Cmdlets, die legacy-Szenarien für Exchange-Webdienste (EWS) ersetzen. Weitere Informationen finden Sie unter Übersicht über die Exchange Online Admin-API.

Endpunkt-URL

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

Tipp

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

Anforderungsmodell

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-DistributionGroupMember",
    "Parameters": {
      "Identity": "<distribution group identity>",    // required
      "ResultSize": <Integer | "Unlimited">           // optional (pagination)
    }
  }
}

Paginierung

Der ResultSize-Parameter 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, stellen Sie eine neue POST-Anforderung an die URL in @odata.nextLink mit demselben Text.

Eigenschaftenauswahl

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>/DistributionGroupMember?$select=DisplayName,PrimarySmtpAddress

Unterstützte Cmdlets und Parameter

Das unterstützte Cmdlet für diesen Endpunkt ist Get-DistributionGroupMember. Jedes andere Cmdlet im Text 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	Erforderlich	Zeichenfolge	Gibt die Verteilergruppe an, zu der Mitgliedschaftsinformationen abgerufen werden sollen. Gültige Werte sind der Gruppenname, die E-Mail-Adresse oder die GUID. Vorbehaltlich von ResultSize gibt das Cmdlet alle Gruppenmitglieder zurück, einschließlich ausgeblendeter Empfänger.
ResultSize	Optional	Integer oder Unlimited	Schränkt die Anzahl der zurückgegebenen Ergebnisse ein. Gültige Werte sind eine ganze Zahl (z. B. 10) oder der Wert "Unlimited".

Antwortübersicht

Hinweis

Während der Vorschau enthält der Endpunkt die vollständige Ausgabe des Cmdlets Get-DistributionGroupMember in der API-Antwort. Während des Übergangs zur öffentlichen Version ist die Antwort auf die in diesem Abschnitt aufgeführten Kerneigenschaften beschränkt (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 von Gruppenmitgliedern. Jedes Empfängerobjekt enthält Details und Metadateninformationen. Die folgenden Eigenschaften werden zurückgegeben:

• Identität: Kanonische Identität des Empfängers (wird für Verwaltungsvorgänge verwendet).
• Alias: E-Mail-Alias (falls zutreffend).
• EmailAddresses: Alle Proxyadressen für den Empfänger (einschließlich SMTP- und smtp:-Einträge).
• PrimarySmtpAddress: Primäre SMTP-Adresse für den Empfänger (entspricht dem SMTP:-Wert in EmailAddresses).
• DisplayName: Anzeigename des Empfängers.
• FirstName
• LastName
• Name: Exchange-Anzeigename (häufig entspricht DisplayName).
• RecipientType: Mögliche Werte finden Sie unter RecipientType.
• RecipientTypeDetails: Mögliche Werte finden Sie unter RecipientTypeDetails.
• HiddenFromAddressListsEnabled: Ist der Empfänger vor der Mitgliedschaft in der Verteilergruppe ausgeblendet.

Beispiele

• Beispiel 1: Abrufen aller Mitglieder einer Verteilergruppe:

  In diesem Beispiel werden maximal 1.000 Mitglieder der angegebenen Verteilergruppe abgerufen, da der ResultSize-Parameter nicht verwendet wird.

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

• Beispiel 2: Einschränken der Ergebnisse mithilfe von ResultSize:

  In diesem Beispiel werden die Ergebnisse auf 10 Elemente der angegebenen Verteilergruppe beschränkt, indem der ResultSize-Parameter auf den Wert 10 festgelegt wird.

  POST /adminapi/v2.0/<TenantID>/DistributionGroupMember HTTP/1.1
  Host: outlook.office365.com
  Authorization: Bearer <auth token>
  Content-Type: application/json
  X-AnchorMailbox: <Routing Hint>>
  
  {
    "CmdletInput": {
      "CmdletName": "Get-DistributionGroupMember",
      "Parameters": {
        "Identity": "marketing@contoso.com",
        "ResultSize": 10
      }
    }
  }