Share via

Microsoft.DocumentDB cassandraClusters/dataCenters 2021-04-01-preview

  • Article

Bicep resource definition

The cassandraClusters/dataCenters 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.DocumentDB/cassandraClusters/dataCenters resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    base64EncodedCassandraYamlFragment: 'string'
    dataCenterLocation: 'string'
    delegatedSubnetId: 'string'
    nodeCount: int
    provisioningState: 'string'
  }
}

Property values

DataCenterResourceProperties

Name Description Value
base64EncodedCassandraYamlFragment A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. string
dataCenterLocation The region this data center should be created in. string
delegatedSubnetId Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'. string
nodeCount The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. int
provisioningState The status of the resource at the time the operation was called. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

Microsoft.DocumentDB/cassandraClusters/dataCenters

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: cassandraClusters
properties Properties of a managed Cassandra data center. DataCenterResourceProperties

ARM template resource definition

The cassandraClusters/dataCenters 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.DocumentDB/cassandraClusters/dataCenters resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "properties": {
    "base64EncodedCassandraYamlFragment": "string",
    "dataCenterLocation": "string",
    "delegatedSubnetId": "string",
    "nodeCount": "int",
    "provisioningState": "string"
  }
}

Property values

DataCenterResourceProperties

Name Description Value
base64EncodedCassandraYamlFragment A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. string
dataCenterLocation The region this data center should be created in. string
delegatedSubnetId Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'. string
nodeCount The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. int
provisioningState The status of the resource at the time the operation was called. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

Microsoft.DocumentDB/cassandraClusters/dataCenters

Name Description Value
apiVersion The api version '2021-04-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (required)
properties Properties of a managed Cassandra data center. DataCenterResourceProperties
type The resource type 'Microsoft.DocumentDB/cassandraClusters/dataCenters'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-04-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      base64EncodedCassandraYamlFragment = "string"
      dataCenterLocation = "string"
      delegatedSubnetId = "string"
      nodeCount = int
      provisioningState = "string"
    }
  })
}

Property values

DataCenterResourceProperties

Name Description Value
base64EncodedCassandraYamlFragment A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. string
dataCenterLocation The region this data center should be created in. string
delegatedSubnetId Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'. string
nodeCount The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. int
provisioningState The status of the resource at the time the operation was called. 'Canceled'
'Creating'
'Deleting'
'Failed'
'Succeeded'
'Updating'

Microsoft.DocumentDB/cassandraClusters/dataCenters

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: cassandraClusters
properties Properties of a managed Cassandra data center. DataCenterResourceProperties
type The resource type "Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-04-01-preview"