Iot Hub Resource - Get Event Hub Consumer Group

Service:
IoT Hub
API Version:
2017-01-19

Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.

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

URI Parameters

Name In Required Type Description
subscriptionId
 path True
  • string

The subscription identifier.
resourceGroupName
 path True
  • string

The name of the resource group that contains the IoT hub.
resourceName
 path True
  • string

The name of the IoT hub.
eventHubEndpointName
 path True
  • string

The name of the Event Hub-compatible endpoint in the IoT hub.
name
 path True
  • string

The name of the consumer group to retrieve.
api-version
 query True
  • string

The version of the API.

Responses

Name Type Description
200 OK

This is a synchronous operation. The body contains a JSON-serialized consumer group.
Other Status Codes

DefaultErrorResponse

Definitions

ErrorDetails
EventHubConsumerGroupInfo
Name Type Description
Code
  • string

The error code.
Details
  • string

The error details.
HttpStatusCode
  • string

The HTTP status code.
Message
  • string

The error message.
Name Type Description
id
  • string

The Event Hub-compatible consumer group identifier.
name
  • string

The Event Hub-compatible consumer group name.
tags
  • <string, string>

The tags.