Microsoft.DocumentDB databaseAccounts/apis/databases/collections 2016-03-19

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-19' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    options: {}
    resource: {
      id: 'string'
      indexes: [
          key: {
            keys: [ 'string' ]
          options: {
            expireAfterSeconds: int
            unique: bool
      shardKey: {}

Property values


Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
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.
properties Properties to create and update Azure Cosmos DB MongoDB collection. MongoDBCollectionCreateUpdateProperties (required)


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" object (required)
resource Cosmos DB MongoDB collection resource object MongoDBCollectionResource (required)


Name Description Value
id Name of the Cosmos DB MongoDB collection string (required)
indexes List of index keys MongoIndex[]
shardKey The shard key and partition kind pair, only support "Hash" partition kind object


Name Description Value
key Cosmos DB MongoDB collection resource object MongoIndexKeys
options Cosmos DB MongoDB collection index options MongoIndexOptions


Name Description Value
keys List of keys for each MongoDB collection in the Azure Cosmos DB service string[]


Name Description Value
expireAfterSeconds Expire after seconds int
unique Is unique or not bool