EventHubResource.GetEventHubsConsumerGroup(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.ResourceManager.EventHubs

Assembly:: Azure.ResourceManager.EventHubs.dll

Package:: Azure.ResourceManager.EventHubs v1.0.1

Package:: Azure.ResourceManager.EventHubs v1.1.0-beta.8

Source:: EventHubResource.cs

Source:: EventHubResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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: 2023-01-01-preview
Resource: EventHubsConsumerGroupResource

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

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

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

Parameters

consumerGroupName: String

The consumer group name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<EventHubsConsumerGroupResource>

Exceptions

ArgumentNullException

consumerGroupName is null.

ArgumentException

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

Applies to

Share via