Microsoft.DocumentDB mongoClusters/users

• Mais recente
• 2025-09-01
• 2025-08-01-visualização
• 2025-07-01-preview
• 2025-04-01-visualização

Definição de recurso do Bicep

O tipo de recurso mongoClusters/users pode ser implantado com operações direcionadas:

• Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/mongoClusters/users, adicione o seguinte Bicep ao seu modelo.

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

Objetos IdentityProvider

Defina a propriedade tipo para especificar o tipo de objeto.

Para MicrosoftEntraID, use:

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

Valores de propriedade

Microsoft.DocumentDB/mongoClusters/users

Nome	Descrição	Valor
nome	O nome do recurso	cadeia de caracteres Restrições: Comprimento mínimo = 1 Comprimento máximo = 63 Padrão = ^[a-zA-Z0-9\-]* (obrigatório)
pai	No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai.	Nome simbólico do recurso do tipo: mongoClusters
propriedades	As propriedades específicas do recurso para esse recurso.	Propriedades do usuário

Função de banco de dados

Nome	Descrição	Valor
Db	Escopo do banco de dados ao qual a função é atribuída.	cadeia de caracteres (obrigatório)
função	A função atribuída ao usuário no escopo do banco de dados.	'root' (obrigatório)

EntraIdentityProvider

Nome	Descrição	Valor
propriedades	As propriedades de identidade do Entra para o usuário.	EntraIdentityProviderProperties (obrigatório)
tipo	O tipo de provedor de identidade ao qual o usuário pertence.	'MicrosoftEntraID' (obrigatório)

EntraIdentityProviderProperties

Nome	Descrição	Valor
TipoPrincipal	O tipo principal do usuário.	'servicePrincipal' 'user' (obrigatório)

Provedor de identidade

Nome	Descrição	Valor
tipo	Defina como 'MicrosoftEntraID' para o tipo EntraIdentityProvider.	'MicrosoftEntraID' (obrigatório)

PropriedadesDoUsuário

Nome	Descrição	Valor
identityProvider	A definição do provedor de identidade do usuário.	Provedor de identidade
funções	Funções de banco de dados atribuídas ao usuário.	Função de banco de dados

Exemplos de uso

Exemplos do Bicep

Um exemplo básico de implantação do Azure Cosmos DB para usuários do MongoDB (vCore).

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' = {
  parent: mongoClusterSSDv2
  name: 'userAssignedIdentity.properties.principalId'
  properties: {
    identityProvider: {
      properties: {
        principalType: 'ServicePrincipal'
      }
      type: 'MicrosoftEntraID'
    }
    roles: [
      {
        db: 'admin'
        role: 'root'
      }
    ]
  }
}

Definição de recurso de modelo do ARM

O tipo de recurso mongoClusters/users pode ser implantado com operações direcionadas:

• Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/mongoClusters/users, adicione o JSON a seguir ao modelo.

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

Objetos IdentityProvider

Defina a propriedade tipo para especificar o tipo de objeto.

Para MicrosoftEntraID, use:

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

Valores de propriedade

Microsoft.DocumentDB/mongoClusters/users

Nome	Descrição	Valor
apiVersion	A versão da API	'2025-09-01'
nome	O nome do recurso	cadeia de caracteres Restrições: Comprimento mínimo = 1 Comprimento máximo = 63 Padrão = ^[a-zA-Z0-9\-]* (obrigatório)
propriedades	As propriedades específicas do recurso para esse recurso.	Propriedades do usuário
tipo	O tipo de recurso	'Microsoft.DocumentDB/mongoClusters/users'

Função de banco de dados

Nome	Descrição	Valor
Db	Escopo do banco de dados ao qual a função é atribuída.	cadeia de caracteres (obrigatório)
função	A função atribuída ao usuário no escopo do banco de dados.	'root' (obrigatório)

EntraIdentityProvider

Nome	Descrição	Valor
propriedades	As propriedades de identidade do Entra para o usuário.	EntraIdentityProviderProperties (obrigatório)
tipo	O tipo de provedor de identidade ao qual o usuário pertence.	'MicrosoftEntraID' (obrigatório)

EntraIdentityProviderProperties

Nome	Descrição	Valor
TipoPrincipal	O tipo principal do usuário.	'servicePrincipal' 'user' (obrigatório)

Provedor de identidade

Nome	Descrição	Valor
tipo	Defina como 'MicrosoftEntraID' para o tipo EntraIdentityProvider.	'MicrosoftEntraID' (obrigatório)

PropriedadesDoUsuário

Nome	Descrição	Valor
identityProvider	A definição do provedor de identidade do usuário.	Provedor de identidade
funções	Funções de banco de dados atribuídas ao usuário.	Função de banco de dados

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso mongoClusters/users pode ser implantado com operações direcionadas:

• Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/mongoClusters/users, adicione o Terraform a seguir ao seu modelo.

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

Objetos IdentityProvider

Defina a propriedade tipo para especificar o tipo de objeto.

Para MicrosoftEntraID, use:

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

Valores de propriedade

Microsoft.DocumentDB/mongoClusters/users

Nome	Descrição	Valor
nome	O nome do recurso	cadeia de caracteres Restrições: Comprimento mínimo = 1 Comprimento máximo = 63 Padrão = ^[a-zA-Z0-9\-]* (obrigatório)
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: mongoClusters
propriedades	As propriedades específicas do recurso para esse recurso.	Propriedades do usuário
tipo	O tipo de recurso	"Microsoft.DocumentDB/mongoClusters/users@2025-09-01"

Função de banco de dados

Nome	Descrição	Valor
Db	Escopo do banco de dados ao qual a função é atribuída.	cadeia de caracteres (obrigatório)
função	A função atribuída ao usuário no escopo do banco de dados.	'root' (obrigatório)

EntraIdentityProvider

Nome	Descrição	Valor
propriedades	As propriedades de identidade do Entra para o usuário.	EntraIdentityProviderProperties (obrigatório)
tipo	O tipo de provedor de identidade ao qual o usuário pertence.	'MicrosoftEntraID' (obrigatório)

EntraIdentityProviderProperties

Nome	Descrição	Valor
TipoPrincipal	O tipo principal do usuário.	'servicePrincipal' 'user' (obrigatório)

Provedor de identidade

Nome	Descrição	Valor
tipo	Defina como 'MicrosoftEntraID' para o tipo EntraIdentityProvider.	'MicrosoftEntraID' (obrigatório)

PropriedadesDoUsuário

Nome	Descrição	Valor
identityProvider	A definição do provedor de identidade do usuário.	Provedor de identidade
funções	Funções de banco de dados atribuídas ao usuário.	Função de banco de dados

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Azure Cosmos DB para usuários do 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    = ["*"]
}