Share via

Microsoft.DocumentDB databaseAccounts/cassandraKeyspaces/tables 2020-04-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-04-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      defaultTtl: int
      id: 'string'
      schema: {
        clusterKeys: [
          {
            name: 'string'
            orderBy: 'string'
          }
        ]
        columns: [
          {
            name: 'string'
            type: 'string'
          }
        ]
        partitionKeys: [
          {
            name: 'string'
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

CassandraPartitionKey

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

CassandraSchema

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

CassandraTableCreateUpdatePropertiesOrCassandraTableGetProperties

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. CreateUpdateOptionsOrCassandraTableGetPropertiesOptions (required)
resource The standard JSON format of a Cassandra table CassandraTableResourceOrCassandraTableGetPropertiesResource (required)

CassandraTableResourceOrCassandraTableGetPropertiesResource

Name Description Value
analyticalStorageTtl Analytical TTL. int
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

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

CreateUpdateOptionsOrCassandraTableGetPropertiesOptions

Name Description Value
autoscaleSettings Specifies the Autoscale settings. AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables

Name Description Value
location The location of the resource group to which the resource belongs. string
name The resource name string (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: databaseAccounts/cassandraKeyspaces
properties Properties to create and update Azure Cosmos DB Cassandra table. CassandraTableCreateUpdatePropertiesOrCassandraTableGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

Tags

Name Description Value

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Create an Azure Cosmos DB account for Cassandra API 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 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-04-01",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "defaultTtl": "int",
      "id": "string",
      "schema": {
        "clusterKeys": [
          {
            "name": "string",
            "orderBy": "string"
          }
        ],
        "columns": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "partitionKeys": [
          {
            "name": "string"
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

CassandraPartitionKey

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

CassandraSchema

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

CassandraTableCreateUpdatePropertiesOrCassandraTableGetProperties

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. CreateUpdateOptionsOrCassandraTableGetPropertiesOptions (required)
resource The standard JSON format of a Cassandra table CassandraTableResourceOrCassandraTableGetPropertiesResource (required)

CassandraTableResourceOrCassandraTableGetPropertiesResource

Name Description Value
analyticalStorageTtl Analytical TTL. int
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

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

CreateUpdateOptionsOrCassandraTableGetPropertiesOptions

Name Description Value
autoscaleSettings Specifies the Autoscale settings. AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables

Name Description Value
apiVersion The api version '2020-04-01'
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
properties Properties to create and update Azure Cosmos DB Cassandra table. CassandraTableCreateUpdatePropertiesOrCassandraTableGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables'

Tags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure 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-04-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        defaultTtl = int
        id = "string"
        schema = {
          clusterKeys = [
            {
              name = "string"
              orderBy = "string"
            }
          ]
          columns = [
            {
              name = "string"
              type = "string"
            }
          ]
          partitionKeys = [
            {
              name = "string"
            }
          ]
        }
      }
    }
  }
}

Property Values

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

CassandraPartitionKey

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

CassandraSchema

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

CassandraTableCreateUpdatePropertiesOrCassandraTableGetProperties

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. CreateUpdateOptionsOrCassandraTableGetPropertiesOptions (required)
resource The standard JSON format of a Cassandra table CassandraTableResourceOrCassandraTableGetPropertiesResource (required)

CassandraTableResourceOrCassandraTableGetPropertiesResource

Name Description Value
analyticalStorageTtl Analytical TTL. int
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

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

CreateUpdateOptionsOrCassandraTableGetPropertiesOptions

Name Description Value
autoscaleSettings Specifies the Autoscale settings. AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables

Name Description Value
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts/cassandraKeyspaces
properties Properties to create and update Azure Cosmos DB Cassandra table. CassandraTableCreateUpdatePropertiesOrCassandraTableGetProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables@2020-04-01"

Tags

Name Description Value