你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。

请求正文

名称	必需	类型	说明
location	True	string	托管资源和数据的位置。可以是“美国”、“欧洲”、“亚太”或“澳大利亚”之一。有关详细信息，请参阅此文档。
sku	True	B2CResourceSKU	Azure AD B2C 租户的 SKU 属性。若要详细了解 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	确定 - 如果异步操作成功，则响应 Location 标头中的 URL。将创建资源。
202 Accepted		接受 Azure AD B2C 租户创建请求。 Location 标头指示检查获取操作异步状态的 URL/位置。标头 Location: string Retry-After: string
Other Status Codes	CloudError	描述操作失败原因的错误响应。

名称

类型

说明

200 OK

B2CTenantResource

确定 - 如果异步操作成功，则响应 Location 标头中的 URL。将创建资源。

202 Accepted

接受 Azure AD B2C 租户创建请求。 Location 标头指示检查获取操作异步状态的 URL/位置。

标头

Location: string
Retry-After: string

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: 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	Azure AD B2C 租户的 SKU 属性。若要详细了解 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

Azure AD B2C 租户的 SKU 属性。若要详细了解 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	用于所有 Azure AD B2C 租户的 SKU 层。

B2CTenantResource

名称	类型	说明
id	string	表示 Azure AD B2C 租户资源的标识符。
location	string	托管资源和数据的位置。可以是“美国”、“欧洲”、“亚太”或“澳大利亚”之一。有关详细信息，请参阅此文档。
name	string	Azure AD B2C 租户资源的名称。
properties.billingConfig	BillingConfig	租户的计费配置。
properties.tenantId	string	Azure AD B2C 租户的标识符。
sku	B2CResourceSKU	Azure AD B2C 租户的 SKU 属性。若要详细了解 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	错误响应对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式。)

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

创建 Azure AD B2C 租户和相应的 Azure 资源所需的信息，用于计费目的。

名称	类型	说明
location	string	托管资源和数据的位置。可以是“美国”、“欧洲”、“亚太”或“澳大利亚”之一。有关详细信息，请参阅此文档。
properties.createTenantProperties.countryCode	string	Azure 租户 (的国家/地区代码，例如“US”) 。请参阅 aka.ms/B2CDataResidency ，查看有效的国家/地区代码和相应的数据驻留位置。如果在有效的数据驻留位置中看不到国家/地区代码，请从列表中选择一个。
properties.createTenantProperties.displayName	string	Azure AD B2C 租户的显示名称。
sku	B2CResourceSKU	Azure AD B2C 租户的 SKU 属性。若要详细了解 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 租户资源的资源类型。

通过

B2C Tenants - Create

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Create tenant

示例请求

示例响应

定义

B2CResourceSKU

B2CResourceSKUName

B2CResourceSKUTier

B2CTenantResource

BillingConfig

BillingType

CloudError

createdByType

CreateTenantRequestBody

ErrorAdditionalInfo

ErrorResponse

systemData

TypeValue

其他资源