Udostępnij za pośrednictwem

Microsoft.DocumentDB mongoClusters 2023-09-15-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu mongoClusters można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/mongoClusters, dodaj następujący kod Bicep do szablonu.

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'
  }
}

Wartości właściwości

mongoClusters

Nazwa Opis Wartość
name Nazwa zasobu ciąg (wymagany)
location Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
tags Tagi zasobów. Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
properties Właściwości klastra mongo. Właściwości elementu MongoClusterProperties

Właściwości elementu MongoClusterProperties

Nazwa Opis Wartość
administratorLogin Identyfikator logowania administratora dla klastra mongo. ciąg
administratorLoginPassword Hasło logowania administratora. ciąg

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
createMode Tryb tworzenia klastra mongo. "Wartość domyślna"
"PointInTimeRestore"
"Przywróć"
nodeGroupSpecs Lista specyfikacji grupy węzłów w klastrze. NodeGroupSpec[]

Ograniczenia:
Minimalna długość = 1
restoreParameters Parametry używane do operacji przywracania MongoClusterRestoreParameters
Serverversion Wersja serwera Mongo DB. Wartość domyślna to najnowsza dostępna wersja, jeśli nie zostanie określona. ciąg

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
Rodzaju Typ węzła wdrożony w grupie węzłów. "Fragment"
nodeCount Liczba węzłów w grupie węzłów. int
sku Jednostka SKU zasobu dla grupy węzłów. Definiuje on rozmiar procesora i pamięci aprowizowania dla każdego węzła. Przykładowe wartości: "M30", "M40". ciąg

MongoClusterRestoreParameters

Nazwa Opis Wartość
pointInTimeUTC Punkt w czasie UTC w celu przywrócenia klastra mongo ciąg
sourceResourceId Identyfikator zasobu do zlokalizowania klastra źródłowego do przywrócenia ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu mongoClusters można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/mongoClusters, dodaj następujący kod JSON do szablonu.

{
  "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"
  }
}

Wartości właściwości

mongoClusters

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/mongoClusters"
apiVersion Wersja interfejsu API zasobów "2023-09-15-preview"
name Nazwa zasobu ciąg (wymagany)
location Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
tags Tagi zasobów. Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
properties Właściwości klastra mongo. MongoClusterProperties

MongoClusterProperties

Nazwa Opis Wartość
administratorLogin Identyfikator logowania administratora dla klastra mongo. ciąg
administratorLoginPassword Hasło logowania administratora. ciąg

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
createMode Tryb tworzenia klastra mongo. "Wartość domyślna"
"PointInTimeRestore"
"Przywróć"
nodeGroupSpecs Lista specyfikacji grupy węzłów w klastrze. NodeGroupSpec[]

Ograniczenia:
Minimalna długość = 1
restoreParameters Parametry używane do operacji przywracania MongoClusterRestoreParameters
Serverversion Wersja serwera bazy danych Mongo DB. Domyślnie jest to najnowsza dostępna wersja, jeśli nie zostanie określona. ciąg

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 Czy wysoka dostępność jest włączona w grupie węzłów. bool
Rodzaju Typ węzła wdrożony w grupie węzłów. "Fragment"
nodeCount Liczba węzłów w grupie węzłów. int
sku Jednostka SKU zasobu 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". ciąg

MongoClusterRestoreParameters

Nazwa Opis Wartość
pointInTimeUTC Punkt CZASU UTC w celu przywrócenia klastra mongo ciąg
sourceResourceId Identyfikator zasobu w celu zlokalizowania klastra źródłowego do przywrócenia ciąg

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 dziennik 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@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"
    }
  })
}

Wartości właściwości

mongoClusters

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/mongoClusters@2023-09-15-preview"
name Nazwa zasobu ciąg (wymagany)
location Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
parent_id Aby wdrożyć w grupie zasobów, użyj identyfikatora tej grupy zasobów. ciąg (wymagany)
tags Tagi zasobów. Słownik nazw tagów i wartości.
properties Właściwości klastra mongo. MongoClusterProperties

MongoClusterProperties

Nazwa Opis Wartość
administratorLogin Identyfikator logowania administratora dla klastra mongo. ciąg
administratorLoginPassword Hasło logowania administratora. ciąg

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
createMode Tryb tworzenia klastra mongo. "Wartość domyślna"
"PointInTimeRestore"
"Przywróć"
nodeGroupSpecs Lista specyfikacji grupy węzłów w klastrze. NodeGroupSpec[]

Ograniczenia:
Minimalna długość = 1
restoreParameters Parametry używane do operacji przywracania MongoClusterRestoreParameters
Serverversion Wersja serwera bazy danych Mongo DB. Domyślnie jest to najnowsza dostępna wersja, jeśli nie zostanie określona. ciąg

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 Czy wysoka dostępność jest włączona w grupie węzłów. bool
Rodzaju Typ węzła wdrożony w grupie węzłów. "Fragment"
nodeCount Liczba węzłów w grupie węzłów. int
sku Jednostka SKU zasobu 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". ciąg

MongoClusterRestoreParameters

Nazwa Opis Wartość
pointInTimeUTC Punkt CZASU UTC w celu przywrócenia klastra mongo ciąg
sourceResourceId Identyfikator zasobu w celu zlokalizowania klastra źródłowego do przywrócenia ciąg