B2C Tenants - Create

Ссылка

Служба:: Azure AD B2C

Версия API:: 2021-04-01

Инициирует асинхронный запрос для создания клиента Azure AD B2C и соответствующего ресурса Azure, связанного с подпиской.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/b2cDirectories/{resourceName}?api-version=2021-04-01

Параметры URI

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

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Расположение размещения ресурса и данных. Может быть одним из "Соединенных Штатов", "Европа", "Азиатско-Тихоокеанский регион" или "Австралия". Дополнительные сведения см. в этой документации.
sku	True	B2CResourceSKU	Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling.
properties.createTenantProperties.countryCode		string	Код страны клиента Azure (например, US). Ознакомьтесь с aka.ms/B2CDataResidency, чтобы просмотреть допустимые коды стран и соответствующие расположения расположения данных. Если код страны не отображается в допустимом расположении данных, выберите его из списка.
properties.createTenantProperties.displayName		string	Отображаемое имя клиента Azure AD B2C.
tags		object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	B2CTenantResource	ОК . Ответ URL-адреса в заголовке расположения, если асинхронная операция выполнена успешно. Будет создан ресурс.
202 Accepted		Принятый запрос на создание клиента Azure AD B2C. Заголовок location указывает URL-адрес или расположение, в котором необходимо проверить, чтобы получить асинхронное состояние операции. Заголовки Location: string Retry-After: string
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

B2CTenantResource

ОК . Ответ URL-адреса в заголовке расположения, если асинхронная операция выполнена успешно. Будет создан ресурс.

202 Accepted

Принятый запрос на создание клиента Azure AD B2C. Заголовок location указывает URL-адрес или расположение, в котором необходимо проверить, чтобы получить асинхронное состояние операции.

Заголовки

Location: string
Retry-After: string

Other Status Codes

CloudError

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

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

Create tenant

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/b2cDirectories/contoso.onmicrosoft.com?api-version=2021-04-01

{
  "location": "United States",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "createTenantProperties": {
      "displayName": "Contoso",
      "countryCode": "US"
    }
  }
}

const { ExternalIdentitiesConfigurationClient } = require("@azure/arm-azureadexternalidentities");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
 *
 * @summary Initiates an async request to create both the Azure AD B2C tenant and the corresponding Azure resource linked to a subscription.
 * x-ms-original-file: specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/stable/2021-04-01/examples/createTenant.json
 */
async function createTenant() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "contosoResourceGroup";
  const resourceName = "contoso.onmicrosoft.com";
  const createTenantRequestBody = {
    countryCode: "US",
    displayName: "Contoso",
    location: "United States",
    sku: { name: "Standard", tier: "A0" },
  };
  const options = { createTenantRequestBody };
  const credential = new DefaultAzureCredential();
  const client = new ExternalIdentitiesConfigurationClient(credential, subscriptionId);
  const result = await client.b2CTenants.beginCreateAndWait(
    resourceGroupName,
    resourceName,
    options
  );
  console.log(result);
}

createTenant().catch(console.error);

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

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

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

{
  "type": "Microsoft.AzureActiveDirectory/b2cDirectories",
  "sku": {
    "name": "Standard",
    "tier": "A0"
  },
  "properties": {
    "billingConfig": {
      "billingType": "MAU",
      "effectiveStartDateUtc": "1/1/0001 12:00:00 AM"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/b2cDirectories/contoso.onmicrosoft.com",
  "name": "contoso.onmicrosoft.com",
  "location": "United States",
  "tags": null
}

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

Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.AzureActiveDirectory/operations/99999999-9999-9999-9999-999999999999
Retry-After: 60

Определения

Имя	Описание
B2CResourceSKU	Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling.
B2CResourceSKUName	Имя номера SKU для клиента.
B2CResourceSKUTier	Уровень клиента.
B2CTenantResource
BillingConfig	Конфигурация выставления счетов для клиента.
BillingType	Тип выставления счетов. Будет MAU для всех новых клиентов. Если "Auths", его можно обновить до MAU. Невозможно изменить, если значение равно "MAU". Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling.
CloudError	Ответ об ошибке для запроса на управление ресурсами.
createdByType	Тип удостоверения, создавшего ресурс.
CreateTenantRequestBody	Сведения, необходимые для создания клиента Azure AD B2C и соответствующего ресурса Azure, который используется для выставления счетов.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Ответ на ошибку
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TypeValue	Тип ресурса клиента B2C.

B2CResourceSKU

Object

Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling.

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

B2CResourceSKUName

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

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

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

B2CResourceSKUTier

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

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

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

B2CTenantResource

Object

Имя	Тип	Описание
id	string	Идентификатор, представляющий ресурс клиента Azure AD B2C.
location	string	Расположение размещения ресурса и данных. Может быть одним из "Соединенных Штатов", "Европа", "Азиатско-Тихоокеанский регион" или "Австралия". Дополнительные сведения см. в этой документации.
name	string	Имя ресурса клиента Azure AD B2C.
properties.billingConfig	BillingConfig	Конфигурация выставления счетов для клиента.
properties.tenantId	string	Идентификатор клиента Azure AD B2C.
sku	B2CResourceSKU	Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object	Теги ресурсов
type	TypeValue	Тип ресурса клиента B2C.

BillingConfig

Object

Конфигурация выставления счетов для клиента.

Имя	Тип	Описание
billingType	BillingType	Тип выставления счетов. Будет MAU для всех новых клиентов. Если "Auths", его можно обновить до MAU. Невозможно изменить, если значение равно "MAU". Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling.
effectiveStartDateUtc	string	Данные, из которых вступил в силу тип выставления счетов

BillingType

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

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

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

CloudError

Object

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

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

createdByType

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

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

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

CreateTenantRequestBody

Object

Сведения, необходимые для создания клиента Azure AD B2C и соответствующего ресурса Azure, который используется для выставления счетов.

Имя	Тип	Описание
location	string	Расположение размещения ресурса и данных. Может быть одним из "Соединенных Штатов", "Европа", "Азиатско-Тихоокеанский регион" или "Австралия". Дополнительные сведения см. в этой документации.
properties.createTenantProperties.countryCode	string	Код страны клиента Azure (например, US). Ознакомьтесь с aka.ms/B2CDataResidency, чтобы просмотреть допустимые коды стран и соответствующие расположения расположения данных. Если код страны не отображается в допустимом расположении данных, выберите его из списка.
properties.createTenantProperties.displayName	string	Отображаемое имя клиента Azure AD B2C.
sku	B2CResourceSKU	Свойства SKU клиента Azure AD B2C. Дополнительные сведения о выставлении счетов Azure AD B2C см. в aka.ms/b2cBilling.
tags	object	Теги ресурсов

ErrorAdditionalInfo

Object

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

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

ErrorResponse

Object

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

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

systemData

Object

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

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

TypeValue

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

Тип ресурса клиента B2C.

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

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

B2C Tenants - Create

Параметры URI

Текст запроса

Ответы

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

azure_auth

Области

Примеры

Create tenant

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

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

Определения

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

Дополнительные ресурсы