Microsoft.DocumentDB databaseAccounts/apis/keyspaces/tables 2015-11-06

Template format

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

{
  "name": "string",
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables",
  "apiVersion": "2015-11-06",
  "properties": {
    "resource": {
      "id": "string",
      "defaultTtl": "integer",
      "schema": {
        "columns": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "partitionKeys": [
          {
            "name": "string"
          }
        ],
        "clusterKeys": [
          {
            "name": "string",
            "orderBy": "string"
          }
        ]
      }
    },
    "options": {}
  }
}

Property values

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

Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables object

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

See Set name and type for child resources.
apiVersion enum Yes 2015-11-06
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 Yes A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

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

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

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"