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

Cassandra Data Centers - Update

更新托管 Cassandra 数据中心的某些属性。

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

URI 参数

Name In Required Type Description
clusterName
path True
  • string

托管 Cassandra 群集名称。

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

dataCenterName
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 版本。

请求正文

Name Type Description
properties

托管 Cassandra 数据中心的属性。

响应

Name Type Description
200 OK

同步完成。 仅当修补程序更改的字段不需要对实际的 Cassandra 群集进行任何更改(例如编辑标记)时,才会发生这种情况。

202 Accepted

已接受。 更新将以异步方式继续。

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

CosmosDBManagedCassandraDataCenterUpdate

Sample Request

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

{
  "properties": {
    "dataCenterLocation": "West US 2",
    "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet",
    "nodeCount": 9,
    "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA="
  }
}

Sample Response

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus2/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2022-05-15
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1",
  "name": "dc1",
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "properties": {
    "provisioningState": "Updating",
    "dataCenterLocation": "West US 2",
    "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1",
    "nodeCount": 9,
    "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=",
    "seedNodes": [
      {
        "ipAddress": "192.168.12.2"
      },
      {
        "ipAddress": "192.168.12.3"
      },
      {
        "ipAddress": "192.168.12.4"
      }
    ]
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1",
  "name": "dc1",
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "properties": {
    "provisioningState": "Succeeded",
    "dataCenterLocation": "West US 2",
    "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1",
    "nodeCount": 9,
    "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=",
    "seedNodes": [
      {
        "ipAddress": "192.168.12.2"
      },
      {
        "ipAddress": "192.168.12.3"
      },
      {
        "ipAddress": "192.168.12.4"
      }
    ]
  }
}

定义

AuthenticationMethod

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

Certificate
CloudError

服务的错误响应。

DataCenterResource

托管 Cassandra 数据中心。

ErrorResponse

错误响应。

ManagedCassandraProvisioningState

调用操作时资源的状态。

Properties

托管 Cassandra 群集的属性。

SeedNode

AuthenticationMethod

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

Name Type Description
Cassandra
  • string
None
  • string

Certificate

Name Type Description
pem
  • string

PEM 格式的公钥。

CloudError

服务的错误响应。

Name Type Description
error

错误响应。

DataCenterResource

托管 Cassandra 数据中心。

Name Type Description
id
  • string

数据库帐户的唯一资源标识符。

name
  • string

数据库帐户的名称。

properties

托管 Cassandra 数据中心的属性。

type
  • string

Azure 资源的类型。

ErrorResponse

错误响应。

Name Type Description
code
  • string

错误代码。

message
  • string

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

ManagedCassandraProvisioningState

调用操作时资源的状态。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

Properties

托管 Cassandra 群集的属性。

Name Type Description
authenticationMethod

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

cassandraAuditLoggingEnabled
  • boolean

是否启用 Cassandra 审核日志记录

cassandraVersion
  • string

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

clientCertificates

用于授权连接到群集的客户端的 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

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

externalSeedNodes

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

gossipCertificates

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

hoursBetweenBackups
  • integer

在备份群集之间等待的小时数。 若要禁用备份,请将此属性设置为 0。

initialCassandraAdminPassword
  • string

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

prometheusEndpoint

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

provisioningState

调用操作时资源的状态。

repairEnabled
  • boolean

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

restoreFromBackupId
  • string

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

seedNodes

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

SeedNode

Name Type Description
ipAddress
  • string

此种子节点的 IP 地址。