Microsoft.DocumentDB mongoClusters 2023-03-15-preview
Definice prostředku Bicep
Typ prostředku mongoClusters je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy nasazení skupiny prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.DocumentDB/mongoClusters, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-03-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'
}
}
Hodnoty vlastností
mongoClusters
| Název | Description | Hodnota |
|---|---|---|
| name | Název prostředku | string (povinné) |
| location | Geografické umístění, ve kterém se nachází prostředek | string (povinné) |
| tags | Značky prostředků. | Slovník názvů značek a hodnot. Viz Značky v šablonách |
| properties | Vlastnosti clusteru mongo. | MongoClusterProperties |
MongoClusterProperties
| Název | Description | Hodnota |
|---|---|---|
| administratorLogin | Přihlášení správce ke clusteru Mongo | řetězec |
| administratorLoginPassword | Heslo pro přihlášení správce. | řetězec Omezení: Citlivá hodnota. Předání jako zabezpečený parametr |
| createMode | Režim vytvoření clusteru Mongo. | Výchozí PointInTimeRestore 'Obnovit' |
| nodeGroupSpecs | Seznam specifikací skupin uzlů v clusteru | NodeGroupSpec[] Omezení: Minimální délka = 1 |
| restoreParameters | Parametry používané pro operace obnovení | MongoClusterRestoreParameters |
| verze serveru | Verze serveru Mongo DB. Výchozí hodnota je nejnovější dostupná verze, pokud není zadána. | řetězec |
NodeGroupSpec
| Název | Description | Hodnota |
|---|---|---|
| diskSizeGB | Velikost diskového úložiště pro skupinu uzlů v GB. Příklady hodnot: 128, 256, 512, 1024. | int |
| enableHa | Určuje, jestli je ve skupině uzlů povolená vysoká dostupnost. | bool |
| Druhu | Typ uzlu nasazený ve skupině uzlů. | Shard |
| nodeCount | Počet uzlů ve skupině uzlů. | int |
| Sku | Skladová položka prostředku pro skupinu uzlů. Tím se definuje velikost procesoru a paměti, která je zřízena pro každý uzel. Příklady hodnot: M30, M40. | řetězec |
MongoClusterRestoreParameters
| Název | Description | Hodnota |
|---|---|---|
| pointInTimeUTC | Obnovení clusteru Mongo k bodu v čase (UTC) | řetězec |
| sourceResourceId | ID prostředku pro vyhledání zdrojového clusteru, který se má obnovit | řetězec |
Definice prostředku šablony ARM
Typ prostředku mongoClusters je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy nasazení skupiny prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.DocumentDB/mongoClusters, přidejte do šablony následující kód JSON.
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2023-03-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"
}
}
Hodnoty vlastností
MongoClusters
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.DocumentDB/mongoClusters |
| apiVersion | Verze rozhraní API prostředku | 2023-03-15-preview |
| name | Název prostředku | string (povinné) |
| location | Geografické umístění, kde se prostředek nachází | string (povinné) |
| tags | Značky prostředků. | Slovník názvů a hodnot značek. Zobrazit značky v šablonách |
| properties | Vlastnosti clusteru Mongo. | MongoClusterProperties |
MongoClusterProperties
| Název | Description | Hodnota |
|---|---|---|
| administratorLogin | Přihlašovací jméno správce pro cluster Mongo. | řetězec |
| administratorLoginPassword | Heslo přihlášení správce. | řetězec Omezení: Citlivá hodnota. Předání jako zabezpečený parametr |
| createMode | Režim vytvoření clusteru Mongo. | 'Výchozí' PointInTimeRestore Obnovit |
| nodeGroupSpecs | Seznam specifikací skupin uzlů v clusteru. | NodeGroupSpec[] Omezení: Minimální délka = 1 |
| obnoveníParameters | Parametry používané pro operace obnovení | MongoClusterRestoreParameters |
| Verze serveru | Verze serveru Mongo DB. Výchozí hodnota je nejnovější dostupná verze, pokud není zadána. | řetězec |
NodeGroupSpec
| Název | Description | Hodnota |
|---|---|---|
| diskSizeGB | Velikost úložiště disku pro skupinu uzlů v GB. Příklady hodnot: 128, 256, 512, 1024. | int |
| enableHa | Určuje, jestli je ve skupině uzlů povolená vysoká dostupnost. | bool |
| Druhu | Typ uzlu nasazený ve skupině uzlů. | Shard |
| počet uzlů | Počet uzlů ve skupině uzlů. | int |
| Sku | SKU prostředku pro skupinu uzlů. To definuje velikost procesoru a paměti, která je zřízena pro každý uzel. Ukázkové hodnoty: M30, M40. | řetězec |
MongoClusterRestoreParameters
| Název | Description | Hodnota |
|---|---|---|
| bodInTimeUTC | Obnovení clusteru Mongo k bodu v čase UTC | řetězec |
| sourceResourceId | ID prostředku pro vyhledání zdrojového clusteru, který se má obnovit | řetězec |
Definice prostředku Terraform (poskytovatel AzAPI)
Typ prostředku MongoClusters je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.DocumentDB/mongoClusters, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2023-03-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"
}
})
}
Hodnoty vlastností
MongoClusters
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.DocumentDB/mongoClusters@2023-03-15-preview |
| name | Název prostředku | string (povinné) |
| location | Geografické umístění, ve kterém se nachází prostředek | string (povinné) |
| parent_id | K nasazení do skupiny prostředků použijte ID této skupiny prostředků. | string (povinné) |
| tags | Značky prostředků. | Slovník názvů značek a hodnot. |
| properties | Vlastnosti clusteru mongo. | MongoClusterProperties |
MongoClusterProperties
| Název | Description | Hodnota |
|---|---|---|
| administratorLogin | Přihlášení správce ke clusteru Mongo | řetězec |
| administratorLoginPassword | Heslo pro přihlášení správce. | řetězec Omezení: Citlivá hodnota. Předání jako zabezpečený parametr |
| createMode | Režim vytvoření clusteru Mongo. | "Výchozí" "PointInTimeRestore" "Obnovit" |
| nodeGroupSpecs | Seznam specifikací skupin uzlů v clusteru | NodeGroupSpec[] Omezení: Minimální délka = 1 |
| restoreParameters | Parametry používané pro operace obnovení | MongoClusterRestoreParameters |
| verze serveru | Verze serveru Mongo DB. Výchozí hodnota je nejnovější dostupná verze, pokud není zadána. | řetězec |
NodeGroupSpec
| Název | Description | Hodnota |
|---|---|---|
| diskSizeGB | Velikost diskového úložiště pro skupinu uzlů v GB. Příklady hodnot: 128, 256, 512, 1024. | int |
| enableHa | Určuje, jestli je ve skupině uzlů povolená vysoká dostupnost. | bool |
| Druhu | Typ uzlu nasazený ve skupině uzlů. | "Shard" |
| nodeCount | Počet uzlů ve skupině uzlů. | int |
| Sku | Skladová položka prostředku pro skupinu uzlů. Tím se definuje velikost procesoru a paměti, která je zřízena pro každý uzel. Příklady hodnot: M30, M40. | řetězec |
MongoClusterRestoreParameters
| Název | Description | Hodnota |
|---|---|---|
| pointInTimeUTC | Obnovení clusteru Mongo k bodu v čase (UTC) | řetězec |
| sourceResourceId | ID prostředku pro vyhledání zdrojového clusteru, který se má obnovit | řetězec |