Point de terminaison DynamicDistributionGroupMember dans l’API Exchange Online Administration

Remarque

Les fonctionnalités décrites dans cet article sont actuellement en préversion, ne sont pas disponibles dans toutes les organisations et sont susceptibles d’être modifiées.

Le point de terminaison DynamicDistributionGroupMember dans l’API Exchange Online Administration récupère les membres d’un groupe de distribution dynamique spécifié. Le point de terminaison retourne une collection d’objets destinataires représentant l’appartenance au groupe et les informations d’annuaire associées.

Les cas d’usage classiques sont les suivants :

• Développement de l’appartenance à des groupes de distribution dynamiques.
• Récupération des détails des membres individuels du groupe.

Remarque

La réponse de ce point de terminaison inclut les membres qui sont masqués dans les listes d’adresses.

L’API Exchange Online Administration fournit un moyen basé sur REST d’exécuter des applets de commande PowerShell spécifiques, en remplaçant les scénarios EWS (Exchange Web Services) hérités. Pour plus d’informations, consultez Vue d’ensemble de l’API Exchange Online Administration.

URL du point de terminaison

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

Conseil

Utilisez l’URL de base pour votre environnement, comme décrit dans Environnements et URL de base pris en charge.

Modèle de demande

En-têtes

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

Pour connaître les valeurs X-AnchorMailbox , consultez Indicateur de routage X-AnchorMailbox.

Corps

{
  "CmdletInput": {
    "CmdletName": "Get-DynamicDistributionGroupMember",
    "Parameters": {
      "Identity": "<dynamic distribution group email address>",    // required
      "ResultSize": <Integer | "Unlimited">                        // optional (pagination)
    }
  }
}

Pagination

Le paramètre ResultSize contrôle la pagination. Par défaut, jusqu’à 1 000 résultats sont retournés.

Si d’autres résultats sont disponibles, la réponse inclut une @odata.nextLink propriété avec une URL de continuation. Pour extraire la page suivante, émettez une nouvelle requête POST à l’URL dans @odata.nextLink avec le même corps.

Sélection de propriété

Ce point de terminaison prend en charge le $select paramètre de requête pour retourner uniquement des propriétés spécifiques dans la réponse. Par exemple :

POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/DynamicDistributionGroupMember?$select=DisplayName,PrimarySmtpAddress

Applets de commande et paramètres pris en charge

L’applet de commande prise en charge pour ce point de terminaison est Get-DynamicDistributionGroupMember. Toute autre applet de commande dans le corps de ce point de terminaison génère une erreur.

Seuls les paramètres décrits dans le tableau suivant sont disponibles via le point de terminaison REST :

Paramètre	Obligatoire	Type	Description
Identité	Obligatoire	String	Spécifie le groupe de distribution dynamique pour lequel récupérer les informations d’appartenance. Les valeurs valides sont le nom du groupe, l’adresse e-mail ou le GUID. Sous réserve de ResultSize, l’applet de commande retourne tous les membres du groupe, y compris les destinataires masqués.
ResultSize	Facultatif	Entier ou Illimité	Limite le nombre de résultats retournés. Les valeurs valides sont un entier (par exemple, 10) ou la valeur "Unlimited".

Vue d’ensemble de la réponse

Remarque

Pendant la préversion, le point de terminaison inclut la sortie complète de l’applet de commande Get-DynamicDistributionGroupMember dans la réponse de l’API. Pendant la transition vers la mise en production publique, la réponse sera limitée aux propriétés principales répertoriées dans cette section (propriétés nécessaires pour le scénario équivalent à EWS). Nous vous recommandons d’utiliser uniquement les propriétés répertoriées dans cette section. Nous allons documenter les modifications apportées aux propriétés disponibles.

La réponse est un tableau JSON de membres du groupe. Chaque objet destinataire contient des détails et des informations de métadonnées. Les propriétés suivantes sont renvoyées:

• Identité : identité canonique du destinataire (utilisée pour les opérations de gestion).
• Alias : alias de messagerie (le cas échéant).
• EmailAddresses : toutes les adresses proxy du destinataire (y compris les entrées SMTP : et smtp :).
• PrimarySmtpAddress : adresse SMTP principale du destinataire (correspond à la valeur SMTP : dans EmailAddresses).
• DisplayName : nom d’affichage du destinataire.
• FirstName
• LastName
• Nom : nom d’affichage Exchange (reflète souvent DisplayName).
• RecipientType : pour connaître les valeurs possibles, consultez RecipientType.
• RecipientTypeDetails : pour connaître les valeurs possibles, consultez RecipientTypeDetails.
• HiddenFromAddressListsEnabled : destinataire masqué de l’appartenance au groupe de distribution dynamique.

Exemples

• Exemple 1 : Obtenir tous les membres d’un groupe de distribution dynamique :

  Cet exemple récupère un maximum de 1 000 membres du groupe de distribution dynamique spécifié, car nous n’utilisons pas le paramètre ResultSize .

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

• Exemple 2 : Limiter les résultats à l’aide de ResultSize :

  Cet exemple limite les résultats à 10 membres du groupe de distribution dynamique spécifié en définissant le paramètre ResultSize sur la valeur 10.

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