EventHubsConsumerGroupCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.EventHubs

Assembly:

Azure.ResourceManager.EventHubs.dll

Package:

Azure.ResourceManager.EventHubs v1.1.0

Source:

EventHubsConsumerGroupCollection.cs

Tries to get details for this resource from the service.

• 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.NullableResponse<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>> GetIfExistsAsync (string consumerGroupName, System.Threading.CancellationToken cancellationToken = default);

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

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

Parameters

consumerGroupName

String

The consumer group name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<EventHubsConsumerGroupResource>>

Exceptions

ArgumentException

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

ArgumentNullException

consumerGroupName is null.