Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Definizione della risorsa Bicep
Il tipo di risorsa mongoClusters/users può essere distribuito con operazioni destinate a:
Resource groups - Vediresource group
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Esempi di utilizzo
Esempi di Bicep
Un esempio base di distribuzione di Azure Cosmos DB per MongoDB (vCore) User.
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'
}
]
}
}
Formato di risorsa
Per creare una risorsa Microsoft.DocumentDB/mongoClusters/users, aggiungere il Bicep seguente al modello.
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'
}
]
}
}
Oggetti IdentityProvider
Impostare la proprietà tipo di
Per MicrosoftEntraID usare:
{
properties: {
principalType: 'string'
}
type: 'MicrosoftEntraID'
}
Valori delle proprietà
Microsoft.DocumentDB/mongoClusters/users
| Name | Description | Value |
|---|---|---|
| nome | Nome della risorsa | string Vincoli: Lunghezza minima = 1 Lunghezza massima = 63 Pattern = ^[a-zA-Z0-9\-]* (obbligatorio) |
| parent | In Bicep, puoi specificare la risorsa genitore per una risorsa figlia. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre. Per ulteriori informazioni, vedi Risorsa figlio esterna risorsa genitore. |
Nome simbolico per la risorsa di tipo: mongoClusters |
| properties | Proprietà specifiche della risorsa. | proprietà utente |
Ruolo database
| Name | Description | Value |
|---|---|---|
| database | Ambito del database a cui è assegnato il ruolo. | stringa (obbligatorio) |
| Ruolo | Ruolo assegnato all'utente nell'ambito del database. | 'root' (obbligatorio) |
EntraIdentityProvider
| Name | Description | Value |
|---|---|---|
| properties | Le proprietà dell'identità Entra per l'utente. | EntraIdentityProviderProperties (obbligatorio) |
| type | Il tipo di provider di identità a cui appartiene l'utente. | 'MicrosoftEntraID' (obbligatorio) |
EntraIdentityProviderProperties
| Name | Description | Value |
|---|---|---|
| tipoPrincipale | Tipo principale dell'utente. | 'servicePrincipal' 'user' (obbligatorio) |
IdentityProvider
| Name | Description | Value |
|---|---|---|
| type | Impostare su 'MicrosoftEntraID' per il tipo EntraIdentityProvider. | 'MicrosoftEntraID' (obbligatorio) |
Proprietà utente
| Name | Description | Value |
|---|---|---|
| Fornitore di identità | Definizione del provider di identità dell'utente. | Fornitore di identità |
| roles | Ruoli del database assegnati all'utente. | Ruolo del database[] |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa mongoClusters/users può essere distribuito con operazioni destinate a:
- Gruppi di risorse - Vedi comandi di distribuzione dei gruppi di risorse Per un elenco delle proprietà modificate in ciascuna versione API, vedi registro delle modifiche.
Esempi di utilizzo
Formato di risorsa
Per creare una risorsa Microsoft.DocumentDB/mongoClusters/users, aggiungere il codice JSON seguente al modello.
{
"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"
}
]
}
}
Oggetti IdentityProvider
Impostare la proprietà tipo di
Per MicrosoftEntraID usare:
{
"properties": {
"principalType": "string"
},
"type": "MicrosoftEntraID"
}
Valori delle proprietà
Microsoft.DocumentDB/mongoClusters/users
| Name | Description | Value |
|---|---|---|
| apiVersion | Versione dell'API | '2026-06-01' |
| nome | Nome della risorsa | string Vincoli: Lunghezza minima = 1 Lunghezza massima = 63 Pattern = ^[a-zA-Z0-9\-]* (obbligatorio) |
| properties | Proprietà specifiche della risorsa. | proprietà utente |
| type | Tipo di risorsa | 'Microsoft.DocumentDB/mongoClusters/users' |
Ruolo database
| Name | Description | Value |
|---|---|---|
| database | Ambito del database a cui è assegnato il ruolo. | stringa (obbligatorio) |
| Ruolo | Ruolo assegnato all'utente nell'ambito del database. | 'root' (obbligatorio) |
EntraIdentityProvider
| Name | Description | Value |
|---|---|---|
| properties | Le proprietà dell'identità Entra per l'utente. | EntraIdentityProviderProperties (obbligatorio) |
| type | Il tipo di provider di identità a cui appartiene l'utente. | 'MicrosoftEntraID' (obbligatorio) |
EntraIdentityProviderProperties
| Name | Description | Value |
|---|---|---|
| tipoPrincipale | Tipo principale dell'utente. | 'servicePrincipal' 'user' (obbligatorio) |
IdentityProvider
| Name | Description | Value |
|---|---|---|
| type | Impostare su 'MicrosoftEntraID' per il tipo EntraIdentityProvider. | 'MicrosoftEntraID' (obbligatorio) |
Proprietà utente
| Name | Description | Value |
|---|---|---|
| Fornitore di identità | Definizione del provider di identità dell'utente. | Fornitore di identità |
| roles | Ruoli del database assegnati all'utente. | Ruolo del database[] |
Definizione di risorsa Terraform (provider AzAPI)
Il tipo di risorsa mongoClusters/users può essere distribuito con operazioni destinate a:
- Gruppi di risorse Per un elenco delle proprietà modificate in ogni versione dell'API, vedi il registro modifiche.
Esempi di utilizzo
Esempi di Terraform
Un esempio base di distribuzione di Azure Cosmos DB per MongoDB (vCore) User.
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 = ["*"]
}
Formato di risorsa
Per creare una risorsa Microsoft.DocumentDB/mongoClusters/users, aggiungere il Terraform seguente al modello.
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"
}
]
}
}
}
Oggetti IdentityProvider
Impostare la proprietà tipo di
Per MicrosoftEntraID usare:
{
properties = {
principalType = "string"
}
type = "MicrosoftEntraID"
}
Valori delle proprietà
Microsoft.DocumentDB/mongoClusters/users
| Name | Description | Value |
|---|---|---|
| nome | Nome della risorsa | string Vincoli: Lunghezza minima = 1 Lunghezza massima = 63 Pattern = ^[a-zA-Z0-9\-]* (obbligatorio) |
| parent_id | ID della risorsa padre per questa risorsa. | ID per la risorsa di tipo: mongoClusters |
| properties | Proprietà specifiche della risorsa. | proprietà utente |
| type | Tipo di risorsa | "Microsoft. DocumentDB/mongoClusters/users@2026-06-01" |
Ruolo database
| Name | Description | Value |
|---|---|---|
| database | Ambito del database a cui è assegnato il ruolo. | stringa (obbligatorio) |
| Ruolo | Ruolo assegnato all'utente nell'ambito del database. | 'root' (obbligatorio) |
EntraIdentityProvider
| Name | Description | Value |
|---|---|---|
| properties | Le proprietà dell'identità Entra per l'utente. | EntraIdentityProviderProperties (obbligatorio) |
| type | Il tipo di provider di identità a cui appartiene l'utente. | 'MicrosoftEntraID' (obbligatorio) |
EntraIdentityProviderProperties
| Name | Description | Value |
|---|---|---|
| tipoPrincipale | Tipo principale dell'utente. | 'servicePrincipal' 'user' (obbligatorio) |
IdentityProvider
| Name | Description | Value |
|---|---|---|
| type | Impostare su 'MicrosoftEntraID' per il tipo EntraIdentityProvider. | 'MicrosoftEntraID' (obbligatorio) |
Proprietà utente
| Name | Description | Value |
|---|---|---|
| Fornitore di identità | Definizione del provider di identità dell'utente. | Fornitore di identità |
| roles | Ruoli del database assegnati all'utente. | Ruolo del database[] |