Microsoft.DocumentDB databaseAccounts/apis/keyspaces/tables 2015-04-01

Choose a deployment language

Bicep ARM template Terraform

Bicep resource definition

The databaseAccounts/apis/keyspaces/tables resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2015-04-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      defaultTtl: int
      id: 'string'
      schema: {
        clusterKeys: [
          {
            name: 'string'
            orderBy: 'string'
          }
        ]
        columns: [
          {
            name: 'string'
            type: 'string'
          }
        ]
        partitionKeys: [
          {
            name: 'string'
          }
        ]
      }
    }
  }
}

Property Values

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[]

CassandraTableCreateUpdatePropertiesOrCassandraTableProperties

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

CassandraTableResource

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

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

CreateUpdateOptions

Name	Description	Value

Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables

Name	Description	Value
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/apis/keyspaces
properties	Properties to create and update Azure Cosmos DB Cassandra table.	CassandraTableCreateUpdatePropertiesOrCassandraTableProperties (required)

ARM template resource definition

The databaseAccounts/apis/keyspaces/tables resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables",
  "apiVersion": "2015-04-01",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "defaultTtl": "int",
      "id": "string",
      "schema": {
        "clusterKeys": [
          {
            "name": "string",
            "orderBy": "string"
          }
        ],
        "columns": [
          {
            "name": "string",
            "type": "string"
          }
        ],
        "partitionKeys": [
          {
            "name": "string"
          }
        ]
      }
    }
  }
}

Property Values

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[]

CassandraTableCreateUpdatePropertiesOrCassandraTableProperties

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

CassandraTableResource

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

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

CreateUpdateOptions

Name	Description	Value

Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables

Name	Description	Value
apiVersion	The api version	'2015-04-01'
name	The resource name	string (required)
properties	Properties to create and update Azure Cosmos DB Cassandra table.	CassandraTableCreateUpdatePropertiesOrCassandraTableProperties (required)
type	The resource type	'Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables'

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2015-04-01"
  name = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        defaultTtl = int
        id = "string"
        schema = {
          clusterKeys = [
            {
              name = "string"
              orderBy = "string"
            }
          ]
          columns = [
            {
              name = "string"
              type = "string"
            }
          ]
          partitionKeys = [
            {
              name = "string"
            }
          ]
        }
      }
    }
  })
}

Property Values

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[]

CassandraTableCreateUpdatePropertiesOrCassandraTableProperties

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

CassandraTableResource

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

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

CreateUpdateOptions

Name	Description	Value

Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables

Name	Description	Value
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/apis/keyspaces
properties	Properties to create and update Azure Cosmos DB Cassandra table.	CassandraTableCreateUpdatePropertiesOrCassandraTableProperties (required)
type	The resource type	"Microsoft.DocumentDB/databaseAccounts/apis/keyspaces/tables@2015-04-01"