Udostępnij przez


Microsoft.DocumentDB garnetClusters

Definicja zasobu Bicep

Typ zasobu garnetClusters można wdrożyć z operacjami przeznaczonymi na:

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/garnetClusters, dodaj następujący Bicep do szablonu.

resource symbolicname 'Microsoft.DocumentDB/garnetClusters@2025-11-01-preview' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    allocationState: 'string'
    availabilityZone: bool
    clusterType: 'string'
    extensions: [
      'string'
    ]
    nodeCount: int
    nodeSku: 'string'
    provisionError: {}
    replicationFactor: int
    subnetId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Microsoft.DocumentDB/garnetClusters

Name Description Wartość
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu string

Constraints:
Minimalna długość = 1
Maksymalna długość = 100
Wzorzec = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (wymagane)
properties Właściwości klastra pamięci podręcznej Garnet. ClusterResourceProperties
zakres Użyj polecenia podczas tworzenia zasobu w zakresie innym niż zakres wdrożenia. Ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia.
tags Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

ClusterResourceProperties

Name Description Wartość
allocationState (stan alokacji) Stan alokacji klastra i zasobów centrum danych. Aktywna oznacza, że maszyny wirtualne klastra są alokowane, cofnięta alokacja oznacza, że maszyny wirtualne i zasoby są cofnięte. 'Active'
"Cofnięto przydział"
Strefa dostępności Jeśli centrum danych obsługuje strefę dostępności, zastosuj ją do zestawu Virtual Machine ScaleSet, który hostuje maszyny wirtualne klastra granatów. bool
clusterType Typ klastra. W przypadku ustawienia opcji Produkcja niektóre operacje mogą nie być dozwolone w klastrze. 'NonProduction'
"Produkcja"
extensions Rozszerzenia do dodania lub zaktualizowania w klastrze. string[]
nodeCount (liczba_węzłów) Liczba węzłów int
nodeSku (jednostka przemysłowa nodeSku) Jednostka SKU maszyny wirtualnej używana dla klastrów. Wartość domyślna to Standard_DS14_v2 ciąg
provisionError (błąd zaopatrzenia) Błąd związany z aprowizowaniem zasobów. ErrorDetailAutoGenerated
replicationFactor Liczba kopii danych przechowywanych przez klaster int
subnetId Identyfikator zasobu podsieci, do którego powinna być dołączona usługa zarządzania tego klastra. Podsieć musi być routingowa do wszystkich podsieci, które zostaną delegowane do centrów danych. Identyfikator zasobu musi mieć postać "/subscriptions/<identyfikator subskrypcji>/resourceGroups/<grupy zasobów>/providers/Microsoft.Network/virtualNetworks/<sieci wirtualnej>/subnets/<podsieci>" ciąg

ErrorDetailAutoGenerated

Name Description Wartość

TrackedResourceTags

Name Description Wartość

Definicja zasobu szablonu usługi ARM

Typ zasobu garnetClusters można wdrożyć z operacjami przeznaczonymi na:

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/garnetClusters, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.DocumentDB/garnetClusters",
  "apiVersion": "2025-11-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "allocationState": "string",
    "availabilityZone": "bool",
    "clusterType": "string",
    "extensions": [ "string" ],
    "nodeCount": "int",
    "nodeSku": "string",
    "provisionError": {
    },
    "replicationFactor": "int",
    "subnetId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Microsoft.DocumentDB/garnetClusters

Name Description Wartość
apiVersion Wersja interfejsu API "2025-11-01-podgląd"
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu string

Constraints:
Minimalna długość = 1
Maksymalna długość = 100
Wzorzec = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (wymagane)
properties Właściwości klastra pamięci podręcznej Garnet. ClusterResourceProperties
tags Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DocumentDB/garnetClusters" (Microsoft.DocumentDB/klastry granatu)

ClusterResourceProperties

Name Description Wartość
allocationState (stan alokacji) Stan alokacji klastra i zasobów centrum danych. Aktywna oznacza, że maszyny wirtualne klastra są alokowane, cofnięta alokacja oznacza, że maszyny wirtualne i zasoby są cofnięte. 'Active'
"Cofnięto przydział"
Strefa dostępności Jeśli centrum danych obsługuje strefę dostępności, zastosuj ją do zestawu Virtual Machine ScaleSet, który hostuje maszyny wirtualne klastra granatów. bool
clusterType Typ klastra. W przypadku ustawienia opcji Produkcja niektóre operacje mogą nie być dozwolone w klastrze. 'NonProduction'
"Produkcja"
extensions Rozszerzenia do dodania lub zaktualizowania w klastrze. string[]
nodeCount (liczba_węzłów) Liczba węzłów int
nodeSku (jednostka przemysłowa nodeSku) Jednostka SKU maszyny wirtualnej używana dla klastrów. Wartość domyślna to Standard_DS14_v2 ciąg
provisionError (błąd zaopatrzenia) Błąd związany z aprowizowaniem zasobów. ErrorDetailAutoGenerated
replicationFactor Liczba kopii danych przechowywanych przez klaster int
subnetId Identyfikator zasobu podsieci, do którego powinna być dołączona usługa zarządzania tego klastra. Podsieć musi być routingowa do wszystkich podsieci, które zostaną delegowane do centrów danych. Identyfikator zasobu musi mieć postać "/subscriptions/<identyfikator subskrypcji>/resourceGroups/<grupy zasobów>/providers/Microsoft.Network/virtualNetworks/<sieci wirtualnej>/subnets/<podsieci>" ciąg

ErrorDetailAutoGenerated

Name Description Wartość

TrackedResourceTags

Name Description Wartość

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu garnetClusters można wdrożyć z operacjami przeznaczonymi na:

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/garnetClusters, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/garnetClusters@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      allocationState = "string"
      availabilityZone = bool
      clusterType = "string"
      extensions = [
        "string"
      ]
      nodeCount = int
      nodeSku = "string"
      provisionError = {
      }
      replicationFactor = int
      subnetId = "string"
    }
  }
}

Wartości właściwości

Microsoft.DocumentDB/garnetClusters

Name Description Wartość
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu string

Constraints:
Minimalna długość = 1
Maksymalna długość = 100
Wzorzec = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (wymagane)
parent_id Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
properties Właściwości klastra pamięci podręcznej Garnet. ClusterResourceProperties
tags Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DocumentDB/garnetClusters@2025-11-01-preview"

ClusterResourceProperties

Name Description Wartość
allocationState (stan alokacji) Stan alokacji klastra i zasobów centrum danych. Aktywna oznacza, że maszyny wirtualne klastra są alokowane, cofnięta alokacja oznacza, że maszyny wirtualne i zasoby są cofnięte. 'Active'
"Cofnięto przydział"
Strefa dostępności Jeśli centrum danych obsługuje strefę dostępności, zastosuj ją do zestawu Virtual Machine ScaleSet, który hostuje maszyny wirtualne klastra granatów. bool
clusterType Typ klastra. W przypadku ustawienia opcji Produkcja niektóre operacje mogą nie być dozwolone w klastrze. 'NonProduction'
"Produkcja"
extensions Rozszerzenia do dodania lub zaktualizowania w klastrze. string[]
nodeCount (liczba_węzłów) Liczba węzłów int
nodeSku (jednostka przemysłowa nodeSku) Jednostka SKU maszyny wirtualnej używana dla klastrów. Wartość domyślna to Standard_DS14_v2 ciąg
provisionError (błąd zaopatrzenia) Błąd związany z aprowizowaniem zasobów. ErrorDetailAutoGenerated
replicationFactor Liczba kopii danych przechowywanych przez klaster int
subnetId Identyfikator zasobu podsieci, do którego powinna być dołączona usługa zarządzania tego klastra. Podsieć musi być routingowa do wszystkich podsieci, które zostaną delegowane do centrów danych. Identyfikator zasobu musi mieć postać "/subscriptions/<identyfikator subskrypcji>/resourceGroups/<grupy zasobów>/providers/Microsoft.Network/virtualNetworks/<sieci wirtualnej>/subnets/<podsieci>" ciąg

ErrorDetailAutoGenerated

Name Description Wartość

TrackedResourceTags

Name Description Wartość