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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
resourceName	path	True	string	Azure AD B2C 租使用者的初始功能變數名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

要求本文

名稱	必要	類型	Description
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	資源標記

回應

名稱	類型	Description
200 OK	B2CTenantResource	確定 - 如果異步操作成功，[位置] 標頭中的 URL 回應。將會建立資源。
202 Accepted		已接受 Azure AD B2C 租使用者建立要求。 [位置] 標頭會指出要檢查以取得作業異步狀態的 URL/位置。 Headers Location: string Retry-After: string
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

名稱

類型

Description

200 OK

B2CTenantResource

確定 - 如果異步操作成功，[位置] 標頭中的 URL 回應。將會建立資源。

202 Accepted

已接受 Azure AD B2C 租使用者建立要求。 [位置] 標頭會指出要檢查以取得作業異步狀態的 URL/位置。

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
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

定義

名稱	Description
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。

名稱	類型	Description
name	B2CResourceSKUName	租使用者 SKU 的名稱。
tier	B2CResourceSKUTier	租用戶的層。

B2CResourceSKUName

租使用者 SKU 的名稱。

名稱	類型	Description
PremiumP1	string	Azure AD B2C 使用量會向連結的 Azure 訂用帳戶計費，並使用以驗證為基礎的計費數目。
PremiumP2	string	Azure AD B2C 使用量會向連結的 Azure 訂用帳戶計費，並使用以驗證為基礎的計費數目。
Standard	string	Azure AD B2C 使用量會向連結的 Azure 訂用帳戶計費，並使用每月作用中的使用者， (MAU) 計費模型。

B2CResourceSKUTier

租用戶的層。

名稱	類型	Description
A0	string	用於所有 Azure AD B2C 租使用者的 SKU 層。

B2CTenantResource

名稱	類型	Description
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

租用戶的計費組態。

名稱	類型	Description
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。

名稱	類型	Description
Auths	string	Azure AD B2C 使用量會向連結的 Azure 訂用帳戶計費，並使用以驗證為基礎的計費數目。
MAU	string	Azure AD B2C 使用量會向連結的 Azure 訂用帳戶計費，並使用每月作用中的使用者， (MAU) 計費模型。

CloudError

資源管理要求的錯誤回應。

名稱	類型	Description
error	ErrorResponse	錯誤回應所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式。)

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateTenantRequestBody

建立 Azure AD B2C 租用戶和對應的 Azure 資源所需的資訊，用於計費用途。

名稱	類型	Description
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

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorResponse

錯誤回應

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorResponse[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

TypeValue

B2C 租用戶資源的類型。

名稱	類型	Description
Microsoft.AzureActiveDirectory/b2cDirectories	string	Azure AD B2C 租用戶資源的資源類型。

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

其他資源