Microsoft.DocumentDB cassandraClusters 2024-05-15
- 最新
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-預覽版
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-04-01-preview
- 2021-03-01-preview
Bicep 資源定義
cassandraClusters 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/cassandraClusters 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2024-05-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
}
properties: {
authenticationMethod: 'string'
azureConnectionMethod: 'string'
cassandraAuditLoggingEnabled: bool
cassandraVersion: 'string'
clientCertificates: [
{
pem: 'string'
}
]
clusterNameOverride: 'string'
deallocated: bool
delegatedManagementSubnetId: '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'
}
}
屬性值
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' |
| azureConnectionMethod | 如何連線到執行叢集所需的 Azure 服務 | 'None' 'VPN' |
| cassandraAuditLoggingEnabled | 是否啟用 Cassandra 稽核記錄 | bool |
| cassandraVersion | 此叢集應該交集至執行 (的 Cassandra 版本，例如 3.11) 。 更新時，叢集可能需要一些時間才能移轉至新版本。 | 字串 |
| clientCertificates | 用來授權連線到叢集之用戶端的 TLS 憑證清單。 無論是否已設定 clientCertificates，但設定 clientCertificates 時，受控 Cassandra 叢集都會拒絕所有連線，而不會包含可從此屬性中的一或多個公用憑證驗證的 TLS 用戶端憑證。 | Certificate[] |
| clusterNameOverride | 如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將此值設定為在此屬性上使用。 | 字串 |
| 已解除分配 | 叢集和相關聯的數據中心是否已解除分配。 | bool |
| delegatedManagementSubnetId | 此叢集管理服務應連結其網路介面的子網資源標識符。 子網必須可路由傳送到將委派給數據中心的所有子網。 資源標識符的格式必須是 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{虛擬網络}/subnets/{subnet}' 格式 | 字串 |
| 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。 若要將備份還原到新的叢集，請將此字段設定為備份的資源識別碼。 | 字串 |
憑證
| 名稱 | 描述 | 值 |
|---|---|---|
| Pem | PEM 格式化的公鑰。 | 字串 |
SeedNode
| 名稱 | 描述 | 值 |
|---|---|---|
| ipAddress | 此種子節點的IP位址。 | 字串 |
CassandraError
| 名稱 | 描述 | 值 |
|---|---|---|
| additionalErrorInfo | 錯誤的其他資訊。 | 字串 |
| code | 發生的錯誤碼。 | 字串 |
| message | 錯誤的訊息。 | 字串 |
| 目標 | 錯誤的目標資源。 | 字串 |
ARM 範本資源定義
cassandraClusters 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.DocumentDB/cassandraClusters 資源，請將下列 JSON 新增至您的範本。
{
"type": "Microsoft.DocumentDB/cassandraClusters",
"apiVersion": "2024-05-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string"
},
"properties": {
"authenticationMethod": "string",
"azureConnectionMethod": "string",
"cassandraAuditLoggingEnabled": "bool",
"cassandraVersion": "string",
"clientCertificates": [
{
"pem": "string"
}
],
"clusterNameOverride": "string",
"deallocated": "bool",
"delegatedManagementSubnetId": "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"
}
}
屬性值
cassandraClusters
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.DocumentDB/cassandraClusters' |
| apiVersion | 資源 API 版本 | '2024-05-15' |
| 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' |
| azureConnectionMethod | 如何連線到執行叢集所需的 Azure 服務 | 'None' 'VPN' |
| cassandraAuditLoggingEnabled | 是否啟用 Cassandra 稽核記錄 | bool |
| cassandraVersion | 此叢集應該交集至執行 (例如 3.11) 的 Cassandra 版本。 更新時，叢集可能需要一些時間才能移轉至新版本。 | 字串 |
| clientCertificates | 用來授權連線到叢集之用戶端的 TLS 憑證清單。 不論是否已設定 clientCertificates，但如果已設定 clientCertificates，則 Managed Cassandra 叢集會拒絕所有未包含 TLS 用戶端憑證的 TLS 用戶端憑證，這些聯機都可以從此屬性中的一或多個公用憑證進行驗證。 | Certificate[] |
| clusterNameOverride | 如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集的資源名稱以外的專案，請將此值設定為在此屬性上使用。 | 字串 |
| 已解除分配 | 叢集和相關聯的數據中心是否已解除分配。 | bool |
| delegatedManagementSubnetId | 此叢集管理服務應連結其網路介面的子網資源標識符。 子網必須可路由傳送到將委派給數據中心的所有子網。 資源標識符的格式必須是 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{虛擬網络}/subnets/{subnet}' 格式 | 字串 |
| 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。 若要將備份還原到新的叢集，請將此字段設定為備份的資源識別碼。 | 字串 |
憑證
| 名稱 | 描述 | 值 |
|---|---|---|
| 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-05-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
authenticationMethod = "string"
azureConnectionMethod = "string"
cassandraAuditLoggingEnabled = bool
cassandraVersion = "string"
clientCertificates = [
{
pem = "string"
}
]
clusterNameOverride = "string"
deallocated = bool
delegatedManagementSubnetId = "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"
}
})
}
屬性值
cassandraClusters
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.DocumentDB/cassandraClusters@2024-05-15” |
| 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" |
| azureConnectionMethod | 如何連線到執行叢集所需的 Azure 服務 | "None" “VPN” |
| cassandraAuditLoggingEnabled | 是否啟用 Cassandra 稽核記錄 | bool |
| cassandraVersion | 此叢集應該交集至執行 (的 Cassandra 版本，例如 3.11) 。 更新時，叢集可能需要一些時間才能移轉至新版本。 | 字串 |
| clientCertificates | 用來授權連線到叢集之用戶端的 TLS 憑證清單。 不論是否已設定 clientCertificates，但如果已設定 clientCertificates，則 Managed Cassandra 叢集會拒絕所有未包含 TLS 用戶端憑證的 TLS 用戶端憑證，這些聯機都可以從此屬性中的一或多個公用憑證進行驗證。 | Certificate[] |
| clusterNameOverride | 如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集的資源名稱以外的專案，請將此值設定為在此屬性上使用。 | 字串 |
| 已解除分配 | 叢集和相關聯的數據中心是否已解除分配。 | bool |
| delegatedManagementSubnetId | 此叢集管理服務應連結其網路介面的子網資源標識符。 子網必須可路由傳送到將委派給數據中心的所有子網。 資源標識符的格式必須是 '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{虛擬網络}/subnets/{subnet}' 格式 | 字串 |
| 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。 若要將備份還原到新的叢集，請將此字段設定為備份的資源識別碼。 | 字串 |
憑證
| 名稱 | 描述 | 值 |
|---|---|---|
| Pem | PEM 格式化的公鑰。 | 字串 |
SeedNode
| 名稱 | 描述 | 值 |
|---|---|---|
| ipAddress | 此種子節點的IP位址。 | 字串 |
CassandraError
| 名稱 | 描述 | 值 |
|---|---|---|
| additionalErrorInfo | 錯誤的其他資訊。 | 字串 |
| code | 發生的錯誤碼。 | 字串 |
| message | 錯誤的訊息。 | 字串 |
| 目標 | 錯誤的目標資源。 | 字串 |