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

Consumer Groups - List All

获取命名空间中的所有使用者组。 如果命名空间中不存在使用者组,则返回空源。

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

URI 参数

名称 必需 类型 说明
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 版本。

响应

名称 类型 说明
200 OK

ConsumerGroupListResult

已成功检索使用者组的列表。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ConsumerGroupsListAll

示例请求

GET https://management.azure.com/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.EventHub/namespaces/sdk-Namespace736/eventhubs/sdk-EventHub5290/consumergroups?api-version=2015-08-01

示例响应

{
  "value": [
    {
      "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.EventHub/namespaces/sdk-Namespace736/eventhubs/sdk-EventHub5290/consumergroups/$Default",
      "name": "$Default",
      "type": "Microsoft.EventHub/ConsumerGroups",
      "properties": {
        "createdAt": "2017-03-12T09:19:03.577Z",
        "updatedAt": "2017-03-12T09:19:05.577Z"
      }
    },
    {
      "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.EventHub/namespaces/sdk-Namespace736/eventhubs/sdk-EventHub5290/consumergroups/sdk-consumergroup115",
      "name": "sdk-consumergroup115",
      "type": "Microsoft.EventHub/ConsumerGroups",
      "properties": {
        "createdAt": "2017-03-12T09:19:07.577Z",
        "updatedAt": "2017-03-12T09:19:09.577Z"
      }
    }
  ]
}

定义

名称 说明
ConsumerGroupListResult

列出使用者组操作的结果。

ConsumerGroupResource

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

ConsumerGroupListResult

列出使用者组操作的结果。

名称 类型 说明
nextLink

string

链接到下一组结果。 如果 Value 包含使用者组的不完整列表,则不为空

value

ConsumerGroupResource[]

列出使用者组操作的结果。

ConsumerGroupResource

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

名称 类型 说明
id

string

资源 ID

location

string

资源位置

name

string

资源名称

properties.createdAt

string

创建消息的确切时间。

properties.eventHubPath

string

事件中心的路径。

properties.updatedAt

string

更新消息的确切时间。

properties.userMetadata

string

用户元数据。

type

string

资源类型