Microsoft.DocumentDB ガーネットクラスター 2025-11-01-preview

Bicep リソース定義

garnetClusters リソースタイプは、以下を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/garnetClusters リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/garnetClusters@2025-11-01-preview' = {
  identity: {
    type: 'string'
  }
  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'
  }
}

プロパティ値

Microsoft.DocumentDB/garnetClusters

名前 Description 価値
ID リソースの ID。 ManagedCassandraManagedServiceIdentity の
位置 リソースが存在する地理的な場所 string (必須)
名前 リソース名 string

Constraints:
最小長 = 1
最大長 = 100
パターン = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (必須)
プロパティ このリソースのリソース固有のプロパティ。 GarnetClusterResourceProperties
tags リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

エラー詳細

名前 Description 価値

GarnetClusterResourceProperties

名前 Description 価値
割り当て状態 クラスターおよびデータセンターリソースの割り当て状態。 アクティブはクラスターの仮想マシンが割り当てられていることを意味し、割り当て解除は仮想マシンとリソースの割り当てが解除されることを意味します。 'Active'
'割り当て解除'
アベイラビリティゾーン データ センターでアベイラビリティー ゾーンがサポートされている場合は、ガーネット クラスター仮想マシンをホストする仮想マシン スケールセットに適用します。 ブール (bool)
clusterType クラスターの種類。 運用環境に設定すると、クラスターで一部の操作が許可されない場合があります。 'NonProduction'
「プロダクション」
extensions クラスターで追加または更新する拡張機能。 string[]
ノードカウント ノードの数。 整数 (int)
ノードスク クラスターに使用される仮想マシン SKU。 デフォルト値はStandard_DS14_v2です。 文字列
provisionError (プロビジョニングエラー) リソースのプロビジョニングに関連するエラー。 ErrorDetail
replicationFactor クラスターが管理するデータのコピー数。 整数 (int)
subnetId このクラスターの管理サービスのネットワーク インターフェイスがアタッチされている必要があるサブネットのリソース ID。 サブネットは、データ センターに委任されるすべてのサブネットにルーティング可能である必要があります。 リソース ID は、/providers/Microsoft.Network/virtualNetworks/<仮想ネットワーク>/subnets/<サブネット>'</resourceGroups/>リソース グループ<'/subscriptions/>サブスクリプション ID の形式である必要があります。 文字列

ManagedCassandraManagedServiceIdentity の

名前 Description 価値
型 リソースの型。 「なし」
'システム割り当て'

TrackedResourceTags

名前 Description 価値

ARM テンプレート リソース定義

garnetClusters リソースタイプは、以下を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/garnetClusters リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.DocumentDB/garnetClusters",
  "apiVersion": "2025-11-01-preview",
  "name": "string",
  "identity": {
    "type": "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"
  }
}

プロパティ値

Microsoft.DocumentDB/garnetClusters

名前 Description 価値
apiVersion API のバージョン 「2025-11-01-プレビュー」
ID リソースの ID。 ManagedCassandraManagedServiceIdentity の
位置 リソースが存在する地理的な場所 string (必須)
名前 リソース名 string

Constraints:
最小長 = 1
最大長 = 100
パターン = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (必須)
プロパティ このリソースのリソース固有のプロパティ。 GarnetClusterResourceProperties
tags リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
型 リソースの種類 'Microsoft.DocumentDB/garnetClusters'

エラー詳細

名前 Description 価値

GarnetClusterResourceProperties

名前 Description 価値
割り当て状態 クラスターおよびデータセンターリソースの割り当て状態。 アクティブはクラスターの仮想マシンが割り当てられていることを意味し、割り当て解除は仮想マシンとリソースの割り当てが解除されることを意味します。 'Active'
'割り当て解除'
アベイラビリティゾーン データ センターでアベイラビリティー ゾーンがサポートされている場合は、ガーネット クラスター仮想マシンをホストする仮想マシン スケールセットに適用します。 ブール (bool)
clusterType クラスターの種類。 運用環境に設定すると、クラスターで一部の操作が許可されない場合があります。 'NonProduction'
「プロダクション」
extensions クラスターで追加または更新する拡張機能。 string[]
ノードカウント ノードの数。 整数 (int)
ノードスク クラスターに使用される仮想マシン SKU。 デフォルト値はStandard_DS14_v2です。 文字列
provisionError (プロビジョニングエラー) リソースのプロビジョニングに関連するエラー。 ErrorDetail
replicationFactor クラスターが管理するデータのコピー数。 整数 (int)
subnetId このクラスターの管理サービスのネットワーク インターフェイスがアタッチされている必要があるサブネットのリソース ID。 サブネットは、データ センターに委任されるすべてのサブネットにルーティング可能である必要があります。 リソース ID は、/providers/Microsoft.Network/virtualNetworks/<仮想ネットワーク>/subnets/<サブネット>'</resourceGroups/>リソース グループ<'/subscriptions/>サブスクリプション ID の形式である必要があります。 文字列

ManagedCassandraManagedServiceIdentity の

名前 Description 価値
型 リソースの型。 「なし」
'システム割り当て'

TrackedResourceTags

名前 Description 価値

使用例

Terraform (AzAPI プロバイダー) リソース定義

garnetClusters リソースタイプは、以下を対象とする操作でデプロイできます。

  • リソース グループ

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/garnetClusters リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/garnetClusters@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "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"
    }
  }
}

プロパティ値

Microsoft.DocumentDB/garnetClusters

名前 Description 価値
ID リソースの ID。 ManagedCassandraManagedServiceIdentity の
位置 リソースが存在する地理的な場所 string (必須)
名前 リソース名 string

Constraints:
最小長 = 1
最大長 = 100
パターン = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (必須)
プロパティ このリソースのリソース固有のプロパティ。 GarnetClusterResourceProperties
tags リソース タグ タグ名と値のディクショナリ。
型 リソースの種類 "Microsoft.DocumentDB/garnetClusters@2025-11-01-preview"

エラー詳細

名前 Description 価値

GarnetClusterResourceProperties

名前 Description 価値
割り当て状態 クラスターおよびデータセンターリソースの割り当て状態。 アクティブはクラスターの仮想マシンが割り当てられていることを意味し、割り当て解除は仮想マシンとリソースの割り当てが解除されることを意味します。 'Active'
'割り当て解除'
アベイラビリティゾーン データ センターでアベイラビリティー ゾーンがサポートされている場合は、ガーネット クラスター仮想マシンをホストする仮想マシン スケールセットに適用します。 ブール (bool)
clusterType クラスターの種類。 運用環境に設定すると、クラスターで一部の操作が許可されない場合があります。 'NonProduction'
「プロダクション」
extensions クラスターで追加または更新する拡張機能。 string[]
ノードカウント ノードの数。 整数 (int)
ノードスク クラスターに使用される仮想マシン SKU。 デフォルト値はStandard_DS14_v2です。 文字列
provisionError (プロビジョニングエラー) リソースのプロビジョニングに関連するエラー。 ErrorDetail
replicationFactor クラスターが管理するデータのコピー数。 整数 (int)
subnetId このクラスターの管理サービスのネットワーク インターフェイスがアタッチされている必要があるサブネットのリソース ID。 サブネットは、データ センターに委任されるすべてのサブネットにルーティング可能である必要があります。 リソース ID は、/providers/Microsoft.Network/virtualNetworks/<仮想ネットワーク>/subnets/<サブネット>'</resourceGroups/>リソース グループ<'/subscriptions/>サブスクリプション ID の形式である必要があります。 文字列

ManagedCassandraManagedServiceIdentity の

名前 Description 価値
型 リソースの型。 「なし」
'システム割り当て'

TrackedResourceTags

名前 Description 価値
  • Last updated on