Microsoft.DocumentDB databaseAccounts template reference

Template format

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

{
  "name": "string",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2015-04-08",
  "location": "string",
  "tags": {},
  "kind": "string",
  "properties": {
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxStalenessPrefix": "integer",
      "maxIntervalInSeconds": "integer"
    },
    "locations": [
      {
        "locationName": "string",
        "failoverPriority": "integer",
        "isZoneRedundant": "boolean"
      }
    ],
    "databaseAccountOfferType": "Standard",
    "ipRangeFilter": "string",
    "isVirtualNetworkFilterEnabled": "boolean",
    "enableAutomaticFailover": "boolean",
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "boolean"
      }
    ],
    "enableMultipleWriteLocations": "boolean",
    "enableCassandraConnector": "boolean",
    "connectorOffer": "Small"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.DocumentDB/databaseAccounts object

Name Type Required Value
name string Yes Cosmos DB database account name.
type enum Yes Microsoft.DocumentDB/databaseAccounts
apiVersion enum Yes 2015-04-08
location string No The location of the resource group to which the resource belongs.
tags object No
kind enum No Indicates the type of database account. This can only be set at database account creation. - GlobalDocumentDB, MongoDB, Parse
properties object Yes DatabaseAccountCreateUpdateProperties object

DatabaseAccountCreateUpdateProperties object

Name Type Required Value
consistencyPolicy object No The consistency policy for the Cosmos DB account. - ConsistencyPolicy object
locations array Yes An array that contains the georeplication locations enabled for the Cosmos DB account. - Location object
databaseAccountOfferType enum Yes The offer type for the database - Standard
ipRangeFilter string No Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
isVirtualNetworkFilterEnabled boolean No Flag to indicate whether to enable/disable Virtual Network ACL rules.
enableAutomaticFailover boolean No Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
capabilities array No List of Cosmos DB capabilities for the account - Capability object
virtualNetworkRules array No List of Virtual Network ACL rules configured for the Cosmos DB account. - VirtualNetworkRule object
enableMultipleWriteLocations boolean No Enables the account to write in multiple locations
enableCassandraConnector boolean No Enables the cassandra connector on the Cosmos DB C* account
connectorOffer enum No The cassandra connector offer type for the Cosmos DB database C* account. - Small

ConsistencyPolicy object

Name Type Required Value
defaultConsistencyLevel enum Yes The default consistency level and configuration settings of the Cosmos DB account. - Eventual, Session, BoundedStaleness, Strong, ConsistentPrefix
maxStalenessPrefix integer No When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
maxIntervalInSeconds integer No When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.

Location object

Name Type Required Value
locationName string No The name of the region.
failoverPriority integer No The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
isZoneRedundant boolean No Flag to indicate whether or not this region is an AvailabilityZone region

Capability object

Name Type Required Value
name string No Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".

VirtualNetworkRule object

Name Type Required Value
id string No Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint boolean No Create firewall rule before the virtual network has vnet service endpoint enabled.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an Azure Cosmos DB account for Cassandra API

Deploy to Azure
This template creates an Azure Cosmos DB account for Cassandra API in two regions with a keyspace and table with dedicated throughput.
Create autoscale Azure Cosmos DB account for Cassandra API

Deploy to Azure
This template creates an Azure Cosmos DB account for Cassandra API in two regions with a keyspace and table with autoscale throughput.
Create an Azure Cosmos account for SQL API

Deploy to Azure
This template creates an Azure Cosmos account for Core (SQL) API, a database, a container with dedicate throughput and multiple other options.
Create an Azure CosmosDB Account

Deploy to Azure
This ARM template is intented to create a CosmosDB Account quickly with the minimal required values
Create an Azure Cosmos DB account in multiple regions

Deploy to Azure
This template creates an Azure Cosmos DB account for any API Type with a primary and secondary region with choice of consistency level and options to enable multi-master and Failover Type.
Create a free-tier Azure Cosmos DB account

Deploy to Azure
This template creates a free-tier Azure Cosmos account for Core (SQL) API with a database with shared throughput of 400 RU/s.
Create an Azure Cosmos DB account for Gremlin API

Deploy to Azure
This template creates an Azure Cosmos DB account for Gremlin API in two regions with one database and one graph using dedicated throughput.
Create an Azure Cosmos DB account for Gremlin API autoscale

Deploy to Azure
This template creates an Azure Cosmos DB account for Gremlin API in two regions with one database and one graph using autoscale throughput.
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.
Create an Azure Cosmos DB Account with a private endpoint

Deploy to Azure
This template will create a Cosmos account, a virtual network and a private endpoint exposing the Cosmos account to the virtual network.
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 autoscale and 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.
Create an Azure Cosmos account for Table API

Deploy to Azure
This template creates an Azure Cosmos DB account for Table API in two regions and a single table with provisioned throughput.
Create an Azure Cosmos account for Table API with autoscale

Deploy to Azure
This template creates an Azure Cosmos DB account for Table API in two regions and a single table with autoscale throughput.
Create a CosmosDB Account with Advanced Threat Protection.

Deploy to Azure
This template allows you to deploy an Azure CosmosDB account with Advanced Threat Protection (preview) enabled.
Azure Cosmos DB Account with Web App

Deploy to Azure
This template deploys an Azure Cosmos DB account, an App Service Plan, and creates a Web App in the App Service Plan. It also adds two Application settings to the Web App that reference the Azure Cosmos DB account endpoint. This way solutions deployed to the Web App can connect to the Azure Cosmos DB account endpoint using those settings.
Web App with a SQL Database, Azure Cosmos DB, Azure Search

Deploy to Azure
This template provisions a Web App, a SQL Database, Azure Cosmos DB, Azure Search and Application Insights.
CI/CD using Jenkins on Azure Container Service (AKS)

Deploy to Azure
Containers make it very easy for you to continuously build and deploy your applications. By orchestrating deployment of those containers using Kubernetes in Azure Container Service, you can achieve replicable, manageable clusters of containers. By setting up a continuous build to produce your container images and orchestration, you can increase the speed and reliability of your deployment.