Поделиться через

Iot Hub Resource - List Event Hub Consumer Groups

Служба:
IoT Hub
Версия API:
2023-06-30

Получение списка групп потребителей в конечной точке центра событий, совместимой с устройством и облаком, в Центре Интернета вещей.

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

Имя группы ресурсов, содержащей Центр Интернета вещей.
resourceName
 path True

string

Имя Центра Интернета вещей.
subscriptionId
 path True

string

Идентификатор подписки.
api-version
 query True

string

Версия API.

Ответы

Имя Тип Описание
200 OK

EventHubConsumerGroupsListResult

Это синхронная операция. Текст содержит сериализованный в формате JSON список групп потребителей в конечной точке, совместимой с Концентратором событий, в этом Центре Интернета вещей
Other Status Codes

ErrorDetails

DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: 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[]

Список объектов групп потребителей