Microsoft.DocumentDB mongoClusters

  • Articolo

Definizione di risorsa Bicep

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

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

Formato di risorsa

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

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-02-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    createMode: 'string'
    nodeGroupSpecs: [
      {
        diskSizeGB: int
        enableHa: bool
        kind: 'Shard'
        nodeCount: int
        sku: 'string'
      }
    ]
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
  }
}

Valori delle proprietà

mongoClusters

Nome Descrizione valore
name Nome della risorsa stringa (obbligatoria)
posizione Posizione geografica in cui vive la risorsa stringa (obbligatoria)
tags Tag di risorse. Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli
properties Proprietà del cluster mongo. MongoClusterProperties

MongoClusterProperties

Nome Descrizione Valore
administratorLogin Account di accesso dell'amministratore per il cluster mongo. string
administratorLoginPassword Password dell'account di accesso dell'amministratore. string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
createMode Modalità per creare un cluster mongo. Impostazione predefinita
'PointInTimeRestore'
'Restore'
nodeGroupSpecs Elenco delle specifiche del gruppo di nodi nel cluster. NodeGroupSpec[]

Vincoli:
Lunghezza minima = 1
restoreParameters Parametri usati per le operazioni di ripristino MongoClusterRestoreParameters
serverVersion Versione del server Mongo DB. Impostazione predefinita alla versione più recente disponibile se non specificata. string

NodeGroupSpec

Nome Descrizione Valore
diskSizeGB Dimensioni dell'archiviazione su disco per il gruppo di nodi in GB. Valori di esempio: 128, 256, 512, 1024. INT
enableHa Se la disponibilità elevata è abilitata nel gruppo di nodi. bool
kind Tipo di nodo distribuito nel gruppo di nodi. 'Partizione'
nodeCount Numero di nodi nel gruppo di nodi. INT
sku Sku di risorsa per il gruppo di nodi. In questo modo vengono definite le dimensioni della CPU e della memoria di cui è stato effettuato il provisioning per ogni nodo. Valori di esempio: 'M30', 'M40'. string

MongoClusterRestoreParameters

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

Definizione della risorsa modello di Resource Manager

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

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

Formato di risorsa

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

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2024-02-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "createMode": "string",
    "nodeGroupSpecs": [
      {
        "diskSizeGB": "int",
        "enableHa": "bool",
        "kind": "Shard",
        "nodeCount": "int",
        "sku": "string"
      }
    ],
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string"
  }
}

Valori delle proprietà

mongoClusters

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.DocumentDB/mongoClusters'
apiVersion Versione dell'API risorsa '2024-02-15-preview'
name Nome della risorsa stringa (obbligatoria)
posizione Posizione geografica in cui vive la risorsa stringa (obbligatoria)
tags Tag di risorse. Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli
properties Proprietà del cluster mongo. MongoClusterProperties

MongoClusterProperties

Nome Descrizione Valore
administratorLogin Account di accesso dell'amministratore per il cluster mongo. string
administratorLoginPassword Password dell'account di accesso dell'amministratore. string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
createMode Modalità per creare un cluster mongo. Impostazione predefinita
'PointInTimeRestore'
'Restore'
nodeGroupSpecs Elenco delle specifiche del gruppo di nodi nel cluster. NodeGroupSpec[]

Vincoli:
Lunghezza minima = 1
restoreParameters Parametri usati per le operazioni di ripristino MongoClusterRestoreParameters
serverVersion Versione del server Mongo DB. Impostazione predefinita alla versione più recente disponibile se non specificata. string

NodeGroupSpec

Nome Descrizione Valore
diskSizeGB Dimensioni dell'archiviazione su disco per il gruppo di nodi in GB. Valori di esempio: 128, 256, 512, 1024. INT
enableHa Se la disponibilità elevata è abilitata nel gruppo di nodi. bool
kind Tipo di nodo distribuito nel gruppo di nodi. 'Partizione'
nodeCount Numero di nodi nel gruppo di nodi. INT
sku Sku di risorsa per il gruppo di nodi. In questo modo vengono definite le dimensioni della CPU e della memoria di cui è stato effettuato il provisioning per ogni nodo. Valori di esempio: 'M30', 'M40'. string

MongoClusterRestoreParameters

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

Definizione della risorsa Terraform (provider AzAPI)

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

  • Gruppi di risorse

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

Formato di risorsa

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2024-02-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      createMode = "string"
      nodeGroupSpecs = [
        {
          diskSizeGB = int
          enableHa = bool
          kind = "Shard"
          nodeCount = int
          sku = "string"
        }
      ]
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
    }
  })
}

Valori delle proprietà

mongoClusters

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.DocumentDB/mongoClusters@2024-02-15-preview"
name Nome della risorsa stringa (obbligatorio)
posizione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
parent_id Per eseguire la distribuzione in un gruppo di risorse, usare l'ID del gruppo di risorse. stringa (obbligatorio)
tags Tag delle risorse. Dizionario di nomi e valori di tag.
properties Proprietà del cluster mongo. MongoClusterProperties

MongoClusterProperties

Nome Descrizione Valore
administratorLogin Account di accesso dell'amministratore per il cluster mongo. string
administratorLoginPassword Password dell'account di accesso dell'amministratore. string

Vincoli:
Valore sensibile. Passare come parametro sicuro.
createMode Modalità di creazione di un cluster Mongo. "Default"
"PointInTimeRestore"
"Ripristina"
nodeGroupSpecs Elenco delle specifiche del gruppo di nodi nel cluster. NodeGroupSpec[]

Vincoli:
Lunghezza minima = 1
restoreParameters Parametri usati per le operazioni di ripristino MongoClusterRestoreParameters
serverVersion Versione del server Mongo DB. Se non specificato, il valore predefinito è la versione più recente disponibile. string

NodeGroupSpec

Nome Descrizione Valore
diskSizeGB Dimensioni di archiviazione su disco per il gruppo di nodi in GB. Valori di esempio: 128, 256, 512, 1024. INT
enableHa Indica se la disponibilità elevata è abilitata nel gruppo di nodi. bool
kind Tipo di nodo distribuito nel gruppo di nodi. "Partizione"
nodeCount Numero di nodi nel gruppo di nodi. INT
sku SKU della risorsa per il gruppo di nodi. In questo modo vengono definite le dimensioni della CPU e della memoria di cui viene effettuato il provisioning per ogni nodo. Valori di esempio: 'M30', 'M40'. string

MongoClusterRestoreParameters

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