EventHubsConsumerGroupCollection Class

Definition

Namespace:

Azure.ResourceManager.EventHubs

Assembly:

Azure.ResourceManager.EventHubs.dll

Package:

Azure.ResourceManager.EventHubs v1.1.0

Source:

EventHubsConsumerGroupCollection.cs

A class representing a collection of EventHubsConsumerGroupResource and their operations. Each EventHubsConsumerGroupResource in the collection will belong to the same instance of EventHubResource. To get an EventHubsConsumerGroupCollection instance call the GetEventHubsConsumerGroups method from an instance of EventHubResource.

public class EventHubsConsumerGroupCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.EventHubs.EventHubsConsumerGroupResource>

type EventHubsConsumerGroupCollection = class
    inherit ArmCollection
    interface seq<EventHubsConsumerGroupResource>
    interface IEnumerable
    interface IAsyncEnumerable<EventHubsConsumerGroupResource>

Public Class EventHubsConsumerGroupCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of EventHubsConsumerGroupResource), IEnumerable(Of EventHubsConsumerGroupResource)

Inheritance

Object

ArmCollection

EventHubsConsumerGroupCollection

Implements

IAsyncEnumerable<EventHubsConsumerGroupResource> IEnumerable<EventHubsConsumerGroupResource> IEnumerable

Constructors

EventHubsConsumerGroupCollection()

Initializes a new instance of the EventHubsConsumerGroupCollection class for mocking.

Properties

Client	Gets the ArmClient this resource client was created from. (Inherited from ArmCollection)
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmCollection)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmCollection)
Id	Gets the resource identifier. (Inherited from ArmCollection)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, EventHubsConsumerGroupData, CancellationToken)	Creates or updates an Event Hubs consumer group as a nested resource within a Namespace. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName} Operation Id: ConsumerGroups_CreateOrUpdate Default Api Version: 2024-01-01 Resource: EventHubsConsumerGroupResource
CreateOrUpdateAsync(WaitUntil, String, EventHubsConsumerGroupData, CancellationToken)	Creates or updates an Event Hubs consumer group as a nested resource within a Namespace. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName} Operation Id: ConsumerGroups_CreateOrUpdate Default Api Version: 2024-01-01 Resource: EventHubsConsumerGroupResource
Exists(String, CancellationToken)	Checks to see if the resource exists in azure. 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
ExistsAsync(String, CancellationToken)	Checks to see if the resource exists in azure. 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
Get(String, CancellationToken)	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
GetAll(Nullable<Int32>, Nullable<Int32>, CancellationToken)	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
GetAllAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)	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
GetAsync(String, CancellationToken)	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
GetIfExists(String, CancellationToken)	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
GetIfExistsAsync(String, CancellationToken)	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
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<EventHubsConsumerGroupResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<EventHubsConsumerGroupResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.