你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DocumentDB cassandraClusters 2023-09-15-preview
- 最新
- 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 年 3 月 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@2023-09-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
}
properties: {
authenticationMethod: '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'
]
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 | 资源所属的资源组的位置。 | 字符串 |
| 标记 | 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| 标识 | 资源的标识。 | ManagedCassandraManagedServiceIdentity |
| properties | 托管 Cassandra 群集的属性。 | ClusterResourceProperties |
ManagedCassandraManagedServiceIdentity
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型。 | “None” “SystemAssigned” |
ClusterResourceProperties
| 名称 | 说明 | 值 |
|---|---|---|
| authenticationMethod | Cassandra 应使用哪种身份验证方法对客户端进行身份验证。 “无”将关闭身份验证，因此，除非在紧急情况下，否则不应使用。 “Cassandra”是基于密码的默认身份验证。 默认值为“Cassandra”。 | 'Cassandra' 'Ldap' “None” |
| backupSchedules | 定义何时要备份数据的备份计划的列表。 | BackupSchedule[] |
| cassandraAuditLoggingEnabled | 是否启用 Cassandra 审核日志记录 | bool |
| cassandraVersion | 此群集应将哪个版本的 Cassandra 收敛到运行 (，例如 3.11) 。 更新后，群集可能需要一些时间才能迁移到新版本。 | 字符串 |
| clientCertificates | 用于授权连接到群集的客户端的 TLS 证书列表。 无论是否设置了 clientCertificates，所有连接都经过 TLS 加密，但如果设置了 clientCertificates，托管 Cassandra 群集将拒绝所有不带有 TLS 客户端证书的连接，该证书可以从此属性中的一个或多个公共证书进行验证。 | Certificate[] |
| clusterNameOverride | 如果需要将 cassandra.yaml 中的 clusterName 属性设置为群集的资源名称以外的其他属性，请将 值设置为在此属性上使用。 | 字符串 |
| clusterType | 群集的类型。 如果设置为“生产”，则群集上可能不允许某些操作。 | “NonProduction” “生产” |
| 已解除分配 | 是否已解除分配群集和关联的数据中心。 | bool |
| delegatedManagementSubnetId | 此群集的管理服务应将其网络接口附加到的子网的资源 ID。 子网必须可路由到将委托给数据中心的所有子网。 资源 ID 的格式必须为“/subscriptions/{subscription id}/resourceGroups/{resourcegroups/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}” | 字符串 |
| 扩展 | 群集上要添加或更新的扩展。 | string[] |
| externalGossipCertificates | 用于从非托管数据中心授权 gosip 的 TLS 证书列表。 非托管数据中心内所有节点的 TLS 证书必须使用此属性中提供的证书之一进行验证。 | Certificate[] |
| externalSeedNodes | 非托管数据中心中种子节点的 IP 地址列表。 这些节点将添加到所有托管节点的种子节点列表中。 | SeedNode[] |
| hoursBetweenBackups | (已弃用) 备份群集之间等待的小时数。 | int |
| initialCassandraAdminPassword | 以管理员身份连接到群集的客户端的初始密码。 应在创建群集后进行更改。 在 GET 上返回 null。 仅当 authenticationMethod 字段为“Cassandra”时，此字段才适用。 | 字符串 约束： 敏感值。 作为安全参数传入。 |
| prometheusEndpoint | 可以访问包含托管 Cassandra 节点数据的 Prometheus 终结点的主机名或 IP 地址。 | SeedNode |
| provisionError | 与资源预配相关的错误。 | CassandraError |
| provisioningState | 调用操作时资源的状态。 | “已取消” 'Creating' '正在删除' “Failed” 'Succeeded' “正在更新” |
| repairEnabled | 自动修复是否应在此群集上运行？ 如果省略，则为 true，并且应保持为 true，除非你运行的混合群集已在其中执行自己的修复。 | bool |
| restoreFromBackupId | 若要创建空群集，请省略此字段或将其设置为 null。 若要将备份还原到新群集，请将此字段设置为备份的资源 ID。 | 字符串 |
BackupSchedule
| 名称 | 说明 | 值 |
|---|---|---|
| cronExpression | 定义何时要备份数据的 cron 表达式。 | 字符串 |
| retentionInHours | 备份) 保持期 (小时。 如果要永久保留数据，请将保留期设置为 0。 | int |
| scheduleName | 备份计划的唯一标识符。 | 字符串 |
证书
| 名称 | 说明 | 值 |
|---|---|---|
| Pem | PEM 格式的公钥。 | 字符串 |
SeedNode
| 名称 | 说明 | 值 |
|---|---|---|
| ipAddress | 此种子节点的 IP 地址。 | 字符串 |
CassandraError
| 名称 | 说明 | 值 |
|---|---|---|
| additionalErrorInfo | 有关错误的其他信息。 | 字符串 |
| code | 发生的错误代码。 | 字符串 |
| message | 错误的消息。 | string |
| 目标 | 错误的目标资源。 | 字符串 |
ARM 模板资源定义
cassandraClusters 资源类型可以使用面向以下对象的操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/cassandraClusters 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DocumentDB/cassandraClusters",
"apiVersion": "2023-09-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string"
},
"properties": {
"authenticationMethod": "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" ],
"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
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.DocumentDB/cassandraClusters' |
| apiVersion | 资源 API 版本 | '2023-09-15-preview' |
| name | 资源名称 | 字符串 (必需) |
| location | 资源所属的资源组的位置。 | 字符串 |
| 标记 | 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| 标识 | 资源的标识。 | ManagedCassandraManagedServiceIdentity |
| properties | 托管 Cassandra 群集的属性。 | ClusterResourceProperties |
ManagedCassandraManagedServiceIdentity
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型。 | “None” “SystemAssigned” |
ClusterResourceProperties
| 名称 | 说明 | 值 |
|---|---|---|
| authenticationMethod | Cassandra 应使用哪种身份验证方法对客户端进行身份验证。 “无”将关闭身份验证，因此，除非在紧急情况下，否则不应使用。 “Cassandra”是基于密码的默认身份验证。 默认值为“Cassandra”。 | 'Cassandra' 'Ldap' “None” |
| backupSchedules | 定义何时要备份数据的备份计划的列表。 | BackupSchedule[] |
| cassandraAuditLoggingEnabled | 是否启用 Cassandra 审核日志记录 | bool |
| cassandraVersion | 此群集应将哪个版本的 Cassandra 收敛到运行 (，例如 3.11) 。 更新后，群集可能需要一些时间才能迁移到新版本。 | 字符串 |
| clientCertificates | 用于授权连接到群集的客户端的 TLS 证书列表。 无论是否设置了 clientCertificates，所有连接都经过 TLS 加密，但如果设置了 clientCertificates，托管 Cassandra 群集将拒绝所有不带有 TLS 客户端证书的连接，该证书可以从此属性中的一个或多个公共证书进行验证。 | Certificate[] |
| clusterNameOverride | 如果需要将 cassandra.yaml 中的 clusterName 属性设置为群集的资源名称以外的其他属性，请将 值设置为在此属性上使用。 | 字符串 |
| clusterType | 群集的类型。 如果设置为“生产”，则群集上可能不允许某些操作。 | “NonProduction” “生产” |
| 已解除分配 | 是否已解除分配群集和关联的数据中心。 | bool |
| delegatedManagementSubnetId | 此群集的管理服务应将其网络接口附加到的子网的资源 ID。 子网必须可路由到将委托给数据中心的所有子网。 资源 ID 的格式必须为“/subscriptions/{subscription id}/resourceGroups/{resourcegroups/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}” | 字符串 |
| 扩展 | 群集上要添加或更新的扩展。 | string[] |
| externalGossipCertificates | 用于从非托管数据中心授权 gosip 的 TLS 证书列表。 非托管数据中心内所有节点的 TLS 证书必须使用此属性中提供的证书之一进行验证。 | Certificate[] |
| externalSeedNodes | 非托管数据中心中种子节点的 IP 地址列表。 这些节点将添加到所有托管节点的种子节点列表中。 | SeedNode[] |
| hoursBetweenBackups | (已弃用) 备份群集之间等待的小时数。 | int |
| initialCassandraAdminPassword | 以管理员身份连接到群集的客户端的初始密码。 应在创建群集后进行更改。 GET 时返回 null。 仅当 authenticationMethod 字段为“Cassandra”时，此字段才适用。 | 字符串 约束： 敏感值。 作为安全参数传入。 |
| prometheusEndpoint | 可以在其中访问 Prometheus 终结点的主机名或 IP 地址，其中包含有关托管 Cassandra 节点的数据。 | SeedNode |
| provisionError | 与资源预配相关的错误。 | CassandraError |
| provisioningState | 调用操作时资源的状态。 | “已取消” “正在创建” “正在删除” “失败” “成功” “正在更新” |
| repairEnabled | 自动修复是否应在此群集上运行？ 如果省略，则为 true，并且应保持 true，除非你运行的混合群集已在其中执行自己的修复。 | bool |
| restoreFromBackupId | 若要创建空群集，请省略此字段或将其设置为 null。 若要将备份还原到新群集，请将此字段设置为备份的资源 ID。 | 字符串 |
BackupSchedule
| 名称 | 说明 | 值 |
|---|---|---|
| cronExpression | 定义何时要备份数据的 cron 表达式。 | 字符串 |
| retentionInHours | 备份) 保留期 (小时。 如果要永久保留数据，请将保留期设置为 0。 | int |
| scheduleName | 备份计划的唯一标识符。 | 字符串 |
证书
| 名称 | 说明 | 值 |
|---|---|---|
| Pem | PEM 格式的公钥。 | 字符串 |
SeedNode
| 名称 | 说明 | 值 |
|---|---|---|
| ipAddress | 此种子节点的 IP 地址。 | 字符串 |
CassandraError
| 名称 | 说明 | 值 |
|---|---|---|
| additionalErrorInfo | 有关错误的其他信息。 | 字符串 |
| code | 发生的错误代码。 | 字符串 |
| message | 错误的消息。 | string |
| 目标 | 错误的目标资源。 | 字符串 |
Terraform (AzAPI 提供程序) 资源定义
cassandraClusters 资源类型可以通过针对以下操作进行部署：
- 资源组
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/cassandraClusters 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
authenticationMethod = "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"
]
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
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview” |
| name | 资源名称 | 字符串 (必需) |
| location | 资源所属的资源组的位置。 | 字符串 |
| parent_id | 若要部署到资源组，请使用该资源组的 ID。 | 字符串 (必需) |
| 标记 | 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 | 标记名称和值的字典。 |
| 标识 | 资源的标识。 | ManagedCassandraManagedServiceIdentity |
| properties | 托管 Cassandra 群集的属性。 | ClusterResourceProperties |
ManagedCassandraManagedServiceIdentity
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型。 | “SystemAssigned” |
ClusterResourceProperties
| 名称 | 说明 | 值 |
|---|---|---|
| authenticationMethod | Cassandra 应使用哪种身份验证方法对客户端进行身份验证。 “无”将关闭身份验证，因此，除非在紧急情况下，否则不应使用。 “Cassandra”是基于密码的默认身份验证。 默认值为“Cassandra”。 | “Cassandra” “Ldap” "None" |
| backupSchedules | 定义何时要备份数据的备份计划的列表。 | BackupSchedule[] |
| cassandraAuditLoggingEnabled | 是否启用 Cassandra 审核日志记录 | bool |
| cassandraVersion | 此群集应将哪个版本的 Cassandra 收敛到运行 (，例如 3.11) 。 更新后，群集可能需要一些时间才能迁移到新版本。 | 字符串 |
| clientCertificates | 用于授权连接到群集的客户端的 TLS 证书列表。 无论是否设置了 clientCertificates，所有连接都经过 TLS 加密，但如果设置了 clientCertificates，托管 Cassandra 群集将拒绝所有不带有 TLS 客户端证书的连接，该证书可以从此属性中的一个或多个公共证书进行验证。 | Certificate[] |
| clusterNameOverride | 如果需要将 cassandra.yaml 中的 clusterName 属性设置为群集的资源名称以外的其他属性，请将 值设置为在此属性上使用。 | 字符串 |
| clusterType | 群集的类型。 如果设置为“生产”，则群集上可能不允许某些操作。 | “NonProduction” “Production” |
| 已解除分配 | 是否已解除分配群集和关联的数据中心。 | bool |
| delegatedManagementSubnetId | 此群集的管理服务应将其网络接口附加到的子网的资源 ID。 子网必须可路由到将委托给数据中心的所有子网。 资源 ID 的格式必须为“/subscriptions/{subscription id}/resourceGroups/{resourcegroups/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}” | 字符串 |
| 扩展 | 群集上要添加或更新的扩展。 | string[] |
| externalGossipCertificates | 用于从非托管数据中心授权 gosip 的 TLS 证书列表。 非托管数据中心内所有节点的 TLS 证书必须使用此属性中提供的证书之一进行验证。 | Certificate[] |
| externalSeedNodes | 非托管数据中心中种子节点的 IP 地址列表。 这些节点将添加到所有托管节点的种子节点列表中。 | SeedNode[] |
| hoursBetweenBackups | (已弃用) 备份群集之间等待的小时数。 | int |
| initialCassandraAdminPassword | 以管理员身份连接到群集的客户端的初始密码。 应在创建群集后进行更改。 在 GET 上返回 null。 仅当 authenticationMethod 字段为“Cassandra”时，此字段才适用。 | 字符串 约束： 敏感值。 作为安全参数传入。 |
| prometheusEndpoint | 可以访问包含托管 Cassandra 节点数据的 Prometheus 终结点的主机名或 IP 地址。 | SeedNode |
| provisionError | 与资源预配相关的错误。 | CassandraError |
| provisioningState | 调用操作时资源的状态。 | “已取消” “正在创建” “正在删除” “Failed” “Succeeded” “正在更新” |
| repairEnabled | 自动修复是否应在此群集上运行？ 如果省略，则为 true，并且应保持 true，除非你运行的混合群集已在其中执行自己的修复。 | bool |
| restoreFromBackupId | 若要创建空群集，请省略此字段或将其设置为 null。 若要将备份还原到新群集，请将此字段设置为备份的资源 ID。 | 字符串 |
BackupSchedule
| 名称 | 说明 | 值 |
|---|---|---|
| cronExpression | 定义何时要备份数据的 cron 表达式。 | 字符串 |
| retentionInHours | 备份) 保留期 (小时。 如果要永久保留数据，请将保留期设置为 0。 | int |
| scheduleName | 备份计划的唯一标识符。 | 字符串 |
证书
| 名称 | 说明 | 值 |
|---|---|---|
| Pem | PEM 格式的公钥。 | 字符串 |
SeedNode
| 名称 | 说明 | 值 |
|---|---|---|
| ipAddress | 此种子节点的 IP 地址。 | 字符串 |
CassandraError
| 名称 | 说明 | 值 |
|---|---|---|
| additionalErrorInfo | 有关错误的其他信息。 | 字符串 |
| code | 发生的错误代码。 | 字符串 |
| message | 错误的消息。 | string |
| 目标 | 错误的目标资源。 | 字符串 |