Microsoft.DocumentDB databaseAccounts/mongodbDatabases 2020-04-01

Template format

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

{
  "name": "string",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
  "apiVersion": "2020-04-01",
  "location": "string",
  "tags": {},
  "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/mongodbDatabases object

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

See Set name and type for child resources.
apiVersion enum Yes 2020-04-01
location string No The location of the resource group to which the resource belongs.
tags object No
properties object Yes Properties to create and update Azure Cosmos DB MongoDB database. - MongoDBDatabaseCreateUpdateProperties object
resources array No collections

MongoDBDatabaseCreateUpdateProperties object

Name Type Required Value
resource object Yes The standard JSON format of a MongoDB database - MongoDBDatabaseResource 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

MongoDBDatabaseResource object

Name Type Required Value
id string Yes Name of the Cosmos DB MongoDB database

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 account for MongoDB API (3.2 or 3.6)

Deploy to Azure
This template creates an Azure Cosmos DB account for MongoDB API (3.2 or 3.6) 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 or 3.6) in two regions using shared autoscale database throughput with two collections.