Microsoft.DocumentDB cassandraClusters/dataCenters 2021-03-01-preview

  • [アーティクル]

Bicep リソース定義

cassandraClusters/dataCenters リソースの種類は、次をターゲットとする操作でデプロイできます。

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

リソース形式

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    base64EncodedCassandraYamlFragment: 'string'
    dataCenterLocation: 'string'
    delegatedSubnetId: 'string'
    nodeCount: int
    provisioningState: 'string'
  }
}

プロパティ値

cassandraClusters/dataCenters

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 種類のリソースのシンボル名: cassandraClusters
properties マネージド Cassandra データ センターのプロパティ。 DataCenterResourceProperties

DataCenterResourceProperties

名前 説明 値
base64EncodedCassandraYamlFragment このデータ センター内のすべてのノードの cassandra.yaml に含める cassandra.yaml 構成ファイルのフラグメント。 フラグメントは Base64 でエンコードする必要があり、キーのサブセットのみが許可されます。 string
dataCenterLocation このデータ センターを作成するリージョン。 string
delegatedSubnetId このデータ センター内のノードがネットワーク インターフェイスに接続されている必要があるサブネットのリソース ID。 サブネットは、'dataCenterLocation' で指定されたのと同じリージョンに存在し、クラスターの 'delegatedManagementSubnetId' プロパティで指定されたサブネットにルーティングできる必要があります。 このリソース ID は、'/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' の形式になります。 string
nodeCount データ センターに必要なノードの数。 これは目的の数値です。 設定後、データ センターが一致するようにスケーリングされるまでに時間がかかる場合があります。 ノードの数とその状態を監視するには、クラスターで fetchNodeStatus メソッドを使用します。 INT
provisioningState 操作が呼び出されたときのリソースの状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

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

cassandraClusters/dataCenters リソースの種類は、次をターゲットとする操作でデプロイできます。

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2021-03-01-preview",
  "name": "string",
  "properties": {
    "base64EncodedCassandraYamlFragment": "string",
    "dataCenterLocation": "string",
    "delegatedSubnetId": "string",
    "nodeCount": "int",
    "provisioningState": "string"
  }
}

プロパティ値

cassandraClusters/dataCenters

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/cassandraClusters/dataCenters'
apiVersion リソース API のバージョン '2021-03-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties マネージド Cassandra データ センターのプロパティ。 DataCenterResourceProperties

DataCenterResourceProperties

名前 説明 値
base64EncodedCassandraYamlFragment このデータ センター内のすべてのノードの cassandra.yaml に含める cassandra.yaml 構成ファイルのフラグメント。 フラグメントは Base64 でエンコードする必要があり、キーのサブセットのみが許可されます。 string
dataCenterLocation このデータ センターを作成するリージョン。 string
delegatedSubnetId このデータ センター内のノードのネットワーク インターフェイスが接続されているサブネットのリソース ID。 サブネットは、'dataCenterLocation' で指定されているのと同じリージョンに存在し、クラスターの 'delegatedManagementSubnetId' プロパティで指定されたサブネットにルーティングできる必要があります。 このリソース ID は、'/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' の形式になります。 string
nodeCount データ センターに必要なノードの数。 これは目的の数値です。 設定後、データ センターが一致するようにスケーリングされるまでに時間がかかる場合があります。 ノードの数とその状態を監視するには、クラスターで fetchNodeStatus メソッドを使用します。 INT
provisioningState 操作が呼び出された時点のリソースの状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

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

cassandraClusters/dataCenters リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      base64EncodedCassandraYamlFragment = "string"
      dataCenterLocation = "string"
      delegatedSubnetId = "string"
      nodeCount = int
      provisioningState = "string"
    }
  })
}

プロパティ値

cassandraClusters/dataCenters

名前 説明 値
type リソースの種類 "Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-03-01-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: cassandraClusters
properties マネージド Cassandra データ センターのプロパティ。 DataCenterResourceProperties

DataCenterResourceProperties

名前 説明 値
base64EncodedCassandraYamlFragment このデータ センター内のすべてのノードの cassandra.yaml に含める cassandra.yaml 構成ファイルのフラグメント。 フラグメントは Base64 でエンコードする必要があり、キーのサブセットのみが許可されます。 string
dataCenterLocation このデータ センターを作成するリージョン。 string
delegatedSubnetId このデータ センター内のノードのネットワーク インターフェイスが接続されているサブネットのリソース ID。 サブネットは、'dataCenterLocation' で指定されているのと同じリージョンに存在し、クラスターの 'delegatedManagementSubnetId' プロパティで指定されたサブネットにルーティングできる必要があります。 このリソース ID は、'/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' の形式になります。 string
nodeCount データ センターに必要なノードの数。 これは目的の数値です。 設定後、データ センターが一致するようにスケーリングされるまでに時間がかかる場合があります。 ノードの数とその状態を監視するには、クラスターで fetchNodeStatus メソッドを使用します。 INT
provisioningState 操作が呼び出された時点のリソースの状態。 "キャンセル済み"
"作成中"
"削除中"
"Failed"
"Succeeded"
"更新中"