Microsoft.DocumentDB cassandraClusters 2021-03-01-preview

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    authenticationMethod: 'string'
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    delegatedManagementSubnetId: 'string'
    externalGossipCertificates: [
      {
        pem: 'string'
      }
    ]
    externalSeedNodes: [
      {
        ipAddress: 'string'
      }
    ]
    hoursBetweenBackups: int
    initialCassandraAdminPassword: 'string'
    prometheusEndpoint: {
      ipAddress: 'string'
    }
    provisioningState: 'string'
    repairEnabled: bool
    restoreFromBackupId: 'string'
  }
}

プロパティ値

cassandraClusters

名前 説明 値
name リソース名 string (必須)
location リソースが属しているリソース グループの場所。 string
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
identity リソースの ID。 ManagedServiceIdentity
properties マネージド Cassandra クラスターのプロパティ。 ClusterResourceProperties

ManagedServiceIdentity

名前 説明 値
type リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

ClusterResourceProperties

名前 説明 値
authenticationMethod Cassandra がクライアントの認証に使用する必要がある認証方法。 'None' は認証をオフにするため、緊急時以外は使用しないでください。 "Cassandra" は、既定のパスワード ベースの認証です。 既定値は 'Cassandra' です。 'Cassandra'
'None'
cassandraVersion このクラスターを実行に収束させる Cassandra のバージョン (例: 3.11)。 更新すると、クラスターが新しいバージョンに移行するまでに時間がかかる場合があります。 string
clientCertificates クラスターに接続するクライアントを承認するために使用される TLS 証明書の一覧。 clientCertificates が設定されているかどうかにかかわらず、すべての接続は TLS で暗号化されますが、clientCertificates が設定されている場合、マネージド Cassandra クラスターは、このプロパティの 1 つ以上のパブリック証明書から検証できる TLS クライアント証明書を持たないすべての接続を拒否します。 Certificate[]
clusterNameOverride cassandra.yaml の clusterName プロパティをクラスターのリソース名以外の値に設定する必要がある場合は、このプロパティで使用する値を設定します。 string
delegatedManagementSubnetId このクラスターの管理サービスのネットワーク インターフェイスがアタッチされている必要があるサブネットのリソース ID。 サブネットは、データ センターに委任されるすべてのサブネットにルーティング可能である必要があります。 リソース ID は、'/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' の形式である必要があります。 string
externalGossipCertificates アンマネージド データ センターからのゴシップを承認するために使用される TLS 証明書の一覧。 アンマネージド データ センター内のすべてのノードの TLS 証明書は、このプロパティで提供されている証明書のいずれかを使用して検証可能である必要があります。 Certificate[]
externalSeedNodes アンマネージド データ センター内のシード ノードの IP アドレスの一覧。 これらは、すべてのマネージド ノードのシード ノード リストに追加されます。 SeedNode[]
hoursBetweenBackups クラスターのバックアップを作成するまでに待機する時間数。 バックアップを無効にするには、このプロパティを 0 に設定します。 INT
initialCassandraAdminPassword クラスターに管理者として接続しているクライアントの初期パスワード。 クラスターの作成後に変更する必要があります。 GET で null を返します。 このフィールドは、authenticationMethod フィールドが 'Cassandra' の場合にのみ適用されます。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
prometheusEndpoint マネージド Cassandra ノードに関するデータを含む Prometheus エンドポイントに到達できるホスト名または IP アドレス。 SeedNode
provisioningState 操作が呼び出された時点のリソースの状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'
repairEnabled このクラスターで自動修復を実行する必要がありますか? 省略した場合、これは true であり、既に独自の修復を行っているハイブリッド クラスターを実行している場合を除き、true を維持する必要があります。 [bool]
restoreFromBackupId 空のクラスターを作成するには、このフィールドを省略するか、null に設定します。 バックアップを新しいクラスターに復元するには、このフィールドをバックアップのリソース ID に設定します。 string

Certificate

名前 説明 値
Pem PEM 形式の公開キー。 string

SeedNode

名前 説明 値
ipAddress このシード ノードの IP アドレス。 string

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

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

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2021-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "authenticationMethod": "string",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "delegatedManagementSubnetId": "string",
    "externalGossipCertificates": [
      {
        "pem": "string"
      }
    ],
    "externalSeedNodes": [
      {
        "ipAddress": "string"
      }
    ],
    "hoursBetweenBackups": "int",
    "initialCassandraAdminPassword": "string",
    "prometheusEndpoint": {
      "ipAddress": "string"
    },
    "provisioningState": "string",
    "repairEnabled": "bool",
    "restoreFromBackupId": "string"
  }
}

プロパティ値

cassandraClusters

名前 説明 値
type リソースの種類 'Microsoft.DocumentDB/cassandraClusters'
apiVersion リソース API のバージョン '2021-03-01-preview'
name リソース名 string (必須)
location リソースが属しているリソース グループの場所。 string
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
identity リソースの ID。 ManagedServiceIdentity
properties マネージド Cassandra クラスターのプロパティ。 ClusterResourceProperties

ManagedServiceIdentity

名前 説明 値
type リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

ClusterResourceProperties

名前 説明 値
authenticationMethod Cassandra がクライアントの認証に使用する必要がある認証方法。 'None' は認証をオフにするため、緊急時以外は使用しないでください。 "Cassandra" は、既定のパスワード ベースの認証です。 既定値は 'Cassandra' です。 'Cassandra'
'None'
cassandraVersion このクラスターを実行に収束させる Cassandra のバージョン (例: 3.11)。 更新すると、クラスターが新しいバージョンに移行するまでに時間がかかる場合があります。 string
clientCertificates クラスターに接続するクライアントを承認するために使用される TLS 証明書の一覧。 clientCertificates が設定されているかどうかにかかわらず、すべての接続は TLS で暗号化されますが、clientCertificates が設定されている場合、マネージド Cassandra クラスターは、このプロパティの 1 つ以上のパブリック証明書から検証できる TLS クライアント証明書を持たないすべての接続を拒否します。 Certificate[]
clusterNameOverride cassandra.yaml の clusterName プロパティをクラスターのリソース名以外の値に設定する必要がある場合は、このプロパティで使用する値を設定します。 string
delegatedManagementSubnetId このクラスターの管理サービスのネットワーク インターフェイスがアタッチされている必要があるサブネットのリソース ID。 サブネットは、データ センターに委任されるすべてのサブネットにルーティング可能である必要があります。 リソース ID は、'/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' の形式である必要があります。 string
externalGossipCertificates アンマネージド データ センターからのゴシップを承認するために使用される TLS 証明書の一覧。 アンマネージド データ センター内のすべてのノードの TLS 証明書は、このプロパティで提供されている証明書のいずれかを使用して検証可能である必要があります。 Certificate[]
externalSeedNodes アンマネージド データ センター内のシード ノードの IP アドレスの一覧。 これらは、すべてのマネージド ノードのシード ノード リストに追加されます。 SeedNode[]
hoursBetweenBackups クラスターのバックアップを作成するまでに待機する時間数。 バックアップを無効にするには、このプロパティを 0 に設定します。 INT
initialCassandraAdminPassword クラスターに管理者として接続しているクライアントの初期パスワード。 クラスターの作成後に変更する必要があります。 GET で null を返します。 このフィールドは、authenticationMethod フィールドが 'Cassandra' の場合にのみ適用されます。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
prometheusEndpoint マネージド Cassandra ノードに関するデータを含む Prometheus エンドポイントに到達できるホスト名または IP アドレス。 SeedNode
provisioningState 操作が呼び出された時点のリソースの状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'
repairEnabled このクラスターで自動修復を実行する必要がありますか? 省略した場合、これは true であり、既に独自の修復を行っているハイブリッド クラスターを実行している場合を除き、true を維持する必要があります。 [bool]
restoreFromBackupId 空のクラスターを作成するには、このフィールドを省略するか、null に設定します。 バックアップを新しいクラスターに復元するには、このフィールドをバックアップのリソース ID に設定します。 string

Certificate

名前 説明 値
Pem PEM 形式の公開キー。 string

SeedNode

名前 説明 値
ipAddress このシード ノードの IP アドレス。 string

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      delegatedManagementSubnetId = "string"
      externalGossipCertificates = [
        {
          pem = "string"
        }
      ]
      externalSeedNodes = [
        {
          ipAddress = "string"
        }
      ]
      hoursBetweenBackups = int
      initialCassandraAdminPassword = "string"
      prometheusEndpoint = {
        ipAddress = "string"
      }
      provisioningState = "string"
      repairEnabled = bool
      restoreFromBackupId = "string"
    }
  })
}

プロパティ値

cassandraClusters

名前 説明 値
type リソースの種類 "Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview"
name リソース名 string (必須)
location リソースが属しているリソース グループの場所。 string
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 タグ名と値のディクショナリ。
identity リソースの ID。 ManagedServiceIdentity
properties マネージド Cassandra クラスターのプロパティ。 ClusterResourceProperties

ManagedServiceIdentity

名前 説明 値
type リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスから ID を削除します。 "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 ユーザー ID ID の配列。

ManagedServiceIdentityUserAssignedIdentities

名前 説明 値
{カスタマイズされたプロパティ} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

ClusterResourceProperties

名前 説明 値
authenticationMethod Cassandra がクライアントの認証に使用する必要がある認証方法。 'None' は認証をオフにするため、緊急時以外は使用しないでください。 "Cassandra" は、既定のパスワード ベースの認証です。 既定値は 'Cassandra' です。 "Cassandra"
"None"
cassandraVersion このクラスターが実行中に収束する Cassandra のバージョン (例: 3.11)。 更新されると、クラスターが新しいバージョンに移行するまでに時間がかかる場合があります。 string
clientCertificates クラスターに接続するクライアントを承認するために使用される TLS 証明書の一覧。 clientCertificates が設定されているかどうかに関係なく、すべての接続は TLS で暗号化されますが、clientCertificates が設定されている場合、マネージド Cassandra クラスターは、このプロパティの 1 つ以上のパブリック証明書から検証できる TLS クライアント証明書を含まないすべての接続を拒否します。 Certificate[]
clusterNameOverride cassandra.yaml の clusterName プロパティをクラスターのリソース名以外の値に設定する必要がある場合は、このプロパティで使用する値を設定します。 string
delegatedManagementSubnetId このクラスターの管理サービスのネットワーク インターフェイスがアタッチされている必要があるサブネットのリソース ID。 サブネットは、データ センターに委任されるすべてのサブネットにルーティング可能である必要があります。 リソース ID は、'/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' の形式である必要があります。 string
externalGossipCertificates アンマネージド データ センターからのゴシップを承認するために使用される TLS 証明書の一覧。 アンマネージド データ センター内のすべてのノードの TLS 証明書は、このプロパティで提供されている証明書のいずれかを使用して検証可能である必要があります。 Certificate[]
externalSeedNodes アンマネージド データ センター内のシード ノードの IP アドレスの一覧。 これらは、すべてのマネージド ノードのシード ノード リストに追加されます。 SeedNode[]
hoursBetweenBackups クラスターのバックアップを作成するまでに待機する時間数。 バックアップを無効にするには、このプロパティを 0 に設定します。 INT
initialCassandraAdminPassword クラスターに管理者として接続しているクライアントの初期パスワード。 クラスターの作成後に変更する必要があります。 GET で null を返します。 このフィールドは、authenticationMethod フィールドが 'Cassandra' の場合にのみ適用されます。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
prometheusEndpoint マネージド Cassandra ノードに関するデータを含む Prometheus エンドポイントに到達できるホスト名または IP アドレス。 SeedNode
provisioningState 操作が呼び出された時点のリソースの状態。 "キャンセル済み"
"作成中"
"削除中"
"Failed"
"Succeeded"
"更新中"
repairEnabled このクラスターで自動修復を実行する必要がありますか? 省略した場合、これは true であり、既に独自の修復を行っているハイブリッド クラスターを実行している場合を除き、true を維持する必要があります。 [bool]
restoreFromBackupId 空のクラスターを作成するには、このフィールドを省略するか、null に設定します。 バックアップを新しいクラスターに復元するには、このフィールドをバックアップのリソース ID に設定します。 string

Certificate

名前 説明 値
Pem PEM 形式の公開キー。 string

SeedNode

名前 説明 値
ipAddress このシード ノードの IP アドレス。 string