Microsoft.DocumentDB mongoClusters
- nejnovější
- z 10. 10. 2024 ve verzi Preview
-
2024-07-01 -
2024-06-01-preview - 2024-03-01-preview
-
2024-024-15-preview - 11. 11. 2023 ve verzi Preview
-
2023-09-15-preview -
2023-03-15-preview - 1. 3. 2023 ve verzi Preview
Definice prostředku Bicep
Typ prostředku mongoClusters je možné nasadit s operacemi, které cílí:
- 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@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'
}
}
Hodnoty vlastností
AdministratorProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| heslo | Heslo správce. | řetězec Omezení: Citlivá hodnota. Předejte ho jako zabezpečený parametr. |
| userName | Uživatelské jméno správce. | řetězec |
Zálohováníproperties
| Jméno | Popis | Hodnota |
|---|
ComputeProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| úroveň | Úroveň výpočetních prostředků, která se má přiřadit ke clusteru, kde se každá vrstva mapuje na virtuální jádro a velikost paměti. Příklady hodnot: M30, M40. | řetězec |
DataApiProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| režim | Režim označující, jestli je pro cluster povolené rozhraní Mongo Data API. | Zakázáno Povoleno |
HighAvailabilityProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| targetMode | Cílový režim vysoké dostupnosti požadovaný pro cluster. | Zakázáno SameZone ZoneRedundantPreferred |
Microsoft.DocumentDB/mongoClusters
| Jméno | Popis | Hodnota |
|---|---|---|
| umístění | Geografické umístění, ve kterém se nachází zdroj | string (povinné) |
| Jméno | Název prostředku | řetězec Omezení: Minimální délka = 3 Maximální délka = 3 Model = ^[a-z0-9]+(-[a-z0-9]+)* (povinné) |
| vlastnosti | Vlastnosti specifické pro prostředek pro tento prostředek. | MongoClusterProperties |
| visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
MongoClusterProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| správce | Vlastnosti místního správce clusteru Mongo. | správce |
| zálohování | Vlastnosti zálohování clusteru Mongo. | |
| vypočítat | Vlastnosti výpočetních prostředků clusteru Mongo. | |
| createMode | Režim vytvoření clusteru Mongo. | Výchozí "GeoReplica" PointInTimeRestore Replika |
| dataApi | Vlastnosti rozhraní DATA API clusteru Mongo. | dataApiProperties |
| vysoká dostupnost | Vlastnosti vysoké dostupnosti clusteru Mongo. | HighAvailabilityProperties |
| PreviewFeatures | Seznam připojení privátních koncových bodů | Řetězcové pole obsahující některou z těchto možností: "GeoReplicas" |
| publicNetworkAccess | Určuje, jestli je pro tento cluster Mongo povolený přístup k veřejnému koncovému bodu nebo ne. | Zakázáno Povoleno |
| replicaParameters | Parametry pro vytvoření clusteru Mongo repliky. | MongoClusterReplicaParameters |
| restoreParameters | Parametry pro vytvoření clusteru Mongo k určitému bodu v čase. | |
| serverVersion | Verze serveru Mongo DB. Výchozí hodnota je nejnovější dostupná verze, pokud není zadána. | řetězec |
| Sharding | Vlastnosti horizontálního dělení clusteru Mongo. | ShardingProperties |
| skladování | Vlastnosti úložiště clusteru Mongo. | storageProperties |
MongoClusterReplicaParameters
| Jméno | Popis | Hodnota |
|---|---|---|
| sourceLocation | Umístění zdrojového clusteru | string (povinné) |
| sourceResourceId | ID zdrojového clusteru replikace. | string (povinné) |
MongoClusterRestoreParameters
| Jméno | Popis | Hodnota |
|---|---|---|
| pointInTimeUTC | Obnovení clusteru Mongo k určitému bodu v čase UTC | řetězec |
| sourceResourceId | ID prostředku pro vyhledání zdrojového clusteru pro obnovení | řetězec |
ShardingProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| shardCount | Počet horizontálních oddílů, které se mají zřídit v clusteru | Int |
StorageProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| sizeGb | Velikost datového disku přiřazeného každému serveru. | Int |
TrackedResourceTags
| Jméno | Popis | Hodnota |
|---|
Definice prostředku šablony ARM
Typ prostředku mongoClusters je možné nasadit s operacemi, které cílí:
- 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í JSON.
{
"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"
}
}
Hodnoty vlastností
AdministratorProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| heslo | Heslo správce. | řetězec Omezení: Citlivá hodnota. Předejte ho jako zabezpečený parametr. |
| userName | Uživatelské jméno správce. | řetězec |
Zálohováníproperties
| Jméno | Popis | Hodnota |
|---|
ComputeProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| úroveň | Úroveň výpočetních prostředků, která se má přiřadit ke clusteru, kde se každá vrstva mapuje na virtuální jádro a velikost paměti. Příklady hodnot: M30, M40. | řetězec |
DataApiProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| režim | Režim označující, jestli je pro cluster povolené rozhraní Mongo Data API. | Zakázáno Povoleno |
HighAvailabilityProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| targetMode | Cílový režim vysoké dostupnosti požadovaný pro cluster. | Zakázáno SameZone ZoneRedundantPreferred |
Microsoft.DocumentDB/mongoClusters
| Jméno | Popis | Hodnota |
|---|---|---|
| apiVersion | Verze rozhraní API | 2024-10-01-preview |
| umístění | Geografické umístění, ve kterém se nachází zdroj | string (povinné) |
| Jméno | Název prostředku | řetězec Omezení: Minimální délka = 3 Maximální délka = 3 Model = ^[a-z0-9]+(-[a-z0-9]+)* (povinné) |
| vlastnosti | Vlastnosti specifické pro prostředek pro tento prostředek. | MongoClusterProperties |
| visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
| typ | Typ prostředku | Microsoft.DocumentDB/mongoClusters |
MongoClusterProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| správce | Vlastnosti místního správce clusteru Mongo. | správce |
| zálohování | Vlastnosti zálohování clusteru Mongo. | |
| vypočítat | Vlastnosti výpočetních prostředků clusteru Mongo. | |
| createMode | Režim vytvoření clusteru Mongo. | Výchozí "GeoReplica" PointInTimeRestore Replika |
| dataApi | Vlastnosti rozhraní DATA API clusteru Mongo. | dataApiProperties |
| vysoká dostupnost | Vlastnosti vysoké dostupnosti clusteru Mongo. | HighAvailabilityProperties |
| PreviewFeatures | Seznam připojení privátních koncových bodů | Řetězcové pole obsahující některou z těchto možností: "GeoReplicas" |
| publicNetworkAccess | Určuje, jestli je pro tento cluster Mongo povolený přístup k veřejnému koncovému bodu nebo ne. | Zakázáno Povoleno |
| replicaParameters | Parametry pro vytvoření clusteru Mongo repliky. | MongoClusterReplicaParameters |
| restoreParameters | Parametry pro vytvoření clusteru Mongo k určitému bodu v čase. | |
| serverVersion | Verze serveru Mongo DB. Výchozí hodnota je nejnovější dostupná verze, pokud není zadána. | řetězec |
| Sharding | Vlastnosti horizontálního dělení clusteru Mongo. | ShardingProperties |
| skladování | Vlastnosti úložiště clusteru Mongo. | storageProperties |
MongoClusterReplicaParameters
| Jméno | Popis | Hodnota |
|---|---|---|
| sourceLocation | Umístění zdrojového clusteru | string (povinné) |
| sourceResourceId | ID zdrojového clusteru replikace. | string (povinné) |
MongoClusterRestoreParameters
| Jméno | Popis | Hodnota |
|---|---|---|
| pointInTimeUTC | Obnovení clusteru Mongo k určitému bodu v čase UTC | řetězec |
| sourceResourceId | ID prostředku pro vyhledání zdrojového clusteru pro obnovení | řetězec |
ShardingProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| shardCount | Počet horizontálních oddílů, které se mají zřídit v clusteru | Int |
StorageProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| sizeGb | Velikost datového disku přiřazeného každému serveru. | Int |
TrackedResourceTags
| Jméno | Popis | Hodnota |
|---|
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku mongoClusters je možné nasadit s operacemi, které cílí:
- 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@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
}
}
})
}
Hodnoty vlastností
AdministratorProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| heslo | Heslo správce. | řetězec Omezení: Citlivá hodnota. Předejte ho jako zabezpečený parametr. |
| userName | Uživatelské jméno správce. | řetězec |
Zálohováníproperties
| Jméno | Popis | Hodnota |
|---|
ComputeProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| úroveň | Úroveň výpočetních prostředků, která se má přiřadit ke clusteru, kde se každá vrstva mapuje na virtuální jádro a velikost paměti. Příklady hodnot: M30, M40. | řetězec |
DataApiProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| režim | Režim označující, jestli je pro cluster povolené rozhraní Mongo Data API. | Zakázáno Povoleno |
HighAvailabilityProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| targetMode | Cílový režim vysoké dostupnosti požadovaný pro cluster. | Zakázáno SameZone ZoneRedundantPreferred |
Microsoft.DocumentDB/mongoClusters
MongoClusterProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| správce | Vlastnosti místního správce clusteru Mongo. | správce |
| zálohování | Vlastnosti zálohování clusteru Mongo. | |
| vypočítat | Vlastnosti výpočetních prostředků clusteru Mongo. | |
| createMode | Režim vytvoření clusteru Mongo. | Výchozí "GeoReplica" PointInTimeRestore Replika |
| dataApi | Vlastnosti rozhraní DATA API clusteru Mongo. | dataApiProperties |
| vysoká dostupnost | Vlastnosti vysoké dostupnosti clusteru Mongo. | HighAvailabilityProperties |
| PreviewFeatures | Seznam připojení privátních koncových bodů | Řetězcové pole obsahující některou z těchto možností: "GeoReplicas" |
| publicNetworkAccess | Určuje, jestli je pro tento cluster Mongo povolený přístup k veřejnému koncovému bodu nebo ne. | Zakázáno Povoleno |
| replicaParameters | Parametry pro vytvoření clusteru Mongo repliky. | MongoClusterReplicaParameters |
| restoreParameters | Parametry pro vytvoření clusteru Mongo k určitému bodu v čase. | |
| serverVersion | Verze serveru Mongo DB. Výchozí hodnota je nejnovější dostupná verze, pokud není zadána. | řetězec |
| Sharding | Vlastnosti horizontálního dělení clusteru Mongo. | ShardingProperties |
| skladování | Vlastnosti úložiště clusteru Mongo. | storageProperties |
MongoClusterReplicaParameters
| Jméno | Popis | Hodnota |
|---|---|---|
| sourceLocation | Umístění zdrojového clusteru | string (povinné) |
| sourceResourceId | ID zdrojového clusteru replikace. | string (povinné) |
MongoClusterRestoreParameters
| Jméno | Popis | Hodnota |
|---|---|---|
| pointInTimeUTC | Obnovení clusteru Mongo k určitému bodu v čase UTC | řetězec |
| sourceResourceId | ID prostředku pro vyhledání zdrojového clusteru pro obnovení | řetězec |
ShardingProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| shardCount | Počet horizontálních oddílů, které se mají zřídit v clusteru | Int |
StorageProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| sizeGb | Velikost datového disku přiřazeného každému serveru. | Int |
TrackedResourceTags
| Jméno | Popis | Hodnota |
|---|