Microsoft.DocumentDB cassandraClusters

  • 發行項

Bicep 資源定義

cassandraClusters 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.DocumentDB/cassandraClusters 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2024-02-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: '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'
  }
}

屬性值

cassandraClusters

名稱 描述 值
NAME 資源名稱 字串 (必要)
location 資源所屬資源群組的位置。 字串
tags 標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。 請參閱 範本中的標記
身分識別 資源的身分識別。 ManagedCassandraManagedServiceIdentity
properties 受控 Cassandra 叢集的屬性。 ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

名稱 描述 值
類型 資源類型。 'None'
'SystemAssigned'

ClusterResourceProperties

名稱 描述 值
authenticationMethod 哪一種驗證方法 Cassandra 應該用來驗證用戶端。 'None' 會關閉驗證，因此不應該在緊急狀況中使用。 'Cassandra' 是以密碼為基礎的默認驗證。 預設值為 『Cassandra』。 'Cassandra'
'Ldap'
'None'
autoReplicate 此叢集所使用的 AutoReplicate 形式。 'AllKeyspaces'
'None'
'SystemKeyspaces'
azureConnectionMethod 如何連線到執行叢集所需的 Azure 服務 'None'
'VPN'
backupSchedules 備份排程的清單，定義何時要備份數據。 BackupSchedule[]
cassandraAuditLoggingEnabled 是否啟用 Cassandra 稽核記錄 bool
cassandraVersion 此叢集應該交集至執行 (例如 3.11) 的 Cassandra 版本。 更新時，叢集可能需要一些時間才能移轉至新版本。 字串
clientCertificates 用來授權連線到叢集之用戶端的 TLS 憑證清單。 無論是否已設定 clientCertificates，但設定 clientCertificates 時，受控 Cassandra 叢集都會拒絕所有連線，而不會包含可從此屬性中的一或多個公用憑證驗證的 TLS 用戶端憑證。 Certificate[]
clusterNameOverride 如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將此值設定為在此屬性上使用。 字串
clusterType 叢集的類型。 如果設定為 [生產]，則叢集上可能不允許某些作業。 'NonProduction'
'Production'
已解除分配 是否已解除分配叢集和相關聯的數據中心。 bool
delegatedManagementSubnetId 此叢集管理服務應與其網路介面連結的子網資源標識符。 子網必須可路由傳送至將委派給數據中心的所有子網。 資源標識符的格式必須是 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtualNetworks/{virtual network}/subnets/{subnet}' 格式 字串
擴充功能 要新增或更新叢集上的擴充功能。 string[]
externalDataCenters 此叢集中非受控數據中心的數據中心名稱清單，要包含在自動復寫中。 string[]
externalGossipCertificates 用來從非受控數據中心授權 Gossip 的 TLS 憑證清單。 非受控數據中心內所有節點的 TLS 憑證必須使用此屬性中提供的其中一個憑證進行驗證。 Certificate[]
externalSeedNodes 非受控數據中心內種子節點的IP位址清單。 這些會新增至所有受控節點的種子節點清單。 SeedNode[]
hoursBetweenBackups (淘汰) 在備份叢集之間等候的時數。 int
initialCassandraAdminPassword 以系統管理員身分連線到叢集的用戶端初始密碼。 應在叢集建立之後變更。 在 GET 上傳回 Null。 此欄位僅適用於 authenticationMethod 字段為 'Cassandra' 時。 字串

約束：
敏感性值。 以安全參數的形式傳入。
prometheusEndpoint 可連線到 Prometheus 端點的主機名或 IP 位址，其中包含受控 Cassandra 節點的相關數據。 SeedNode
provisionError 與資源布建相關的錯誤。 CassandraError
provisioningState 呼叫作業時的資源狀態。 'Canceled'
'Creating'
'刪除'
'Failed'
'Succeeded'
'Updateing'
repairEnabled 是否應該在此叢集上執行自動修復？ 如果省略，則這是 true，除非您正在執行已自行修復的混合式叢集，否則應該保持 true。 bool
restoreFromBackupId 若要建立空的叢集，請省略此字段，或將其設定為 null。 若要將備份還原到新的叢集，請將此字段設定為備份的資源識別碼。 字串
scheduledEventStrategy 叢集中的節點如何回應已排程的事件 'Ignore'
'StopAny'
'StopBy，'

BackupSchedule

名稱 描述 值
cronExpression 定義何時要備份數據的cron表達式。 字串
retentionInHours 備份 (小時) 保留期間。 如果您想要永遠保留數據，請將保留設定為 0。 int
scheduleName 備份排程的唯一標識符。 字串

憑證

名稱 描述 值
Pem PEM 格式化的公鑰。 字串

SeedNode

名稱 描述 值
ipAddress 這個種子節點的IP位址。 字串

CassandraError

名稱 描述 值
additionalErrorInfo 錯誤的其他資訊。 字串
code 發生的錯誤碼。 字串
message 錯誤的訊息。 字串
目標 錯誤的目標資源。 字串

ARM 範本資源定義

cassandraClusters 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/cassandraClusters 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2024-02-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "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"
  }
}

屬性值

cassandraClusters

名稱 描述 值
類型 資源類型 'Microsoft.DocumentDB/cassandraClusters'
apiVersion 資源 API 版本 '2024-02-15-preview'
NAME 資源名稱 需要字串 ()
location 資源所屬之資源群組的位置。 字串
tags 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。 請參閱 範本中的標籤
身分識別 資源的身分識別。 ManagedCassandraManagedServiceIdentity
properties 受控 Cassandra 叢集的屬性。 ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

名稱 描述 值
類型 資源類型。 'None'
'SystemAssigned'

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，但設定 clientCertificates 時，受控 Cassandra 叢集都會拒絕所有連線，而不會包含可從此屬性中的一或多個公用憑證驗證的 TLS 用戶端憑證。 Certificate[]
clusterNameOverride 如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將此值設定為在此屬性上使用。 字串
clusterType 叢集的類型。 如果設定為生產環境，叢集上可能不允許某些作業。 'NonProduction'
'Production'
已解除分配 叢集和相關聯的數據中心是否已解除分配。 bool
delegatedManagementSubnetId 此叢集管理服務應連結其網路介面的子網資源標識符。 子網必須可路由傳送到將委派給數據中心的所有子網。 資源標識符的格式必須是 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{虛擬網络}/subnets/{subnet}' 格式 字串
擴充功能 要新增或更新叢集上的擴充功能。 string[]
externalDataCenters 要包含在自動復寫中之此叢集中非受控數據中心的數據中心名稱清單。 string[]
externalGossipCertificates 用來授權非受控數據中心之 Gossip 的 TLS 憑證清單。 Unmanaged 資料中心內所有節點的 TLS 憑證必須使用此屬性中提供的其中一個憑證進行驗證。 Certificate[]
externalSeedNodes 非受控數據中心種子節點的IP位址清單。 這些會新增至所有受控節點的種子節點清單。 SeedNode[]
hoursBetweenBackups (淘汰) 在備份叢集之間等候的時數。 int
initialCassandraAdminPassword 以系統管理員身分連線至叢集的用戶端初始密碼。 應在叢集建立之後變更。 在 GET 上傳回 null。 只有在 authenticationMethod 字段為 'Cassandra' 時，才會套用此字段。 字串

約束：
敏感性值。 以安全參數的形式傳入。
prometheusEndpoint 可以觸達包含受控 Cassandra 節點相關數據的 Prometheus 端點的主機名或 IP 位址。 SeedNode
provisionError 與資源布建相關的錯誤。 CassandraError
provisioningState 呼叫作業時的資源狀態。 'Canceled'
'Creating'
'刪除'
'Failed'
'Succeeded'
'Updateing'
repairEnabled 自動修復是否應該在此叢集上執行？ 如果省略，則這是 true，除非您執行已執行自己的修復的混合式叢集，否則應該保持 true。 bool
restoreFromBackupId 若要建立空的叢集，請省略此字段，或將其設定為 Null。 若要將備份還原到新的叢集，請將此字段設定為備份的資源識別碼。 字串
scheduledEventStrategy 叢集中的節點如何回應已排程的事件 'Ignore'
'StopAny'
'StopByRack'

BackupSchedule

名稱 描述 值
cronExpression 定義何時要備份數據的cron表達式。 字串
retentionInHours 備份的保留期間 (小時) 。 如果您想要永遠保留數據，請將保留設定為 0。 int
scheduleName 備份排程的唯一標識符。 字串

憑證

名稱 描述 值
Pem PEM 格式化的公鑰。 字串

SeedNode

名稱 描述 值
ipAddress 此種子節點的IP位址。 字串

CassandraError

名稱 描述 值
additionalErrorInfo 錯誤的其他資訊。 字串
code 發生的錯誤碼。 字串
message 錯誤的訊息。 字串
目標 錯誤的目標資源。 字串

Terraform (AzAPI 提供者) 資源定義

cassandraClusters 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/cassandraClusters 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2024-02-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  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"
    }
  })
}

屬性值

cassandraClusters

名稱 描述 值
類型 資源類型 “Microsoft.DocumentDB/cassandraClusters@2024-02-15-preview”
NAME 資源名稱 需要字串 ()
location 資源所屬之資源群組的位置。 字串
parent_id 若要部署至資源群組，請使用該資源群組的標識碼。 需要字串 ()
tags 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。
身分識別 資源的身分識別。 ManagedCassandraManagedServiceIdentity
properties 受控 Cassandra 叢集的屬性。 ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

名稱 描述 值
類型 資源類型。 “SystemAssigned”

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，但設定 clientCertificates 時，受控 Cassandra 叢集都會拒絕所有連線，而不會包含可從此屬性中的一或多個公用憑證驗證的 TLS 用戶端憑證。 Certificate[]
clusterNameOverride 如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將此值設定為在此屬性上使用。 字串
clusterType 叢集的類型。 如果設定為 [生產]，則叢集上可能不允許某些作業。 “NonProduction”
“生產”
已解除分配 是否已解除分配叢集和相關聯的數據中心。 bool
delegatedManagementSubnetId 此叢集管理服務應連結其網路介面的子網資源標識符。 子網必須可路由傳送到將委派給數據中心的所有子網。 資源標識符的格式必須是 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{虛擬網络}/subnets/{subnet}' 格式 字串
擴充功能 要新增或更新叢集上的擴充功能。 string[]
externalDataCenters 要包含在自動復寫中之此叢集中非受控數據中心的數據中心名稱清單。 string[]
externalGossipCertificates 用來授權非受控數據中心之 Gossip 的 TLS 憑證清單。 Unmanaged 資料中心內所有節點的 TLS 憑證必須使用此屬性中提供的其中一個憑證進行驗證。 Certificate[]
externalSeedNodes 非受控數據中心種子節點的IP位址清單。 這些會新增至所有受控節點的種子節點清單。 SeedNode[]
hoursBetweenBackups (淘汰) 在備份叢集之間等候的時數。 int
initialCassandraAdminPassword 以系統管理員身分連線至叢集的用戶端初始密碼。 應在叢集建立之後變更。 在 GET 上傳回 null。 只有在 authenticationMethod 字段為 'Cassandra' 時，才會套用此字段。 字串

約束：
敏感性值。 以安全參數的形式傳入。
prometheusEndpoint 可以觸達包含受控 Cassandra 節點相關數據的 Prometheus 端點的主機名或 IP 位址。 SeedNode
provisionError 與資源布建相關的錯誤。 CassandraError
provisioningState 呼叫作業時的資源狀態。 “Canceled”
“建立”
“刪除”
“Failed”
“Succeeded”
“Updateing”
repairEnabled 自動修復是否應該在此叢集上執行？ 如果省略，則這是 true，除非您執行已執行自己的修復的混合式叢集，否則應該保持 true。 bool
restoreFromBackupId 若要建立空的叢集，請省略此字段，或將其設定為 Null。 若要將備份還原到新的叢集，請將此字段設定為備份的資源識別碼。 字串
scheduledEventStrategy 叢集中的節點如何回應已排程的事件 “Ignore”
“StopAny”
“StopByRack”

BackupSchedule

名稱 描述 值
cronExpression 定義何時要備份數據的cron表達式。 字串
retentionInHours 備份的保留期間 (小時) 。 如果您想要永遠保留數據，請將保留設定為 0。 int
scheduleName 備份排程的唯一標識符。 字串

憑證

名稱 描述 值
Pem PEM 格式化的公鑰。 字串

SeedNode

名稱 描述 值
ipAddress 此種子節點的IP位址。 字串

CassandraError

名稱 描述 值
additionalErrorInfo 錯誤的其他資訊。 字串
code 發生的錯誤碼。 字串
message 錯誤的訊息。 字串
目標 錯誤的目標資源。 字串