Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2021-04-15

The databaseAccounts/sqlDatabases/containers resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-04-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: parentSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          {
            order: 'string'
            path: 'string'
          }
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [ 'string' ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [ 'string' ]
        version: int
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [ 'string' ]
          }
        ]
      }
    }
  }
}

Property values

databaseAccounts/sqlDatabases/containers

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-04-15'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
location The location of the resource group to which the resource belongs. string
tags Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB". Dictionary of tag names and values. See Tags in templates
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.
parentSymbolicName
properties Properties to create and update Azure Cosmos DB container. SqlContainerCreateUpdateProperties (required)

SqlContainerCreateUpdateProperties

Name Description Value
options CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput" CreateUpdateOptions
resource Cosmos DB SQL container resource object SqlContainerResource (required)

CreateUpdateOptions

Name Description Value
autoscaleSettings AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

SqlContainerResource

Name Description Value
analyticalStorageTtl Analytical TTL. int
conflictResolutionPolicy The conflict resolution policy for the container. ConflictResolutionPolicy
defaultTtl Default time to live int
id Name of the Cosmos DB SQL container string (required)
indexingPolicy Cosmos DB indexing policy IndexingPolicy
partitionKey The configuration of the partition key to be used for partitioning data into multiple partitions ContainerPartitionKey
uniqueKeyPolicy The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. UniqueKeyPolicy

ConflictResolutionPolicy

Name Description Value
conflictResolutionPath The conflict resolution path in the case of LastWriterWins mode. string
conflictResolutionProcedure The procedure to resolve conflicts in the case of custom mode. string
mode Indicates the conflict resolution mode. 'Custom'
'LastWriterWins'

IndexingPolicy

Name Description Value
automatic Indicates if the indexing policy is automatic bool
compositeIndexes List of composite path list CompositePath[]
excludedPaths List of paths to exclude from indexing ExcludedPath[]
includedPaths List of paths to include in the indexing IncludedPath[]
indexingMode Indicates the indexing mode. 'consistent'
'lazy'
'none'
spatialIndexes List of spatial specifics SpatialSpec[]

CompositePath

Name Description Value
order Sort order for composite paths. 'ascending'
'descending'
path The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) string

ExcludedPath

Name Description Value
path The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) string

IncludedPath

Name Description Value
indexes List of indexes for this path Indexes[]
path The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) string

Indexes

Name Description Value
dataType The datatype for which the indexing behavior is applied to. 'LineString'
'MultiPolygon'
'Number'
'Point'
'Polygon'
'String'
kind Indicates the type of index. 'Hash'
'Range'
'Spatial'
precision The precision of the index. -1 is maximum precision. int

SpatialSpec

Name Description Value
path The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) string
types List of path's spatial type String array containing any of:
'LineString'
'MultiPolygon'
'Point'
'Polygon'

ContainerPartitionKey

Name Description Value
kind Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create 'Hash'
'MultiHash'
'Range'
paths List of paths using which data within the container can be partitioned string[]
version Indicates the version of the partition key definition int

UniqueKeyPolicy

Name Description Value
uniqueKeys List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. UniqueKey[]

UniqueKey

Name Description Value
paths List of paths must be unique for each document in the Azure Cosmos DB service string[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Cosmos account for Core (SQL) API

Deploy to Azure
This template creates an Azure Cosmos account for Core (SQL) API with a database and container with throughput with multiple other options.
Azure Cosmos DB account SQL API with analytical store

Deploy to Azure
This template creates an Azure Cosmos account for Core (SQL) API with a database and container configured with analytical store.
Create an Azure Cosmos DB account SQL API with autoscale

Deploy to Azure
This template creates an Azure Cosmos account for Core (SQL) API with a database and container with autoscale throughput with multiple other options.
Create Azure Cosmos Core (SQL) API stored procedures

Deploy to Azure
This template creates an Azure Cosmos account for Core (SQL) API and a container with a stored procedure, trigger and user defined function.