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

Consumer Groups - Get

获取指定使用者组的说明。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}?api-version=2021-11-01

URI 参数

Name In Required Type Description
consumerGroupName
path True
  • string

使用者组名称

eventHubName
path True
  • string

事件中心名称

namespaceName
path True
  • string

命名空间名称

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

api-version
query True
  • string

客户端 API 版本。

响应

Name Type Description
200 OK

已成功检索使用者组说明。

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 模拟用户帐户

示例

ConsumerGroupGet

Sample Request

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups/sdk-ConsumerGroup-5563?api-version=2021-11-01

Sample Response

{
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2661/eventhubs/sdk-EventHub-6681/consumergroups/sdk-ConsumerGroup-5563",
  "name": "sdk-ConsumerGroup-5563",
  "type": "Microsoft.EventHub/Namespaces/EventHubs/ConsumerGroups",
  "properties": {
    "createdAt": "2017-05-25T03:43:08.7152556Z",
    "updatedAt": "2017-05-25T03:43:08.7152556Z"
  }
}

定义

ConsumerGroup

列表或获取使用者组操作中的单个项

createdByType

创建资源的标识的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

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

systemData

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

ConsumerGroup

列表或获取使用者组操作中的单个项

Name Type Description
id
  • string

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

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties.createdAt
  • string

创建消息的确切时间。

properties.updatedAt
  • string

消息的确切时间。

properties.userMetadata
  • string

用户元数据是一个占位符,用于存储最大长度为 1024 的用户定义字符串数据。 例如,它可用于存储描述性数据,例如团队列表及其联系信息,也可以存储用户定义的配置设置。

systemData

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

type
  • string

资源类型。 例如“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

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

Name Type Description
error

错误对象。

systemData

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

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

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

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

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