Share via

EventHubsConsumerGroupCollection.GetAllAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.EventHubs
Assembly:
Azure.ResourceManager.EventHubs.dll
Package:
Azure.ResourceManager.EventHubs v1.1.0
Package:
Azure.ResourceManager.EventHubs v1.2.0-beta.1
Source:
EventHubsConsumerGroupCollection.cs
Source:
EventHubsConsumerGroupCollection.cs

Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups
  • Operation Id: ConsumerGroups_ListByEventHub
  • Default Api Version: 2024-01-01
  • Resource: EventHubsConsumerGroupResource
public virtual Azure.AsyncPageable<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource> GetAllAsync (int? skip = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAllAsync : Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>
override this.GetAllAsync : Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>
Public Overridable Function GetAllAsync (Optional skip As Nullable(Of Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of EventHubsConsumerGroupResource)

Parameters

skip
Nullable<Int32>

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

top
Nullable<Int32>

May be used to limit the number of results to the most recent N usageDetails.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

AsyncPageable<EventHubsConsumerGroupResource>

An async collection of EventHubsConsumerGroupResource that may take multiple service requests to iterate over.

Applies to