Microsoft.AzureActiveDirectory b2cDirectories 2019-01-01-preview
Bicep リソース定義
b2cDirectories リソースの種類は、次の場合にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
注釈
ARM テンプレートまたは Bicep ファイルを使用して B2C テナントを作成できますが、既存の B2C テナントを更新することはできません。 また、同じテナント名のテンプレートを再デプロイすることはできません。 B2C テナントを更新する必要がある場合は、 B2C テナント - 更新を使用します。
リソース形式
Microsoft.AzureActiveDirectory/b2cDirectories リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.AzureActiveDirectory/b2cDirectories@2019-01-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
tier: 'A0'
}
properties: {
createTenantProperties: {
countryCode: 'string'
displayName: 'string'
}
}
}
プロパティ値
b2cDirectories
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) |
| location | リソースがホストされ、データが存在する場所。 "米国"、"ヨーロッパ"、"アジア太平洋"、または "オーストラリア" (プレビュー) のいずれかを指定できます。 詳細については、 こちらのドキュメント を参照してください。 | string (必須) |
| 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 」を参照してください。 有効なデータ所在地に国番号が表示されない場合は、一覧から国番号を選択します。 | string |
| displayName | B2C テナントの表示名。 | string |
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": "2019-01-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string",
"tier": "A0"
},
"properties": {
"createTenantProperties": {
"countryCode": "string",
"displayName": "string"
}
}
}
プロパティ値
b2cDirectories
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.AzureActiveDirectory/b2cDirectories' |
| apiVersion | リソース API のバージョン | '2019-01-01-preview' |
| name | リソース名 | string (必須) |
| location | リソースがホストされ、データが存在する場所。 "米国"、"ヨーロッパ"、"アジア太平洋"、または "オーストラリア" (プレビュー) のいずれかを指定できます。 詳細については、 こちらのドキュメント を参照してください。 | string (必須) |
| 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 」を参照してください。 有効なデータ所在地に国コードが表示されない場合は、一覧から国番号を選択します。 | string |
| displayName | B2C テナントの表示名。 | string |
B2CResourceSKU
| 名前 | 説明 | 値 |
|---|---|---|
| name | テナントの SKU の名前。 | 'PremiumP1' 'PremiumP2' 'Standard' |
| レベル | テナントの層。 | 'A0' |
Terraform (AzAPI プロバイダー) リソース定義
b2cDirectories リソースの種類は、次のようにデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.AzureActiveDirectory/b2cDirectories リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AzureActiveDirectory/b2cDirectories@2019-01-01-preview"
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
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.AzureActiveDirectory/b2cDirectories@2019-01-01-preview" |
| name | リソース名 | string (必須) |
| location | リソースがホストされ、データが存在する場所。 "米国"、"ヨーロッパ"、"アジア太平洋"、または "オーストラリア" (プレビュー) のいずれかを指定できます。 詳細については、 こちらのドキュメント を参照してください。 | string (必須) |
| parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
| 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 」を参照してください。 有効なデータ所在地に国コードが表示されない場合は、一覧から国番号を選択します。 | string |
| displayName | B2C テナントの表示名。 | string |
B2CResourceSKU
| 名前 | 説明 | 値 |
|---|---|---|
| name | テナントの SKU の名前。 | "PremiumP1" "PremiumP2" "Standard" |
| レベル | テナントの層。 | "A0" |