Share via

Microsoft.DocumentDB databaseAccounts/apis/databases/collections 2016-03-19

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-19' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

Property values

CreateUpdateOptions

Name Description Value

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Name Description Value
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/apis/databases
properties Properties to create and update Azure Cosmos DB MongoDB collection. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (required)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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. CreateUpdateOptions (required)
resource The standard JSON format of a MongoDB collection MongoDBCollectionResource (required)

MongoDBCollectionResource

Name Description Value
id Name of the Cosmos DB MongoDB collection string (required)
indexes List of index keys MongoIndex[]
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

ShardKeys

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2016-03-19",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

Property values

CreateUpdateOptions

Name Description Value

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Name Description Value
apiVersion The api version '2016-03-19'
name The resource name string (required)
properties Properties to create and update Azure Cosmos DB MongoDB collection. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (required)
type The resource type 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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. CreateUpdateOptions (required)
resource The standard JSON format of a MongoDB collection MongoDBCollectionResource (required)

MongoDBCollectionResource

Name Description Value
id Name of the Cosmos DB MongoDB collection string (required)
indexes List of index keys MongoIndex[]
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

ShardKeys

Name Description Value

Terraform (AzAPI provider) resource definition

The databaseAccounts/apis/databases/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/apis/databases/collections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-19"
  name = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Property values

CreateUpdateOptions

Name Description Value

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Name Description Value
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/apis/databases
properties Properties to create and update Azure Cosmos DB MongoDB collection. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (required)
type The resource type "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-19"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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. CreateUpdateOptions (required)
resource The standard JSON format of a MongoDB collection MongoDBCollectionResource (required)

MongoDBCollectionResource

Name Description Value
id Name of the Cosmos DB MongoDB collection string (required)
indexes List of index keys MongoIndex[]
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

ShardKeys

Name Description Value