Udostępnij przez


Microsoft.DocumentDB databaseAccounts/mongodbUserDefinitions

Definicja zasobu Bicep

Typ zasobu databaseAccounts/mongodbUserDefinitions można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: databaseAccounts
Właściwości Właściwości do tworzenia i aktualizowania definicji użytkownika mongo usługi Azure Cosmos DB. MongoUserDefinitionResource

MongoUserDefinitionResource

Nazwa Opis Wartość
customData Definicja niestandardowa definicji USer. ciąg
nazwaBazyDanych Nazwa bazy danych, dla której jest udzielany dostęp dla tej definicji użytkownika. ciąg
Mechanizmy Mechanizm uwierzytelniania Mongo. Na razie obsługujemy tylko mechanizm uwierzytelniania SCRAM-SHA-256. ciąg
hasło Hasło definicji użytkownika. Odpowiedź nie zawiera hasła użytkownika. ciąg
Ról Zestaw ról dziedziczony przez definicję użytkownika. roli []
userName Nazwa użytkownika definicji użytkownika. ciąg

Rola

Nazwa Opis Wartość
Db Nazwa bazy danych, która jest stosowana. ciąg
rola Nazwa roli. ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/mongodbUserDefinitions można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions",
  "apiVersion": "2025-11-01-preview",
  "name": "string",
  "properties": {
    "customData": "string",
    "databaseName": "string",
    "mechanisms": "string",
    "password": "string",
    "roles": [
      {
        "db": "string",
        "role": "string"
      }
    ],
    "userName": "string"
  }
}

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2025-11-01-podgląd"
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do tworzenia i aktualizowania definicji użytkownika mongo usługi Azure Cosmos DB. MongoUserDefinitionResource
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions"

MongoUserDefinitionResource

Nazwa Opis Wartość
customData Definicja niestandardowa definicji USer. ciąg
nazwaBazyDanych Nazwa bazy danych, dla której jest udzielany dostęp dla tej definicji użytkownika. ciąg
Mechanizmy Mechanizm uwierzytelniania Mongo. Na razie obsługujemy tylko mechanizm uwierzytelniania SCRAM-SHA-256. ciąg
hasło Hasło definicji użytkownika. Odpowiedź nie zawiera hasła użytkownika. ciąg
Ról Zestaw ról dziedziczony przez definicję użytkownika. roli []
userName Nazwa użytkownika definicji użytkownika. ciąg

Rola

Nazwa Opis Wartość
Db Nazwa bazy danych, która jest stosowana. ciąg
rola Nazwa roli. ciąg

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/mongodbUserDefinitions można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      customData = "string"
      databaseName = "string"
      mechanisms = "string"
      password = "string"
      roles = [
        {
          db = "string"
          role = "string"
        }
      ]
      userName = "string"
    }
  }
}

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts
Właściwości Właściwości do tworzenia i aktualizowania definicji użytkownika mongo usługi Azure Cosmos DB. MongoUserDefinitionResource
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions@2025-11-01-preview"

MongoUserDefinitionResource

Nazwa Opis Wartość
customData Definicja niestandardowa definicji USer. ciąg
nazwaBazyDanych Nazwa bazy danych, dla której jest udzielany dostęp dla tej definicji użytkownika. ciąg
Mechanizmy Mechanizm uwierzytelniania Mongo. Na razie obsługujemy tylko mechanizm uwierzytelniania SCRAM-SHA-256. ciąg
hasło Hasło definicji użytkownika. Odpowiedź nie zawiera hasła użytkownika. ciąg
Ról Zestaw ról dziedziczony przez definicję użytkownika. roli []
userName Nazwa użytkownika definicji użytkownika. ciąg

Rola

Nazwa Opis Wartość
Db Nazwa bazy danych, która jest stosowana. ciąg
rola Nazwa roli. ciąg

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania definicji użytkownika Cosmos DB Mongo.

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"
    }
  }
}