IIotHubResourceOperations.ListEventHubConsumerGroupsWithHttpMessagesAsync(String, String, String, Dictionary<String,List<String>>, CancellationToken) Method

Definition

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.IotHub.Models.EventHubConsumerGroupInfo>>> ListEventHubConsumerGroupsWithHttpMessagesAsync (string resourceGroupName, string resourceName, string eventHubEndpointName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ListEventHubConsumerGroupsWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.IotHub.Models.EventHubConsumerGroupInfo>>>
Public Function ListEventHubConsumerGroupsWithHttpMessagesAsync (resourceGroupName As String, resourceName As String, eventHubEndpointName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of EventHubConsumerGroupInfo)))

Parameters

resourceGroupName
System.String

The name of the resource group that contains the IoT hub.

resourceName
System.String

The name of the IoT hub.

eventHubEndpointName
System.String

The name of the Event Hub-compatible endpoint.

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<AzureOperationResponse<IPage<EventHubConsumerGroupInfo>>>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Remarks

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

Applies to