Freigeben über


Microsoft.DocumentDB mongoClusters 2023-09-15-preview

Bicep-Ressourcendefinition

Der MongoClusters-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/mongoClusters-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-09-15-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    createMode: 'string'
    nodeGroupSpecs: [
      {
        diskSizeGB: int
        enableHa: bool
        kind: 'string'
        nodeCount: int
        sku: 'string'
      }
    ]
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschaftswerte

Microsoft.DocumentDB/mongoClusters

Name Beschreibung Wert
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (erforderlich)
Eigenschaften Eigenschaften des Mongoclusters. MongoClusterProperties
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

MongoClusterProperties

Name Beschreibung Wert
administratorLogin Die Anmeldung des Administrators für den Mongo-Cluster. Schnur
administratorLoginPassword Das Kennwort der Administratoranmeldung. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
createMode Der Modus zum Erstellen eines Mongoclusters. 'Standard'
'PointInTimeRestore'
"Wiederherstellen"
nodeGroupSpecs Die Liste der Knotengruppenspezifikationen im Cluster. NodeGroupSpec[]
restoreParameters Parameter, die für Wiederherstellungsvorgänge verwendet werden MongoClusterRestoreParameters
serverVersion Die Mongo DB-Serverversion. Wenn nicht angegeben, wird standardmäßig die neueste verfügbare Version verwendet. Schnur

MongoClusterRestoreParameters

Name Beschreibung Wert
pointInTimeUTC UTC-Zeitpunkt zum Wiederherstellen eines Mongoclusters Schnur
sourceResourceId Ressourcen-ID zum Suchen des Quellclusters zum Wiederherstellen Schnur

NodeGroupSpec

Name Beschreibung Wert
diskSizeGB Die Datenträgerspeichergröße für die Knotengruppe in GB. Beispielwerte: 128, 256, 512, 1024. Int
enableHa Gibt an, ob hohe Verfügbarkeit in der Knotengruppe aktiviert ist. Bool
Art Der in der Knotengruppe bereitgestellte Knotentyp. 'Shard'
nodeCount Die Anzahl der Knoten in der Knotengruppe. Int
Sku Die Ressourcensku für die Knotengruppe. Dadurch wird die Größe der CPU und des Arbeitsspeichers definiert, die für jeden Knoten bereitgestellt werden. Beispielwerte: 'M30', 'M40'. Schnur

TrackedResourceTags

Name Beschreibung Wert

ARM-Vorlagenressourcendefinition

Der MongoClusters-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/mongoClusters-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "createMode": "string",
    "nodeGroupSpecs": [
      {
        "diskSizeGB": "int",
        "enableHa": "bool",
        "kind": "string",
        "nodeCount": "int",
        "sku": "string"
      }
    ],
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschaftswerte

Microsoft.DocumentDB/mongoClusters

Name Beschreibung Wert
apiVersion Die API-Version "2023-09-15-preview"
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (erforderlich)
Eigenschaften Eigenschaften des Mongoclusters. MongoClusterProperties
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp 'Microsoft.DocumentDB/mongoClusters'

MongoClusterProperties

Name Beschreibung Wert
administratorLogin Die Anmeldung des Administrators für den Mongo-Cluster. Schnur
administratorLoginPassword Das Kennwort der Administratoranmeldung. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
createMode Der Modus zum Erstellen eines Mongoclusters. 'Standard'
'PointInTimeRestore'
"Wiederherstellen"
nodeGroupSpecs Die Liste der Knotengruppenspezifikationen im Cluster. NodeGroupSpec[]
restoreParameters Parameter, die für Wiederherstellungsvorgänge verwendet werden MongoClusterRestoreParameters
serverVersion Die Mongo DB-Serverversion. Wenn nicht angegeben, wird standardmäßig die neueste verfügbare Version verwendet. Schnur

MongoClusterRestoreParameters

Name Beschreibung Wert
pointInTimeUTC UTC-Zeitpunkt zum Wiederherstellen eines Mongoclusters Schnur
sourceResourceId Ressourcen-ID zum Suchen des Quellclusters zum Wiederherstellen Schnur

NodeGroupSpec

Name Beschreibung Wert
diskSizeGB Die Datenträgerspeichergröße für die Knotengruppe in GB. Beispielwerte: 128, 256, 512, 1024. Int
enableHa Gibt an, ob hohe Verfügbarkeit in der Knotengruppe aktiviert ist. Bool
Art Der in der Knotengruppe bereitgestellte Knotentyp. 'Shard'
nodeCount Die Anzahl der Knoten in der Knotengruppe. Int
Sku Die Ressourcensku für die Knotengruppe. Dadurch wird die Größe der CPU und des Arbeitsspeichers definiert, die für jeden Knoten bereitgestellt werden. Beispielwerte: 'M30', 'M40'. Schnur

TrackedResourceTags

Name Beschreibung Wert

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der MongoClusters-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/mongoClusters-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2023-09-15-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      createMode = "string"
      nodeGroupSpecs = [
        {
          diskSizeGB = int
          enableHa = bool
          kind = "string"
          nodeCount = int
          sku = "string"
        }
      ]
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
    }
  })
}

Eigenschaftswerte

Microsoft.DocumentDB/mongoClusters

Name Beschreibung Wert
Ort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 3
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (erforderlich)
Eigenschaften Eigenschaften des Mongoclusters. MongoClusterProperties
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.DocumentDB/mongoClusters@2023-09-15-preview"

MongoClusterProperties

Name Beschreibung Wert
administratorLogin Die Anmeldung des Administrators für den Mongo-Cluster. Schnur
administratorLoginPassword Das Kennwort der Administratoranmeldung. Schnur

Zwänge:
Vertraulicher Wert. Übergeben Als sicherer Parameter.
createMode Der Modus zum Erstellen eines Mongoclusters. 'Standard'
'PointInTimeRestore'
"Wiederherstellen"
nodeGroupSpecs Die Liste der Knotengruppenspezifikationen im Cluster. NodeGroupSpec[]
restoreParameters Parameter, die für Wiederherstellungsvorgänge verwendet werden MongoClusterRestoreParameters
serverVersion Die Mongo DB-Serverversion. Wenn nicht angegeben, wird standardmäßig die neueste verfügbare Version verwendet. Schnur

MongoClusterRestoreParameters

Name Beschreibung Wert
pointInTimeUTC UTC-Zeitpunkt zum Wiederherstellen eines Mongoclusters Schnur
sourceResourceId Ressourcen-ID zum Suchen des Quellclusters zum Wiederherstellen Schnur

NodeGroupSpec

Name Beschreibung Wert
diskSizeGB Die Datenträgerspeichergröße für die Knotengruppe in GB. Beispielwerte: 128, 256, 512, 1024. Int
enableHa Gibt an, ob hohe Verfügbarkeit in der Knotengruppe aktiviert ist. Bool
Art Der in der Knotengruppe bereitgestellte Knotentyp. 'Shard'
nodeCount Die Anzahl der Knoten in der Knotengruppe. Int
Sku Die Ressourcensku für die Knotengruppe. Dadurch wird die Größe der CPU und des Arbeitsspeichers definiert, die für jeden Knoten bereitgestellt werden. Beispielwerte: 'M30', 'M40'. Schnur

TrackedResourceTags

Name Beschreibung Wert