Partilhar via


Tenants - List

Obtém os inquilinos da sua conta.

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

Parâmetros do URI

Name Em Necessário Tipo Description
api-version
query True

string

A versão da API a utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

TenantListResult

OK - Devolve uma matriz de inquilinos.

Other Status Codes

CloudError

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

GetAllTenants

Pedido de amostra

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

Resposta da amostra

{
  "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": "..."
}

Definições

Name Description
CloudError

Uma resposta de erro para um pedido de gestão de recursos.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

TenantCategory

Categoria do inquilino.

TenantIdDescription

Informações de ID do inquilino.

TenantListResult

Informações de IDs de inquilino.

CloudError

Uma resposta de erro para um pedido de gestão de recursos.

Name Tipo Description
error

ErrorResponse

Resposta a erros
Resposta de erro comum para todas as APIs Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta de erro OData.).

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

TenantCategory

Categoria do inquilino.

Name Tipo Description
Home

string

ManagedBy

string

ProjectedBy

string

TenantIdDescription

Informações de ID do inquilino.

Name Tipo Description
country

string

Nome do país/região do endereço do inquilino.

countryCode

string

Abreviatura país/região para o inquilino.

defaultDomain

string

O domínio predefinido do inquilino.

displayName

string

O nome a apresentar do inquilino.

domains

string[]

A lista de domínios do inquilino.

id

string

O ID completamente qualificado do inquilino. Por exemplo, /tenants/8d65815f-a5b6-402f-9298-045155da7d74

tenantBrandingLogoUrl

string

O URL do logótipo de imagem corporativa do inquilino. Apenas disponível para a categoria de inquilino "Home".

tenantCategory

TenantCategory

Categoria do inquilino.

tenantId

string

O ID do inquilino. Por exemplo, 8d65815f-a5b6-402f-9298-045155da7d74

tenantType

string

O tipo de inquilino. Apenas disponível para a categoria de inquilino "Home".

TenantListResult

Informações de IDs de inquilino.

Name Tipo Description
nextLink

string

O URL a utilizar para obter o próximo conjunto de resultados.

value

TenantIdDescription[]

Uma matriz de inquilinos.