Microsoft.DocumentDB databaseAccounts/mongodbDatabases 2024-02-15-preview
- Latest
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep resource definition
The databaseAccounts/mongodbDatabases 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/mongodbDatabases resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-02-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
}
}
}
Property values
databaseAccounts/mongodbDatabases
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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 |
| 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 |
| identity | Identity for the resource. | ManagedServiceIdentity |
| properties | Properties to create and update Azure Cosmos DB MongoDB database. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (required) |
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
| Name | Description | Value |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| 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. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| resource | The standard JSON format of a MongoDB database | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (required) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| 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 |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Name | Description | Value |
|---|---|---|
| createMode | Enum to indicate the mode of resource creation. | 'Default' 'PointInTimeRestore' 'Restore' |
| id | Name of the Cosmos DB MongoDB database | string (required) |
| restoreParameters | Parameters to indicate the information about the restore | ResourceRestoreParameters |
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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | 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 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/mongodbDatabases resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
"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": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
}
}
}
}
Property values
databaseAccounts/mongodbDatabases
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases' |
| 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 database. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (required) |
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
| Name | Description | Value |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| 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. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| resource | The standard JSON format of a MongoDB database | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (required) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| 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 |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Name | Description | Value |
|---|---|---|
| createMode | Enum to indicate the mode of resource creation. | 'Default' 'PointInTimeRestore' 'Restore' |
| id | Name of the Cosmos DB MongoDB database | string (required) |
| restoreParameters | Parameters to indicate the information about the restore | ResourceRestoreParameters |
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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | 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. |
Terraform (AzAPI provider) resource definition
The databaseAccounts/mongodbDatabases 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 resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-02-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
}
}
})
}
Property values
databaseAccounts/mongodbDatabases
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-02-15-preview" |
| name | The resource name | string (required) |
| location | The location of the resource group to which the resource belongs. | string |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: databaseAccounts |
| 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. |
| identity | Identity for the resource. | ManagedServiceIdentity |
| properties | Properties to create and update Azure Cosmos DB MongoDB database. | MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (required) |
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. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | 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}'. | Array of user identity IDs. |
ManagedServiceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
| 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. | CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt... |
| resource | The standard JSON format of a MongoDB database | MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (required) |
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| 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 |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| Name | Description | Value |
|---|---|---|
| createMode | Enum to indicate the mode of resource creation. | "Default" "PointInTimeRestore" "Restore" |
| id | Name of the Cosmos DB MongoDB database | string (required) |
| restoreParameters | Parameters to indicate the information about the restore | ResourceRestoreParameters |
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 |