Udostępnij przez

Microsoft.DocumentDB mongoClusters/users

Definicja zasobu Bicep

Typ zasobu mongoClusters/users można wdrożyć z operacjami przeznaczonymi do:

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/mongoClusters/users, dodaj następujący Bicep do szablonu.

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

Obiekty IdentityProvider

Ustaw właściwość , aby określić typ obiektu.

W przypadku identyfikatora MicrosoftEntraID użyj:

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

Wartości właściwości

Microsoft.DocumentDB/mongoClusters/users

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 63
Wzorzec = ^[a-zA-Z0-9\-]* (wymagane)
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: mongoClusters
właściwości Właściwości specyficzne dla zasobu dla tego zasobu. Właściwości użytkownika

DatabaseRole (Rola bazy danych)

Nazwa Opis Wartość
baza danych Zakres bazy danych, do którego jest przypisana rola. ciąg (wymagany)
rola Rola przypisana do użytkownika w zakresie bazy danych. 'root' (wymagane)

EntraIdentityProvider

Nazwa Opis Wartość
właściwości Właściwości tożsamości Entra dla użytkownika. EntraIdentityProviderProperties (wymagane)
typ Typ dostawcy tożsamości, do którego należy użytkownik. "MicrosoftEntraID" (wymagane)

EntraIdentityProviderProperties

Nazwa Opis Wartość
typ główny Główny typ użytkownika. "servicePrincipal"
"użytkownik" (wymagany)

Dostawca tożsamości

Nazwa Opis Wartość
typ Ustaw wartość "MicrosoftEntraID" dla typu EntraIdentityProvider. "MicrosoftEntraID" (wymagane)

Właściwości użytkownika

Nazwa Opis Wartość
identityProvider (dostawca tożsamości) Definicja dostawcy tożsamości użytkownika. Dostawca tożsamości
Ról Role bazy danych, które są przypisane do użytkownika. Rola bazy danych[]

Definicja zasobu szablonu usługi ARM

Typ zasobu mongoClusters/users można wdrożyć z operacjami przeznaczonymi do:

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/mongoClusters/users, dodaj następujący kod JSON do szablonu.

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

Obiekty IdentityProvider

Ustaw właściwość , aby określić typ obiektu.

W przypadku identyfikatora MicrosoftEntraID użyj:

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

Wartości właściwości

Microsoft.DocumentDB/mongoClusters/users

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API '2025-09-01'
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 63
Wzorzec = ^[a-zA-Z0-9\-]* (wymagane)
właściwości Właściwości specyficzne dla zasobu dla tego zasobu. Właściwości użytkownika
typ Typ zasobu "Microsoft.DocumentDB/mongoClusters/users" (Microsoft.DocumentDB/mongoClusters/users)

DatabaseRole (Rola bazy danych)

Nazwa Opis Wartość
baza danych Zakres bazy danych, do którego jest przypisana rola. ciąg (wymagany)
rola Rola przypisana do użytkownika w zakresie bazy danych. 'root' (wymagane)

EntraIdentityProvider

Nazwa Opis Wartość
właściwości Właściwości tożsamości Entra dla użytkownika. EntraIdentityProviderProperties (wymagane)
typ Typ dostawcy tożsamości, do którego należy użytkownik. "MicrosoftEntraID" (wymagane)

EntraIdentityProviderProperties

Nazwa Opis Wartość
typ główny Główny typ użytkownika. "servicePrincipal"
"użytkownik" (wymagany)

Dostawca tożsamości

Nazwa Opis Wartość
typ Ustaw wartość "MicrosoftEntraID" dla typu EntraIdentityProvider. "MicrosoftEntraID" (wymagane)

Właściwości użytkownika

Nazwa Opis Wartość
identityProvider (dostawca tożsamości) Definicja dostawcy tożsamości użytkownika. Dostawca tożsamości
Ról Role bazy danych, które są przypisane do użytkownika. Rola bazy danych[]

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu mongoClusters/users można wdrożyć z operacjami przeznaczonymi do:

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/mongoClusters/users, dodaj następujący program Terraform do szablonu.

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

Obiekty IdentityProvider

Ustaw właściwość , aby określić typ obiektu.

W przypadku identyfikatora MicrosoftEntraID użyj:

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

Wartości właściwości

Microsoft.DocumentDB/mongoClusters/users

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 63
Wzorzec = ^[a-zA-Z0-9\-]* (wymagane)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: mongoClusters
właściwości Właściwości specyficzne dla zasobu dla tego zasobu. Właściwości użytkownika
typ Typ zasobu "Microsoft.DocumentDB/mongoClusters/users@2025-09-01"

DatabaseRole (Rola bazy danych)

Nazwa Opis Wartość
baza danych Zakres bazy danych, do którego jest przypisana rola. ciąg (wymagany)
rola Rola przypisana do użytkownika w zakresie bazy danych. 'root' (wymagane)

EntraIdentityProvider

Nazwa Opis Wartość
właściwości Właściwości tożsamości Entra dla użytkownika. EntraIdentityProviderProperties (wymagane)
typ Typ dostawcy tożsamości, do którego należy użytkownik. "MicrosoftEntraID" (wymagane)

EntraIdentityProviderProperties

Nazwa Opis Wartość
typ główny Główny typ użytkownika. "servicePrincipal"
"użytkownik" (wymagany)

Dostawca tożsamości

Nazwa Opis Wartość
typ Ustaw wartość "MicrosoftEntraID" dla typu EntraIdentityProvider. "MicrosoftEntraID" (wymagane)

Właściwości użytkownika

Nazwa Opis Wartość
identityProvider (dostawca tożsamości) Definicja dostawcy tożsamości użytkownika. Dostawca tożsamości
Ról Role bazy danych, które są przypisane do użytkownika. Rola bazy danych[]

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania Azure Cosmos DB dla użytkownika MongoDB (vCore).

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    = ["*"]
}
  • Last updated on