通过

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

Iot Hub Resource - List Event Hub Consumer Groups

服务:
IoT Hub
API 版本:
2023-06-30

获取 IoT 中心与事件中心兼容的设备到云终结点中的使用者组列表。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups?api-version=2023-06-30

URI 参数

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

string

与事件中心兼容的终结点的名称。
resourceGroupName
 path True

string

包含 IoT 中心的资源组的名称。
resourceName
 path True

string

IoT 中心的名称。
subscriptionId
 path True

string

订阅标识符。
api-version
 query True

string

API 的版本。

响应

名称 类型 说明
200 OK

EventHubConsumerGroupsListResult

这是一个同步作。 正文包含此 IoT 中心与事件中心兼容的终结点中的使用者组的 JSON 序列化列表
Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

IotHubResource_ListEventHubConsumerGroups

示例请求

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/eventHubEndpoints/events/ConsumerGroups?api-version=2023-06-30

示例响应

状态代码:
200 
{
  "value": [
    {
      "properties": {
        "created": "Thu, 15 Jun 2017 19:20:58 GMT"
      },
      "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default",
      "name": "$Default",
      "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups",
      "etag": "AAAAAAFD6M4="
    }
  ]
}

定义

名称 说明
ErrorDetails

错误详细信息。
EventHubConsumerGroupInfo

EventHubConsumerGroupInfo 对象的属性。
EventHubConsumerGroupsListResult

与事件中心兼容的使用者组名称的 JSON 序列化数组，其中包含下一个链接。

ErrorDetails

Object

错误详细信息。

名称 类型 说明
code

string

错误代码。
details

string

错误详细信息。
httpStatusCode

string

HTTP 状态代码。
message

string

错误消息。

EventHubConsumerGroupInfo

Object

EventHubConsumerGroupInfo 对象的属性。

名称 类型 说明
etag

string

etag。
id

string

与事件中心兼容的使用者组标识符。
name

string

与事件中心兼容的使用者组名称。
properties

标记。
type

string

资源类型。

EventHubConsumerGroupsListResult

Object

与事件中心兼容的使用者组名称的 JSON 序列化数组，其中包含下一个链接。

名称 类型 说明
nextLink

string

下一个链接。
value

EventHubConsumerGroupInfo[]

使用者组对象列表