CIAM Tenants - List By Subscription

Служба:: Azure AD B2C

Версия API:: 2023-05-17-preview

Получите все ресурсы клиента Azure AD для клиентов в подписке.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/ciamDirectories?api-version=2023-05-17-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия API для использования с клиентским запросом.

Ответы

Имя	Тип	Описание
200 OK	CIAMTenantResourceList	Ресурсы клиента Azure AD для клиентов в подписке успешно извлекаются.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

CIAMTenants_ListBySubscription

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

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.AzureActiveDirectory/ciamDirectories?api-version=2023-05-17-preview

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

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

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/ciamDirectories/contoso",
      "name": "contoso",
      "type": "Microsoft.AzureActiveDirectory/ciamDirectories",
      "location": "United States",
      "sku": {
        "name": "Standard",
        "tier": "A0"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "createTenantProperties": {
          "displayName": "Contoso",
          "countryCode": "US"
        },
        "billingConfig": {
          "billingType": "MAU",
          "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
        },
        "domainName": "contoso.onmicrosoft.com",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "tags": null,
      "systemData": {
        "createdBy": "contosoAdmin@onmicrosoft.com",
        "createdByType": "User",
        "createdAt": "2020-02-03T01:01:01.1075056Z",
        "lastModifiedBy": "contosoAdmin@onmicrosoft.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-02-04T01:01:01.1075056Z"
      }
    }
  ],
  "nextLink": null
}

Определения

Имя	Описание
ciamBillingType	Тип выставления счетов. Будет MAU для всех новых клиентов. Невозможно изменить, если значение равно "MAU". Дополнительные сведения о выставлении счетов azure AD для клиентов см. в aka.ms/b2cBilling.
CIAMResourceSKU	Свойства SKU клиента Azure AD для клиентов. Дополнительные сведения о выставлении счетов за azure AD для клиентов см. в https://aka.ms/ciambilling.
CIAMResourceSKUName	Имя номера SKU для клиента.
CIAMResourceSKUTier	Уровень клиента.
CIAMTenantResource	Ресурс Azure AD для клиентов.
CIAMTenantResourceList	Коллекция ресурсов клиента Azure AD для клиентов
ciamTypeValue	Тип ресурса клиента Azure AD для клиентов.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ProvisioningState	Состояние подготовки
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

ciamBillingType

Перечисление

Тип выставления счетов. Будет MAU для всех новых клиентов. Невозможно изменить, если значение равно "MAU". Дополнительные сведения о выставлении счетов azure AD для клиентов см. в aka.ms/b2cBilling.

Значение	Описание
MAU	Плата за использование Azure AD для клиентов взимается в связанную подписку Azure и использует ежемесячную модель выставления счетов активных пользователей (MAU).

CIAMResourceSKU

Object

Свойства SKU клиента Azure AD для клиентов. Дополнительные сведения о выставлении счетов за azure AD для клиентов см. в https://aka.ms/ciambilling.

Имя	Тип	Описание
name	CIAMResourceSKUName	Имя номера SKU для клиента.
tier	CIAMResourceSKUTier	Уровень клиента.

CIAMResourceSKUName

Перечисление

Имя номера SKU для клиента.

Значение	Описание
Standard
PremiumP1
PremiumP2

CIAMResourceSKUTier

Перечисление

Уровень клиента.

Значение	Описание
A0	Уровень SKU, используемый для всех клиентов Azure AD для клиентов.

CIAMTenantResource

Object

Ресурс Azure AD для клиентов.

Имя	Тип	Описание
id	string	Идентификатор, представляющий ресурс клиента Azure AD для клиентов.
location	string	Расположение размещения ресурса и данных. Может быть одним из "Соединенных Штатов", "Европа", "Азиатско-Тихоокеанский регион" или "Австралия". Дополнительные сведения см. в этой документации.
name	string	Имя ресурса клиента Azure AD для клиентов.
properties.billingConfig.billingType	ciamBillingType	Тип выставления счетов. Будет MAU для всех новых клиентов. Невозможно изменить, если значение равно "MAU". Дополнительные сведения о выставлении счетов azure AD для клиентов см. в aka.ms/b2cBilling.
properties.billingConfig.effectiveStartDateUtc	string	Данные, из которых вступил в силу тип выставления счетов
properties.createTenantProperties.countryCode	string	Код страны клиента Azure (например, US). Ознакомьтесь с https://aka.ms/ciam-data-location, чтобы просмотреть допустимые коды стран и соответствующие расположения расположения данных. Если код страны не отображается в допустимом расположении данных, выберите его из списка.
properties.createTenantProperties.displayName	string	Отображаемое имя клиента Azure AD для клиентов.
properties.domainName	string	Доменное имя клиента
properties.provisioningState	ProvisioningState	Состояние подготовки
properties.tenantId	string	Идентификатор клиента Azure AD для клиентов.
sku	CIAMResourceSKU	Свойства SKU клиента Azure AD для клиентов. Дополнительные сведения о выставлении счетов за azure AD для клиентов см. в https://aka.ms/ciambilling.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object	Теги ресурсов
type	ciamTypeValue	Тип ресурса клиента Azure AD для клиентов.

CIAMTenantResourceList

Object

Коллекция ресурсов клиента Azure AD для клиентов

Имя	Тип	Описание
nextLink	string	URL-адрес для получения следующего набора ресурсов клиента Azure AD для клиентов.
value	CIAMTenantResource[]	Список ресурсов клиента Azure AD для клиентов

ciamTypeValue

Перечисление

Тип ресурса клиента Azure AD для клиентов.

Значение	Описание
Microsoft.AzureActiveDirectory/ciamDirectories	Тип ресурса azure AD для ресурса клиента клиента.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

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

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ProvisioningState

Перечисление

Состояние подготовки

Значение	Описание
Succeeded
Failed
Canceled
Provisioning
Deleting
Deleted

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.