Condividi tramite

Microsoft.DocumentDB mongoClusters 2024-07-01

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa mongoClusters può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/mongoClusters, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-07-01' = {
  location: 'string'
  name: 'string'
  properties: {
    administrator: {
      password: 'string'
      userName: 'string'
    }
    backup: {}
    compute: {
      tier: 'string'
    }
    createMode: 'string'
    highAvailability: {
      targetMode: 'string'
    }
    previewFeatures: [
      'string'
    ]
    publicNetworkAccess: 'string'
    replicaParameters: {
      sourceLocation: 'string'
      sourceResourceId: 'string'
    }
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
    sharding: {
      shardCount: int
    }
    storage: {
      sizeGb: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

AdministratorProperties

Nome Descrizione Valore
parola d’ordine Password amministratore. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.
nome utente Nome utente amministratore. corda

BackupProprietà

Nome Descrizione Valore

ComputeProperties

Nome Descrizione Valore
livello Livello di calcolo da assegnare al cluster, in cui ogni livello esegue il mapping a una dimensione di memoria e core virtuale. Valori di esempio: 'M30', 'M40'. corda

HighAvailabilityProperties

Nome Descrizione Valore
targetMode Modalità di disponibilità elevata di destinazione richiesta per il cluster. 'Disabilitato'
'SameZone'
'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

Nome Descrizione Valore
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (obbligatorio)
proprietà Proprietà specifiche della risorsa. MongoClusterProperties
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

MongoClusterProperties

Nome Descrizione Valore
amministratore Proprietà dell'amministratore locale per il cluster mongo. AdministratorProperties
backup Proprietà di backup del cluster mongo. BackupProperties
calcolare Proprietà di calcolo del cluster mongo. ComputeProperties
createMode Modalità per creare un cluster mongo. 'Default'
'GeoReplica'
'PointInTimeRestore'
'Replica'
highAvailability Proprietà a disponibilità elevata del cluster mongo. HighAvailabilityProperties
previewFeatures Elenco delle connessioni endpoint private. Matrice di stringhe contenente uno dei seguenti elementi:
'GeoReplicas'
publicNetworkAccess Indica se l'accesso all'endpoint pubblico è consentito per questo cluster mongo. 'Disabilitato'
'Enabled'
replicaParameters Parametri per creare un cluster mongo di replica. MongoClusterReplicaParameters
restoreParameters Parametri per creare un cluster mongo di ripristino temporizzato. MongoClusterRestoreParameters
serverVersion Versione del server Mongo DB. L'impostazione predefinita è la versione disponibile più recente, se non specificata. corda
partizionamento orizzontale Proprietà di partizionamento orizzontale del cluster mongo. proprietà di partizionamento orizzontale
immagazzinamento Proprietà di archiviazione del cluster mongo. StorageProperties

MongoClusterReplicaParameters

Nome Descrizione Valore
sourceLocation Percorso del cluster di origine stringa (obbligatorio)
sourceResourceId ID del cluster di origine della replica. stringa (obbligatorio)

MongoClusterRestoreParameters

Nome Descrizione Valore
pointInTimeUTC Ora UTC per ripristinare un cluster mongo corda
sourceResourceId ID risorsa per individuare il cluster di origine da ripristinare corda

Proprietà partizionamento orizzontale

Nome Descrizione Valore
shardCount Numero di partizioni di cui eseguire il provisioning nel cluster. Int

StorageProperties

Nome Descrizione Valore
sizeGb Dimensioni del disco dati assegnato a ogni server. Int

TrackedResourceTags

Nome Descrizione Valore

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa mongoClusters può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/mongoClusters, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2024-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "administrator": {
      "password": "string",
      "userName": "string"
    },
    "backup": {
    },
    "compute": {
      "tier": "string"
    },
    "createMode": "string",
    "highAvailability": {
      "targetMode": "string"
    },
    "previewFeatures": [ "string" ],
    "publicNetworkAccess": "string",
    "replicaParameters": {
      "sourceLocation": "string",
      "sourceResourceId": "string"
    },
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string",
    "sharding": {
      "shardCount": "int"
    },
    "storage": {
      "sizeGb": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

AdministratorProperties

Nome Descrizione Valore
parola d’ordine Password amministratore. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.
nome utente Nome utente amministratore. corda

BackupProprietà

Nome Descrizione Valore

ComputeProperties

Nome Descrizione Valore
livello Livello di calcolo da assegnare al cluster, in cui ogni livello esegue il mapping a una dimensione di memoria e core virtuale. Valori di esempio: 'M30', 'M40'. corda

HighAvailabilityProperties

Nome Descrizione Valore
targetMode Modalità di disponibilità elevata di destinazione richiesta per il cluster. 'Disabilitato'
'SameZone'
'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

Nome Descrizione Valore
apiVersion Versione dell'API '2024-07-01'
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (obbligatorio)
proprietà Proprietà specifiche della risorsa. MongoClusterProperties
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.DocumentDB/mongoClusters'

MongoClusterProperties

Nome Descrizione Valore
amministratore Proprietà dell'amministratore locale per il cluster mongo. AdministratorProperties
backup Proprietà di backup del cluster mongo. BackupProperties
calcolare Proprietà di calcolo del cluster mongo. ComputeProperties
createMode Modalità per creare un cluster mongo. 'Default'
'GeoReplica'
'PointInTimeRestore'
'Replica'
highAvailability Proprietà a disponibilità elevata del cluster mongo. HighAvailabilityProperties
previewFeatures Elenco delle connessioni endpoint private. Matrice di stringhe contenente uno dei seguenti elementi:
'GeoReplicas'
publicNetworkAccess Indica se l'accesso all'endpoint pubblico è consentito per questo cluster mongo. 'Disabilitato'
'Enabled'
replicaParameters Parametri per creare un cluster mongo di replica. MongoClusterReplicaParameters
restoreParameters Parametri per creare un cluster mongo di ripristino temporizzato. MongoClusterRestoreParameters
serverVersion Versione del server Mongo DB. L'impostazione predefinita è la versione disponibile più recente, se non specificata. corda
partizionamento orizzontale Proprietà di partizionamento orizzontale del cluster mongo. proprietà di partizionamento orizzontale
immagazzinamento Proprietà di archiviazione del cluster mongo. StorageProperties

MongoClusterReplicaParameters

Nome Descrizione Valore
sourceLocation Percorso del cluster di origine stringa (obbligatorio)
sourceResourceId ID del cluster di origine della replica. stringa (obbligatorio)

MongoClusterRestoreParameters

Nome Descrizione Valore
pointInTimeUTC Ora UTC per ripristinare un cluster mongo corda
sourceResourceId ID risorsa per individuare il cluster di origine da ripristinare corda

Proprietà partizionamento orizzontale

Nome Descrizione Valore
shardCount Numero di partizioni di cui eseguire il provisioning nel cluster. Int

StorageProperties

Nome Descrizione Valore
sizeGb Dimensioni del disco dati assegnato a ogni server. Int

TrackedResourceTags

Nome Descrizione Valore

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa mongoClusters può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/mongoClusters, aggiungere il file Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2024-07-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administrator = {
        password = "string"
        userName = "string"
      }
      backup = {
      }
      compute = {
        tier = "string"
      }
      createMode = "string"
      highAvailability = {
        targetMode = "string"
      }
      previewFeatures = [
        "string"
      ]
      publicNetworkAccess = "string"
      replicaParameters = {
        sourceLocation = "string"
        sourceResourceId = "string"
      }
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
      sharding = {
        shardCount = int
      }
      storage = {
        sizeGb = int
      }
    }
  })
}

Valori delle proprietà

AdministratorProperties

Nome Descrizione Valore
parola d’ordine Password amministratore. corda

Vincoli:
Valore sensibile. Passare come parametro sicuro.
nome utente Nome utente amministratore. corda

BackupProprietà

Nome Descrizione Valore

ComputeProperties

Nome Descrizione Valore
livello Livello di calcolo da assegnare al cluster, in cui ogni livello esegue il mapping a una dimensione di memoria e core virtuale. Valori di esempio: 'M30', 'M40'. corda

HighAvailabilityProperties

Nome Descrizione Valore
targetMode Modalità di disponibilità elevata di destinazione richiesta per il cluster. 'Disabilitato'
'SameZone'
'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

Nome Descrizione Valore
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (obbligatorio)
proprietà Proprietà specifiche della risorsa. MongoClusterProperties
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.DocumentDB/mongoClusters@2024-07-01"

MongoClusterProperties

Nome Descrizione Valore
amministratore Proprietà dell'amministratore locale per il cluster mongo. AdministratorProperties
backup Proprietà di backup del cluster mongo. BackupProperties
calcolare Proprietà di calcolo del cluster mongo. ComputeProperties
createMode Modalità per creare un cluster mongo. 'Default'
'GeoReplica'
'PointInTimeRestore'
'Replica'
highAvailability Proprietà a disponibilità elevata del cluster mongo. HighAvailabilityProperties
previewFeatures Elenco delle connessioni endpoint private. Matrice di stringhe contenente uno dei seguenti elementi:
'GeoReplicas'
publicNetworkAccess Indica se l'accesso all'endpoint pubblico è consentito per questo cluster mongo. 'Disabilitato'
'Enabled'
replicaParameters Parametri per creare un cluster mongo di replica. MongoClusterReplicaParameters
restoreParameters Parametri per creare un cluster mongo di ripristino temporizzato. MongoClusterRestoreParameters
serverVersion Versione del server Mongo DB. L'impostazione predefinita è la versione disponibile più recente, se non specificata. corda
partizionamento orizzontale Proprietà di partizionamento orizzontale del cluster mongo. proprietà di partizionamento orizzontale
immagazzinamento Proprietà di archiviazione del cluster mongo. StorageProperties

MongoClusterReplicaParameters

Nome Descrizione Valore
sourceLocation Percorso del cluster di origine stringa (obbligatorio)
sourceResourceId ID del cluster di origine della replica. stringa (obbligatorio)

MongoClusterRestoreParameters

Nome Descrizione Valore
pointInTimeUTC Ora UTC per ripristinare un cluster mongo corda
sourceResourceId ID risorsa per individuare il cluster di origine da ripristinare corda

Proprietà partizionamento orizzontale

Nome Descrizione Valore
shardCount Numero di partizioni di cui eseguire il provisioning nel cluster. Int

StorageProperties

Nome Descrizione Valore
sizeGb Dimensioni del disco dati assegnato a ogni server. Int

TrackedResourceTags

Nome Descrizione Valore