B2C Tenants - Create

Ссылка

Service:: Azure AD B2C

API Version:: 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 (например, "США"). Ознакомьтесь с aka.ms/B2CDataResidency , чтобы просмотреть допустимые коды стран и соответствующие расположения расположения данных. Если вы не видите код страны в допустимом расположении данных, выберите его из списка.
properties.createTenantProperties.displayName		string	Отображаемое имя клиента Azure AD B2C.
tags		object	Теги ресурсов

Ответы

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

Имя

Тип

Описание

200 OK

B2CTenantResource

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

202 Accepted

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

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
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

Sample Response

Status code:: 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
}

Status code:: 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

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

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

B2CResourceSKUName

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

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

B2CResourceSKUTier

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

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

B2CTenantResource

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

BillingConfig

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

Имя	Тип	Описание
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	string	Azure AD использование B2C оплачивается в связанной подписке Azure и используется количество операций выставления счетов на основе проверки подлинности.
MAU	string	Azure AD использование B2C оплачивается в связанной подписке Azure и использует модель выставления счетов для активных пользователей (MAU).

CloudError

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

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

createdByType

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

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

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

Имя	Тип	Описание
location	string	Расположение, в котором размещен ресурс и находятся данные. Может быть одним из "США", "Европа", "Азиатско-Тихоокеанский регион" или "Австралия". Дополнительные сведения см. в этой документации .
properties.createTenantProperties.countryCode	string	Код страны клиента Azure (например, "США"). Ознакомьтесь с 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

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

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

ErrorResponse

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

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

systemData

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

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

TypeValue

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

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

Share via

B2C Tenants - Create

Параметры URI

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

Ответы

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

azure_auth

Scopes

Примеры

Create tenant

Sample Request

Sample Response

Определения

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

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