Share via

Microsoft.DocumentDB locations 2023-09-15

  • Article

Bicep resource definition

The locations resource type can exist at: Subscriptions

Note

This resource type is read-only, which means it can't be deployed but an existing instance can be referenced. Typically, read-only resource types are automatically created by the service.

Use the existing keyword.

Resource format

To create a Microsoft.DocumentDB/locations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/locations@2023-09-15' existing = {
  name: 'string'
}

Property values

locations

Name Description Value
name The name of the existing resource. string (required)

ARM template resource definition

The locations resource type can exist at: Subscriptions

Note

This resource type is read-only, which means it can't be deployed but an existing instance can be referenced. Typically, read-only resource types are automatically created by the service.

Use the reference function.

Resource format

To create a Microsoft.DocumentDB/locations resource, add the following JSON to your template.

[reference(resourceId('Microsoft.DocumentDB/locations', '{name}'), '2023-09-15')]

Property values

locations

Name Description Value
name The name of the existing resource. string (required)

Terraform (AzAPI provider) resource definition

The locations resource type can exist at: Subscriptions

Note

This resource type is read-only, which means it can't be deployed but an existing instance can be referenced. Typically, read-only resource types are automatically created by the service.

Use the data keyword.

Resource format

To create a Microsoft.DocumentDB/locations resource, add the following Terraform to your template.

data "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/locations@2023-09-15"
  name = "string"
  parent_id = "string"
}

Property values

locations

Name Description Value
name The name of the existing resource. string (required)
parent_id To reference a subscription, use the ID of that subscription. string (required)