Microsoft.AzureActiveDirectory b2cDirectories
Bicep 資源定義
b2cDirectories 資源類型可以部署到：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
備註
您可以使用 ARM 範本或 Bicep 檔案建立 B2C 租使用者，但無法更新現有的 B2C 租使用者。 此外，您無法使用相同的租使用者名稱重新部署範本。 如果您需要更新 B2C 租使用者，請使用 B2C 租使用者 - 更新。
資源格式
若要建立 Microsoft.AzureActiveDirectory/b2cDirectories 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.AzureActiveDirectory/b2cDirectories@2021-04-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
tier: 'A0'
}
properties: {
createTenantProperties: {
countryCode: 'string'
displayName: 'string'
}
}
}
屬性值
b2cDirectories
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 | 需要字串 () |
| location | 裝載資源及資料所在的位置。 可以是 '美國'、'Europe'、'Asia Pacific' 或 'Australia' 的其中一個。 如需詳細資訊，請參閱 這份檔 。 | 需要字串 () |
| tags | 資源標記 | 標記名稱和值的字典。 請參閱 範本中的標籤 |
| sku | Azure AD B2C 租使用者的 SKU 屬性。 若要深入瞭解 Azure AD B2C 計費，請參閱 aka.ms/b2cBilling。 | B2CResourceSKU (必要) |
| properties | CreateTenantRequestBodyPropertiesOrB2CTenantResource... 必要 () |
CreateTenantRequestBodyPropertiesOrB2CTenantResource...
| 名稱 | 描述 | 值 |
|---|---|---|
| createTenantProperties | 這些屬性是用來建立 Azure AD B2C 租使用者。 這些屬性不是 Azure 資源的一部分。 | CreateTenantProperties |
CreateTenantProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| countryCode | Azure 租使用者的國家/地區代碼 (例如'US') 。 請參閱 aka.ms/B2CDataResidency ，以查看有效的國家/地區代碼和對應的資料落地位置。 如果您在有效的資料落地位置中看不到國家/地區代碼，請從清單中選擇一個。 | 字串 |
| displayName | Azure AD B2C 租使用者的顯示名稱。 | 字串 |
B2CResourceSKU
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 租使用者 SKU 的名稱。 | 'PremiumP1' 'PremiumP2' 'Standard' |
| tier | 租使用者的層。 | 'A0' |
ARM 範本資源定義
b2cDirectories 資源類型可以部署到：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
備註
您可以使用 ARM 範本或 Bicep 檔案建立 B2C 租使用者，但無法更新現有的 B2C 租使用者。 此外，您無法使用相同的租使用者名稱重新部署範本。 如果您需要更新 B2C 租使用者，請使用 B2C 租使用者 - 更新。
資源格式
若要建立 Microsoft.AzureActiveDirectory/b2cDirectories 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.AzureActiveDirectory/b2cDirectories",
"apiVersion": "2021-04-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string",
"tier": "A0"
},
"properties": {
"createTenantProperties": {
"countryCode": "string",
"displayName": "string"
}
}
}
屬性值
b2cDirectories
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.AzureActiveDirectory/b2cDirectories' |
| apiVersion | 資源 API 版本 | '2021-04-01' |
| NAME | 資源名稱 | 需要字串 () |
| location | 裝載資源及資料所在的位置。 可以是 '美國'、'Europe'、'Asia Pacific' 或 'Australia' 的其中一個。 如需詳細資訊，請參閱 這份檔 。 | 字串 (必要) |
| tags | 資源標記 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| sku | Azure AD B2C 租使用者的 SKU 屬性。 在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。 | B2CResourceSKU (必要) |
| properties | CreateTenantRequestBodyPropertiesOrB2CTenantResource... 必要 () |
CreateTenantRequestBodyPropertiesOrB2CTenantResource...
| 名稱 | 描述 | 值 |
|---|---|---|
| createTenantProperties | 這些屬性可用來建立 Azure AD B2C 租使用者。 這些屬性不是 Azure 資源的一部分。 | CreateTenantProperties |
CreateTenantProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| countryCode | Azure 租使用者的國家/地區代碼 (例如'US') 。 請參閱 aka.ms/B2CDataResidency 以查看有效的國家/地區代碼和對應的資料落地位置。 如果您沒有在有效的資料落地位置看到國家/地區代碼，請從清單中選擇一個。 | 字串 |
| displayName | Azure AD B2C 租使用者的顯示名稱。 | 字串 |
B2CResourceSKU
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 租使用者 SKU 的名稱。 | 'PremiumP1' 'PremiumP2' 'Standard' |
| tier | 租使用者的階層。 | 'A0' |
Terraform (AzAPI 提供者) 資源定義
b2cDirectories 資源類型可以部署到：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.AzureActiveDirectory/b2cDirectories 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AzureActiveDirectory/b2cDirectories@2021-04-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
createTenantProperties = {
countryCode = "string"
displayName = "string"
}
}
sku = {
name = "string"
tier = "A0"
}
})
}
屬性值
b2cDirectories
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 「Microsoft.AzureActiveDirectory/b2cDirectories@2021-04-01」 |
| NAME | 資源名稱 | 字串 (必要) |
| location | 資源裝載所在的位置和資料所在的位置。 可以是 「美國」、「歐洲」、「亞太地區」或「澳洲」的其中一個。 如需詳細資訊，請參閱 這份檔 。 | 字串 (必要) |
| parent_id | 若要部署至資源群組，請使用該資源群組的識別碼。 | 字串 (必要) |
| tags | 資源標記 | 標記名稱和值的字典。 |
| sku | Azure AD B2C 租使用者的 SKU 屬性。 在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。 | B2CResourceSKU (必要) |
| properties | CreateTenantRequestBodyPropertiesOrB2CTenantResource... 必要 () |
CreateTenantRequestBodyPropertiesOrB2CTenantResource...
| 名稱 | 描述 | 值 |
|---|---|---|
| createTenantProperties | 這些屬性可用來建立 Azure AD B2C 租使用者。 這些屬性不是 Azure 資源的一部分。 | CreateTenantProperties |
CreateTenantProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| countryCode | Azure 租使用者的國家/地區代碼 (例如'US') 。 請參閱 aka.ms/B2CDataResidency 以查看有效的國家/地區代碼和對應的資料落地位置。 如果您沒有在有效的資料落地位置看到國家/地區代碼，請從清單中選擇一個。 | 字串 |
| displayName | Azure AD B2C 租使用者的顯示名稱。 | 字串 |
B2CResourceSKU
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 租使用者 SKU 的名稱。 | 「PremiumP1」 「PremiumP2」 「標準」 |
| tier | 租使用者的層。 | 「A0」 |