Dela via

Microsoft.DocumentDB mongoClusters 2023-11-15-preview

  • Artikel

Bicep-resursdefinition

Resurstypen mongoClusters kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/mongoClusters-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-11-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'
  }
}

Egenskapsvärden

mongoClusters

Name Beskrivning Värde
name Resursnamnet sträng (krävs)
location Den geo-plats där resursen finns sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
properties Egenskaper för Mongo-klustret. MongoClusterProperties

MongoClusterProperties

Name Beskrivning Värde
administratorLogin Administratörens inloggning för Mongo-klustret. sträng
administratorLoginPassword Lösenordet för administratörsinloggningen. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
createMode Läget för att skapa ett mongo-kluster. "Standard"
"PointInTimeRestore"
"Återställ"
nodeGroupSpecs Listan över nodgruppsspecifikationer i klustret. NodeGroupSpec[]

Begränsningar:
Minsta längd = 1
restoreParameters Parametrar som används för återställningsåtgärder MongoClusterRestoreParameters
serverVersion Mongo DB-serverversionen. Standardvärdet är den senaste tillgängliga versionen om det inte anges. sträng

NodeGroupSpec

Name Beskrivning Värde
diskSizeGB Disklagringsstorleken för nodgruppen i GB. Exempelvärden: 128, 256, 512, 1024. int
enableHa Om hög tillgänglighet är aktiverat i nodgruppen. boolesk
Typ Nodtypen som distribueras i nodgruppen. "Shard"
nodeCount Antalet noder i nodgruppen. int
sku Resurs-SKU:n för nodgruppen. Detta definierar storleken på cpu och minne som etableras för varje nod. Exempelvärden: "M30", "M40". sträng

MongoClusterRestoreParameters

Name Beskrivning Värde
pointInTimeUTC UTC-tidpunkt för att återställa ett mongo-kluster sträng
sourceResourceId Resurs-ID för att hitta källklustret som ska återställas sträng

Resursdefinition för ARM-mall

Resurstypen mongoClusters kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/mongoClusters-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2023-11-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"
  }
}

Egenskapsvärden

mongoClusters

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/mongoClusters"
apiVersion Resurs-API-versionen "2023-11-15-preview"
name Resursnamnet sträng (krävs)
location Den geo-plats där resursen finns sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
properties Egenskaper för mongo-klustret. MongoClusterEgenskaper

MongoClusterEgenskaper

Name Beskrivning Värde
administratorLogin Administratörens inloggning för mongo-klustret. sträng
administratorLoginPassword Lösenordet för administratörsinloggningen. sträng

Begränsningar:
Känsligt värde. Skicka som en säker parameter.
createMode Läget för att skapa ett mongo-kluster. "Standard"
"PointInTimeRestore"
"Återställ"
nodeGroupSpecs Listan över nodgruppsspecifikationer i klustret. NodeGroupSpec[]

Begränsningar:
Minsta längd = 1
restoreParameters Parametrar som används för återställningsåtgärder MongoClusterRestoreParameters
serverVersion Mongo DB-serverversionen. Standardvärdet är den senaste tillgängliga versionen om den inte har angetts. sträng

NodeGroupSpec

Name Beskrivning Värde
diskSizeGB Disklagringsstorleken för nodgruppen i GB. Exempelvärden: 128, 256, 512, 1024. int
enableHa Om hög tillgänglighet är aktiverat i nodgruppen. boolesk
Typ Nodtypen som distribueras i nodgruppen. "Shard"
nodeCount Antalet noder i nodgruppen. int
sku Resurs-SKU:n för nodgruppen. Detta definierar storleken på cpu och minne som etableras för varje nod. Exempelvärden: "M30", "M40". sträng

MongoClusterRestoreParameters

Name Beskrivning Värde
pointInTimeUTC UTC-tidpunkt för att återställa ett mongo-kluster sträng
sourceResourceId Resurs-ID för att hitta källklustret som ska återställas sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen mongoClusters kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/mongoClusters-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2023-11-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"
    }
  })
}

Egenskapsvärden

mongoClusters

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/mongoClusters@2023-11-15-preview"
name Resursnamnet sträng (krävs)
location Den geo-plats där resursen finns sträng (krävs)
parent_id Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden.
properties Egenskaper för Mongo-klustret. MongoClusterProperties

MongoClusterProperties

Name Beskrivning Värde
administratorLogin Administratörens inloggning för Mongo-klustret. sträng
administratorLoginPassword Lösenordet för administratörsinloggningen. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
createMode Läget för att skapa ett mongo-kluster. "Standard"
"PointInTimeRestore"
"Återställ"
nodeGroupSpecs Listan över nodgruppsspecifikationer i klustret. NodeGroupSpec[]

Begränsningar:
Minsta längd = 1
restoreParameters Parametrar som används för återställningsåtgärder MongoClusterRestoreParameters
serverVersion Mongo DB-serverversionen. Standardvärdet är den senaste tillgängliga versionen om det inte anges. sträng

NodeGroupSpec

Name Beskrivning Värde
diskSizeGB Disklagringsstorleken för nodgruppen i GB. Exempelvärden: 128, 256, 512, 1024. int
enableHa Om hög tillgänglighet är aktiverat i nodgruppen. boolesk
Typ Nodtypen som distribueras i nodgruppen. "Shard"
nodeCount Antalet noder i nodgruppen. int
sku Resurs-SKU:n för nodgruppen. Detta definierar storleken på cpu och minne som etableras för varje nod. Exempelvärden: "M30", "M40". sträng

MongoClusterRestoreParameters

Name Beskrivning Värde
pointInTimeUTC UTC-tidpunkt för att återställa ett mongo-kluster sträng
sourceResourceId Resurs-ID för att hitta källklustret som ska återställas sträng