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

Microsoft.AzureActiveDirectory b2cDirectories

• 最新
• 2023-05-17-preview
• 2023-01-18-preview
• 2021-04-01
• 2019-01-01-preview

言论

可以使用 ARM 模板或 Bicep 文件创建 B2C 租户，但无法更新现有的 B2C 租户。 此外，不能重新部署具有相同租户名称的模板。 如果需要更新 B2C 租户，请使用 B2C 租户 - 更新。

Bicep 资源定义

可以使用目标操作部署 b2cDirectories 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.AzureActiveDirectory/b2cDirectories 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    createTenantProperties: {
      countryCode: 'string'
      displayName: 'string'
      isGoLocalTenant: bool
    }
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

B2CResourceSKU

名字	描述	价值
名字	租户的 SKU 的名称。	“PremiumP1” “PremiumP2” “Standard”
层	租户的层。	“A0”

CreateTenantProperties

名字	描述	价值
countryCode	Azure 租户的国家/地区代码（例如“US”）。 请参阅 aka.ms/B2CDataResidency 查看有效的国家/地区代码和相应的数据驻留位置。 如果在有效的数据驻留位置看不到国家/地区代码，请从列表中选择一个。	字符串
displayName	Azure AD B2C 租户的显示名称。	字符串
isGoLocalTenant	启用 GoLocal 加载项以在特定地理位置存储静态数据。 请参阅 aka.ms/B2CDataResidency 查看本地数据驻留选项。	bool

CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties

名字	描述	价值
createTenantProperties	这些属性用于创建 Azure AD B2C 租户。 这些属性不是 Azure 资源的一部分。	CreateTenantProperties

CreateTenantRequestBodyTags

名字	描述	价值

Microsoft.AzureActiveDirectory/b2cDirectories

名字	描述	价值
位置	托管资源的位置和数据驻留。 可以是“美国”、“欧洲”、“亚太地区”或“澳大利亚”之一。 有关详细信息，请参阅本文档 。	string （必需）
名字	资源名称	string （必需）
性能		CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties（必需）
sku	Azure AD B2C 租户的 SKU 属性。 在 aka.ms/b2cBilling了解有关 Azure AD B2C 计费的详细信息。	B2CResourceSKU （必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

ARM 模板资源定义

可以使用目标操作部署 b2cDirectories 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.AzureActiveDirectory/b2cDirectories 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.AzureActiveDirectory/b2cDirectories",
  "apiVersion": "2023-05-17-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "createTenantProperties": {
      "countryCode": "string",
      "displayName": "string",
      "isGoLocalTenant": "bool"
    }
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

B2CResourceSKU

名字	描述	价值
名字	租户的 SKU 的名称。	“PremiumP1” “PremiumP2” “Standard”
层	租户的层。	“A0”

CreateTenantProperties

名字	描述	价值
countryCode	Azure 租户的国家/地区代码（例如“US”）。 请参阅 aka.ms/B2CDataResidency 查看有效的国家/地区代码和相应的数据驻留位置。 如果在有效的数据驻留位置看不到国家/地区代码，请从列表中选择一个。	字符串
displayName	Azure AD B2C 租户的显示名称。	字符串
isGoLocalTenant	启用 GoLocal 加载项以在特定地理位置存储静态数据。 请参阅 aka.ms/B2CDataResidency 查看本地数据驻留选项。	bool

CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties

名字	描述	价值
createTenantProperties	这些属性用于创建 Azure AD B2C 租户。 这些属性不是 Azure 资源的一部分。	CreateTenantProperties

CreateTenantRequestBodyTags

名字	描述	价值

Microsoft.AzureActiveDirectory/b2cDirectories

名字	描述	价值
apiVersion	API 版本	'2023-05-17-preview'
位置	托管资源的位置和数据驻留。 可以是“美国”、“欧洲”、“亚太地区”或“澳大利亚”之一。 有关详细信息，请参阅本文档 。	string （必需）
名字	资源名称	string （必需）
性能		CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties（必需）
sku	Azure AD B2C 租户的 SKU 属性。 在 aka.ms/b2cBilling了解有关 Azure AD B2C 计费的详细信息。	B2CResourceSKU （必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.AzureActiveDirectory/b2cDirectories”

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 b2cDirectories 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.AzureActiveDirectory/b2cDirectories 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview"
  name = "string"
  location = "string"
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      createTenantProperties = {
        countryCode = "string"
        displayName = "string"
        isGoLocalTenant = bool
      }
    }
  })
}

属性值

B2CResourceSKU

名字	描述	价值
名字	租户的 SKU 的名称。	“PremiumP1” “PremiumP2” “Standard”
层	租户的层。	“A0”

CreateTenantProperties

名字	描述	价值
countryCode	Azure 租户的国家/地区代码（例如“US”）。 请参阅 aka.ms/B2CDataResidency 查看有效的国家/地区代码和相应的数据驻留位置。 如果在有效的数据驻留位置看不到国家/地区代码，请从列表中选择一个。	字符串
displayName	Azure AD B2C 租户的显示名称。	字符串
isGoLocalTenant	启用 GoLocal 加载项以在特定地理位置存储静态数据。 请参阅 aka.ms/B2CDataResidency 查看本地数据驻留选项。	bool

CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties

名字	描述	价值
createTenantProperties	这些属性用于创建 Azure AD B2C 租户。 这些属性不是 Azure 资源的一部分。	CreateTenantProperties

CreateTenantRequestBodyTags

名字	描述	价值

Microsoft.AzureActiveDirectory/b2cDirectories

名字	描述	价值
位置	托管资源的位置和数据驻留。 可以是“美国”、“欧洲”、“亚太地区”或“澳大利亚”之一。 有关详细信息，请参阅本文档 。	string （必需）
名字	资源名称	string （必需）
性能		CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties（必需）
sku	Azure AD B2C 租户的 SKU 属性。 在 aka.ms/b2cBilling了解有关 Azure AD B2C 计费的详细信息。	B2CResourceSKU （必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.AzureActiveDirectory/b2cDirectories@2023-05-17-preview”