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.
To create a Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-02-15-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
id: 'string'
indexes: [
{
key: {
keys: [
'string'
]
}
options: {
expireAfterSeconds: int
unique: bool
}
}
]
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 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Name |
Description |
Value |
autoscaleSettings |
Specifies the Autoscale settings. |
AutoscaleSettings |
throughput |
Request Units per second. For example, "throughput": 10000. |
int |
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}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
Name |
Description |
Value |
analyticalStorageTtl |
Analytical TTL. |
int |
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
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
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
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.
To create a Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
"apiVersion": "2022-02-15-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"id": "string",
"indexes": [
{
"key": {
"keys": [ "string" ]
},
"options": {
"expireAfterSeconds": "int",
"unique": "bool"
}
}
],
"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 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Name |
Description |
Value |
autoscaleSettings |
Specifies the Autoscale settings. |
AutoscaleSettings |
throughput |
Request Units per second. For example, "throughput": 10000. |
int |
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}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
Name |
Description |
Value |
apiVersion |
The api version |
'2022-02-15-preview' |
identity |
Identity for the resource. |
ManagedServiceIdentity |
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
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
Name |
Description |
Value |
analyticalStorageTtl |
Analytical TTL. |
int |
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
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
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
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.
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@2022-02-15-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = int
id = "string"
indexes = [
{
key = {
keys = [
"string"
]
}
options = {
expireAfterSeconds = int
unique = bool
}
}
]
shardKey = {
{customized property} = "string"
}
}
}
}
}
Property Values
AutoscaleSettings
Name |
Description |
Value |
maxThroughput |
Represents maximum throughput, the resource can scale up to. |
int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
Name |
Description |
Value |
autoscaleSettings |
Specifies the Autoscale settings. |
AutoscaleSettings |
throughput |
Request Units per second. For example, "throughput": 10000. |
int |
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}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
Name |
Description |
Value |
identity |
Identity for the resource. |
ManagedServiceIdentity |
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@2022-02-15-preview" |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
Name |
Description |
Value |
analyticalStorageTtl |
Analytical TTL. |
int |
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
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