Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2019-08-01

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2019-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: parentSymbolicName
  properties: {
    options: {}
    resource: {
      id: 'string'
      indexes: [
        {
          key: {
            keys: [ 'string' ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {}
    }
  }
}

Property values

databaseAccounts/mongodbDatabases/collections

Name Description Value
type The resource type

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

For Bicep, set this value in the resource declaration.
'2019-08-01'
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 MongoDB collection. MongoDBCollectionCreateUpdateProperties (required)

MongoDBCollectionCreateUpdateProperties

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)

MongoDBCollectionResource

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

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Cosmos account for MongoDB API

Deploy to Azure
This template creates an Azure Cosmos DB account for MongoDB API (3.2, 3.6 and 4.0) in two regions using shared database throughput with two collections.
Create an Azure Cosmos account for MongoDB API autoscale

Deploy to Azure
This template creates an Azure Cosmos DB account for MongoDB API (3.2, 3.6 or 4.0) in two regions using shared autoscale database throughput with two collections.