Share via

Microsoft.DocumentDB databaseAccounts/apis/keyspaces 2016-03-31

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2016-03-31' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      id: 'string'
    }
  }
}

Property values

databaseAccounts/apis/keyspaces

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 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: apis
properties Properties to create and update Azure Cosmos DB Cassandra keyspace. CassandraKeyspaceCreateUpdatePropertiesOrCassandraKe... (required)

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKe...

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 keyspace CassandraKeyspaceResource (required)

CreateUpdateOptions

Name Description Value
{customized property} string

CassandraKeyspaceResource

Name Description Value
id Name of the Cosmos DB Cassandra keyspace string (required)

ARM template resource definition

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces",
  "apiVersion": "2016-03-31",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "id": "string"
    }
  }
}

Property values

databaseAccounts/apis/keyspaces

Name Description Value
type The resource type 'Microsoft.DocumentDB/databaseAccounts/apis/keyspaces'
apiVersion The resource api version '2016-03-31'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Properties to create and update Azure Cosmos DB Cassandra keyspace. CassandraKeyspaceCreateUpdatePropertiesOrCassandraKe... (required)

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKe...

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 keyspace CassandraKeyspaceResource (required)

CreateUpdateOptions

Name Description Value
{customized property} string

CassandraKeyspaceResource

Name Description Value
id Name of the Cosmos DB Cassandra keyspace string (required)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2016-03-31"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
      }
    }
  })
}

Property values

databaseAccounts/apis/keyspaces

Name Description Value
type The resource type "Microsoft.DocumentDB/databaseAccounts/apis/keyspaces@2016-03-31"
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: apis
properties Properties to create and update Azure Cosmos DB Cassandra keyspace. CassandraKeyspaceCreateUpdatePropertiesOrCassandraKe... (required)

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKe...

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 keyspace CassandraKeyspaceResource (required)

CreateUpdateOptions

Name Description Value
{customized property} string

CassandraKeyspaceResource

Name Description Value
id Name of the Cosmos DB Cassandra keyspace string (required)