Microsoft.DocumentDB cassandraClusters 2023-11-15-preview

[アーティクル]
12/20/2024

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-11-15-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    authenticationMethod: 'string'
    autoReplicate: 'string'
    azureConnectionMethod: 'string'
    backupSchedules: [
      {
        cronExpression: 'string'
        retentionInHours: int
        scheduleName: 'string'
      }
    ]
    cassandraAuditLoggingEnabled: bool
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    clusterType: 'string'
    deallocated: bool
    delegatedManagementSubnetId: 'string'
    extensions: [
      'string'
    ]
    externalDataCenters: [
      'string'
    ]
    externalGossipCertificates: [
      {
        pem: 'string'
      }
    ]
    externalSeedNodes: [
      {
        ipAddress: 'string'
      }
    ]
    hoursBetweenBackups: int
    initialCassandraAdminPassword: 'string'
    prometheusEndpoint: {
      ipAddress: 'string'
    }
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    repairEnabled: bool
    restoreFromBackupId: 'string'
    scheduledEventStrategy: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

BackupSchedule

名前	形容	価値
cronExpression	データをバックアップするタイミングを定義する cron 式。	糸
retentionInHours	バックアップの保有期間 (時間)。データを永続的に保持する場合は、保持期間を 0 に設定します。	int
scheduleName	バックアップスケジュールの一意識別子。	糸

CassandraError

名前	形容	価値
additionalErrorInfo	エラーに関する追加情報。	糸
コード	発生したエラーのコード。	糸
メッセージ	エラーのメッセージ。	糸
ターゲット	エラーのターゲットリソース。	糸

証書

名前	形容	価値
pem	PEM 形式の公開キー。	糸

ClusterResourceProperties

名前	形容	価値
authenticationMethod	Cassandra がクライアントの認証に使用する認証方法。 'None' は認証をオフにするため、緊急時以外は使用しないでください。 "Cassandra" は、既定のパスワードベースの認証です。既定値は "Cassandra" です。	'Cassandra' 'Ldap' 'None'
autoReplicate	このクラスターで使用されている AutoReplicate の形式。	'AllKeyspaces' 'None' 'SystemKeyspaces'
azureConnectionMethod	クラスターの実行に必要な Azure サービスに接続する方法	'None' 'VPN'
backupSchedules	データをバックアップするタイミングを定義するバックアップスケジュールの一覧。	BackupSchedule[]
cassandraAuditLoggingEnabled	Cassandra 監査ログが有効になっているかどうか	bool
cassandraVersion	このクラスターが実行に収束する必要がある Cassandra のバージョン (例: 3.11)。更新されると、クラスターが新しいバージョンに移行するまでに時間がかかる場合があります。	糸
clientCertificates	クラスターに接続するクライアントを承認するために使用される TLS 証明書の一覧。 clientCertificates が設定されているかどうかに関係なく、すべての接続は TLS で暗号化されますが、clientCertificates が設定されている場合、マネージド Cassandra クラスターは、このプロパティの 1 つ以上のパブリック証明書から検証できる TLS クライアント証明書を含まないすべての接続を拒否します。	証明書[]
clusterNameOverride	cassandra.yaml の clusterName プロパティをクラスターのリソース名以外に設定する必要がある場合は、このプロパティで使用する値を設定します。	糸
clusterType	クラスターの種類。運用環境に設定すると、クラスターで一部の操作が許可されない場合があります。	'NonProduction' 'Production'
解放	クラスターと関連するデータセンターの割り当てが解除されたかどうか。	bool
delegatedManagementSubnetId	このクラスターの管理サービスのネットワークインターフェイスがアタッチされている必要があるサブネットのリソース ID。サブネットは、データセンターに委任されるすべてのサブネットにルーティング可能である必要があります。リソース ID は、/providers/Microsoft.Network/virtualNetworks/<仮想ネットワーク>/subnets/<サブネット>'>/resourceGroups/<リソースグループ>'/subscriptions/<サブスクリプション ID の形式である必要があります。	糸
拡張機能	クラスターで追加または更新する拡張機能。	string[]
externalDataCenters	自動レプリケーションに含める、このクラスター内の非管理対象データセンターのデータセンター名の一覧。	string[]
externalGossipCertificates	アンマネージドデータセンターからのゴシップを承認するために使用される TLS 証明書の一覧。アンマネージドデータセンター内のすべてのノードの TLS 証明書は、このプロパティで提供されている証明書のいずれかを使用して検証できる必要があります。	証明書[]
externalSeedNodes	アンマネージドデータセンター内のシードノードの IP アドレスの一覧。これらは、すべてのマネージドノードのシードノードリストに追加されます。	SeedNode[]
hoursBetweenBackups	(非推奨)クラスターのバックアップを作成するまでに待機する時間数。	int
initialCassandraAdminPassword	管理者としてクラスターに接続しているクライアントの初期パスワード。クラスターの作成後に変更する必要があります。 GET で null を返します。このフィールドは、authenticationMethod フィールドが 'Cassandra' の場合にのみ適用されます。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
prometheusEndpoint	マネージド Cassandra ノードに関するデータを含む Prometheus エンドポイントに到達できるホスト名または IP アドレス。	SeedNode
provisionError	リソースのプロビジョニングに関連するエラー。	CassandraError
provisioningState	操作が呼び出されたときのリソースの状態。	'Canceled' 'Creating' '削除中' 'Failed' 'Succeeded' '更新中'
repairEnabled	このクラスターで自動修復を実行する必要がありますか? 省略した場合、これは true であり、既に独自の修復を行っているハイブリッドクラスターを実行している場合を除き、true のままである必要があります。	bool
restoreFromBackupId	空のクラスターを作成するには、このフィールドを省略するか、null に設定します。バックアップを新しいクラスターに復元するには、このフィールドをバックアップのリソース ID に設定します。	糸
scheduledEventStrategy	クラスター内のノードがスケジュールされたイベントにどのように反応するか	'Ignore' 'StopAny' 'StopByRack'

ManagedCassandraManagedServiceIdentity

名前	形容	価値
種類	リソースの種類。	'None' 'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

名前	形容	価値
同一性	リソースの ID。	ManagedCassandraManagedServiceIdentity
場所	リソースが属するリソースグループの場所。	糸
名前	リソース名	糸制約：最小長 = 1 最大長 = 1 パターン = `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$` (必須)
プロパティ	マネージド Cassandra クラスターのプロパティ。	ClusterResourceProperties の
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

SeedNode

名前	形容	価値
ipAddress	このシードノードの IP アドレス。	糸

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-11-15-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "authenticationMethod": "string",
    "autoReplicate": "string",
    "azureConnectionMethod": "string",
    "backupSchedules": [
      {
        "cronExpression": "string",
        "retentionInHours": "int",
        "scheduleName": "string"
      }
    ],
    "cassandraAuditLoggingEnabled": "bool",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "clusterType": "string",
    "deallocated": "bool",
    "delegatedManagementSubnetId": "string",
    "extensions": [ "string" ],
    "externalDataCenters": [ "string" ],
    "externalGossipCertificates": [
      {
        "pem": "string"
      }
    ],
    "externalSeedNodes": [
      {
        "ipAddress": "string"
      }
    ],
    "hoursBetweenBackups": "int",
    "initialCassandraAdminPassword": "string",
    "prometheusEndpoint": {
      "ipAddress": "string"
    },
    "provisionError": {
      "additionalErrorInfo": "string",
      "code": "string",
      "message": "string",
      "target": "string"
    },
    "provisioningState": "string",
    "repairEnabled": "bool",
    "restoreFromBackupId": "string",
    "scheduledEventStrategy": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

BackupSchedule

名前	形容	価値
cronExpression	データをバックアップするタイミングを定義する cron 式。	糸
retentionInHours	バックアップの保有期間 (時間)。データを永続的に保持する場合は、保持期間を 0 に設定します。	int
scheduleName	バックアップスケジュールの一意識別子。	糸

CassandraError

名前	形容	価値
additionalErrorInfo	エラーに関する追加情報。	糸
コード	発生したエラーのコード。	糸
メッセージ	エラーのメッセージ。	糸
ターゲット	エラーのターゲットリソース。	糸

証書

名前	形容	価値
pem	PEM 形式の公開キー。	糸

ClusterResourceProperties

名前	形容	価値
authenticationMethod	Cassandra がクライアントの認証に使用する認証方法。 'None' は認証をオフにするため、緊急時以外は使用しないでください。 "Cassandra" は、既定のパスワードベースの認証です。既定値は "Cassandra" です。	'Cassandra' 'Ldap' 'None'
autoReplicate	このクラスターで使用されている AutoReplicate の形式。	'AllKeyspaces' 'None' 'SystemKeyspaces'
azureConnectionMethod	クラスターの実行に必要な Azure サービスに接続する方法	'None' 'VPN'
backupSchedules	データをバックアップするタイミングを定義するバックアップスケジュールの一覧。	BackupSchedule[]
cassandraAuditLoggingEnabled	Cassandra 監査ログが有効になっているかどうか	bool
cassandraVersion	このクラスターが実行に収束する必要がある Cassandra のバージョン (例: 3.11)。更新されると、クラスターが新しいバージョンに移行するまでに時間がかかる場合があります。	糸
clientCertificates	クラスターに接続するクライアントを承認するために使用される TLS 証明書の一覧。 clientCertificates が設定されているかどうかに関係なく、すべての接続は TLS で暗号化されますが、clientCertificates が設定されている場合、マネージド Cassandra クラスターは、このプロパティの 1 つ以上のパブリック証明書から検証できる TLS クライアント証明書を含まないすべての接続を拒否します。	証明書[]
clusterNameOverride	cassandra.yaml の clusterName プロパティをクラスターのリソース名以外に設定する必要がある場合は、このプロパティで使用する値を設定します。	糸
clusterType	クラスターの種類。運用環境に設定すると、クラスターで一部の操作が許可されない場合があります。	'NonProduction' 'Production'
解放	クラスターと関連するデータセンターの割り当てが解除されたかどうか。	bool
delegatedManagementSubnetId	このクラスターの管理サービスのネットワークインターフェイスがアタッチされている必要があるサブネットのリソース ID。サブネットは、データセンターに委任されるすべてのサブネットにルーティング可能である必要があります。リソース ID は、/providers/Microsoft.Network/virtualNetworks/<仮想ネットワーク>/subnets/<サブネット>'>/resourceGroups/<リソースグループ>'/subscriptions/<サブスクリプション ID の形式である必要があります。	糸
拡張機能	クラスターで追加または更新する拡張機能。	string[]
externalDataCenters	自動レプリケーションに含める、このクラスター内の非管理対象データセンターのデータセンター名の一覧。	string[]
externalGossipCertificates	アンマネージドデータセンターからのゴシップを承認するために使用される TLS 証明書の一覧。アンマネージドデータセンター内のすべてのノードの TLS 証明書は、このプロパティで提供されている証明書のいずれかを使用して検証できる必要があります。	証明書[]
externalSeedNodes	アンマネージドデータセンター内のシードノードの IP アドレスの一覧。これらは、すべてのマネージドノードのシードノードリストに追加されます。	SeedNode[]
hoursBetweenBackups	(非推奨)クラスターのバックアップを作成するまでに待機する時間数。	int
initialCassandraAdminPassword	管理者としてクラスターに接続しているクライアントの初期パスワード。クラスターの作成後に変更する必要があります。 GET で null を返します。このフィールドは、authenticationMethod フィールドが 'Cassandra' の場合にのみ適用されます。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
prometheusEndpoint	マネージド Cassandra ノードに関するデータを含む Prometheus エンドポイントに到達できるホスト名または IP アドレス。	SeedNode
provisionError	リソースのプロビジョニングに関連するエラー。	CassandraError
provisioningState	操作が呼び出されたときのリソースの状態。	'Canceled' 'Creating' '削除中' 'Failed' 'Succeeded' '更新中'
repairEnabled	このクラスターで自動修復を実行する必要がありますか? 省略した場合、これは true であり、既に独自の修復を行っているハイブリッドクラスターを実行している場合を除き、true のままである必要があります。	bool
restoreFromBackupId	空のクラスターを作成するには、このフィールドを省略するか、null に設定します。バックアップを新しいクラスターに復元するには、このフィールドをバックアップのリソース ID に設定します。	糸
scheduledEventStrategy	クラスター内のノードがスケジュールされたイベントにどのように反応するか	'Ignore' 'StopAny' 'StopByRack'

ManagedCassandraManagedServiceIdentity

名前	形容	価値
種類	リソースの種類。	'None' 'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

名前	形容	価値
apiVersion	API のバージョン	'2023-11-15-preview'
同一性	リソースの ID。	ManagedCassandraManagedServiceIdentity
場所	リソースが属するリソースグループの場所。	糸
名前	リソース名	糸制約：最小長 = 1 最大長 = 1 パターン = `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$` (必須)
プロパティ	マネージド Cassandra クラスターのプロパティ。	ClusterResourceProperties の
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
種類	リソースの種類	'Microsoft.DocumentDB/cassandraClusters'

SeedNode

名前	形容	価値
ipAddress	このシードノードの IP アドレス。	糸

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

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

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-11-15-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      autoReplicate = "string"
      azureConnectionMethod = "string"
      backupSchedules = [
        {
          cronExpression = "string"
          retentionInHours = int
          scheduleName = "string"
        }
      ]
      cassandraAuditLoggingEnabled = bool
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      clusterType = "string"
      deallocated = bool
      delegatedManagementSubnetId = "string"
      extensions = [
        "string"
      ]
      externalDataCenters = [
        "string"
      ]
      externalGossipCertificates = [
        {
          pem = "string"
        }
      ]
      externalSeedNodes = [
        {
          ipAddress = "string"
        }
      ]
      hoursBetweenBackups = int
      initialCassandraAdminPassword = "string"
      prometheusEndpoint = {
        ipAddress = "string"
      }
      provisionError = {
        additionalErrorInfo = "string"
        code = "string"
        message = "string"
        target = "string"
      }
      provisioningState = "string"
      repairEnabled = bool
      restoreFromBackupId = "string"
      scheduledEventStrategy = "string"
    }
  })
}

プロパティ値

BackupSchedule

名前	形容	価値
cronExpression	データをバックアップするタイミングを定義する cron 式。	糸
retentionInHours	バックアップの保有期間 (時間)。データを永続的に保持する場合は、保持期間を 0 に設定します。	int
scheduleName	バックアップスケジュールの一意識別子。	糸

CassandraError

名前	形容	価値
additionalErrorInfo	エラーに関する追加情報。	糸
コード	発生したエラーのコード。	糸
メッセージ	エラーのメッセージ。	糸
ターゲット	エラーのターゲットリソース。	糸

証書

名前	形容	価値
pem	PEM 形式の公開キー。	糸

ClusterResourceProperties

名前	形容	価値
authenticationMethod	Cassandra がクライアントの認証に使用する認証方法。 'None' は認証をオフにするため、緊急時以外は使用しないでください。 "Cassandra" は、既定のパスワードベースの認証です。既定値は "Cassandra" です。	'Cassandra' 'Ldap' 'None'
autoReplicate	このクラスターで使用されている AutoReplicate の形式。	'AllKeyspaces' 'None' 'SystemKeyspaces'
azureConnectionMethod	クラスターの実行に必要な Azure サービスに接続する方法	'None' 'VPN'
backupSchedules	データをバックアップするタイミングを定義するバックアップスケジュールの一覧。	BackupSchedule[]
cassandraAuditLoggingEnabled	Cassandra 監査ログが有効になっているかどうか	bool
cassandraVersion	このクラスターが実行に収束する必要がある Cassandra のバージョン (例: 3.11)。更新されると、クラスターが新しいバージョンに移行するまでに時間がかかる場合があります。	糸
clientCertificates	クラスターに接続するクライアントを承認するために使用される TLS 証明書の一覧。 clientCertificates が設定されているかどうかに関係なく、すべての接続は TLS で暗号化されますが、clientCertificates が設定されている場合、マネージド Cassandra クラスターは、このプロパティの 1 つ以上のパブリック証明書から検証できる TLS クライアント証明書を含まないすべての接続を拒否します。	証明書[]
clusterNameOverride	cassandra.yaml の clusterName プロパティをクラスターのリソース名以外に設定する必要がある場合は、このプロパティで使用する値を設定します。	糸
clusterType	クラスターの種類。運用環境に設定すると、クラスターで一部の操作が許可されない場合があります。	'NonProduction' 'Production'
解放	クラスターと関連するデータセンターの割り当てが解除されたかどうか。	bool
delegatedManagementSubnetId	このクラスターの管理サービスのネットワークインターフェイスがアタッチされている必要があるサブネットのリソース ID。サブネットは、データセンターに委任されるすべてのサブネットにルーティング可能である必要があります。リソース ID は、/providers/Microsoft.Network/virtualNetworks/<仮想ネットワーク>/subnets/<サブネット>'>/resourceGroups/<リソースグループ>'/subscriptions/<サブスクリプション ID の形式である必要があります。	糸
拡張機能	クラスターで追加または更新する拡張機能。	string[]
externalDataCenters	自動レプリケーションに含める、このクラスター内の非管理対象データセンターのデータセンター名の一覧。	string[]
externalGossipCertificates	アンマネージドデータセンターからのゴシップを承認するために使用される TLS 証明書の一覧。アンマネージドデータセンター内のすべてのノードの TLS 証明書は、このプロパティで提供されている証明書のいずれかを使用して検証できる必要があります。	証明書[]
externalSeedNodes	アンマネージドデータセンター内のシードノードの IP アドレスの一覧。これらは、すべてのマネージドノードのシードノードリストに追加されます。	SeedNode[]
hoursBetweenBackups	(非推奨)クラスターのバックアップを作成するまでに待機する時間数。	int
initialCassandraAdminPassword	管理者としてクラスターに接続しているクライアントの初期パスワード。クラスターの作成後に変更する必要があります。 GET で null を返します。このフィールドは、authenticationMethod フィールドが 'Cassandra' の場合にのみ適用されます。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
prometheusEndpoint	マネージド Cassandra ノードに関するデータを含む Prometheus エンドポイントに到達できるホスト名または IP アドレス。	SeedNode
provisionError	リソースのプロビジョニングに関連するエラー。	CassandraError
provisioningState	操作が呼び出されたときのリソースの状態。	'Canceled' 'Creating' '削除中' 'Failed' 'Succeeded' '更新中'
repairEnabled	このクラスターで自動修復を実行する必要がありますか? 省略した場合、これは true であり、既に独自の修復を行っているハイブリッドクラスターを実行している場合を除き、true のままである必要があります。	bool
restoreFromBackupId	空のクラスターを作成するには、このフィールドを省略するか、null に設定します。バックアップを新しいクラスターに復元するには、このフィールドをバックアップのリソース ID に設定します。	糸
scheduledEventStrategy	クラスター内のノードがスケジュールされたイベントにどのように反応するか	'Ignore' 'StopAny' 'StopByRack'

ManagedCassandraManagedServiceIdentity

名前	形容	価値
種類	リソースの種類。	'None' 'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

名前	形容	価値
同一性	リソースの ID。	ManagedCassandraManagedServiceIdentity
場所	リソースが属するリソースグループの場所。	糸
名前	リソース名	糸制約：最小長 = 1 最大長 = 1 パターン = `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$` (必須)
プロパティ	マネージド Cassandra クラスターのプロパティ。	ClusterResourceProperties の
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.DocumentDB/cassandraClusters@2023-11-15-preview"

SeedNode

名前	形容	価値
ipAddress	このシードノードの IP アドレス。	糸

次の方法で共有

Microsoft.DocumentDB cassandraClusters 2023-11-15-preview

Bicep リソース定義

リソースの形式

プロパティ値

BackupSchedule

CassandraError

証書

ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Microsoft.DocumentDB/cassandraClusters

SeedNode

タグ

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

リソースの形式

プロパティ値

BackupSchedule

CassandraError

証書

ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Microsoft.DocumentDB/cassandraClusters

SeedNode

タグ

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

リソースの形式

プロパティ値

BackupSchedule

CassandraError

証書

ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Microsoft.DocumentDB/cassandraClusters

SeedNode

タグ

フィードバック

その他のリソース

次の方法で共有

Microsoft.DocumentDB cassandraClusters 2023-11-15-preview

Bicep リソース定義

リソースの形式

プロパティ値

BackupSchedule

CassandraError

証書

ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Microsoft.DocumentDB/cassandraClusters

SeedNode

タグ

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

リソースの形式

プロパティ値

BackupSchedule

CassandraError

証書

ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Microsoft.DocumentDB/cassandraClusters

SeedNode

タグ

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

リソースの形式

プロパティ値

BackupSchedule

CassandraError

証書

ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Microsoft.DocumentDB/cassandraClusters

SeedNode

タグ

フィードバック

その他のリソース

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