Partilhar via

Tenants - List

Serviço:
Resource Management
Versão da API:
2022-12-01

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

minLength: 1

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

Respostas

Name Tipo Description
200 OK

TenantListResult

OK - Retorna uma matriz de locatários.
Other Status Codes

CloudError

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

GetAllTenants

Pedido de amostra

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

Resposta da amostra

Código de estado:
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": "..."
}

Definições

Name Description
CloudError

Uma resposta de erro para uma solicitação de gerenciamento de recursos.
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
TenantCategory

Categoria do inquilino.
TenantIdDescription

Informações de identificação do locatário.
TenantListResult

Informações de IDs do locatário.

CloudError

Object

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

Name Tipo Description
error

ErrorResponse

Resposta de erro
Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

TenantCategory

Enumeração

Categoria do inquilino.

Valor Description
Home
ProjectedBy
ManagedBy

TenantIdDescription

Object

Informações de identificação do locatário.

Name Tipo Description
country

string

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

string

Abreviatura do país/região do inquilino.
defaultDomain

string

O domínio padrão para o locatário.
displayName

string

O nome para exibição do locatário.
domains

string[]

A lista de domínios para o locatário.
id

string

A ID totalmente qualificada do inquilino. Por exemplo, /tenants/8d65815f-a5b6-402f-9298-045155da7d74
tenantBrandingLogoUrl

string

URL do logotipo da marca do locatário. Disponível apenas para a categoria de inquilino 'Home'.
tenantCategory

TenantCategory

Categoria do inquilino.
tenantId

string

O ID do locatário. Por exemplo, 8d65815f-a5b6-402f-9298-045155da7d74
tenantType

string

O tipo de locatário. Disponível apenas para a categoria de inquilino 'Home'.

TenantListResult

Object

Informações de IDs do locatário.

Name Tipo Description
nextLink

string

A URL a ser usada para obter o próximo conjunto de resultados.
value

TenantIdDescription[]

Uma matriz de inquilinos.