你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
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 | 托管资源和数据的位置。 可以是“美国”、“欧洲”、“亚太”或“澳大利亚”之一。 有关详细信息,请参阅 此文档 。 | 字符串 (必需) |
标记 | 资源标记 | 标记名称和值的字典。 请参阅 模板中的标记 |
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' |
层 | 租户的层。 | “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
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | 'Microsoft.AzureActiveDirectory/b2cDirectories' |
apiVersion | 资源 API 版本 | '2021-04-01' |
name | 资源名称 | 字符串 (必需) |
location | 托管资源和数据的位置。 可以是“美国”、“欧洲”、“亚太”或“澳大利亚”之一。 有关详细信息,请参阅 此文档 。 | 字符串 (必需) |
标记 | 资源标记 | 标记名称和值的字典。 请参阅 模板中的标记 |
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” |
层 | 租户的层。 | “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
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.AzureActiveDirectory/b2cDirectories@2021-04-01” |
name | 资源名称 | 字符串 (必需) |
location | 托管资源和数据所在的位置。 可以是“美国”、“欧洲”、“亚太地区”或“澳大利亚”之一。 有关详细信息,请参阅 此文档 。 | 字符串 (必需) |
parent_id | 若要部署到资源组,请使用该资源组的 ID。 | 字符串 (必需) |
标记 | 资源标记 | 标记名称和值的字典。 |
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” “标准” |
层 | 租户的层。 | “A0” |