Microsoft.DocumentDB mongoClusters 2024-10-01-preview

Artikel
12/20/2024

Bicep-Ressourcendefinition

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

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

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@2024-10-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    administrator: {
      password: 'string'
      userName: 'string'
    }
    backup: {}
    compute: {
      tier: 'string'
    }
    createMode: 'string'
    dataApi: {
      mode: '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'
  }
}

Eigenschaftswerte

AdministratorEigenschaften

Name	Beschreibung	Wert
Passwort	Das Administratorkennwort.	Schnur Zwänge: Vertraulicher Wert. Übergeben Als sicherer Parameter.
Nutzername	Der Administratorbenutzername.	Schnur

BackupProperties

Name	Beschreibung	Wert

ComputeProperties

Name	Beschreibung	Wert
Rang	Die Computeebene, die dem Cluster zugewiesen werden soll, wobei jede Ebene einer größe des virtuellen Kerns und des Arbeitsspeichers zugeordnet ist. Beispielwerte: 'M30', 'M40'.	Schnur

DataApiProperties

Name	Beschreibung	Wert
Modus	Der Modus, der angibt, ob die Mongo-Daten-API für einen Cluster aktiviert ist.	"Deaktiviert" "Aktiviert"

HighAvailabilityProperties

Name	Beschreibung	Wert
targetMode	Der für den Cluster angeforderte Zielmodus für hohe Verfügbarkeit.	"Deaktiviert" 'SameZone' "ZoneRedundantPreferred"

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	Die ressourcenspezifischen Eigenschaften für diese Ressource.	MongoClusterProperties
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

MongoClusterProperties

Name	Beschreibung	Wert
Administrator	Die lokalen Administratoreigenschaften für den Mongo-Cluster.	"AdministratorProperties"
Sicherungskopie	Die Sicherungseigenschaften des Mongoclusters.	BackupProperties-
berechnen	Die Berechnungseigenschaften des Mongoclusters.	ComputeProperties-
createMode	Der Modus zum Erstellen eines Mongoclusters.	'Standard' "GeoReplica" 'PointInTimeRestore' 'Replikat'
dataApi	Die Daten-API-Eigenschaften des Mongo-Clusters.	DataApiProperties-
highAvailability	Die Eigenschaften der hohen Verfügbarkeit des Mongo-Clusters.	HighAvailabilityProperties
previewFeatures	Liste der privaten Endpunktverbindungen.	Zeichenfolgenarray, das eine der folgenden Elemente enthält: "GeoReplicas"
publicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen Mongo-Cluster zulässig ist.	"Deaktiviert" "Aktiviert"
replicaParameters	Die Parameter zum Erstellen eines Replikat-Mongoclusters.	MongoClusterReplicaParameters
restoreParameters	Die Parameter zum Erstellen eines Mongoclusters für die Punkt-in-Zeit-Wiederherstellung.	MongoClusterRestoreParameters
serverVersion	Die Mongo DB-Serverversion. Wenn nicht angegeben, wird standardmäßig die neueste verfügbare Version verwendet.	Schnur
Sharding	Die Shardingeigenschaften des Mongoclusters.	ShardingProperties-
Lagerung	Die Speichereigenschaften des Mongoclusters.	StorageProperties-

MongoClusterReplicaParameters

Name	Beschreibung	Wert
sourceLocation	Der Speicherort des Quellclusters	Zeichenfolge (erforderlich)
sourceResourceId	Die ID des Replikationsquellclusters.	Zeichenfolge (erforderlich)

MongoClusterRestoreParameters

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

ShardingProperties

Name	Beschreibung	Wert
shardCount	Anzahl der Für den Cluster bereitzustellenden Shards.	Int

StorageProperties

Name	Beschreibung	Wert
sizeGb	Die Größe des Datenträgers, der jedem Server zugewiesen ist.	Int

TrackedResourceTags

Name	Beschreibung	Wert

ARM-Vorlagenressourcendefinition

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

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

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": "2024-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "administrator": {
      "password": "string",
      "userName": "string"
    },
    "backup": {
    },
    "compute": {
      "tier": "string"
    },
    "createMode": "string",
    "dataApi": {
      "mode": "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"
  }
}

Eigenschaftswerte

AdministratorEigenschaften

Name	Beschreibung	Wert
Passwort	Das Administratorkennwort.	Schnur Zwänge: Vertraulicher Wert. Übergeben Als sicherer Parameter.
Nutzername	Der Administratorbenutzername.	Schnur

BackupProperties

Name	Beschreibung	Wert

ComputeProperties

Name	Beschreibung	Wert
Rang	Die Computeebene, die dem Cluster zugewiesen werden soll, wobei jede Ebene einer größe des virtuellen Kerns und des Arbeitsspeichers zugeordnet ist. Beispielwerte: 'M30', 'M40'.	Schnur

DataApiProperties

Name	Beschreibung	Wert
Modus	Der Modus, der angibt, ob die Mongo-Daten-API für einen Cluster aktiviert ist.	"Deaktiviert" "Aktiviert"

HighAvailabilityProperties

Name	Beschreibung	Wert
targetMode	Der für den Cluster angeforderte Zielmodus für hohe Verfügbarkeit.	"Deaktiviert" 'SameZone' "ZoneRedundantPreferred"

Microsoft.DocumentDB/mongoClusters

Name	Beschreibung	Wert
apiVersion	Die API-Version	"2024-10-01-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	Die ressourcenspezifischen Eigenschaften für diese Ressource.	MongoClusterProperties
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art	Der Ressourcentyp	'Microsoft.DocumentDB/mongoClusters'

MongoClusterProperties

Name	Beschreibung	Wert
Administrator	Die lokalen Administratoreigenschaften für den Mongo-Cluster.	"AdministratorProperties"
Sicherungskopie	Die Sicherungseigenschaften des Mongoclusters.	BackupProperties-
berechnen	Die Berechnungseigenschaften des Mongoclusters.	ComputeProperties-
createMode	Der Modus zum Erstellen eines Mongoclusters.	'Standard' "GeoReplica" 'PointInTimeRestore' 'Replikat'
dataApi	Die Daten-API-Eigenschaften des Mongo-Clusters.	DataApiProperties-
highAvailability	Die Eigenschaften der hohen Verfügbarkeit des Mongo-Clusters.	HighAvailabilityProperties
previewFeatures	Liste der privaten Endpunktverbindungen.	Zeichenfolgenarray, das eine der folgenden Elemente enthält: "GeoReplicas"
publicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen Mongo-Cluster zulässig ist.	"Deaktiviert" "Aktiviert"
replicaParameters	Die Parameter zum Erstellen eines Replikat-Mongoclusters.	MongoClusterReplicaParameters
restoreParameters	Die Parameter zum Erstellen eines Mongoclusters für die Punkt-in-Zeit-Wiederherstellung.	MongoClusterRestoreParameters
serverVersion	Die Mongo DB-Serverversion. Wenn nicht angegeben, wird standardmäßig die neueste verfügbare Version verwendet.	Schnur
Sharding	Die Shardingeigenschaften des Mongoclusters.	ShardingProperties-
Lagerung	Die Speichereigenschaften des Mongoclusters.	StorageProperties-

MongoClusterReplicaParameters

Name	Beschreibung	Wert
sourceLocation	Der Speicherort des Quellclusters	Zeichenfolge (erforderlich)
sourceResourceId	Die ID des Replikationsquellclusters.	Zeichenfolge (erforderlich)

MongoClusterRestoreParameters

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

ShardingProperties

Name	Beschreibung	Wert
shardCount	Anzahl der Für den Cluster bereitzustellenden Shards.	Int

StorageProperties

Name	Beschreibung	Wert
sizeGb	Die Größe des Datenträgers, der jedem Server zugewiesen ist.	Int

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@2024-10-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administrator = {
        password = "string"
        userName = "string"
      }
      backup = {
      }
      compute = {
        tier = "string"
      }
      createMode = "string"
      dataApi = {
        mode = "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
      }
    }
  })
}

Eigenschaftswerte

AdministratorEigenschaften

Name	Beschreibung	Wert
Passwort	Das Administratorkennwort.	Schnur Zwänge: Vertraulicher Wert. Übergeben Als sicherer Parameter.
Nutzername	Der Administratorbenutzername.	Schnur

BackupProperties

Name	Beschreibung	Wert

ComputeProperties

Name	Beschreibung	Wert
Rang	Die Computeebene, die dem Cluster zugewiesen werden soll, wobei jede Ebene einer größe des virtuellen Kerns und des Arbeitsspeichers zugeordnet ist. Beispielwerte: 'M30', 'M40'.	Schnur

DataApiProperties

Name	Beschreibung	Wert
Modus	Der Modus, der angibt, ob die Mongo-Daten-API für einen Cluster aktiviert ist.	"Deaktiviert" "Aktiviert"

HighAvailabilityProperties

Name	Beschreibung	Wert
targetMode	Der für den Cluster angeforderte Zielmodus für hohe Verfügbarkeit.	"Deaktiviert" 'SameZone' "ZoneRedundantPreferred"

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	Die ressourcenspezifischen Eigenschaften für diese Ressource.	MongoClusterProperties
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte.
Art	Der Ressourcentyp	"Microsoft.DocumentDB/mongoClusters@2024-10-01-preview"

MongoClusterProperties

Name	Beschreibung	Wert
Administrator	Die lokalen Administratoreigenschaften für den Mongo-Cluster.	"AdministratorProperties"
Sicherungskopie	Die Sicherungseigenschaften des Mongoclusters.	BackupProperties-
berechnen	Die Berechnungseigenschaften des Mongoclusters.	ComputeProperties-
createMode	Der Modus zum Erstellen eines Mongoclusters.	'Standard' "GeoReplica" 'PointInTimeRestore' 'Replikat'
dataApi	Die Daten-API-Eigenschaften des Mongo-Clusters.	DataApiProperties-
highAvailability	Die Eigenschaften der hohen Verfügbarkeit des Mongo-Clusters.	HighAvailabilityProperties
previewFeatures	Liste der privaten Endpunktverbindungen.	Zeichenfolgenarray, das eine der folgenden Elemente enthält: "GeoReplicas"
publicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen Mongo-Cluster zulässig ist.	"Deaktiviert" "Aktiviert"
replicaParameters	Die Parameter zum Erstellen eines Replikat-Mongoclusters.	MongoClusterReplicaParameters
restoreParameters	Die Parameter zum Erstellen eines Mongoclusters für die Punkt-in-Zeit-Wiederherstellung.	MongoClusterRestoreParameters
serverVersion	Die Mongo DB-Serverversion. Wenn nicht angegeben, wird standardmäßig die neueste verfügbare Version verwendet.	Schnur
Sharding	Die Shardingeigenschaften des Mongoclusters.	ShardingProperties-
Lagerung	Die Speichereigenschaften des Mongoclusters.	StorageProperties-

MongoClusterReplicaParameters

Name	Beschreibung	Wert
sourceLocation	Der Speicherort des Quellclusters	Zeichenfolge (erforderlich)
sourceResourceId	Die ID des Replikationsquellclusters.	Zeichenfolge (erforderlich)

MongoClusterRestoreParameters

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

ShardingProperties

Name	Beschreibung	Wert
shardCount	Anzahl der Für den Cluster bereitzustellenden Shards.	Int

StorageProperties

Name	Beschreibung	Wert
sizeGb	Die Größe des Datenträgers, der jedem Server zugewiesen ist.	Int

TrackedResourceTags

Name	Beschreibung	Wert

Freigeben über

Microsoft.DocumentDB mongoClusters 2024-10-01-preview

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

AdministratorEigenschaften

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

ARM-Vorlagenressourcendefinition

Ressourcenformat

Eigenschaftswerte

AdministratorEigenschaften

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Ressourcenformat

Eigenschaftswerte

AdministratorEigenschaften

BackupProperties

ComputeProperties

DataApiProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

Feedback

Zusätzliche Ressourcen