Share via

Microsoft.DocumentDB databaseAccounts/mongodbUserDefinitions

  • Article

Bicep resource definition

The databaseAccounts/mongodbUserDefinitions resource type can be deployed with operations that target:

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

Resource format

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2024-05-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    customData: 'string'
    databaseName: 'string'
    mechanisms: 'string'
    password: 'string'
    roles: [
      {
        db: 'string'
        role: 'string'
      }
    ]
    userName: 'string'
  }
}

Property values

databaseAccounts/mongodbUserDefinitions

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 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 to create and update an Azure Cosmos DB Mongo 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
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:

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

Resource format

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions",
  "apiVersion": "2024-05-15",
  "name": "string",
  "properties": {
    "customData": "string",
    "databaseName": "string",
    "mechanisms": "string",
    "password": "string",
    "roles": [
      {
        "db": "string",
        "role": "string"
      }
    ],
    "userName": "string"
  }
}

Property values

databaseAccounts/mongodbUserDefinitions

Name Description Value
type The resource type 'Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions'
apiVersion The resource api version '2024-05-15'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Properties to create and update an Azure Cosmos DB Mongo 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
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.

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@2024-05-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      customData = "string"
      databaseName = "string"
      mechanisms = "string"
      password = "string"
      roles = [
        {
          db = "string"
          role = "string"
        }
      ]
      userName = "string"
    }
  })
}

Property values

databaseAccounts/mongodbUserDefinitions

Name Description Value
type The resource type "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2024-05-15"
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 to create and update an Azure Cosmos DB Mongo 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
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