Microsoft.DocumentDB databaseAccounts/cassandraKeyspaces/tables 2021-04-15

Template format

To create a Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables",
  "apiVersion": "2021-04-15",
  "location": "string",
  "tags": {},
  "properties": {
    "resource": {
      "id": "string",
      "defaultTtl": "integer",
      "schema": {
        "columns": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "partitionKeys": [
          {
            "name": "string"
          }
        ],
        "clusterKeys": [
          {
            "name": "string",
            "orderBy": "string"
          }
        ]
      },
      "analyticalStorageTtl": "integer"
    },
    "options": {
      "throughput": "integer",
      "autoscaleSettings": {
        "maxThroughput": "integer"
      }
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Cosmos DB table name.
type enum Yes For JSON -tables
-or-
Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/tables

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2021-04-15
location string No The location of the resource group to which the resource belongs.
tags object No
properties object Yes Properties to create and update Azure Cosmos DB Cassandra table. - CassandraTableCreateUpdateProperties object

CassandraTableCreateUpdateProperties object

Name Type Required Value
resource object Yes The standard JSON format of a Cassandra table - CassandraTableResource object
options object No A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. - CreateUpdateOptions object

CassandraTableResource object

Name Type Required Value
id string Yes Name of the Cosmos DB Cassandra table
defaultTtl integer No Time to live of the Cosmos DB Cassandra table
schema object No Schema of the Cosmos DB Cassandra table - CassandraSchema object
analyticalStorageTtl integer No Analytical TTL.

CreateUpdateOptions object

Name Type Required Value
throughput integer No Request Units per second. For example, "throughput": 10000.
autoscaleSettings object No Specifies the Autoscale settings. - AutoscaleSettings object

CassandraSchema object

Name Type Required Value
columns array No List of Cassandra table columns. - Column object
partitionKeys array No List of partition key. - CassandraPartitionKey object
clusterKeys array No List of cluster key. - ClusterKey object

AutoscaleSettings object

Name Type Required Value
maxThroughput integer No Represents maximum throughput, the resource can scale up to.

Column object

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

CassandraPartitionKey object

Name Type Required Value
name string No Name of the Cosmos DB Cassandra table partition key

ClusterKey object

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

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.