你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Cassandra Clusters - Update

  • 参考
Service:
Cosmos DB Resource Provider
API Version:
2023-11-15

汇报托管 Cassandra 群集的某些属性。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}?api-version=2023-11-15

URI 参数

名称 在 必需 类型 说明
clusterName
 path True

string

托管 Cassandra 群集名称。

Regex pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$
resourceGroupName
 path True

string

资源组的名称。 此名称不区分大小写。
subscriptionId
 path True

string

目标订阅的 ID。
api-version
 query True

string

要用于此操作的 API 版本。

请求正文

名称 类型 说明
identity

ManagedCassandraManagedServiceIdentity

资源的标识。
location

string

资源所属的资源组的位置。
properties

Properties

托管 Cassandra 群集的属性。
tags

object

标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

响应

名称 类型 说明
200 OK

ClusterResource

同步完成。 仅当修补程序更改的字段不需要更改实际的 Cassandra 数据中心时，才会发生这种情况。
202 Accepted

ClusterResource

正在更新托管的 Cassandra 群集。 轮询所提供的操作以完成。
Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

CosmosDBManagedCassandraClusterPatch

Sample Request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod?api-version=2023-11-15

{
  "tags": {
    "owner": "mike"
  },
  "properties": {
    "externalSeedNodes": [
      {
        "ipAddress": "10.52.221.2"
      },
      {
        "ipAddress": "10.52.221.3"
      },
      {
        "ipAddress": "10.52.221.4"
      }
    ],
    "externalGossipCertificates": [
      {
        "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
      }
    ],
    "hoursBetweenBackups": 12,
    "authenticationMethod": "None"
  }
}

Sample Response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2023-11-15
Response Body
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod",
  "name": "cassandra-prod",
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "location": "West US",
  "tags": {
    "owner": "mike"
  },
  "properties": {
    "provisioningState": "Updating",
    "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management",
    "cassandraVersion": "3.11",
    "hoursBetweenBackups": 24,
    "authenticationMethod": "Cassandra",
    "externalSeedNodes": [
      {
        "ipAddress": "10.52.221.2"
      },
      {
        "ipAddress": "10.52.221.3"
      },
      {
        "ipAddress": "10.52.221.4"
      }
    ],
    "clusterNameOverride": "ClusterNameIllegalForAzureResource",
    "seedNodes": [
      {
        "ipAddress": "10.52.221.2"
      },
      {
        "ipAddress": "10.52.221.3"
      },
      {
        "ipAddress": "10.52.221.4"
      },
      {
        "ipAddress": "192.168.12.2"
      },
      {
        "ipAddress": "192.168.12.3"
      },
      {
        "ipAddress": "192.168.12.4"
      }
    ],
    "clientCertificates": [
      {
        "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
      }
    ],
    "externalGossipCertificates": [
      {
        "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
      }
    ],
    "gossipCertificates": [
      {
        "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
      }
    ]
  }
}
Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod",
  "name": "cassandra-prod",
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "location": "West US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management",
    "cassandraVersion": "3.11",
    "hoursBetweenBackups": 24,
    "authenticationMethod": "Cassandra",
    "externalSeedNodes": [
      {
        "ipAddress": "10.52.221.2"
      },
      {
        "ipAddress": "10.52.221.3"
      },
      {
        "ipAddress": "10.52.221.4"
      }
    ],
    "clusterNameOverride": "ClusterNameIllegalForAzureResource",
    "seedNodes": [
      {
        "ipAddress": "10.52.221.2"
      },
      {
        "ipAddress": "10.52.221.3"
      },
      {
        "ipAddress": "10.52.221.4"
      },
      {
        "ipAddress": "192.168.12.2"
      },
      {
        "ipAddress": "192.168.12.3"
      },
      {
        "ipAddress": "192.168.12.4"
      }
    ],
    "clientCertificates": [
      {
        "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
      }
    ],
    "externalGossipCertificates": [
      {
        "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
      }
    ],
    "gossipCertificates": [
      {
        "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----"
      }
    ]
  }
}

定义

名称 说明
AuthenticationMethod

Cassandra 应使用哪种身份验证方法对客户端进行身份验证。 “无”会关闭身份验证，因此除非在紧急情况下，否则不应使用。 “Cassandra”是基于密码的默认身份验证。 默认值为“Cassandra”。
CassandraError
Certificate
CloudError

来自服务的错误响应。
ClusterResource

托管 Cassandra 群集的表示形式。
ErrorResponse

错误响应。
ManagedCassandraManagedServiceIdentity

资源的标识。
ManagedCassandraProvisioningState

调用操作时资源的状态。
ManagedCassandraResourceIdentityType

资源类型。
Properties

托管 Cassandra 群集的属性。
SeedNode

AuthenticationMethod

Cassandra 应使用哪种身份验证方法对客户端进行身份验证。 “无”会关闭身份验证，因此除非在紧急情况下，否则不应使用。 “Cassandra”是基于密码的默认身份验证。 默认值为“Cassandra”。

名称 类型 说明
Cassandra

string

Ldap

string

None

string

CassandraError

名称 类型 说明
additionalErrorInfo

string

有关错误的其他信息。
code

string

发生的错误代码。
message

string

错误的消息。
target

string

错误的目标资源。

Certificate

名称 类型 说明
pem

string

PEM 格式的公钥。

CloudError

来自服务的错误响应。

名称 类型 说明
error

ErrorResponse

错误响应。

ClusterResource

托管 Cassandra 群集的表示形式。

名称 类型 说明
id

string

ARM 资源的唯一资源标识符。
identity

ManagedCassandraManagedServiceIdentity

资源的标识。
location

string

资源所属的资源组的位置。
name

string

ARM 资源的名称。
properties

Properties

托管 Cassandra 群集的属性。
tags

object

标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。
type

string

Azure 资源的类型。

ErrorResponse

错误响应。

名称 类型 说明
code

string

错误代码。
message

string

指示操作失败原因的错误消息。

ManagedCassandraManagedServiceIdentity

资源的标识。

名称 类型 说明
principalId

string

标识资源的对象 ID。
tenantId

string

资源的租户 ID。
type

ManagedCassandraResourceIdentityType

资源类型。

ManagedCassandraProvisioningState

调用操作时资源的状态。

名称 类型 说明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ManagedCassandraResourceIdentityType

资源类型。

名称 类型 说明
None

string

SystemAssigned

string

Properties

托管 Cassandra 群集的属性。

名称 类型 说明
authenticationMethod

AuthenticationMethod

Cassandra 应使用哪种身份验证方法对客户端进行身份验证。 “无”会关闭身份验证，因此除非在紧急情况下，否则不应使用。 “Cassandra”是基于密码的默认身份验证。 默认值为“Cassandra”。
cassandraAuditLoggingEnabled

boolean

是否启用 Cassandra 审核日志记录
cassandraVersion

string

哪个版本的 Cassandra 应此群集聚合为运行 (，例如 3.11) 。 更新后，群集可能需要一些时间才能迁移到新版本。
clientCertificates

Certificate[]

用于授权连接到群集的客户端的 TLS 证书列表。 无论是否设置了 clientCertificates，所有连接都是 TLS 加密的，但如果设置了 clientCertificates，托管 Cassandra 群集将拒绝所有没有 TLS 客户端证书的连接，这些证书可以从此属性中的一个或多个公共证书进行验证。
clusterNameOverride

string

如果需要将 cassandra.yaml 中的 clusterName 属性设置为群集的资源名称以外的某个属性，请将值设置为在此属性上使用。
deallocated

boolean

是否已解除分配群集和关联的数据中心。
delegatedManagementSubnetId

string

此群集的管理服务应附加到其网络接口的子网的资源 ID。 子网必须可路由到将委托给数据中心的所有子网。 资源 ID 的格式必须为“/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/”
externalGossipCertificates

Certificate[]

用于从非托管数据中心授权八卦的 TLS 证书列表。 非托管数据中心内所有节点的 TLS 证书必须使用此属性中提供的证书之一进行验证。
externalSeedNodes

SeedNode[]

非托管数据中心内种子节点的 IP 地址列表。 这些节点将添加到所有托管节点的种子节点列表中。
gossipCertificates

Certificate[]

非托管节点必须信任托管节点八卦的 TLS 证书列表。 所有托管节点都将提供可使用此属性中提供的证书之一进行验证的 TLS 客户端证书。
hoursBetweenBackups

integer

(已弃用) 备份群集之间等待的小时数。
initialCassandraAdminPassword

string

以管理员身份连接到群集的客户端的初始密码。 应在创建群集后进行更改。 GET 时返回 null。 仅当 authenticationMethod 字段为“Cassandra”时，此字段才适用。
prometheusEndpoint

SeedNode

可以在其中访问 Prometheus 终结点的主机名或 IP 地址，其中包含有关托管 Cassandra 节点的数据。
provisionError

CassandraError

与资源预配相关的错误。
provisioningState

ManagedCassandraProvisioningState

调用操作时资源的状态。
repairEnabled

boolean

自动修复是否应在此群集上运行？ 如果省略，则为 true，并且应保持 true，除非你运行的混合群集已在其中执行自己的修复。
restoreFromBackupId

string

若要创建空群集，请省略此字段或将其设置为 null。 若要将备份还原到新群集，请将此字段设置为备份的资源 ID。
seedNodes

SeedNode[]

托管数据中心中种子节点的 IP 地址列表。 这些应添加到所有非托管节点的种子节点列表中。

SeedNode

名称 类型 说明
ipAddress

string

此种子节点的 IP 地址。