Microsoft.DocumentDB mongoClusters 2023-09-15-preview
Bicep-Ressourcendefinition
Der mongoClusters-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die folgendes zum Ziel haben:
- 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 Bicep hinzu.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-09-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'
}
}
Eigenschaftswerte
mongoClusters
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Ressourcenname | Zeichenfolge (erforderlich) |
location | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
tags | Ressourcentags. | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
properties | Eigenschaften des Mongoclusters. | MongoClusterProperties |
MongoClusterProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
administratorLogin | Die Administratoranmeldung für den Mongocluster. | Zeichenfolge |
administratorLoginPassword | Das Kennwort der Administratoranmeldung. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
createMode | Der Modus zum Erstellen eines Mongoclusters. | 'Standardwert' 'PointInTimeRestore' "Wiederherstellen" |
nodeGroupSpecs | Die Liste der Knotengruppenspezifikationen im Cluster. | NodeGroupSpec[] Einschränkungen: Min. Länge = 1 |
restoreParameters | Parameter, die für Wiederherstellungsvorgänge verwendet werden | MongoClusterRestoreParameters |
serverVersion | Die Mongo DB-Serverversion. Standardmäßig wird die neueste verfügbare Version verwendet, falls nicht angegeben. | Zeichenfolge |
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 Hochverfügbarkeit für die Knotengruppe aktiviert ist. | bool |
kind | Der Knotentyp, der in der Knotengruppe bereitgestellt wird. | "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'. | Zeichenfolge |
MongoClusterRestoreParameters
Name | BESCHREIBUNG | Wert |
---|---|---|
pointInTimeUTC | UTC-Zeitpunkt zum Wiederherstellen eines Mongoclusters | Zeichenfolge |
sourceResourceId | Ressourcen-ID zum Suchen des wiederherzustellenden Quellclusters | Zeichenfolge |
Ressourcendefinition mit einer ARM-Vorlage
Der mongoClusters-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die folgendes zum Ziel haben:
- 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": "2023-09-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"
}
}
Eigenschaftswerte
mongoClusters
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Ressourcentyp | "Microsoft.DocumentDB/mongoClusters" |
apiVersion | Die Version der Ressourcen-API | "2023-09-15-preview" |
name | Der Ressourcenname | Zeichenfolge (erforderlich) |
location | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
tags | Ressourcentags. | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
properties | Eigenschaften des Mongoclusters. | MongoClusterProperties |
MongoClusterProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
administratorLogin | Die Administratoranmeldung für den Mongo-Cluster. | Zeichenfolge |
administratorLoginPassword | Das Kennwort der Administratoranmeldung. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
createMode | Der Modus zum Erstellen eines Mongoclusters. | 'Standardwert' 'PointInTimeRestore' "Wiederherstellen" |
nodeGroupSpecs | Die Liste der Knotengruppenspezifikationen im Cluster. | NodeGroupSpec[] Einschränkungen: Min. Länge = 1 |
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. | Zeichenfolge |
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 Hochverfügbarkeit für die Knotengruppe aktiviert ist. | bool |
kind | Der in der Knotengruppe bereitgestellte Knotentyp. | "Shard" |
nodeCount | Die Anzahl der Knoten in der Knotengruppe. | INT |
sku | Die Ressourcen-SKU 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'. | Zeichenfolge |
MongoClusterRestoreParameters
Name | BESCHREIBUNG | Wert |
---|---|---|
pointInTimeUTC | UTC-Zeitpunkt zum Wiederherstellen eines Mongoclusters | Zeichenfolge |
sourceResourceId | Ressourcen-ID zum Suchen des wiederherzustellenden Quellclusters | Zeichenfolge |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp mongoClusters kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/mongoClusters-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2023-09-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"
}
})
}
Eigenschaftswerte
mongoClusters
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ressourcentyp | "Microsoft.DocumentDB/mongoClusters@2023-09-15-preview" |
name | Der Ressourcenname | Zeichenfolge (erforderlich) |
location | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
parent_id | Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. | Zeichenfolge (erforderlich) |
tags | Ressourcentags. | Wörterbuch der Tagnamen und -werte. |
properties | Eigenschaften des Mongoclusters. | MongoClusterProperties |
MongoClusterProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
administratorLogin | Die Administratoranmeldung für den Mongocluster. | Zeichenfolge |
administratorLoginPassword | Das Kennwort der Administratoranmeldung. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
createMode | Der Modus zum Erstellen eines Mongoclusters. | "Standard" "PointInTimeRestore" "Wiederherstellen" |
nodeGroupSpecs | Die Liste der Knotengruppenspezifikationen im Cluster. | NodeGroupSpec[] Einschränkungen: Min. Länge = 1 |
restoreParameters | Parameter, die für Wiederherstellungsvorgänge verwendet werden | MongoClusterRestoreParameters |
serverVersion | Die Mongo DB-Serverversion. Standardmäßig wird die neueste verfügbare Version verwendet, falls nicht angegeben. | Zeichenfolge |
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 Hochverfügbarkeit für die Knotengruppe aktiviert ist. | bool |
kind | Der Knotentyp, der in der Knotengruppe bereitgestellt wird. | "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'. | Zeichenfolge |
MongoClusterRestoreParameters
Name | BESCHREIBUNG | Wert |
---|---|---|
pointInTimeUTC | UTC-Zeitpunkt zum Wiederherstellen eines Mongoclusters | Zeichenfolge |
sourceResourceId | Ressourcen-ID zum Suchen des wiederherzustellenden Quellclusters | Zeichenfolge |