Compartir a través de

Tenants - List

Servicio:
Resource Management
Versión de la API:
2022-12-01

Obtiene los inquilinos de la cuenta.

GET https://management.azure.com/tenants?api-version=2022-12-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Respuestas

Nombre Tipo Description
200 OK

TenantListResult

Aceptar: devuelve una matriz de inquilinos.
Other Status Codes

CloudError

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

GetAllTenants

Solicitud de ejemplo

GET https://management.azure.com/tenants?api-version=2022-12-01

Respuesta de muestra

status code:
200 
{
  "value": [
    {
      "id": "/tenants/a70a1586-9c4a-4373-b907-1d310660dbd1",
      "tenantId": "a70a1586-9c4a-4373-b907-1d310660dbd1",
      "countryCode": "US",
      "displayName": "Test_Test_aad50",
      "domains": [
        "aad50.ccsctp.net"
      ],
      "tenantCategory": "ManagedBy",
      "defaultDomain": "aad50.ccsctp.net",
      "tenantType": "AAD"
    },
    {
      "id": "/tenants/83abe5cd-bcc3-441a-bd86-e6a75360cecc",
      "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
      "countryCode": "US",
      "displayName": "Contoso Corp.",
      "domains": [
        "auxteststagemanual.ccsctp.net"
      ],
      "tenantCategory": "Home",
      "defaultDomain": "auxteststagemanual.ccsctp.net",
      "tenantType": "AAD"
    },
    {
      "id": "/tenants/daea2e9b-847b-4c93-850d-2aa6f2d7af33",
      "tenantId": "daea2e9b-847b-4c93-850d-2aa6f2d7af33",
      "countryCode": "US",
      "displayName": "TEST_TEST_RDV",
      "domains": [
        "rdvmohoro.ccsctp.net",
        "rdvmohoro.mail.ccsctp.net",
        "rdvmohoro.com"
      ],
      "tenantCategory": "ProjectedBy",
      "defaultDomain": "rdvmohoro.ccsctp.net",
      "tenantType": "AAD",
      "tenantBrandingLogoUrl": "logo1.logo.rdvmohoro.com"
    }
  ],
  "nextLink": "..."
}

Definiciones

Nombre Description
CloudError

Respuesta de error para una solicitud de administración de recursos.
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
TenantCategory

Categoría del inquilino.
TenantIdDescription

Información del identificador de inquilino.
TenantListResult

Información de identificadores de inquilino.

CloudError

Objeto

Respuesta de error para una solicitud de administración de recursos.

Nombre Tipo Description
error

ErrorResponse

Respuesta de error
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

TenantCategory

Enumeración

Categoría del inquilino.

Valor Description
Home
ProjectedBy
ManagedBy

TenantIdDescription

Objeto

Información del identificador de inquilino.

Nombre Tipo Description
country

string

Nombre de país o región de la dirección del inquilino.
countryCode

string

Abreviatura de país o región para el inquilino.
defaultDomain

string

Dominio predeterminado para el inquilino.
displayName

string

Nombre para mostrar del inquilino.
domains

string[]

Lista de dominios para el inquilino.
id

string

Identificador completo del inquilino. Por ejemplo, /tenants/8d65815f-a5b6-402f-9298-045155da7d74
tenantBrandingLogoUrl

string

Dirección URL del logotipo de personalización de marca del inquilino. Solo está disponible para la categoría de inquilino "Inicio".
tenantCategory

TenantCategory

Categoría del inquilino.
tenantId

string

Identificador del inquilino. Por ejemplo, 8d65815f-a5b6-402f-9298-045155da7d74
tenantType

string

Tipo de inquilino. Solo está disponible para la categoría de inquilino "Inicio".

TenantListResult

Objeto

Información de identificadores de inquilino.

Nombre Tipo Description
nextLink

string

Dirección URL que se va a usar para obtener el siguiente conjunto de resultados.
value

TenantIdDescription[]

Matriz de inquilinos.