Microsoft. DocumentDB mongoClusters/users 2026-06-01

Bicep-Ressourcendefinition

Der Ressourcentyp mongoClusters/users kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Resource groups - Siehe resource group deployment-Befehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Verwendungsbeispiele

Beispiele für Bicep

Ein grundlegendes Beispiel für die Bereitstellung von Azure Cosmos DB für MongoDB (vCore)-Nutzer.

param resourceName string = 'acctest0001'
param location string = 'westus3'

resource mongoClusterSSDv2 'Microsoft.DocumentDB/mongoClusters@2025-09-01' = {
  name: '${resourceName}-ssdv2'
  location: location
  properties: {
    authConfig: {
      allowedModes: [
        'MicrosoftEntraID'
      ]
    }
    compute: {
      tier: 'M30'
    }
    highAvailability: {
      targetMode: 'Disabled'
    }
    publicNetworkAccess: 'Disabled'
    serverVersion: '6.0'
    sharding: {
      shardCount: 1
    }
    storage: {
      sizeGb: 64
      type: 'PremiumSSDv2'
    }
  }
}

resource userAssignedIdentity 'Microsoft.ManagedIdentity/userAssignedIdentities@2023-01-31' = {
  name: resourceName
  location: location
}

resource mongouserEntraserviceprincipal 'Microsoft.DocumentDB/mongoClusters/users@2025-09-01' = {
  name: 'azapi_resource.userAssignedIdentity.output.properties.principalId'
  parent: mongoClusterSSDv2
  properties: {
    identityProvider: {
      properties: {
        principalType: 'ServicePrincipal'
      }
      type: 'MicrosoftEntraID'
    }
    roles: [
      {
        db: 'admin'
        role: 'root'
      }
    ]
  }
}

Ressourcenformat

Fügen Sie der Vorlage den folgenden Bicep hinzu, um eine Microsoft.DocumentDB/mongoClusters/users-Ressource zu erstellen.

resource symbolicname 'Microsoft.DocumentDB/mongoClusters/users@2026-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    identityProvider: {
      type: 'string'
      // For remaining properties, see IdentityProvider objects
    }
    roles: [
      {
        db: 'string'
        role: 'string'
      }
    ]
  }
}

IdentityProvider-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für MicrosoftEntraID Folgendes:

{
  properties: {
    principalType: 'string'
  }
  type: 'MicrosoftEntraID'
}

Eigenschaftswerte

Microsoft.DocumentDB/mongoCluster/Benutzer

Datenbank-Rolle

EntraIdentityProvider

EntraIdentityProviderEigenschaften

IdentityProvider

Benutzereigenschaften

ARM-Vorlagenressourcendefinition

Der Ressourcentyp mongoClusters/users kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen – Siehe Ressourcengruppen-Deployment-Befehle Für eine Liste der geänderten Eigenschaften in jeder API-Version siehe Änderungsprotokoll.

Verwendungsbeispiele

Ressourcenformat

Um eine Microsoft.DocumentDB/mongoClusters/users-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/mongoClusters/users",
  "apiVersion": "2026-06-01",
  "name": "string",
  "properties": {
    "identityProvider": {
      "type": "string"
      // For remaining properties, see IdentityProvider objects
    },
    "roles": [
      {
        "db": "string",
        "role": "string"
      }
    ]
  }
}

IdentityProvider-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für MicrosoftEntraID Folgendes:

{
  "properties": {
    "principalType": "string"
  },
  "type": "MicrosoftEntraID"
}

Eigenschaftswerte

Microsoft.DocumentDB/mongoCluster/Benutzer

Datenbank-Rolle

EntraIdentityProvider

EntraIdentityProviderEigenschaften

IdentityProvider

Benutzereigenschaften

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp mongoClusters/users kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Change Log.

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung von Azure Cosmos DB für MongoDB (vCore)-Nutzer.

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

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "userAssignedIdentity" {
  type                      = "Microsoft.ManagedIdentity/userAssignedIdentities@2023-01-31"
  parent_id                 = azapi_resource.resourceGroup.id
  name                      = var.resource_name
  location                  = var.location
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_client_config" "current" {}

resource "azapi_resource" "mongoClusterSSDv2" {
  type      = "Microsoft.DocumentDB/mongoClusters@2025-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-ssdv2"
  location  = var.location
  body = {
    properties = {
      authConfig = {
        allowedModes = ["MicrosoftEntraID"]
      }
      compute = {
        tier = "M30"
      }
      highAvailability = {
        targetMode = "Disabled"
      }
      serverVersion       = "6.0"
      publicNetworkAccess = "Disabled"
      sharding = {
        shardCount = 1
      }
      storage = {
        sizeGb = 64
        type   = "PremiumSSDv2"
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "mongoUser_EntraServicePrincipal" {
  type      = "Microsoft.DocumentDB/mongoClusters/users@2025-09-01"
  name      = azapi_resource.userAssignedIdentity.output.properties.principalId
  parent_id = azapi_resource.mongoClusterSSDv2.id

  body = {
    properties = {
      roles = [
        {
          role = "root"
          db   = "admin"
        }
      ]
      identityProvider = {
        type = "MicrosoftEntraID"
        properties = {
          principalType = "ServicePrincipal"
        }
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Ressourcenformat

Um eine Microsoft.DocumentDB/mongoClusters/users-Ressource zu erstellen, fügen Sie Ihrer Vorlage das folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters/users@2026-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      identityProvider = {
        type = "string"
        // For remaining properties, see IdentityProvider objects
      }
      roles = [
        {
          db = "string"
          role = "string"
        }
      ]
    }
  }
}

IdentityProvider-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für MicrosoftEntraID Folgendes:

{
  properties = {
    principalType = "string"
  }
  type = "MicrosoftEntraID"
}

Eigenschaftswerte

Microsoft.DocumentDB/mongoCluster/Benutzer

Datenbank-Rolle

EntraIdentityProvider

EntraIdentityProviderEigenschaften

IdentityProvider

Benutzereigenschaften