Microsoft.DocumentDB databaseAccounts/mongodbDatabases 2021-04-01-preview

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-04-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: parentSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
    }
  }
}

Property values

databaseAccounts/mongodbDatabases

Name Description Value
type The resource type

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

For Bicep, set this value in the resource declaration.
'2021-04-01-preview'
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
identity Identity for the resource. ManagedServiceIdentity
properties Properties to create and update Azure Cosmos DB MongoDB database. MongoDBDatabaseCreateUpdateProperties (required)

ManagedServiceIdentity

Name Description Value
type The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. object

MongoDBDatabaseCreateUpdateProperties

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 MongoDB database resource object MongoDBDatabaseResource (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

MongoDBDatabaseResource

Name Description Value
id Name of the Cosmos DB MongoDB database string (required)

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.