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

Clusters - Update

修改事件中心群集上的可变属性。 此操作是幂等的。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}?api-version=2024-01-01

URI 参数

名称 必需 类型 说明
clusterName
path True

string

事件中心群集的名称。

resourceGroupName
path True

string

Azure 订阅中的资源组的名称。

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

请求正文

名称 类型 说明
location

string

资源位置。

properties.supportsScaling

boolean

一个 值,该值指示是否支持缩放。

sku

ClusterSku

群集 SKU 的属性。

tags

object

资源标记。

响应

名称 类型 说明
200 OK

Cluster

已成功创建事件中心群集。

201 Created

Cluster

事件中心群集更新请求已接受。

202 Accepted

事件中心群集更新请求已接受。

Other Status Codes

ErrorResponse

事件中心错误响应详细说明了事件中心群集更新操作失败的原因。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ClusterPatch

示例请求

PATCH https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/testCluster?api-version=2024-01-01

{
  "location": "South Central US",
  "tags": {
    "tag3": "value3",
    "tag4": "value4"
  }
}

示例响应

azure-asyncoperation: http://azure.async.operation/status
{
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/testCluster",
  "name": "testCluster",
  "type": "Microsoft.EventHub/Clusters",
  "location": "South Central US",
  "tags": {
    "tag3": "value3",
    "tag4": "value4"
  },
  "sku": {
    "name": "Dedicated",
    "capacity": 4
  },
  "properties": {
    "createdAt": "2017-06-01T21:37:04.46Z",
    "provisioningState": "Succeeded",
    "updatedAt": "2017-06-01T21:37:53.413Z",
    "metricId": "SN6-008"
  }
}
azure-asyncoperation: http://azure.async.operation/status
{
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/clusters/testCluster",
  "name": "testCluster",
  "type": "Microsoft.EventHub/Clusters",
  "location": "South Central US",
  "tags": {
    "tag3": "value3",
    "tag4": "value4"
  },
  "sku": {
    "name": "Dedicated",
    "capacity": 4
  },
  "properties": {
    "createdAt": "2017-06-01T21:37:04.46Z",
    "provisioningState": "Succeeded",
    "updatedAt": "2017-06-01T21:37:53.413Z",
    "metricId": "SN6-008"
  }
}
azure-asyncoperation: http://azure.async.operation/status

定义

名称 说明
Cluster

List 或 Get 操作中的单个事件中心群集资源。

ClusterSku

群集实例特定的 SKU 参数。

ClusterSkuName

此 SKU 的名称。

createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应指示事件中心服务无法处理传入请求。 错误消息中提供了原因。

provisioningState

群集的预配状态。

systemData

与资源的创建和上次修改相关的元数据。

Cluster

List 或 Get 操作中的单个事件中心群集资源。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

资源位置。

name

string

资源的名称

properties.createdAt

string

创建事件中心群集的 UTC 时间。

properties.metricId

string

群集资源的指标 ID。 由服务提供,用户不可修改。

properties.provisioningState

provisioningState

群集的预配状态。

properties.status

string

群集资源的状态

properties.supportsScaling

boolean

一个 值,该值指示是否支持缩放。

properties.updatedAt

string

上次更新事件中心群集的 UTC 时间。

sku

ClusterSku

群集 SKU 的属性。

systemData

systemData

与此资源相关的系统元数据。

tags

object

资源标记。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ClusterSku

群集实例特定的 SKU 参数。

名称 类型 说明
capacity

integer

此群集中包含的事件中心群集容量单位的数量。

name

ClusterSkuName

此 SKU 的名称。

ClusterSkuName

此 SKU 的名称。

名称 类型 说明
Dedicated

string

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应指示事件中心服务无法处理传入请求。 错误消息中提供了原因。

名称 类型 说明
error

ErrorDetail

错误对象。

provisioningState

群集的预配状态。

名称 类型 说明
Active

string

Canceled

string

Creating

string

Deleting

string

Failed

string

Scaling

string

Succeeded

string

Unknown

string

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

上次修改资源的标识类型。

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。