Поделиться через


Tenants - List

Возвращает арендаторы для учетной записи.

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

Параметры URI

Имя В Обязательно Тип Описание
api-version
query True

string

minLength: 1

Версия API, используемая для этой операции.

Ответы

Имя Тип Описание
200 OK

TenantListResult

ОК. Возвращает массив клиентов.

Other Status Codes

CloudError

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

GetAllTenants

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
CloudError

Ответ об ошибке для запроса на управление ресурсами.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Ответ на ошибку

TenantCategory

Категория клиента.

TenantIdDescription

Сведения об идентификаторе клиента.

TenantListResult

Сведения об идентификаторах клиента.

CloudError

Ответ об ошибке для запроса на управление ресурсами.

Имя Тип Описание
error

ErrorResponse

Ответ на ошибку
Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

TenantCategory

Категория клиента.

Значение Описание
Home
ManagedBy
ProjectedBy

TenantIdDescription

Сведения об идентификаторе клиента.

Имя Тип Описание
country

string

Имя страны или региона адреса для клиента.

countryCode

string

Сокращение страны или региона для клиента.

defaultDomain

string

Домен по умолчанию для клиента.

displayName

string

Отображаемое имя клиента.

domains

string[]

Список доменов для клиента.

id

string

Полный идентификатор клиента. Например, /tenants/8d65815f-a5b6-402f-9298-045155da7d74

tenantBrandingLogoUrl

string

URL-адрес логотипа фирменной символики клиента. Доступно только для категории клиента Home.

tenantCategory

TenantCategory

Категория клиента.

tenantId

string

Идентификатор клиента. Например, 8d65815f-a5b6-402f-9298-04515da7d74

tenantType

string

Тип клиента. Доступно только для категории клиента Home.

TenantListResult

Сведения об идентификаторах клиента.

Имя Тип Описание
nextLink

string

URL-адрес, используемый для получения следующего набора результатов.

value

TenantIdDescription[]

Массив клиентов.