Microsoft.DocumentDB mongoClusters 2024-03-01-preview
Definicja zasobu Bicep
Typ zasobu mongoClusters można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/mongoClusters, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-03-01-preview' = {
location: 'string'
name: 'string'
properties: {
administratorLogin: 'string'
administratorLoginPassword: 'string'
createMode: 'string'
nodeGroupSpecs: [
{
diskSizeGB: int
enableHa: bool
kind: 'string'
nodeCount: int
sku: 'string'
}
]
publicNetworkAccess: 'string'
restoreParameters: {
pointInTimeUTC: 'string'
sourceResourceId: 'string'
}
serverVersion: 'string'
}
tags: {
{customized property}: 'string'
}
}
Wartości właściwości
Microsoft.DocumentDB/mongoClusters
| Nazwa | Opis | Wartość |
|---|---|---|
| lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 3 Maksymalna długość = 3 Wzorzec = ^[a-z0-9]+(-[a-z0-9]+)* (wymagane) |
| Właściwości | Właściwości specyficzne dla zasobu dla tego zasobu. | MongoClusterProperties |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
MongoClusterProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| administratorLogin | Identyfikator logowania administratora dla klastra mongo. | struna |
| administratorLoginPassword | Hasło logowania administratora. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| createMode | Tryb tworzenia klastra mongo. | "Wartość domyślna" "PointInTimeRestore" |
| nodeGroupSpecs | Lista specyfikacji grupy węzłów w klastrze. | NodeGroupSpec[] |
| publicNetworkAccess | Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra mongo. | "Wyłączone" "Włączone" |
| restoreParameters | Parametry do utworzenia klastra mongo przywracania do punktu w czasie. | MongoClusterRestoreParameters |
| serverVersion | Wersja serwera Mongo DB. Wartość domyślna to najnowsza dostępna wersja, jeśli nie zostanie określona. | struna |
MongoClusterRestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| pointInTimeUTC | Punkt CZASU UTC w celu przywrócenia klastra mongo | struna |
| sourceResourceId | Identyfikator zasobu do zlokalizowania klastra źródłowego do przywrócenia | struna |
NodeGroupSpec
| Nazwa | Opis | Wartość |
|---|---|---|
| diskSizeGB | Rozmiar magazynu dysku dla grupy węzłów w GB. Przykładowe wartości: 128, 256, 512, 1024. | Int |
| enableHa | Określa, czy w grupie węzłów jest włączona wysoka dostępność. | Bool |
| rodzaj | Typ węzła wdrożony w grupie węzłów. | "Fragment" |
| nodeCount | Liczba węzłów w grupie węzłów. | Int |
| Numer jednostki magazynowej | Jednostka SKU zasobów dla grupy węzłów. Definiuje to rozmiar procesora CPU i pamięci, który jest aprowizowany dla każdego węzła. Przykładowe wartości: "M30", "M40". | struna |
TrackedResourceTags
| Nazwa | Opis | Wartość |
|---|
Definicja zasobu szablonu usługi ARM
Typ zasobu mongoClusters można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/mongoClusters, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2024-03-01-preview",
"name": "string",
"location": "string",
"properties": {
"administratorLogin": "string",
"administratorLoginPassword": "string",
"createMode": "string",
"nodeGroupSpecs": [
{
"diskSizeGB": "int",
"enableHa": "bool",
"kind": "string",
"nodeCount": "int",
"sku": "string"
}
],
"publicNetworkAccess": "string",
"restoreParameters": {
"pointInTimeUTC": "string",
"sourceResourceId": "string"
},
"serverVersion": "string"
},
"tags": {
"{customized property}": "string"
}
}
Wartości właściwości
Microsoft.DocumentDB/mongoClusters
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2024-03-01-preview" |
| lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 3 Maksymalna długość = 3 Wzorzec = ^[a-z0-9]+(-[a-z0-9]+)* (wymagane) |
| Właściwości | Właściwości specyficzne dla zasobu dla tego zasobu. | MongoClusterProperties |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| typ | Typ zasobu | "Microsoft.DocumentDB/mongoClusters" |
MongoClusterProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| administratorLogin | Identyfikator logowania administratora dla klastra mongo. | struna |
| administratorLoginPassword | Hasło logowania administratora. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| createMode | Tryb tworzenia klastra mongo. | "Wartość domyślna" "PointInTimeRestore" |
| nodeGroupSpecs | Lista specyfikacji grupy węzłów w klastrze. | NodeGroupSpec[] |
| publicNetworkAccess | Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra mongo. | "Wyłączone" "Włączone" |
| restoreParameters | Parametry do utworzenia klastra mongo przywracania do punktu w czasie. | MongoClusterRestoreParameters |
| serverVersion | Wersja serwera Mongo DB. Wartość domyślna to najnowsza dostępna wersja, jeśli nie zostanie określona. | struna |
MongoClusterRestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| pointInTimeUTC | Punkt CZASU UTC w celu przywrócenia klastra mongo | struna |
| sourceResourceId | Identyfikator zasobu do zlokalizowania klastra źródłowego do przywrócenia | struna |
NodeGroupSpec
| Nazwa | Opis | Wartość |
|---|---|---|
| diskSizeGB | Rozmiar magazynu dysku dla grupy węzłów w GB. Przykładowe wartości: 128, 256, 512, 1024. | Int |
| enableHa | Określa, czy w grupie węzłów jest włączona wysoka dostępność. | Bool |
| rodzaj | Typ węzła wdrożony w grupie węzłów. | "Fragment" |
| nodeCount | Liczba węzłów w grupie węzłów. | Int |
| Numer jednostki magazynowej | Jednostka SKU zasobów dla grupy węzłów. Definiuje to rozmiar procesora CPU i pamięci, który jest aprowizowany dla każdego węzła. Przykładowe wartości: "M30", "M40". | struna |
TrackedResourceTags
| Nazwa | Opis | Wartość |
|---|
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu mongoClusters można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/mongoClusters, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2024-03-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
administratorLogin = "string"
administratorLoginPassword = "string"
createMode = "string"
nodeGroupSpecs = [
{
diskSizeGB = int
enableHa = bool
kind = "string"
nodeCount = int
sku = "string"
}
]
publicNetworkAccess = "string"
restoreParameters = {
pointInTimeUTC = "string"
sourceResourceId = "string"
}
serverVersion = "string"
}
})
}
Wartości właściwości
Microsoft.DocumentDB/mongoClusters
MongoClusterProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| administratorLogin | Identyfikator logowania administratora dla klastra mongo. | struna |
| administratorLoginPassword | Hasło logowania administratora. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| createMode | Tryb tworzenia klastra mongo. | "Wartość domyślna" "PointInTimeRestore" |
| nodeGroupSpecs | Lista specyfikacji grupy węzłów w klastrze. | NodeGroupSpec[] |
| publicNetworkAccess | Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tego klastra mongo. | "Wyłączone" "Włączone" |
| restoreParameters | Parametry do utworzenia klastra mongo przywracania do punktu w czasie. | MongoClusterRestoreParameters |
| serverVersion | Wersja serwera Mongo DB. Wartość domyślna to najnowsza dostępna wersja, jeśli nie zostanie określona. | struna |
MongoClusterRestoreParameters
| Nazwa | Opis | Wartość |
|---|---|---|
| pointInTimeUTC | Punkt CZASU UTC w celu przywrócenia klastra mongo | struna |
| sourceResourceId | Identyfikator zasobu do zlokalizowania klastra źródłowego do przywrócenia | struna |
NodeGroupSpec
| Nazwa | Opis | Wartość |
|---|---|---|
| diskSizeGB | Rozmiar magazynu dysku dla grupy węzłów w GB. Przykładowe wartości: 128, 256, 512, 1024. | Int |
| enableHa | Określa, czy w grupie węzłów jest włączona wysoka dostępność. | Bool |
| rodzaj | Typ węzła wdrożony w grupie węzłów. | "Fragment" |
| nodeCount | Liczba węzłów w grupie węzłów. | Int |
| Numer jednostki magazynowej | Jednostka SKU zasobów dla grupy węzłów. Definiuje to rozmiar procesora CPU i pamięci, który jest aprowizowany dla każdego węzła. Przykładowe wartości: "M30", "M40". | struna |
TrackedResourceTags
| Nazwa | Opis | Wartość |
|---|