Share via

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2023-11-15

  • Article

Bicep resource definition

The databaseAccounts/mongodbDatabases/collections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      createMode: 'string'
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Name Description Value
autoscaleSettings Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Name Description Value
location The location of the resource group to which the resource belongs. string
name The resource name 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.		 Symbolic name for resource of type: databaseAccounts/mongodbDatabases
properties Properties to create and update Azure Cosmos DB MongoDB collection. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
resource The standard JSON format of a MongoDB collection MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (required)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Name Description Value
analyticalStorageTtl Analytical TTL. int
createMode Enum to indicate the mode of resource creation. 'Default'
'Restore'
id Name of the Cosmos DB MongoDB collection string (required)
indexes List of index keys MongoIndex[]
restoreParameters Parameters to indicate the information about the restore ResourceRestoreParameters
shardKey A key-value pair of shard keys to be applied for the request. ShardKeys

MongoIndex

Name Description Value
key Cosmos DB MongoDB collection index keys MongoIndexKeys
options Cosmos DB MongoDB collection index key 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

ResourceRestoreParameters

Name Description Value
restoreSource The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Time to which the account has to be restored (ISO-8601 format). string

ShardKeys

Name Description Value

Tags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Create an Azure Cosmos account for MongoDB API This template creates an Azure Cosmos DB account for MongoDB API 4.2 in two regions using shared and dedicated throughput with two collections.
Create an Azure Cosmos account for MongoDB API autoscale This template creates an Azure Cosmos DB account for MongoDB API 4.2 in two regions using both shared and dedicated autoscale throughput.

ARM template resource definition

The databaseAccounts/mongodbDatabases/collections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2023-11-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "createMode": "string",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Name Description Value
autoscaleSettings Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Name Description Value
apiVersion The api version '2023-11-15'
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
properties Properties to create and update Azure Cosmos DB MongoDB collection. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
resource The standard JSON format of a MongoDB collection MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (required)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Name Description Value
analyticalStorageTtl Analytical TTL. int
createMode Enum to indicate the mode of resource creation. 'Default'
'Restore'
id Name of the Cosmos DB MongoDB collection string (required)
indexes List of index keys MongoIndex[]
restoreParameters Parameters to indicate the information about the restore ResourceRestoreParameters
shardKey A key-value pair of shard keys to be applied for the request. ShardKeys

MongoIndex

Name Description Value
key Cosmos DB MongoDB collection index keys MongoIndexKeys
options Cosmos DB MongoDB collection index key 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

ResourceRestoreParameters

Name Description Value
restoreSource The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Time to which the account has to be restored (ISO-8601 format). string

ShardKeys

Name Description Value

Tags

Name Description Value

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 4.2 in two regions using shared and dedicated 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 4.2 in two regions using both shared and dedicated autoscale throughput.

Terraform (AzAPI provider) resource definition

The databaseAccounts/mongodbDatabases/collections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        createMode = "string"
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Property values

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Name Description Value
autoscaleSettings Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Name Description Value
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts/mongodbDatabases
properties Properties to create and update Azure Cosmos DB MongoDB collection. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
resource The standard JSON format of a MongoDB collection MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (required)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Name Description Value
analyticalStorageTtl Analytical TTL. int
createMode Enum to indicate the mode of resource creation. 'Default'
'Restore'
id Name of the Cosmos DB MongoDB collection string (required)
indexes List of index keys MongoIndex[]
restoreParameters Parameters to indicate the information about the restore ResourceRestoreParameters
shardKey A key-value pair of shard keys to be applied for the request. ShardKeys

MongoIndex

Name Description Value
key Cosmos DB MongoDB collection index keys MongoIndexKeys
options Cosmos DB MongoDB collection index key 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

ResourceRestoreParameters

Name Description Value
restoreSource The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Time to which the account has to be restored (ISO-8601 format). string

ShardKeys

Name Description Value

Tags

Name Description Value