Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The databaseAccounts/mongodbUserDefinitions 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.
Usage Examples
Bicep Samples
A basic example of deploying Cosmos DB Mongo User Definition.
param resourceName string = 'acctest0001'
param location string = 'westus'
@secure()
@description('The password for the MongoDB user')
param mongodbUserPassword string
resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2024-08-15' = {
name: '${resourceName}-acct'
location: location
kind: 'MongoDB'
properties: {
capabilities: [
{
name: 'EnableMongoRoleBasedAccessControl'
}
{
name: 'EnableMongo'
}
]
consistencyPolicy: {
defaultConsistencyLevel: 'Strong'
maxIntervalInSeconds: 5
maxStalenessPrefix: 100
}
databaseAccountOfferType: 'Standard'
disableKeyBasedMetadataWriteAccess: false
disableLocalAuth: false
enableAnalyticalStorage: false
enableAutomaticFailover: false
enableBurstCapacity: false
enableFreeTier: false
enableMultipleWriteLocations: false
enablePartitionMerge: false
ipRules: []
isVirtualNetworkFilterEnabled: false
locations: [
{
failoverPriority: 0
isZoneRedundant: false
locationName: location
}
]
minimalTlsVersion: 'Tls12'
networkAclBypass: 'None'
networkAclBypassResourceIds: []
publicNetworkAccess: 'Enabled'
virtualNetworkRules: []
}
}
resource mongodbUserDefinition 'Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2022-11-15' = {
name: '${mongodbDatabas.name}.myUserName'
parent: databaseAccount
properties: {
databaseName: mongodbDatabas.name
mechanisms: 'SCRAM-SHA-256'
password: mongodbUserPassword
userName: 'myUserName'
}
}
resource mongodbDatabas 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-10-15' = {
name: '${resourceName}-mongodb'
parent: databaseAccount
properties: {
options: {}
resource: {
id: '${resourceName}-mongodb'
}
}
}
Resource format
To create a Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2026-04-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
customData: 'string'
databaseName: 'string'
mechanisms: 'string'
password: 'string'
roles: [
{
db: 'string'
role: 'string'
}
]
userName: 'string'
}
}
Property Values
Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions
| 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 |
| properties | Properties related to the User Definition. | MongoUserDefinitionResource |
MongoUserDefinitionResource
| Name | Description | Value |
|---|---|---|
| customData | A custom definition for the USer Definition. | string |
| databaseName | The database name for which access is being granted for this User Definition. | string |
| mechanisms | The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256. | string |
| password | The password for User Definition. Response does not contain user password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| roles | The set of roles inherited by the User Definition. | Role[] |
| userName | The user name for User Definition. | string |
Role
| Name | Description | Value |
|---|---|---|
| db | The database name the role is applied. | string |
| role | The role name. | string |
ARM template resource definition
The databaseAccounts/mongodbUserDefinitions 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.
Usage Examples
Resource format
To create a Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions",
"apiVersion": "2026-04-01-preview",
"name": "string",
"properties": {
"customData": "string",
"databaseName": "string",
"mechanisms": "string",
"password": "string",
"roles": [
{
"db": "string",
"role": "string"
}
],
"userName": "string"
}
}
Property Values
Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-04-01-preview' |
| name | The resource name | string (required) |
| properties | Properties related to the User Definition. | MongoUserDefinitionResource |
| type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions' |
MongoUserDefinitionResource
| Name | Description | Value |
|---|---|---|
| customData | A custom definition for the USer Definition. | string |
| databaseName | The database name for which access is being granted for this User Definition. | string |
| mechanisms | The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256. | string |
| password | The password for User Definition. Response does not contain user password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| roles | The set of roles inherited by the User Definition. | Role[] |
| userName | The user name for User Definition. | string |
Role
| Name | Description | Value |
|---|---|---|
| db | The database name the role is applied. | string |
| role | The role name. | string |
Terraform (AzAPI provider) resource definition
The databaseAccounts/mongodbUserDefinitions resource type can be deployed with operations that target:
- Resource groups For a list of changed properties in each API version, see change log.
Usage Examples
Terraform Samples
A basic example of deploying Cosmos DB Mongo User Definition.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westus"
}
variable "mongodb_user_password" {
type = string
description = "The password for the MongoDB user"
sensitive = true
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "databaseAccount" {
type = "Microsoft.DocumentDB/databaseAccounts@2024-08-15"
parent_id = azapi_resource.resourceGroup.id
name = "${var.resource_name}-acct"
location = var.location
body = {
kind = "MongoDB"
properties = {
backupPolicy = null
capabilities = [{
name = "EnableMongoRoleBasedAccessControl"
}, {
name = "EnableMongo"
}]
consistencyPolicy = {
defaultConsistencyLevel = "Strong"
maxIntervalInSeconds = 5
maxStalenessPrefix = 100
}
databaseAccountOfferType = "Standard"
disableKeyBasedMetadataWriteAccess = false
disableLocalAuth = false
enableAnalyticalStorage = false
enableAutomaticFailover = false
enableBurstCapacity = false
enableFreeTier = false
enableMultipleWriteLocations = false
enablePartitionMerge = false
ipRules = []
isVirtualNetworkFilterEnabled = false
locations = [{
failoverPriority = 0
isZoneRedundant = false
locationName = var.location
}]
minimalTlsVersion = "Tls12"
networkAclBypass = "None"
networkAclBypassResourceIds = []
publicNetworkAccess = "Enabled"
virtualNetworkRules = []
}
}
}
resource "azapi_resource" "mongodbDatabas" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2021-10-15"
parent_id = azapi_resource.databaseAccount.id
name = "${var.resource_name}-mongodb"
body = {
properties = {
options = {}
resource = {
id = "${var.resource_name}-mongodb"
}
}
}
}
resource "azapi_resource" "mongodbUserDefinition" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2022-11-15"
parent_id = azapi_resource.databaseAccount.id
name = "${azapi_resource.mongodbDatabas.name}.myUserName"
body = {
properties = {
databaseName = azapi_resource.mongodbDatabas.name
mechanisms = "SCRAM-SHA-256"
password = var.mongodb_user_password
userName = "myUserName"
}
}
}
Resource format
To create a Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2026-04-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
customData = "string"
databaseName = "string"
mechanisms = "string"
password = "string"
roles = [
{
db = "string"
role = "string"
}
]
userName = "string"
}
}
}
Property Values
Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions
| 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 |
| properties | Properties related to the User Definition. | MongoUserDefinitionResource |
| type | The resource type | "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2026-04-01-preview" |
MongoUserDefinitionResource
| Name | Description | Value |
|---|---|---|
| customData | A custom definition for the USer Definition. | string |
| databaseName | The database name for which access is being granted for this User Definition. | string |
| mechanisms | The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256. | string |
| password | The password for User Definition. Response does not contain user password. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| roles | The set of roles inherited by the User Definition. | Role[] |
| userName | The user name for User Definition. | string |
Role
| Name | Description | Value |
|---|---|---|
| db | The database name the role is applied. | string |
| role | The role name. | string |