IIotHubResourceOperations.GetEventHubConsumerGroupWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.IotHub

Assembly:

Microsoft.Azure.Management.IotHub.dll

Package:

Microsoft.Azure.Management.IotHub v4.2.0

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 = default, System.Threading.CancellationToken cancellationToken = default);

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>>

Public Function GetEventHubConsumerGroupWithHttpMessagesAsync (resourceGroupName As String, resourceName As String, eventHubEndpointName As String, name As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of EventHubConsumerGroupInfo))

Parameters

resourceGroupName

String

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

resourceName

String

The name of the IoT hub.

eventHubEndpointName

String

The name of the Event Hub-compatible endpoint in the IoT hub.

name

String

The name of the consumer group to retrieve.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<EventHubConsumerGroupInfo>>

Exceptions

ErrorDetailsException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

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.