Share via

Microsoft.AzureActiveDirectory ciamDirectories

Bicep resource definition

The ciamDirectories resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureActiveDirectory/ciamDirectories resource, add the following Bicep to your template.

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

Property Values

Microsoft.AzureActiveDirectory/ciamDirectories

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'. Refer to this documentation for more information. string (required)
name The resource name string

Constraints:
Max length = 26
Pattern = ^[a-zA-Z0-9]{1,26} (required)
properties The Azure AD for customers tenant resource properties CiamTenantResourceProperties (required)
sku SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling. CiamResourceSKU (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

CiamResourceSKU

Name Description Value
name The name of the SKU for the tenant. 'PremiumP1'
'PremiumP2'
'Standard' (required)
tier The tier of the tenant. 'A0' (required)

CiamTenantResourceProperties

Name Description Value
createTenantProperties These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource. CreateCiamTenantProperties (required)
tenantId An identifier of the Azure AD for customers tenant. string

CiamTenantResourceTags

Name Description Value

CreateCiamTenantProperties

Name Description Value
countryCode Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 (required)
displayName The display name of the Azure AD for customers tenant. string (required)

ARM template resource definition

The ciamDirectories resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureActiveDirectory/ciamDirectories resource, add the following JSON to your template.

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

Property Values

Microsoft.AzureActiveDirectory/ciamDirectories

Name Description Value
apiVersion The api version '2023-05-17-preview'
location The location in which the resource is hosted and data resides. Can be one of 'United States', 'Europe', 'Asia Pacific', or 'Australia'. Refer to this documentation for more information. string (required)
name The resource name string

Constraints:
Max length = 26
Pattern = ^[a-zA-Z0-9]{1,26} (required)
properties The Azure AD for customers tenant resource properties CiamTenantResourceProperties (required)
sku SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling. CiamResourceSKU (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.AzureActiveDirectory/ciamDirectories'

CiamResourceSKU

Name Description Value
name The name of the SKU for the tenant. 'PremiumP1'
'PremiumP2'
'Standard' (required)
tier The tier of the tenant. 'A0' (required)

CiamTenantResourceProperties

Name Description Value
createTenantProperties These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource. CreateCiamTenantProperties (required)
tenantId An identifier of the Azure AD for customers tenant. string

CiamTenantResourceTags

Name Description Value

CreateCiamTenantProperties

Name Description Value
countryCode Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 (required)
displayName The display name of the Azure AD for customers tenant. string (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The ciamDirectories 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/ciamDirectories resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureActiveDirectory/ciamDirectories@2023-05-17-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      createTenantProperties = {
        countryCode = "string"
        displayName = "string"
      }
      tenantId = "string"
    }
    sku = {
      name = "string"
      tier = "string"
    }
  }
}

Property Values

Microsoft.AzureActiveDirectory/ciamDirectories

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'. Refer to this documentation for more information. string (required)
name The resource name string

Constraints:
Max length = 26
Pattern = ^[a-zA-Z0-9]{1,26} (required)
properties The Azure AD for customers tenant resource properties CiamTenantResourceProperties (required)
sku SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at https://aka.ms/ciambilling. CiamResourceSKU (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.AzureActiveDirectory/ciamDirectories@2023-05-17-preview"

CiamResourceSKU

Name Description Value
name The name of the SKU for the tenant. 'PremiumP1'
'PremiumP2'
'Standard' (required)
tier The tier of the tenant. 'A0' (required)

CiamTenantResourceProperties

Name Description Value
createTenantProperties These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource. CreateCiamTenantProperties (required)
tenantId An identifier of the Azure AD for customers tenant. string

CiamTenantResourceTags

Name Description Value

CreateCiamTenantProperties

Name Description Value
countryCode Country code of Azure tenant (e.g. 'US'). Refer to https://aka.ms/ciam-data-location 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 (required)
displayName The display name of the Azure AD for customers tenant. string (required)