Share via


Microsoft.DocumentDB mongoClusters 2024-02-15-preview

Bicep-resourcedefinitie

Het resourcetype mongoClusters kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.DocumentDB/mongoClusters-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Eigenschapswaarden

mongoClusters

Naam Description Waarde
naam De resourcenaam tekenreeks (vereist)
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
properties Eigenschappen van het Mongo-cluster. MongoClusterProperties

MongoClusterProperties

Naam Description Waarde
administratorAanlogen De aanmelding van de beheerder voor het Mongo-cluster. tekenreeks
administratorLoginPassword Het wachtwoord van de beheerdersaanmelding. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
createMode De modus voor het maken van een Mongo-cluster. 'Standaard'
'PointInTimeRestore'
'Herstellen'
nodeGroupSpecs De lijst met specificaties van knooppuntgroepen in het cluster. NodeGroupSpec[]

Beperkingen:
Minimale lengte = 1
restoreParameters Parameters die worden gebruikt voor herstelbewerkingen MongoClusterRestoreParameters
serverVersion De versie van de Mongo DB-server. De standaardinstelling is de meest recente beschikbare versie als deze niet is opgegeven. tekenreeks

NodeGroupSpec

Naam Description Waarde
diskSizeGB De schijfopslaggrootte voor de knooppuntgroep in GB. Voorbeeldwaarden: 128, 256, 512, 1024. int
enableHa Of hoge beschikbaarheid is ingeschakeld voor de knooppuntgroep. booleaans
Soort Het knooppunttype dat is geïmplementeerd in de knooppuntgroep. 'Shard'
nodeCount Het aantal knooppunten in de knooppuntgroep. int
sku De resource-SKU voor de knooppuntgroep. Hiermee definieert u de grootte van de CPU en het geheugen die voor elk knooppunt worden ingericht. Voorbeeldwaarden: 'M30', 'M40'. tekenreeks

MongoClusterRestoreParameters

Naam Description Waarde
pointInTimeUTC UTC-tijdstip om een Mongo-cluster te herstellen tekenreeks
sourceResourceId Resource-id om het broncluster te vinden dat moet worden hersteld tekenreeks

Resourcedefinitie van ARM-sjabloon

Het resourcetype mongoClusters kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.DocumentDB/mongoClusters-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

mongoClusters

Naam Description Waarde
type Het resourcetype 'Microsoft.DocumentDB/mongoClusters'
apiVersion De resource-API-versie '2024-02-15-preview'
naam De resourcenaam tekenreeks (vereist)
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
properties Eigenschappen van het Mongo-cluster. MongoClusterProperties

MongoClusterProperties

Naam Description Waarde
administratorAanlogen De aanmelding van de beheerder voor het Mongo-cluster. tekenreeks
administratorLoginPassword Het wachtwoord van de beheerdersaanmelding. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
createMode De modus voor het maken van een Mongo-cluster. 'Standaard'
'PointInTimeRestore'
'Herstellen'
nodeGroupSpecs De lijst met specificaties van knooppuntgroepen in het cluster. NodeGroupSpec[]

Beperkingen:
Minimale lengte = 1
restoreParameters Parameters die worden gebruikt voor herstelbewerkingen MongoClusterRestoreParameters
serverVersion De versie van de Mongo DB-server. De standaardinstelling is de meest recente beschikbare versie als deze niet is opgegeven. tekenreeks

NodeGroupSpec

Naam Description Waarde
diskSizeGB De schijfopslaggrootte voor de knooppuntgroep in GB. Voorbeeldwaarden: 128, 256, 512, 1024. int
enableHa Of hoge beschikbaarheid is ingeschakeld voor de knooppuntgroep. booleaans
Soort Het knooppunttype dat is geïmplementeerd in de knooppuntgroep. 'Shard'
nodeCount Het aantal knooppunten in de knooppuntgroep. int
sku De resource-SKU voor de knooppuntgroep. Hiermee definieert u de grootte van de CPU en het geheugen die voor elk knooppunt worden ingericht. Voorbeeldwaarden: 'M30', 'M40'. tekenreeks

MongoClusterRestoreParameters

Naam Description Waarde
pointInTimeUTC UTC-tijdstip om een Mongo-cluster te herstellen tekenreeks
sourceResourceId Resource-id om het broncluster te vinden dat moet worden hersteld tekenreeks

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype mongoClusters kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.DocumentDB/mongoClusters-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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

Eigenschapswaarden

mongoClusters

Naam Description Waarde
type Het resourcetype "Microsoft.DocumentDB/mongoClusters@2024-02-15-preview"
naam De resourcenaam tekenreeks (vereist)
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
parent_id Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden.
properties Eigenschappen van het Mongo-cluster. MongoClusterProperties

MongoClusterProperties

Naam Description Waarde
administratorAanlogen De aanmelding van de beheerder voor het Mongo-cluster. tekenreeks
administratorLoginPassword Het wachtwoord van de beheerdersaanmelding. tekenreeks

Beperkingen:
Gevoelige waarde. Doorgeven als een beveiligde parameter.
createMode De modus voor het maken van een Mongo-cluster. "Standaard"
"PointInTimeRestore"
"Herstellen"
nodeGroupSpecs De lijst met specificaties van knooppuntgroepen in het cluster. NodeGroupSpec[]

Beperkingen:
Minimale lengte = 1
restoreParameters Parameters die worden gebruikt voor herstelbewerkingen MongoClusterRestoreParameters
serverVersion De versie van de Mongo DB-server. De standaardinstelling is de meest recente beschikbare versie als deze niet is opgegeven. tekenreeks

NodeGroupSpec

Naam Description Waarde
diskSizeGB De schijfopslaggrootte voor de knooppuntgroep in GB. Voorbeeldwaarden: 128, 256, 512, 1024. int
enableHa Of hoge beschikbaarheid is ingeschakeld voor de knooppuntgroep. booleaans
Soort Het knooppunttype dat is geïmplementeerd in de knooppuntgroep. "Shard"
nodeCount Het aantal knooppunten in de knooppuntgroep. int
sku De resource-SKU voor de knooppuntgroep. Hiermee definieert u de grootte van de CPU en het geheugen die voor elk knooppunt worden ingericht. Voorbeeldwaarden: 'M30', 'M40'. tekenreeks

MongoClusterRestoreParameters

Naam Description Waarde
pointInTimeUTC UTC-tijdstip om een Mongo-cluster te herstellen tekenreeks
sourceResourceId Resource-id om het broncluster te vinden dat moet worden hersteld tekenreeks