EventHubConsumerGroupInfoCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.IotHub

Assembly:

Azure.ResourceManager.IotHub.dll

Package:

Azure.ResourceManager.IotHub v1.1.1

Source:

EventHubConsumerGroupInfoCollection.cs

Tries to get details for this resource from the service.

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

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

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

Parameters

name

String

The name of the consumer group to retrieve.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<EventHubConsumerGroupInfoResource>>

Exceptions

ArgumentException

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

ArgumentNullException

name is null.