Microsoft. DocumentDB mongoClusters/kullanıcılar

Bicep kaynak tanımı

mongoClusters/users kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kullanım Örnekleri

Bicep Örnekleri

Azure Cosmos DB'nin MongoDB (vCore) Kullanıcısı için dağıtılmasına temel bir örnek.

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'
      }
    ]
  }
}

Kaynak biçimi

Microsoft.DocumentDB/mongoClusters/users kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

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 nesneleri

Nesne türünü belirtmek için türü özelliğini ayarlayın.

MicrosoftEntraID için şunu kullanın:

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

Özellik Değerleri

Microsoft.DocumentDB/mongoClusters/users

İsim Açıklama Değer
isim Kaynak adı karakter dizisi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 63
Desen = ^[a-zA-Z0-9\-]* (gerekli)
veli Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.

Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında.		 Tür kaynağı için sembolik ad: mongoClusters
özellikler Bu kaynağın kaynağa özgü özellikleri. UserProperties

Veritabanı Rolü

İsim Açıklama Değer
Db Rolün atandığı veritabanı kapsamı. dize (gerekli)
rol Veritabanı kapsamında kullanıcıya atanan rol. 'root' (gerekli)

EntraIdentityProvider

İsim Açıklama Değer
özellikler Kullanıcının Entra kimlik özellikleri. EntraIdentityProviderProperties (gerekli)
tür Kullanıcının ait olduğu kimlik sağlayıcısının türü. 'MicrosoftEntraID' (gerekli)

EntraIdentityProviderProperties

İsim Açıklama Değer
principalTürü Kullanıcının asıl türü. 'servicePrincipal' (hizmet Sorumlusu)
'user' (gerekli)

Kimlik Sağlayıcı

İsim Açıklama Değer
tür EntraIdentityProvider türü için 'MicrosoftEntraID' olarak ayarlayın. 'MicrosoftEntraID' (gerekli)

KullanıcıÖzellikleri

İsim Açıklama Değer
kimlik Sağlayıcısı Kullanıcının kimlik sağlayıcısı tanımı. Kimlik Sağlayıcı
görevler Kullanıcıya atanan veritabanı rolleri. DatabaseRole[]

ARM şablonu kaynak tanımı

mongoClusters/users kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Kullanım Örnekleri

Kaynak biçimi

Microsoft.DocumentDB/mongoClusters/users kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "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 nesneleri

Nesne türünü belirtmek için türü özelliğini ayarlayın.

MicrosoftEntraID için şunu kullanın:

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

Özellik Değerleri

Microsoft.DocumentDB/mongoClusters/users

İsim Açıklama Değer
apiVersiyonu API sürümü '2026-06-01'
isim Kaynak adı karakter dizisi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 63
Desen = ^[a-zA-Z0-9\-]* (gerekli)
özellikler Bu kaynağın kaynağa özgü özellikleri. UserProperties
tür Kaynak türü 'Microsoft.DocumentDB/mongoClusters/users'

Veritabanı Rolü

İsim Açıklama Değer
Db Rolün atandığı veritabanı kapsamı. dize (gerekli)
rol Veritabanı kapsamında kullanıcıya atanan rol. 'root' (gerekli)

EntraIdentityProvider

İsim Açıklama Değer
özellikler Kullanıcının Entra kimlik özellikleri. EntraIdentityProviderProperties (gerekli)
tür Kullanıcının ait olduğu kimlik sağlayıcısının türü. 'MicrosoftEntraID' (gerekli)

EntraIdentityProviderProperties

İsim Açıklama Değer
principalTürü Kullanıcının asıl türü. 'servicePrincipal' (hizmet Sorumlusu)
'user' (gerekli)

Kimlik Sağlayıcı

İsim Açıklama Değer
tür EntraIdentityProvider türü için 'MicrosoftEntraID' olarak ayarlayın. 'MicrosoftEntraID' (gerekli)

KullanıcıÖzellikleri

İsim Açıklama Değer
kimlik Sağlayıcısı Kullanıcının kimlik sağlayıcısı tanımı. Kimlik Sağlayıcı
görevler Kullanıcıya atanan veritabanı rolleri. DatabaseRole[]

Terraform (AzAPI sağlayıcısı) kaynak tanımı

mongoClusters/users kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Kullanım Örnekleri

Terraform Örnekleri

Azure Cosmos DB'nin MongoDB (vCore) Kullanıcısı için dağıtılmasına temel bir örnek.

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    = ["*"]
}

Kaynak biçimi

Microsoft.DocumentDB/mongoClusters/users kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

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 nesneleri

Nesne türünü belirtmek için türü özelliğini ayarlayın.

MicrosoftEntraID için şunu kullanın:

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

Özellik Değerleri

Microsoft.DocumentDB/mongoClusters/users

İsim Açıklama Değer
isim Kaynak adı karakter dizisi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 63
Desen = ^[a-zA-Z0-9\-]* (gerekli)
ebeveyn_kimlik Bu kaynağın üst öğesi olan kaynağın kimliği. Tür kaynağı kimliği: mongoClusters
özellikler Bu kaynağın kaynağa özgü özellikleri. UserProperties
tür Kaynak türü "Microsoft. DocumentDB/mongoClusters/users@2026-06-01"

Veritabanı Rolü

İsim Açıklama Değer
Db Rolün atandığı veritabanı kapsamı. dize (gerekli)
rol Veritabanı kapsamında kullanıcıya atanan rol. 'root' (gerekli)

EntraIdentityProvider

İsim Açıklama Değer
özellikler Kullanıcının Entra kimlik özellikleri. EntraIdentityProviderProperties (gerekli)
tür Kullanıcının ait olduğu kimlik sağlayıcısının türü. 'MicrosoftEntraID' (gerekli)

EntraIdentityProviderProperties

İsim Açıklama Değer
principalTürü Kullanıcının asıl türü. 'servicePrincipal' (hizmet Sorumlusu)
'user' (gerekli)

Kimlik Sağlayıcı

İsim Açıklama Değer
tür EntraIdentityProvider türü için 'MicrosoftEntraID' olarak ayarlayın. 'MicrosoftEntraID' (gerekli)

KullanıcıÖzellikleri

İsim Açıklama Değer
kimlik Sağlayıcısı Kullanıcının kimlik sağlayıcısı tanımı. Kimlik Sağlayıcı
görevler Kullanıcıya atanan veritabanı rolleri. DatabaseRole[]
  • Last updated on