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

Iot Hub Resource - Create Event Hub Consumer Group

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

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

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

Параметры URI

Имя В Обязательно Тип Описание
eventHubEndpointName
 path True

string

Имя конечной точки, совместимой с Концентратором событий, в Центре Интернета вещей.
name
 path True

string

Имя добавляемой группы потребителей.
resourceGroupName
 path True

string

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

string

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

string

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

string

Версия API.

Текст запроса

Имя Обязательно Тип Описание
properties True

EventHubConsumerGroupName

Имя группы потребителей EventHub.

Ответы

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

EventHubConsumerGroupInfo

Это синхронная операция.
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_CreateEventHubConsumerGroup

Образец запроса

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

{
  "properties": {
    "name": "test"
  }
}

Пример ответа

Код состояния:
200 
{
  "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": "test",
  "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups",
  "etag": "AAAAAAFD6M4="
}

Определения

Имя Описание
ErrorDetails

Сведения об ошибке.
EventHubConsumerGroupBodyDescription

Группа потребителей EventHub.
EventHubConsumerGroupInfo

Свойства объекта EventHubConsumerGroupInfo.
EventHubConsumerGroupName

Имя группы потребителей EventHub.

ErrorDetails

Object

Сведения об ошибке.

Имя Тип Описание
code

string

Код ошибки.
details

string

Сведения об ошибке.
httpStatusCode

string

Код состояния HTTP.
message

string

Сообщение об ошибке.

EventHubConsumerGroupBodyDescription

Object

Группа потребителей EventHub.

Имя Тип Описание
properties

EventHubConsumerGroupName

Имя группы потребителей EventHub.

EventHubConsumerGroupInfo

Object

Свойства объекта EventHubConsumerGroupInfo.

Имя Тип Описание
etag

string

Etag.
id

string

Идентификатор группы потребителей, совместимый с Концентратором событий.
name

string

Имя группы потребителей, совместимой с Концентратором событий.
properties

Теги.
type

string

тип ресурса.

EventHubConsumerGroupName

Object

Имя группы потребителей EventHub.

Имя Тип Описание
name

string

Имя группы потребителей EventHub