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": "2024-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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",
"restoreWithTtlDisabled": "bool"
},
"shardKey": {
"{customized property}": "string"
}
}
}
}
Property values
databaseAccounts/mongodbDatabases/collections
Name |
Description |
Value |
type |
The resource type |
'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections' |
apiVersion |
The resource api version |
'2024-02-15-preview' |
name |
The resource name
See how to set names and types for child resources in JSON ARM templates. |
string (required) |
location |
The location of the resource group to which the resource belongs. |
string |
tags |
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB". |
Dictionary of tag names and values. See Tags in templates |
identity |
Identity for the resource. |
ManagedServiceIdentity |
properties |
Properties to create and update Azure Cosmos DB MongoDB collection. |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (required) |
ManagedServiceIdentity
Name |
Description |
Value |
type |
|
'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned': 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. |
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
Components1Jq1T4ISchemasManagedserviceidentityProper...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
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 |
AutoscaleSettings
Name |
Description |
Value |
maxThroughput |
Represents maximum throughput, the resource can scale up to. |
int |
MongoDBCollectionResourceOrMongoDBCollectionGetPrope...
Name |
Description |
Value |
analyticalStorageTtl |
Analytical TTL. |
int |
createMode |
Enum to indicate the mode of resource creation. |
'Default' 'PointInTimeRestore' '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
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 |
restoreWithTtlDisabled |
Specifies whether the restored account will have Time-To-Live disabled upon the successful restore. |
bool |
ShardKeys
Name |
Description |
Value |
{customized property} |
|
string |
Quickstart templates
The following quickstart templates deploy this resource type.