Microsoft.DocumentDB cassandraClusters 2022-08-15-preview
- 最新
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-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-preview
- 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@2022-08-15-preview' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
authenticationMethod: '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'
}
provisioningState: 'string'
repairEnabled: bool
restoreFromBackupId: 'string'
}
tags: {
{customized property}: 'string'
}
}
屬性值
證書
| 名字 | 描述 | 價值 |
|---|---|---|
| pem | PEM 格式化的公鑰。 | 字串 |
ClusterResourceProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| authenticationMethod | Cassandra 應該使用哪一種驗證方法來驗證用戶端。 「無」會關閉驗證，因此不應在緊急情況下使用。 'Cassandra' 是默認密碼型驗證。 預設值為 『Cassandra』。 'Ldap' 處於預覽狀態。 | 'Cassandra' 'Ldap' 'None' |
| cassandraAuditLoggingEnabled | 是否啟用 Cassandra 稽核記錄 | bool |
| cassandraVersion | 此叢集應該交集至執行中的 Cassandra 版本（例如 3.11）。 更新時，叢集可能需要一些時間才能移轉至新版本。 | 字串 |
| clientCertificates | 用來授權用戶端連線到叢集的 TLS 憑證清單。 不論是否已設定 clientCertificates，所有聯機都會經過 TLS 加密，但如果已設定 clientCertificates，受控 Cassandra 叢集將會拒絕所有未包含 TLS 用戶端憑證的聯機，該憑證可以從此屬性中的一或多個公用憑證進行驗證。 | 憑證[] |
| clusterNameOverride | 如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將值設定為在此屬性上使用。 | 字串 |
| 已解除分配 | 是否已解除分配叢集和相關聯的數據中心。 | bool |
| delegatedManagementSubnetId | 此叢集管理服務應連結其網路介面的子網資源標識符。 子網必須可路由傳送至將委派給數據中心的所有子網。 資源標識符的格式必須是 '/subscriptions/<訂用帳戶標識符>/resourceGroups/<資源群組>/providers/Microsoft.Network/virtualNetworks/<虛擬網络>/subnets/<子網>' | 字串 |
| externalGossipCertificates | 用來授權非受控數據中心八卦的 TLS 憑證清單。 非受控數據中心內所有節點的 TLS 憑證必須使用此屬性中提供的其中一個憑證進行驗證。 | 憑證[] |
| externalSeedNodes | Unmanaged 資料中心種子節點的IP位址清單。 這些會新增至所有受控節點的種子節點清單。 | SeedNode[] |
| hoursBetweenBackups | 取得叢集備份之間的等候時數。 | int |
| initialCassandraAdminPassword | 以系統管理員身分連線到叢集的用戶端初始密碼。 應該在叢集建立之後變更。 在 GET 上傳回 null。 只有在 authenticationMethod 字段是 'Cassandra' 時，才會套用此字段。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| prometheusEndpoint | 可以連線到 Prometheus 端點的主機名或 IP 位址，其中包含受控 Cassandra 節點的相關數據。 | SeedNode |
| provisioningState | 呼叫作業時的資源狀態。 | 'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing' |
| repairEnabled | 自動修復應該在此叢集上執行嗎？ 如果省略，則為 true，除非您正在執行已自行修復的混合式叢集，否則應該保持 true。 | bool |
| restoreFromBackupId | 若要建立空的叢集，請省略此字段，或將它設定為 null。 若要將備份還原到新的叢集，請將此字段設定為備份的資源識別碼。 | 字串 |
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": "2022-08-15-preview",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"authenticationMethod": "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"
},
"provisioningState": "string",
"repairEnabled": "bool",
"restoreFromBackupId": "string"
},
"tags": {
"{customized property}": "string"
}
}
屬性值
證書
| 名字 | 描述 | 價值 |
|---|---|---|
| pem | PEM 格式化的公鑰。 | 字串 |
ClusterResourceProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| authenticationMethod | Cassandra 應該使用哪一種驗證方法來驗證用戶端。 「無」會關閉驗證，因此不應在緊急情況下使用。 'Cassandra' 是默認密碼型驗證。 預設值為 『Cassandra』。 'Ldap' 處於預覽狀態。 | 'Cassandra' 'Ldap' 'None' |
| cassandraAuditLoggingEnabled | 是否啟用 Cassandra 稽核記錄 | bool |
| cassandraVersion | 此叢集應該交集至執行中的 Cassandra 版本（例如 3.11）。 更新時，叢集可能需要一些時間才能移轉至新版本。 | 字串 |
| clientCertificates | 用來授權用戶端連線到叢集的 TLS 憑證清單。 不論是否已設定 clientCertificates，所有聯機都會經過 TLS 加密，但如果已設定 clientCertificates，受控 Cassandra 叢集將會拒絕所有未包含 TLS 用戶端憑證的聯機，該憑證可以從此屬性中的一或多個公用憑證進行驗證。 | 憑證[] |
| clusterNameOverride | 如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將值設定為在此屬性上使用。 | 字串 |
| 已解除分配 | 是否已解除分配叢集和相關聯的數據中心。 | bool |
| delegatedManagementSubnetId | 此叢集管理服務應連結其網路介面的子網資源標識符。 子網必須可路由傳送至將委派給數據中心的所有子網。 資源標識符的格式必須是 '/subscriptions/<訂用帳戶標識符>/resourceGroups/<資源群組>/providers/Microsoft.Network/virtualNetworks/<虛擬網络>/subnets/<子網>' | 字串 |
| externalGossipCertificates | 用來授權非受控數據中心八卦的 TLS 憑證清單。 非受控數據中心內所有節點的 TLS 憑證必須使用此屬性中提供的其中一個憑證進行驗證。 | 憑證[] |
| externalSeedNodes | Unmanaged 資料中心種子節點的IP位址清單。 這些會新增至所有受控節點的種子節點清單。 | SeedNode[] |
| hoursBetweenBackups | 取得叢集備份之間的等候時數。 | int |
| initialCassandraAdminPassword | 以系統管理員身分連線到叢集的用戶端初始密碼。 應該在叢集建立之後變更。 在 GET 上傳回 null。 只有在 authenticationMethod 字段是 'Cassandra' 時，才會套用此字段。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| prometheusEndpoint | 可以連線到 Prometheus 端點的主機名或 IP 位址，其中包含受控 Cassandra 節點的相關數據。 | SeedNode |
| provisioningState | 呼叫作業時的資源狀態。 | 'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing' |
| repairEnabled | 自動修復應該在此叢集上執行嗎？ 如果省略，則為 true，除非您正在執行已自行修復的混合式叢集，否則應該保持 true。 | bool |
| restoreFromBackupId | 若要建立空的叢集，請省略此字段，或將它設定為 null。 若要將備份還原到新的叢集，請將此字段設定為備份的資源識別碼。 | 字串 |
ManagedCassandraManagedServiceIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 資源的型別。 | 'None' 'SystemAssigned' |
Microsoft.DocumentDB/cassandraClusters
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2022-08-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@2022-08-15-preview"
name = "string"
identity = {
type = "string"
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
authenticationMethod = "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"
}
provisioningState = "string"
repairEnabled = bool
restoreFromBackupId = "string"
}
})
}
屬性值
證書
| 名字 | 描述 | 價值 |
|---|---|---|
| pem | PEM 格式化的公鑰。 | 字串 |
ClusterResourceProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| authenticationMethod | Cassandra 應該使用哪一種驗證方法來驗證用戶端。 「無」會關閉驗證，因此不應在緊急情況下使用。 'Cassandra' 是默認密碼型驗證。 預設值為 『Cassandra』。 'Ldap' 處於預覽狀態。 | 'Cassandra' 'Ldap' 'None' |
| cassandraAuditLoggingEnabled | 是否啟用 Cassandra 稽核記錄 | bool |
| cassandraVersion | 此叢集應該交集至執行中的 Cassandra 版本（例如 3.11）。 更新時，叢集可能需要一些時間才能移轉至新版本。 | 字串 |
| clientCertificates | 用來授權用戶端連線到叢集的 TLS 憑證清單。 不論是否已設定 clientCertificates，所有聯機都會經過 TLS 加密，但如果已設定 clientCertificates，受控 Cassandra 叢集將會拒絕所有未包含 TLS 用戶端憑證的聯機，該憑證可以從此屬性中的一或多個公用憑證進行驗證。 | 憑證[] |
| clusterNameOverride | 如果您需要將 cassandra.yaml 中的 clusterName 屬性設定為叢集資源名稱以外的專案，請將值設定為在此屬性上使用。 | 字串 |
| 已解除分配 | 是否已解除分配叢集和相關聯的數據中心。 | bool |
| delegatedManagementSubnetId | 此叢集管理服務應連結其網路介面的子網資源標識符。 子網必須可路由傳送至將委派給數據中心的所有子網。 資源標識符的格式必須是 '/subscriptions/<訂用帳戶標識符>/resourceGroups/<資源群組>/providers/Microsoft.Network/virtualNetworks/<虛擬網络>/subnets/<子網>' | 字串 |
| externalGossipCertificates | 用來授權非受控數據中心八卦的 TLS 憑證清單。 非受控數據中心內所有節點的 TLS 憑證必須使用此屬性中提供的其中一個憑證進行驗證。 | 憑證[] |
| externalSeedNodes | Unmanaged 資料中心種子節點的IP位址清單。 這些會新增至所有受控節點的種子節點清單。 | SeedNode[] |
| hoursBetweenBackups | 取得叢集備份之間的等候時數。 | int |
| initialCassandraAdminPassword | 以系統管理員身分連線到叢集的用戶端初始密碼。 應該在叢集建立之後變更。 在 GET 上傳回 null。 只有在 authenticationMethod 字段是 'Cassandra' 時，才會套用此字段。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| prometheusEndpoint | 可以連線到 Prometheus 端點的主機名或 IP 位址，其中包含受控 Cassandra 節點的相關數據。 | SeedNode |
| provisioningState | 呼叫作業時的資源狀態。 | 'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing' |
| repairEnabled | 自動修復應該在此叢集上執行嗎？ 如果省略，則為 true，除非您正在執行已自行修復的混合式叢集，否則應該保持 true。 | bool |
| restoreFromBackupId | 若要建立空的叢集，請省略此字段，或將它設定為 null。 若要將備份還原到新的叢集，請將此字段設定為備份的資源識別碼。 | 字串 |
ManagedCassandraManagedServiceIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 資源的型別。 | 'None' 'SystemAssigned' |
Microsoft.DocumentDB/cassandraClusters
| 名字 | 描述 | 價值 |
|---|---|---|
| 身份 | 資源的身分識別。 | ManagedCassandraManagedServiceIdentity |
| 位置 | 資源所屬資源群組的位置。 | 字串 |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ （必要） |
| 性能 | 受控 Cassandra 叢集的屬性。 | ClusterResourceProperties |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.DocumentDB/cassandraClusters@2022-08-15-preview” |
SeedNode
| 名字 | 描述 | 價值 |
|---|---|---|
| ipAddress | 此種子節點的IP位址。 | 字串 |
標籤
| 名字 | 描述 | 價值 |
|---|