Tenants - List

Служба:: Resource Management

Версия API:: 2022-12-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	TenantListResult	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.subscriptions import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-subscriptions
# USAGE
    python get_tenants.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.tenants.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/subscriptions/stable/2022-12-01/examples/GetTenants.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Код состояния:: 200

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

Определения

Имя	Описание
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	Дом
ProjectedBy	ProjectedBy
ManagedBy	Управляется

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 (uri)	Ссылка на следующую страницу элементов
value	TenantIdDescription[]	Пункты TenantIdDescription на этой странице