IotHubDescriptionResource.GetEventHubConsumerGroupInfoAsync Method

Definition

Namespace:

Azure.ResourceManager.IotHub

Assembly:

Azure.ResourceManager.IotHub.dll

Package:

Azure.ResourceManager.IotHub v1.1.1

Source:

IotHubDescriptionResource.cs

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

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
• Operation Id: IotHubResource_GetEventHubConsumerGroup
• Default Api Version: 2023-06-30
• Resource: EventHubConsumerGroupInfoResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>> GetEventHubConsumerGroupInfoAsync (string eventHubEndpointName, string name, System.Threading.CancellationToken cancellationToken = default);

abstract member GetEventHubConsumerGroupInfoAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>>
override this.GetEventHubConsumerGroupInfoAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>>

Public Overridable Function GetEventHubConsumerGroupInfoAsync (eventHubEndpointName As String, name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EventHubConsumerGroupInfoResource))

Parameters

eventHubEndpointName

String

The name of the Event Hub-compatible endpoint.

name

String

The name of the consumer group to retrieve.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<EventHubConsumerGroupInfoResource>>

Exceptions

ArgumentNullException

eventHubEndpointName or name is null.

ArgumentException

eventHubEndpointName or name is an empty string, and was expected to be non-empty.