Microsoft.DocumentDB mongoClusters 2024-10-01-preview
Bicep-resourcedefinitie
Het resourcetype mongoClusters kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.DocumentDB/mongoClusters wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
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'
}
}
Eigenschapswaarden
AdministratorProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| wachtwoord | Het beheerderswachtwoord. | snaar Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
| userName | De gebruikersnaam van de beheerder. | snaar |
BackupProperties
| Naam | Beschrijving | Waarde |
|---|
ComputeProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| rang | De rekenlaag die moet worden toegewezen aan het cluster, waarbij elke laag wordt toegewezen aan een virtuele kern en geheugengrootte. Voorbeeldwaarden: 'M30', 'M40'. | snaar |
DataApiProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| wijze | De modus om aan te geven of de Mongo Data-API is ingeschakeld voor een cluster. | 'Uitgeschakeld' 'Ingeschakeld' |
HighAvailabilityProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| targetMode | De doelmodus voor hoge beschikbaarheid die is aangevraagd voor het cluster. | 'Uitgeschakeld' 'SameZone' 'ZoneRedundantPreferred' |
Microsoft.DocumentDB/mongoClusters
| Naam | Beschrijving | Waarde |
|---|---|---|
| plaats | De geografische locatie waar de resource zich bevindt | tekenreeks (vereist) |
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 3 Maximale lengte = 3 Patroon = ^[a-z0-9]+(-[a-z0-9]+)* (vereist) |
| Eigenschappen | De resourcespecifieke eigenschappen voor deze resource. | MongoClusterProperties- |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
MongoClusterProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| administrateur | De lokale beheerderseigenschappen voor het Mongo-cluster. | AdministratorProperties- |
| backup | De back-upeigenschappen van het Mongo-cluster. | BackupProperties- |
| berekenen | De rekeneigenschappen van het Mongo-cluster. | ComputeProperties- |
| createMode | De modus voor het maken van een Mongo-cluster. | 'Standaard' 'GeoReplica' 'PointInTimeRestore' 'Replica' |
| dataApi | De gegevens-API-eigenschappen van het Mongo-cluster. | DataApiProperties- |
| highAvailability | De eigenschappen voor hoge beschikbaarheid van het Mongo-cluster. | HighAvailabilityProperties- |
| previewFeatures | Lijst met privé-eindpuntverbindingen. | Tekenreeksmatrix met een van de volgende waarden: 'GeoReplicas' |
| publicNetworkAccess | Of openbare eindpunttoegang wel of niet is toegestaan voor dit Mongo-cluster. | 'Uitgeschakeld' 'Ingeschakeld' |
| replicaParameters | De parameters voor het maken van een replica mongo-cluster. | MongoClusterReplicaParameters |
| restoreParameters | De parameters voor het maken van een mongo-cluster voor herstel naar een bepaald tijdstip. | MongoClusterRestoreParameters |
| serverVersion | De Mongo DB-serverversie. Standaard ingesteld op de meest recente beschikbare versie als deze niet is opgegeven. | snaar |
| sharding | De sharding-eigenschappen van het Mongo-cluster. | ShardingProperties- |
| opslag | De opslageigenschappen van het Mongo-cluster. | StorageProperties- |
MongoClusterReplicaParameters
| Naam | Beschrijving | Waarde |
|---|---|---|
| sourceLocation | De locatie van het broncluster | tekenreeks (vereist) |
| sourceResourceId | De id van het replicatiebroncluster. | tekenreeks (vereist) |
MongoClusterRestoreParameters
| Naam | Beschrijving | Waarde |
|---|---|---|
| pointInTimeUTC | UTC-tijdstip om een Mongo-cluster te herstellen | snaar |
| sourceResourceId | Resource-id om het broncluster te vinden dat moet worden hersteld | snaar |
ShardingProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| shardCount | Aantal shards dat moet worden ingericht op het cluster. | Int |
StorageProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| sizeGb | De grootte van de gegevensschijf die aan elke server is toegewezen. | Int |
TrackedResourceTags
| Naam | Beschrijving | Waarde |
|---|
Resourcedefinitie van ARM-sjabloon
Het resourcetype mongoClusters kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.DocumentDB/mongoClusters-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"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"
}
}
Eigenschapswaarden
AdministratorProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| wachtwoord | Het beheerderswachtwoord. | snaar Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
| userName | De gebruikersnaam van de beheerder. | snaar |
BackupProperties
| Naam | Beschrijving | Waarde |
|---|
ComputeProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| rang | De rekenlaag die moet worden toegewezen aan het cluster, waarbij elke laag wordt toegewezen aan een virtuele kern en geheugengrootte. Voorbeeldwaarden: 'M30', 'M40'. | snaar |
DataApiProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| wijze | De modus om aan te geven of de Mongo Data-API is ingeschakeld voor een cluster. | 'Uitgeschakeld' 'Ingeschakeld' |
HighAvailabilityProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| targetMode | De doelmodus voor hoge beschikbaarheid die is aangevraagd voor het cluster. | 'Uitgeschakeld' 'SameZone' 'ZoneRedundantPreferred' |
Microsoft.DocumentDB/mongoClusters
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2024-10-01-preview' |
| plaats | De geografische locatie waar de resource zich bevindt | tekenreeks (vereist) |
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 3 Maximale lengte = 3 Patroon = ^[a-z0-9]+(-[a-z0-9]+)* (vereist) |
| Eigenschappen | De resourcespecifieke eigenschappen voor deze resource. | MongoClusterProperties- |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
| type | Het resourcetype | 'Microsoft.DocumentDB/mongoClusters' |
MongoClusterProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| administrateur | De lokale beheerderseigenschappen voor het Mongo-cluster. | AdministratorProperties- |
| backup | De back-upeigenschappen van het Mongo-cluster. | BackupProperties- |
| berekenen | De rekeneigenschappen van het Mongo-cluster. | ComputeProperties- |
| createMode | De modus voor het maken van een Mongo-cluster. | 'Standaard' 'GeoReplica' 'PointInTimeRestore' 'Replica' |
| dataApi | De gegevens-API-eigenschappen van het Mongo-cluster. | DataApiProperties- |
| highAvailability | De eigenschappen voor hoge beschikbaarheid van het Mongo-cluster. | HighAvailabilityProperties- |
| previewFeatures | Lijst met privé-eindpuntverbindingen. | Tekenreeksmatrix met een van de volgende waarden: 'GeoReplicas' |
| publicNetworkAccess | Of openbare eindpunttoegang wel of niet is toegestaan voor dit Mongo-cluster. | 'Uitgeschakeld' 'Ingeschakeld' |
| replicaParameters | De parameters voor het maken van een replica mongo-cluster. | MongoClusterReplicaParameters |
| restoreParameters | De parameters voor het maken van een mongo-cluster voor herstel naar een bepaald tijdstip. | MongoClusterRestoreParameters |
| serverVersion | De Mongo DB-serverversie. Standaard ingesteld op de meest recente beschikbare versie als deze niet is opgegeven. | snaar |
| sharding | De sharding-eigenschappen van het Mongo-cluster. | ShardingProperties- |
| opslag | De opslageigenschappen van het Mongo-cluster. | StorageProperties- |
MongoClusterReplicaParameters
| Naam | Beschrijving | Waarde |
|---|---|---|
| sourceLocation | De locatie van het broncluster | tekenreeks (vereist) |
| sourceResourceId | De id van het replicatiebroncluster. | tekenreeks (vereist) |
MongoClusterRestoreParameters
| Naam | Beschrijving | Waarde |
|---|---|---|
| pointInTimeUTC | UTC-tijdstip om een Mongo-cluster te herstellen | snaar |
| sourceResourceId | Resource-id om het broncluster te vinden dat moet worden hersteld | snaar |
ShardingProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| shardCount | Aantal shards dat moet worden ingericht op het cluster. | Int |
StorageProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| sizeGb | De grootte van de gegevensschijf die aan elke server is toegewezen. | Int |
TrackedResourceTags
| Naam | Beschrijving | Waarde |
|---|
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype mongoClusters kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.DocumentDB/mongoClusters-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
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
}
}
})
}
Eigenschapswaarden
AdministratorProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| wachtwoord | Het beheerderswachtwoord. | snaar Beperkingen: Gevoelige waarde. Doorgeven als een beveiligde parameter. |
| userName | De gebruikersnaam van de beheerder. | snaar |
BackupProperties
| Naam | Beschrijving | Waarde |
|---|
ComputeProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| rang | De rekenlaag die moet worden toegewezen aan het cluster, waarbij elke laag wordt toegewezen aan een virtuele kern en geheugengrootte. Voorbeeldwaarden: 'M30', 'M40'. | snaar |
DataApiProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| wijze | De modus om aan te geven of de Mongo Data-API is ingeschakeld voor een cluster. | 'Uitgeschakeld' 'Ingeschakeld' |
HighAvailabilityProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| targetMode | De doelmodus voor hoge beschikbaarheid die is aangevraagd voor het cluster. | 'Uitgeschakeld' 'SameZone' 'ZoneRedundantPreferred' |
Microsoft.DocumentDB/mongoClusters
| Naam | Beschrijving | Waarde |
|---|---|---|
| plaats | De geografische locatie waar de resource zich bevindt | tekenreeks (vereist) |
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 3 Maximale lengte = 3 Patroon = ^[a-z0-9]+(-[a-z0-9]+)* (vereist) |
| Eigenschappen | De resourcespecifieke eigenschappen voor deze resource. | MongoClusterProperties- |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. |
| type | Het resourcetype | "Microsoft.DocumentDB/mongoClusters@2024-10-01-preview" |
MongoClusterProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| administrateur | De lokale beheerderseigenschappen voor het Mongo-cluster. | AdministratorProperties- |
| backup | De back-upeigenschappen van het Mongo-cluster. | BackupProperties- |
| berekenen | De rekeneigenschappen van het Mongo-cluster. | ComputeProperties- |
| createMode | De modus voor het maken van een Mongo-cluster. | 'Standaard' 'GeoReplica' 'PointInTimeRestore' 'Replica' |
| dataApi | De gegevens-API-eigenschappen van het Mongo-cluster. | DataApiProperties- |
| highAvailability | De eigenschappen voor hoge beschikbaarheid van het Mongo-cluster. | HighAvailabilityProperties- |
| previewFeatures | Lijst met privé-eindpuntverbindingen. | Tekenreeksmatrix met een van de volgende waarden: 'GeoReplicas' |
| publicNetworkAccess | Of openbare eindpunttoegang wel of niet is toegestaan voor dit Mongo-cluster. | 'Uitgeschakeld' 'Ingeschakeld' |
| replicaParameters | De parameters voor het maken van een replica mongo-cluster. | MongoClusterReplicaParameters |
| restoreParameters | De parameters voor het maken van een mongo-cluster voor herstel naar een bepaald tijdstip. | MongoClusterRestoreParameters |
| serverVersion | De Mongo DB-serverversie. Standaard ingesteld op de meest recente beschikbare versie als deze niet is opgegeven. | snaar |
| sharding | De sharding-eigenschappen van het Mongo-cluster. | ShardingProperties- |
| opslag | De opslageigenschappen van het Mongo-cluster. | StorageProperties- |
MongoClusterReplicaParameters
| Naam | Beschrijving | Waarde |
|---|---|---|
| sourceLocation | De locatie van het broncluster | tekenreeks (vereist) |
| sourceResourceId | De id van het replicatiebroncluster. | tekenreeks (vereist) |
MongoClusterRestoreParameters
| Naam | Beschrijving | Waarde |
|---|---|---|
| pointInTimeUTC | UTC-tijdstip om een Mongo-cluster te herstellen | snaar |
| sourceResourceId | Resource-id om het broncluster te vinden dat moet worden hersteld | snaar |
ShardingProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| shardCount | Aantal shards dat moet worden ingericht op het cluster. | Int |
StorageProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| sizeGb | De grootte van de gegevensschijf die aan elke server is toegewezen. | Int |
TrackedResourceTags
| Naam | Beschrijving | Waarde |
|---|