Point de terminaison AcceptedDomain 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 AcceptedDomain dans l’API Exchange Online Administration récupère la liste des domaines acceptés configurés pour le organization. Ce point de terminaison retourne une collection d’objets de domaine avec des valeurs de propriété de clé pour chaque domaine.

Les cas d’usage classiques sont les suivants :

• Répertorier les domaines acceptés pour la configuration du flux de messagerie.
• Passez en revue les valeurs de propriété pour chaque domaine configuré.

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

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-AcceptedDomain",
    "Parameters": {
      "Identity": "<domain name>",           // optional
      "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>/AcceptedDomain?$select=DomainName,Default

Applets de commande et paramètres pris en charge

L’applet de commande prise en charge pour ce point de terminaison est Get-AcceptedDomain. 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é	Facultatif	String	Spécifie le domaine accepté sur lequel récupérer des informations. Les valeurs valides sont le nom de domaine (par exemple, contoso.com) ou le GUID. Si elle est omise et soumise à ResultSize, l’applet de commande retourne tous les domaines acceptés.
ResultSize	Facultatif	Entier ou chaîne	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-AcceptedDomain 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 d’objets de domaine acceptés. Chaque objet contient des informations de configuration de domaine et de métadonnées. Les propriétés retournées sont les suivantes :

• DomainName : nom de domaine complet (FQDN). Par exemple, contoso.com.
• AdminDisplayName : étiquette facultative pour le domaine.
• DomainType : mode domaine pour le routage du courrier. Par exemple, Authoritative, InternalRelayou ExternalRelay .
• Nom : nom d’affichage Exchange unique pour l’objet de domaine accepté.
• Id : identificateur de service de l’objet.
• Identité : identité canonique utilisée par Exchange. Reflète souvent la valeur Name . Utilisé dans les opérations de gestion.
• Guid : identificateur global unique de l’objet de domaine accepté.

Exemples

• Exemple 1 : Afficher tous les domaines acceptés :

  Cet exemple récupère un maximum de 1 000 domaines acceptés configurés pour le organization, car nous n’utilisons pas le paramètre ResultSize.

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

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

  Cet exemple limite les résultats à un domaine accepté en définissant le paramètre ResultSize sur la valeur 1.

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

• Exemple 3 : Obtenir les résultats d’un domaine accepté spécifique :

  Cet exemple récupère les détails du domaine contoso.com accepté spécifié.

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