Punto de conexión AcceptedDomain en la API de Exchange Online Administración

Nota:

Las características descritas en este artículo están actualmente en versión preliminar, no están disponibles en todas las organizaciones y están sujetas a cambios.

El punto de conexión AcceptedDomain de la API de Exchange Online Administración recupera la lista de dominios aceptados configurados para la organización. Este punto de conexión devuelve una colección de objetos de dominio con valores de propiedad clave para cada dominio.

Los casos de uso típicos incluyen:

• Enumera los dominios aceptados para la configuración del flujo de correo.
• Revise los valores de propiedad de cada dominio configurado.

La API de Exchange Online Administración proporciona una manera basada en REST de ejecutar cmdlets de PowerShell específicos, reemplazando escenarios heredados de Exchange Web Services (EWS). Para obtener más información, consulte Introducción a la API de Exchange Online Administración.

URL de extremo

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

Sugerencia

Use la dirección URL base del entorno, tal como se describe en Entornos admitidos y direcciones URL base.

Modelo de solicitud

Encabezados

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

Para ver los valores de X-AnchorMailbox , consulte sugerencia de enrutamiento X-AnchorMailbox.

Cuerpo

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

Paginación

El parámetro ResultSize controla la paginación. De forma predeterminada, se devuelven hasta 1000 resultados.

Si hay más resultados disponibles, la respuesta incluye una @odata.nextLink propiedad con una dirección URL de continuación. Para capturar la página siguiente, emita una nueva solicitud POST a la dirección URL de @odata.nextLink con el mismo cuerpo.

Selección de propiedades

Este punto de conexión admite el parámetro de $select consulta para devolver solo propiedades específicas en la respuesta. Por ejemplo:

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

Cmdlets y parámetros admitidos

El cmdlet admitido para este punto de conexión es Get-AcceptedDomain. Cualquier otro cmdlet en el cuerpo de este punto de conexión produce un error.

Solo los parámetros descritos en la tabla siguiente están disponibles a través del punto de conexión REST:

Parámetro	Obligatorio	Tipo	Descripción
Identidad	Opcional	Cadena	Especifica el dominio aceptado sobre el que se va a recuperar información. Los valores válidos son el nombre de dominio (por ejemplo, contoso.com) o GUID. Si se omite y está sujeto a ResultSize, el cmdlet devuelve todos los dominios aceptados.
ResultSize	Opcional	Entero o cadena	Limita el número de resultados devueltos. Los valores válidos son un entero (por ejemplo, 10) o el valor "Unlimited".

Información general sobre la respuesta

Nota:

Durante la versión preliminar, el punto de conexión incluye la salida completa del cmdlet Get-AcceptedDomain en la respuesta de la API. Durante la transición a la versión pública, la respuesta se limitará a las propiedades principales enumeradas en esta sección (propiedades necesarias para el escenario equivalente a EWS). Se recomienda usar solo las propiedades enumeradas en esta sección. Documentaremos los cambios en las propiedades disponibles.

La respuesta es una matriz JSON de objetos de dominio aceptados. Cada objeto contiene información de metadatos y configuración de dominio. Las propiedades devueltas incluyen:

• DomainName: nombre de dominio completo (FQDN). Por ejemplo, contoso.com.
• AdminDisplayName: etiqueta opcional para el dominio.
• DomainType: modo de dominio para el enrutamiento de correo. Por ejemplo, Authoritative, InternalRelayo ExternalRelay .
• Nombre: nombre único para mostrar de Exchange para el objeto de dominio aceptado.
• Identificador: identificador de servicio para el objeto .
• Identidad: identidad canónica usada por Exchange. A menudo refleja el valor name . Se usa en las operaciones de administración.
• Guid: identificador único global del objeto de dominio aceptado.

Ejemplos

• Ejemplo 1: Ver todos los dominios aceptados:

  En este ejemplo se recupera un máximo de 1000 dominios aceptados configurados para la organización porque no se usa el parámetro 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"
    }
  }
  

• Ejemplo 2: Limitar los resultados mediante ResultSize:

  Este ejemplo limita los resultados a un dominio aceptado estableciendo el parámetro ResultSize en el valor 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
      }
    }
  }
  

• Ejemplo 3: Obtención de resultados para un dominio aceptado específico:

  En este ejemplo se recuperan los detalles del dominio aceptado contoso.com especificado.

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