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

Definition

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.IotHub.Models.EventHubConsumerGroupInfo>> GetEventHubConsumerGroupWithHttpMessagesAsync (string resourceGroupName, string resourceName, string eventHubEndpointName, string name, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetEventHubConsumerGroupWithHttpMessagesAsync : string * 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.Azure.Management.IotHub.Models.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 in the IoT hub.

name
System.String

The name of the consumer group to retrieve.

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<Microsoft.Rest.Azure.AzureOperationResponse<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 consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.

Applies to