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

名稱	位於	必要	類型	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 屬性。在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。
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/位置。標題 Location: string Retry-After: string
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

名稱

類型

Description

200 OK

B2CTenantResource

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

202 Accepted

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

標題

Location: string
Retry-After: string

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Create tenant

範例要求

HTTP

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"
    }
  }
}

範例回覆

狀態碼:: 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

定義

名稱	Description
B2CResourceSKU	Azure AD B2C 租使用者的 SKU 屬性。在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。
B2CResourceSKUName	租使用者 SKU 的名稱。
B2CResourceSKUTier	租用戶的層。
B2CTenantResource
BillingConfig	租用戶的計費組態。
BillingType	計費類型。將會為所有新客戶使用MAU。如果為 'Auths'，它可以更新為 'MAU'。如果值為『MAU』，則無法變更。在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。
CloudError	資源管理要求的錯誤回應。
createdByType	建立資源的身分識別類型。
CreateTenantRequestBody	建立 Azure AD B2C 租用戶和對應的 Azure 資源所需的資訊，用於計費用途。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorResponse	錯誤回應
systemData	與建立和上次修改資源相關的元數據。
TypeValue	B2C 租用戶資源的型別。

B2CResourceSKU

Object

Azure AD B2C 租使用者的 SKU 屬性。在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。

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

B2CResourceSKUName

列舉型別

租使用者 SKU 的名稱。

值	Description
Standard	Azure AD B2C 使用量會計費給連結的 Azure 訂用帳戶，並使用每月作用中使用者（MAU）計費模型。
PremiumP1	Azure AD B2C 使用量會計費給連結的 Azure 訂用帳戶，並使用以驗證為基礎的計費數目。
PremiumP2	Azure AD B2C 使用量會計費給連結的 Azure 訂用帳戶，並使用以驗證為基礎的計費數目。

B2CResourceSKUTier

列舉型別

租用戶的層。

值	Description
A0	用於所有 Azure AD B2C 租使用者的 SKU 層。

B2CTenantResource

Object

名稱	類型	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 屬性。在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。
systemData	systemData	與建立和上次修改資源相關的元數據。
tags	object	資源標籤
type	TypeValue	B2C 租用戶資源的型別。

BillingConfig

Object

租用戶的計費組態。

名稱	類型	Description
billingType	BillingType	計費類型。將會為所有新客戶使用MAU。如果為 'Auths'，它可以更新為 'MAU'。如果值為『MAU』，則無法變更。在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。
effectiveStartDateUtc	string	計費類型生效的數據

BillingType

列舉型別

計費類型。將會為所有新客戶使用MAU。如果為 'Auths'，它可以更新為 'MAU'。如果值為『MAU』，則無法變更。在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。

值	Description
MAU	Azure AD B2C 使用量會計費給連結的 Azure 訂用帳戶，並使用每月作用中使用者（MAU）計費模型。
Auths	Azure AD B2C 使用量會計費給連結的 Azure 訂用帳戶，並使用以驗證為基礎的計費數目。

CloudError

Object

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

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

createdByType

列舉型別

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

值	Description
User
Application
ManagedIdentity
Key

CreateTenantRequestBody

Object

建立 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 屬性。在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。
tags	object	資源標籤

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

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

ErrorResponse

Object

錯誤回應

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

systemData

Object

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

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

TypeValue

列舉型別

B2C 租用戶資源的型別。

值	Description
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