Microsoft.DocumentDB databaseAccounts/apis/databases/containers 2015-11-06

Article
12/09/2024

Bicep resource definition

The databaseAccounts/apis/databases/containers resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

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

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/apis/databases/containers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Property values

ConflictResolutionPolicy

Name	Description	Value
conflictResolutionPath	The conflict resolution path in the case of LastWriterWins mode.	string
conflictResolutionProcedure	The procedure to resolve conflicts in the case of custom mode.	string
mode	Indicates the conflict resolution mode.	'Custom' 'LastWriterWins'

ContainerPartitionKey

Name	Description	Value
kind	Indicates the kind of algorithm used for partitioning	'Hash' 'Range'
paths	List of paths using which data within the container can be partitioned	string[]

CreateUpdateOptions

Name	Description	Value

ExcludedPath

Name	Description	Value
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

IncludedPath

Name	Description	Value
indexes	List of indexes for this path	Indexes[]
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

Indexes

Name	Description	Value
dataType	The datatype for which the indexing behavior is applied to.	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
kind	Indicates the type of index.	'Hash' 'Range' 'Spatial'
precision	The precision of the index. -1 is maximum precision.	int

IndexingPolicy

Name	Description	Value
automatic	Indicates if the indexing policy is automatic	bool
excludedPaths	List of paths to exclude from indexing	ExcludedPath[]
includedPaths	List of paths to include in the indexing	IncludedPath[]
indexingMode	Indicates the indexing mode.	'Consistent' 'Lazy' 'None'

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

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 container.	SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (required)

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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 container	SqlContainerResource (required)

SqlContainerResource

Name	Description	Value
conflictResolutionPolicy	The conflict resolution policy for the container.	ConflictResolutionPolicy
defaultTtl	Default time to live	int
id	Name of the Cosmos DB SQL container	string (required)
indexingPolicy	The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container	IndexingPolicy
partitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions	ContainerPartitionKey
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.	UniqueKeyPolicy

UniqueKey

Name	Description	Value
paths	List of paths must be unique for each document in the Azure Cosmos DB service	string[]

UniqueKeyPolicy

Name	Description	Value
uniqueKeys	List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.	UniqueKey[]

ARM template resource definition

The databaseAccounts/apis/databases/containers resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

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

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/apis/databases/containers resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
  "apiVersion": "2015-11-06",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ]
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Property values

ConflictResolutionPolicy

Name	Description	Value
conflictResolutionPath	The conflict resolution path in the case of LastWriterWins mode.	string
conflictResolutionProcedure	The procedure to resolve conflicts in the case of custom mode.	string
mode	Indicates the conflict resolution mode.	'Custom' 'LastWriterWins'

ContainerPartitionKey

Name	Description	Value
kind	Indicates the kind of algorithm used for partitioning	'Hash' 'Range'
paths	List of paths using which data within the container can be partitioned	string[]

CreateUpdateOptions

Name	Description	Value

ExcludedPath

Name	Description	Value
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

IncludedPath

Name	Description	Value
indexes	List of indexes for this path	Indexes[]
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

Indexes

Name	Description	Value
dataType	The datatype for which the indexing behavior is applied to.	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
kind	Indicates the type of index.	'Hash' 'Range' 'Spatial'
precision	The precision of the index. -1 is maximum precision.	int

IndexingPolicy

Name	Description	Value
automatic	Indicates if the indexing policy is automatic	bool
excludedPaths	List of paths to exclude from indexing	ExcludedPath[]
includedPaths	List of paths to include in the indexing	IncludedPath[]
indexingMode	Indicates the indexing mode.	'Consistent' 'Lazy' 'None'

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Name	Description	Value
apiVersion	The api version	'2015-11-06'
name	The resource name	string (required)
properties	Properties to create and update Azure Cosmos DB container.	SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (required)
type	The resource type	'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers'

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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 container	SqlContainerResource (required)

SqlContainerResource

Name	Description	Value
conflictResolutionPolicy	The conflict resolution policy for the container.	ConflictResolutionPolicy
defaultTtl	Default time to live	int
id	Name of the Cosmos DB SQL container	string (required)
indexingPolicy	The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container	IndexingPolicy
partitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions	ContainerPartitionKey
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.	UniqueKeyPolicy

UniqueKey

Name	Description	Value
paths	List of paths must be unique for each document in the Azure Cosmos DB service	string[]

UniqueKeyPolicy

Name	Description	Value
uniqueKeys	List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.	UniqueKey[]

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create Azure Cosmos with SQL API and multiple containers	The template creates a Cosmos container with a SQL API and allows adding mulitple containers.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06"
  name = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Property values

ConflictResolutionPolicy

Name	Description	Value
conflictResolutionPath	The conflict resolution path in the case of LastWriterWins mode.	string
conflictResolutionProcedure	The procedure to resolve conflicts in the case of custom mode.	string
mode	Indicates the conflict resolution mode.	'Custom' 'LastWriterWins'

ContainerPartitionKey

Name	Description	Value
kind	Indicates the kind of algorithm used for partitioning	'Hash' 'Range'
paths	List of paths using which data within the container can be partitioned	string[]

CreateUpdateOptions

Name	Description	Value

ExcludedPath

Name	Description	Value
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

IncludedPath

Name	Description	Value
indexes	List of indexes for this path	Indexes[]
path	The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)	string

Indexes

Name	Description	Value
dataType	The datatype for which the indexing behavior is applied to.	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
kind	Indicates the type of index.	'Hash' 'Range' 'Spatial'
precision	The precision of the index. -1 is maximum precision.	int

IndexingPolicy

Name	Description	Value
automatic	Indicates if the indexing policy is automatic	bool
excludedPaths	List of paths to exclude from indexing	ExcludedPath[]
includedPaths	List of paths to include in the indexing	IncludedPath[]
indexingMode	Indicates the indexing mode.	'Consistent' 'Lazy' 'None'

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

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 container.	SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (required)
type	The resource type	"Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06"

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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 container	SqlContainerResource (required)

SqlContainerResource

Name	Description	Value
conflictResolutionPolicy	The conflict resolution policy for the container.	ConflictResolutionPolicy
defaultTtl	Default time to live	int
id	Name of the Cosmos DB SQL container	string (required)
indexingPolicy	The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container	IndexingPolicy
partitionKey	The configuration of the partition key to be used for partitioning data into multiple partitions	ContainerPartitionKey
uniqueKeyPolicy	The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.	UniqueKeyPolicy

UniqueKey

Name	Description	Value
paths	List of paths must be unique for each document in the Azure Cosmos DB service	string[]

UniqueKeyPolicy

Name	Description	Value
uniqueKeys	List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.	UniqueKey[]

Share via

Microsoft.DocumentDB databaseAccounts/apis/databases/containers 2015-11-06

Bicep resource definition

Resource format

Property values

ConflictResolutionPolicy

ContainerPartitionKey

CreateUpdateOptions

ExcludedPath

IncludedPath

Indexes

IndexingPolicy

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

SqlContainerResource

UniqueKey

UniqueKeyPolicy

ARM template resource definition

Resource format

Property values

ConflictResolutionPolicy

ContainerPartitionKey

CreateUpdateOptions

ExcludedPath

IncludedPath

Indexes

IndexingPolicy

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

SqlContainerResource

UniqueKey

UniqueKeyPolicy

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

ConflictResolutionPolicy

ContainerPartitionKey

CreateUpdateOptions

ExcludedPath

IncludedPath

Indexes

IndexingPolicy

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

SqlContainerResource

UniqueKey

UniqueKeyPolicy

Feedback

Additional resources