Microsoft.DocumentDB databaseAccounts/cassandraKeyspaces

Template format

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

{
  "name": "string",
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces",
  "apiVersion": "2020-06-01-preview",
  "location": "string",
  "tags": {},
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "resource": {
      "id": "string"
    },
    "options": {
      "throughput": "integer",
      "autoscaleSettings": {
        "maxThroughput": "integer"
      }
    }
  },
  "resources": []
}

Property values

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

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces object

Name Type Required Value
name string Yes Cosmos DB keyspace name.
type enum Yes cassandraKeyspaces
-or-
Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

See Set name and type for child resources.
apiVersion enum Yes 2020-06-01-preview
location string No The location of the resource group to which the resource belongs.
tags object No
identity object No ManagedServiceIdentity object
properties object Yes Properties to create and update Azure Cosmos DB Cassandra keyspace. - CassandraKeyspaceCreateUpdateProperties object
resources array No tables

ManagedServiceIdentity object

Name Type Required Value
type enum No The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. - SystemAssigned, UserAssigned, SystemAssigned,UserAssigned, None
userAssignedIdentities object No The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

CassandraKeyspaceCreateUpdateProperties object

Name Type Required Value
resource object Yes The standard JSON format of a Cassandra keyspace - CassandraKeyspaceResource 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. - CreateUpdateOptions object

CassandraKeyspaceResource object

Name Type Required Value
id string Yes Name of the Cosmos DB Cassandra keyspace

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

AutoscaleSettings object

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

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.