Share via

Microsoft.DocumentDB databaseAccounts/cassandraKeyspaces/tables 2020-03-01

  • Article

Bicep resource definition

The databaseAccounts/cassandraKeyspaces/tables 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/databaseAccounts/cassandraKeyspaces/tables resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      throughput: 'string'
      {customized property}: 'string'
    }
    resource: {
      defaultTtl: int
      id: 'string'
      schema: {
        clusterKeys: [
          {
            name: 'string'
            orderBy: 'string'
          }
        ]
        columns: [
          {
            name: 'string'
            type: 'string'
          }
        ]
        partitionKeys: [
          {
            name: 'string'
          }
        ]
      }
    }
  }
}

Property values

databaseAccounts/cassandraKeyspaces/tables

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location The location of the resource group to which the resource belongs. string
tags Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB". Dictionary of tag names and values. See Tags in templates
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: cassandraKeyspaces
properties Properties to create and update Azure Cosmos DB Cassandra table. CassandraTableCreateUpdatePropertiesOrCassandraTable... (required)

CassandraTableCreateUpdatePropertiesOrCassandraTable...

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptionsOrCassandraTableGetPropertiesOpti... (required)
resource The standard JSON format of a Cassandra table CassandraTableResourceOrCassandraTableGetPropertiesR... (required)

CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...

Name Description Value
throughput Request Units per second. For example, "throughput": "10000". string
{customized property} string

CassandraTableResourceOrCassandraTableGetPropertiesR...

Name Description Value
defaultTtl Time to live of the Cosmos DB Cassandra table int
id Name of the Cosmos DB Cassandra table string (required)
schema Schema of the Cosmos DB Cassandra table CassandraSchema

CassandraSchema

Name Description Value
clusterKeys List of cluster key. ClusterKey[]
columns List of Cassandra table columns. Column[]
partitionKeys List of partition key. CassandraPartitionKey[]

ClusterKey

Name Description Value
name Name of the Cosmos DB Cassandra table cluster key string
orderBy Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" string

Column

Name Description Value
name Name of the Cosmos DB Cassandra table column string
type Type of the Cosmos DB Cassandra table column string

CassandraPartitionKey

Name Description Value
name Name of the Cosmos DB Cassandra table partition key string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Cosmos DB account for Cassandra API

Deploy to Azure		 This template creates an Azure Cosmos DB account for Cassandra API in two regions with a keyspace and table with dedicated throughput.
Create autoscale Azure Cosmos DB account for Cassandra API

Deploy to Azure		 This template creates an Azure Cosmos DB account for Cassandra API in two regions with a keyspace and table with autoscale throughput.

ARM template resource definition

The databaseAccounts/cassandraKeyspaces/tables 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/databaseAccounts/cassandraKeyspaces/tables resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables",
  "apiVersion": "2020-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "throughput": "string",
      "{customized property}": "string"
    },
    "resource": {
      "defaultTtl": "int",
      "id": "string",
      "schema": {
        "clusterKeys": [
          {
            "name": "string",
            "orderBy": "string"
          }
        ],
        "columns": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "partitionKeys": [
          {
            "name": "string"
          }
        ]
      }
    }
  }
}

Property values

databaseAccounts/cassandraKeyspaces/tables

Name Description Value
type The resource type 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables'
apiVersion The resource api version '2020-03-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location The location of the resource group to which the resource belongs. string
tags Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB". Dictionary of tag names and values. See Tags in templates
properties Properties to create and update Azure Cosmos DB Cassandra table. CassandraTableCreateUpdatePropertiesOrCassandraTable... (required)

CassandraTableCreateUpdatePropertiesOrCassandraTable...

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptionsOrCassandraTableGetPropertiesOpti... (required)
resource The standard JSON format of a Cassandra table CassandraTableResourceOrCassandraTableGetPropertiesR... (required)

CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...

Name Description Value
throughput Request Units per second. For example, "throughput": "10000". string
{customized property} string

CassandraTableResourceOrCassandraTableGetPropertiesR...

Name Description Value
defaultTtl Time to live of the Cosmos DB Cassandra table int
id Name of the Cosmos DB Cassandra table string (required)
schema Schema of the Cosmos DB Cassandra table CassandraSchema

CassandraSchema

Name Description Value
clusterKeys List of cluster key. ClusterKey[]
columns List of Cassandra table columns. Column[]
partitionKeys List of partition key. CassandraPartitionKey[]

ClusterKey

Name Description Value
name Name of the Cosmos DB Cassandra table cluster key string
orderBy Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" string

Column

Name Description Value
name Name of the Cosmos DB Cassandra table column string
type Type of the Cosmos DB Cassandra table column string

CassandraPartitionKey

Name Description Value
name Name of the Cosmos DB Cassandra table partition key string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Cosmos DB account for Cassandra API

Deploy to Azure		 This template creates an Azure Cosmos DB account for Cassandra API in two regions with a keyspace and table with dedicated throughput.
Create autoscale Azure Cosmos DB account for Cassandra API

Deploy to Azure		 This template creates an Azure Cosmos DB account for Cassandra API in two regions with a keyspace and table with autoscale throughput.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        throughput = "string"
        {customized property} = "string"
      }
      resource = {
        defaultTtl = int
        id = "string"
        schema = {
          clusterKeys = [
            {
              name = "string"
              orderBy = "string"
            }
          ]
          columns = [
            {
              name = "string"
              type = "string"
            }
          ]
          partitionKeys = [
            {
              name = "string"
            }
          ]
        }
      }
    }
  })
}

Property values

databaseAccounts/cassandraKeyspaces/tables

Name Description Value
type The resource type "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-03-01"
name The resource name string (required)
location The location of the resource group to which the resource belongs. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: cassandraKeyspaces
tags Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB". Dictionary of tag names and values.
properties Properties to create and update Azure Cosmos DB Cassandra table. CassandraTableCreateUpdatePropertiesOrCassandraTable... (required)

CassandraTableCreateUpdatePropertiesOrCassandraTable...

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptionsOrCassandraTableGetPropertiesOpti... (required)
resource The standard JSON format of a Cassandra table CassandraTableResourceOrCassandraTableGetPropertiesR... (required)

CreateUpdateOptionsOrCassandraTableGetPropertiesOpti...

Name Description Value
throughput Request Units per second. For example, "throughput": "10000". string
{customized property} string

CassandraTableResourceOrCassandraTableGetPropertiesR...

Name Description Value
defaultTtl Time to live of the Cosmos DB Cassandra table int
id Name of the Cosmos DB Cassandra table string (required)
schema Schema of the Cosmos DB Cassandra table CassandraSchema

CassandraSchema

Name Description Value
clusterKeys List of cluster key. ClusterKey[]
columns List of Cassandra table columns. Column[]
partitionKeys List of partition key. CassandraPartitionKey[]

ClusterKey

Name Description Value
name Name of the Cosmos DB Cassandra table cluster key string
orderBy Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" string

Column

Name Description Value
name Name of the Cosmos DB Cassandra table column string
type Type of the Cosmos DB Cassandra table column string

CassandraPartitionKey

Name Description Value
name Name of the Cosmos DB Cassandra table partition key string