EventHubResource.GetEventHubsConsumerGroupAsync Method

Definition

Namespace:

Azure.ResourceManager.EventHubs

Assembly:

Azure.ResourceManager.EventHubs.dll

Package:

Azure.ResourceManager.EventHubs v1.1.0

Source:

EventHubResource.cs

Gets a description for the specified consumer group.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName}
• Operation Id: ConsumerGroups_Get
• Default Api Version: 2024-01-01
• Resource: EventHubsConsumerGroupResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>> GetEventHubsConsumerGroupAsync (string consumerGroupName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetEventHubsConsumerGroupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>>
override this.GetEventHubsConsumerGroupAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>>

Public Overridable Function GetEventHubsConsumerGroupAsync (consumerGroupName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EventHubsConsumerGroupResource))

Parameters

consumerGroupName

String

The consumer group name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<EventHubsConsumerGroupResource>>

Exceptions

ArgumentNullException

consumerGroupName is null.

ArgumentException

consumerGroupName is an empty string, and was expected to be non-empty.