Microsoft.AzureActiveDirectory b2cDirectories 2019-01-01-preview
Remarks
You can create a B2C tenant with an ARM template or Bicep file, but you can't update an existing B2C tenant. Also, you can't redeploy a template with the same tenant name. If you need to update a B2C tenant, use B2C Tenants - Update.
Bicep resource definition
The b2cDirectories resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureActiveDirectory/b2cDirectories resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AzureActiveDirectory/b2cDirectories@2019-01-01-preview' = {
location: 'string'
name: 'string'
properties: {
createTenantProperties: {
countryCode: 'string'
displayName: 'string'
}
}
sku: {
name: 'string'
tier: 'A0'
}
tags: {
{customized property}: 'string'
}
}
Property Values
B2CResourceSKU
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU for the tenant. | 'PremiumP1' 'PremiumP2' 'Standard' |
| tier | The tier of the tenant. | 'A0' |
CreateTenantProperties
| Name | Description | Value |
|---|---|---|
| countryCode | Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list. | string |
| displayName | The display name of the B2C tenant. | string |
CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties
| Name | Description | Value |
|---|---|---|
| createTenantProperties | These properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource. | CreateTenantProperties |
CreateTenantRequestBodyTags
| Name | Description | Value |
|---|
Microsoft.AzureActiveDirectory/b2cDirectories
| Name | Description | Value |
|---|---|---|
| location | The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia' (preview). Refer to this documentation for more information. | string (required) |
| name | The resource name | string (required) |
| properties | CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties (required) | |
| sku | SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling. | B2CResourceSKU (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ARM template resource definition
The b2cDirectories resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureActiveDirectory/b2cDirectories resource, add the following JSON to your template.
{
"type": "Microsoft.AzureActiveDirectory/b2cDirectories",
"apiVersion": "2019-01-01-preview",
"name": "string",
"location": "string",
"properties": {
"createTenantProperties": {
"countryCode": "string",
"displayName": "string"
}
},
"sku": {
"name": "string",
"tier": "A0"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
B2CResourceSKU
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU for the tenant. | 'PremiumP1' 'PremiumP2' 'Standard' |
| tier | The tier of the tenant. | 'A0' |
CreateTenantProperties
| Name | Description | Value |
|---|---|---|
| countryCode | Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list. | string |
| displayName | The display name of the B2C tenant. | string |
CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties
| Name | Description | Value |
|---|---|---|
| createTenantProperties | These properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource. | CreateTenantProperties |
CreateTenantRequestBodyTags
| Name | Description | Value |
|---|
Microsoft.AzureActiveDirectory/b2cDirectories
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2019-01-01-preview' |
| location | The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia' (preview). Refer to this documentation for more information. | string (required) |
| name | The resource name | string (required) |
| properties | CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties (required) | |
| sku | SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling. | B2CResourceSKU (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AzureActiveDirectory/b2cDirectories' |
Usage Examples
Terraform (AzAPI provider) resource definition
The b2cDirectories resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureActiveDirectory/b2cDirectories resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AzureActiveDirectory/b2cDirectories@2019-01-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
createTenantProperties = {
countryCode = "string"
displayName = "string"
}
}
sku = {
name = "string"
tier = "A0"
}
}
}
Property Values
B2CResourceSKU
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU for the tenant. | 'PremiumP1' 'PremiumP2' 'Standard' |
| tier | The tier of the tenant. | 'A0' |
CreateTenantProperties
| Name | Description | Value |
|---|---|---|
| countryCode | Country code of Azure tenant (e.g. 'US'). Refer to aka.ms/B2CDataResidency to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list. | string |
| displayName | The display name of the B2C tenant. | string |
CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties
| Name | Description | Value |
|---|---|---|
| createTenantProperties | These properties are used to create the Azure AD B2C tenant. These properties are not part of the Azure resource. | CreateTenantProperties |
CreateTenantRequestBodyTags
| Name | Description | Value |
|---|
Microsoft.AzureActiveDirectory/b2cDirectories
| Name | Description | Value |
|---|---|---|
| location | The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia' (preview). Refer to this documentation for more information. | string (required) |
| name | The resource name | string (required) |
| properties | CreateTenantRequestBodyPropertiesOrB2CTenantResourceProperties (required) | |
| sku | SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at aka.ms/b2cBilling. | B2CResourceSKU (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AzureActiveDirectory/b2cDirectories@2019-01-01-preview" |