Compartilhar via


Tenants - List

Obtém os locatários da sua conta.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
api-version
query True

string

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

Respostas

Nome Tipo Description
200 OK

TenantListResult

OK – retorna uma matriz de locatários.

Other Status Codes

CloudError

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

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

GetAllTenants

Solicitação de exemplo

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

Resposta de exemplo

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

Nome Description
CloudError

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

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

Os detalhes do erro.

ErrorResponse

Resposta de erro

TenantCategory

Categoria do locatário.

TenantIdDescription

Informações de ID do locatário.

TenantListResult

Informações de Ids de locatário.

CloudError

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

Nome Tipo Description
error

ErrorResponse

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

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome 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 de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

TenantCategory

Categoria do locatário.

Nome Tipo Description
Home

string

ManagedBy

string

ProjectedBy

string

TenantIdDescription

Informações de ID do locatário.

Nome Tipo Description
country

string

Nome do país/região do endereço do locatário.

countryCode

string

Abreviação de país/região para o locatário.

defaultDomain

string

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

displayName

string

O nome de exibição do locatário.

domains

string[]

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

id

string

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

tenantBrandingLogoUrl

string

A URL do logotipo de identidade visual do locatário. Disponível apenas para a categoria de locatário 'Home'.

tenantCategory

TenantCategory

Categoria do locatário.

tenantId

string

A 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 locatário 'Home'.

TenantListResult

Informações de Ids de locatário.

Nome Tipo Description
nextLink

string

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

value

TenantIdDescription[]

Uma matriz de locatários.