Microsoft.DocumentDB cassandraClusters 2024-02-15-preview

發行項
12/20/2024

Bicep 資源定義

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

資源群組 - 請參閱資源群組部署命令

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

資源格式

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2024-02-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 應該使用哪一種驗證方法來驗證用戶端。「無」會關閉驗證，因此不應在緊急情況下使用。 '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 叢集將會拒絕所有未包含 TLS 用戶端憑證的聯機，該憑證可以從此屬性中的一或多個公用憑證進行驗證。	憑證[]
clusterNameOverride	如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將值設定為在此屬性上使用。	字串
clusterType	叢集的類型。如果設定為生產環境，則叢集上可能不允許某些作業。	'NonProduction' 'Production'
已解除分配	是否已解除分配叢集和相關聯的數據中心。	bool
delegatedManagementSubnetId	此叢集管理服務應連結其網路介面的子網資源標識符。子網必須可路由傳送至將委派給數據中心的所有子網。資源標識符的格式必須是 '/subscriptions/<訂用帳戶標識符>/resourceGroups/<資源群組>/providers/Microsoft.Network/virtualNetworks/<虛擬網络>/subnets/<子網>'	字串
擴展	要新增或更新叢集上的擴充功能。	string[]
externalDataCenters	要包含在自動復寫中之此叢集中非受控數據中心的數據中心名稱清單。	string[]
externalGossipCertificates	用來授權非受控數據中心八卦的 TLS 憑證清單。非受控數據中心內所有節點的 TLS 憑證必須使用此屬性中提供的其中一個憑證進行驗證。	憑證[]
externalSeedNodes	Unmanaged 資料中心種子節點的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' 'StopByRack'

ManagedCassandraManagedServiceIdentity

名字	描述	價值
類型	資源的型別。	'None' 'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

名字	描述	價值
身份	資源的身分識別。	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": "2024-02-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 應該使用哪一種驗證方法來驗證用戶端。「無」會關閉驗證，因此不應在緊急情況下使用。 '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 叢集將會拒絕所有未包含 TLS 用戶端憑證的聯機，該憑證可以從此屬性中的一或多個公用憑證進行驗證。	憑證[]
clusterNameOverride	如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將值設定為在此屬性上使用。	字串
clusterType	叢集的類型。如果設定為生產環境，則叢集上可能不允許某些作業。	'NonProduction' 'Production'
已解除分配	是否已解除分配叢集和相關聯的數據中心。	bool
delegatedManagementSubnetId	此叢集管理服務應連結其網路介面的子網資源標識符。子網必須可路由傳送至將委派給數據中心的所有子網。資源標識符的格式必須是 '/subscriptions/<訂用帳戶標識符>/resourceGroups/<資源群組>/providers/Microsoft.Network/virtualNetworks/<虛擬網络>/subnets/<子網>'	字串
擴展	要新增或更新叢集上的擴充功能。	string[]
externalDataCenters	要包含在自動復寫中之此叢集中非受控數據中心的數據中心名稱清單。	string[]
externalGossipCertificates	用來授權非受控數據中心八卦的 TLS 憑證清單。非受控數據中心內所有節點的 TLS 憑證必須使用此屬性中提供的其中一個憑證進行驗證。	憑證[]
externalSeedNodes	Unmanaged 資料中心種子節點的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' 'StopByRack'

ManagedCassandraManagedServiceIdentity

名字	描述	價值
類型	資源的型別。	'None' 'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

名字	描述	價值
apiVersion	API 版本	'2024-02-15-preview'
身份	資源的身分識別。	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@2024-02-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 應該使用哪一種驗證方法來驗證用戶端。「無」會關閉驗證，因此不應在緊急情況下使用。 '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 叢集將會拒絕所有未包含 TLS 用戶端憑證的聯機，該憑證可以從此屬性中的一或多個公用憑證進行驗證。	憑證[]
clusterNameOverride	如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將值設定為在此屬性上使用。	字串
clusterType	叢集的類型。如果設定為生產環境，則叢集上可能不允許某些作業。	'NonProduction' 'Production'
已解除分配	是否已解除分配叢集和相關聯的數據中心。	bool
delegatedManagementSubnetId	此叢集管理服務應連結其網路介面的子網資源標識符。子網必須可路由傳送至將委派給數據中心的所有子網。資源標識符的格式必須是 '/subscriptions/<訂用帳戶標識符>/resourceGroups/<資源群組>/providers/Microsoft.Network/virtualNetworks/<虛擬網络>/subnets/<子網>'	字串
擴展	要新增或更新叢集上的擴充功能。	string[]
externalDataCenters	要包含在自動復寫中之此叢集中非受控數據中心的數據中心名稱清單。	string[]
externalGossipCertificates	用來授權非受控數據中心八卦的 TLS 憑證清單。非受控數據中心內所有節點的 TLS 憑證必須使用此屬性中提供的其中一個憑證進行驗證。	憑證[]
externalSeedNodes	Unmanaged 資料中心種子節點的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' 'StopByRack'

ManagedCassandraManagedServiceIdentity

名字	描述	價值
類型	資源的型別。	'None' 'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

名字	描述	價值
身份	資源的身分識別。	ManagedCassandraManagedServiceIdentity
位置	資源所屬資源群組的位置。	字串
名字	資源名稱	字串約束：最小長度 = 1 最大長度 = 1 模式 = `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$` （必要）
性能	受控 Cassandra 叢集的屬性。	ClusterResourceProperties
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.DocumentDB/cassandraClusters@2024-02-15-preview”

SeedNode

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

共用方式為

Microsoft.DocumentDB cassandraClusters 2024-02-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 2024-02-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

標籤

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義