Share via

Iot Hub Resource - List Event Hub Consumer Groups

Service:
IoT Hub
API Version:
2023-06-30

Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.

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

URI Parameters

Name In Required Type Description
eventHubEndpointName
 path True

string

The name of the Event Hub-compatible endpoint.
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.
subscriptionId
 path True

string

The subscription identifier.
api-version
 query True

string

The version of the API.

Responses

Name Type Description
200 OK

EventHubConsumerGroupsListResult

This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the Event Hub-compatible endpoint in this IoT hub
Other Status Codes

ErrorDetails

DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

IotHubResource_ListEventHubConsumerGroups

Sample request

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

Sample response

Status code:
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="
    }
  ]
}

Definitions

Name Description
ErrorDetails

Error details.
EventHubConsumerGroupInfo

The properties of the EventHubConsumerGroupInfo object.
EventHubConsumerGroupsListResult

The JSON-serialized array of Event Hub-compatible consumer group names with a next link.

ErrorDetails

Object

Error details.

Name Type Description
code

string

The error code.
details

string

The error details.
httpStatusCode

string

The HTTP status code.
message

string

The error message.

EventHubConsumerGroupInfo

Object

The properties of the EventHubConsumerGroupInfo object.

Name Type Description
etag

string

The etag.
id

string

The Event Hub-compatible consumer group identifier.
name

string

The Event Hub-compatible consumer group name.
properties

The tags.
type

string

the resource type.

EventHubConsumerGroupsListResult

Object

The JSON-serialized array of Event Hub-compatible consumer group names with a next link.

Name Type Description
nextLink

string

The next link.
value

EventHubConsumerGroupInfo[]

List of consumer groups objects