Microsoft.AzureActiveDirectory b2cDirectories 2021-04-01

• 最新
• 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@2021-04-01' = {
  location: 'string'
  name: 'string'
  properties: {
    createTenantProperties: {
      countryCode: 'string'
      displayName: 'string'
    }
  }
  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 租用戶的顯示名稱。	字串

CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties

名字	描述	價值
createTenantProperties	這些屬性可用來建立 Azure AD B2C 租使用者。 這些屬性不是 Azure 資源的一部分。	CreateTenantProperties

CreateTenantRequestBodyTags

名字	描述	價值

Microsoft.AzureActiveDirectory/b2cDirectories

名字	描述	價值
位置	裝載資源的位置，以及數據所在的位置。 可以是「美國」、「歐洲」、「亞太地區」或「澳大利亞」之一。 如需詳細資訊，請參閱本檔 。	字串 （必要）
名字	資源名稱	字串 （必要）
性能		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": "2021-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "createTenantProperties": {
      "countryCode": "string",
      "displayName": "string"
    }
  },
  "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 租用戶的顯示名稱。	字串

CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties

名字	描述	價值
createTenantProperties	這些屬性可用來建立 Azure AD B2C 租使用者。 這些屬性不是 Azure 資源的一部分。	CreateTenantProperties

CreateTenantRequestBodyTags

名字	描述	價值

Microsoft.AzureActiveDirectory/b2cDirectories

名字	描述	價值
apiVersion	API 版本	'2021-04-01'
位置	裝載資源的位置，以及數據所在的位置。 可以是「美國」、「歐洲」、「亞太地區」或「澳大利亞」之一。 如需詳細資訊，請參閱本檔 。	字串 （必要）
名字	資源名稱	字串 （必要）
性能		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@2021-04-01"
  name = "string"
  location = "string"
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      createTenantProperties = {
        countryCode = "string"
        displayName = "string"
      }
    }
  })
}

屬性值

B2CResourceSKU

名字	描述	價值
名字	租使用者 SKU 的名稱。	'PremiumP1' 'PremiumP2' 'Standard'
層	租用戶的層。	'A0'

CreateTenantProperties

名字	描述	價值
countryCode	Azure 租用戶的國家/地區代碼（例如 'US'）。 請參閱 aka.ms/B2CDataResidency 以查看有效的國家/地區代碼和對應的數據落地位置。 如果您在有效的數據落地位置中看不到國家/地區代碼，請從清單中選擇一個國家/地區代碼。	字串
displayName	Azure AD B2C 租用戶的顯示名稱。	字串

CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties

名字	描述	價值
createTenantProperties	這些屬性可用來建立 Azure AD B2C 租使用者。 這些屬性不是 Azure 資源的一部分。	CreateTenantProperties

CreateTenantRequestBodyTags

名字	描述	價值

Microsoft.AzureActiveDirectory/b2cDirectories

名字	描述	價值
位置	裝載資源的位置，以及數據所在的位置。 可以是「美國」、「歐洲」、「亞太地區」或「澳大利亞」之一。 如需詳細資訊，請參閱本檔 。	字串 （必要）
名字	資源名稱	字串 （必要）
性能		CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties （必要）
sku	Azure AD B2C 租使用者的 SKU 屬性。 在 aka.ms/b2cBilling深入瞭解 Azure AD B2C 計費。	B2CResourceSKU （必要）
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.AzureActiveDirectory/b2cDirectories@2021-04-01”