Share via


EventHubConsumerGroupInfoCollection Class

Definition

A class representing a collection of EventHubConsumerGroupInfoResource and their operations. Each EventHubConsumerGroupInfoResource in the collection will belong to the same instance of IotHubDescriptionResource. To get an EventHubConsumerGroupInfoCollection instance call the GetEventHubConsumerGroupInfos method from an instance of IotHubDescriptionResource.

public class EventHubConsumerGroupInfoCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.IotHub.EventHubConsumerGroupInfoResource>
type EventHubConsumerGroupInfoCollection = class
    inherit ArmCollection
    interface seq<EventHubConsumerGroupInfoResource>
    interface IEnumerable
    interface IAsyncEnumerable<EventHubConsumerGroupInfoResource>
Public Class EventHubConsumerGroupInfoCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of EventHubConsumerGroupInfoResource), IEnumerable(Of EventHubConsumerGroupInfoResource)
Inheritance
EventHubConsumerGroupInfoCollection
Implements

Constructors

EventHubConsumerGroupInfoCollection()

Initializes a new instance of the EventHubConsumerGroupInfoCollection 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, EventHubConsumerGroupInfoCreateOrUpdateContent, CancellationToken)

Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
  • Operation Id: IotHubResource_CreateEventHubConsumerGroup
  • Default Api Version: 2023-06-30
  • Resource: EventHubConsumerGroupInfoResource
CreateOrUpdateAsync(WaitUntil, String, EventHubConsumerGroupInfoCreateOrUpdateContent, CancellationToken)

Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}
  • Operation Id: IotHubResource_CreateEventHubConsumerGroup
  • Default Api Version: 2023-06-30
  • Resource: EventHubConsumerGroupInfoResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • 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
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • 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
Get(String, CancellationToken)

Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.

  • 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
GetAll(CancellationToken)

Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups
  • Operation Id: IotHubResource_ListEventHubConsumerGroups
  • Default Api Version: 2023-06-30
  • Resource: EventHubConsumerGroupInfoResource
GetAllAsync(CancellationToken)

Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups
  • Operation Id: IotHubResource_ListEventHubConsumerGroups
  • Default Api Version: 2023-06-30
  • Resource: EventHubConsumerGroupInfoResource
GetAsync(String, CancellationToken)

Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.

  • 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
GetIfExists(String, CancellationToken)

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
GetIfExistsAsync(String, CancellationToken)

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
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<EventHubConsumerGroupInfoResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<EventHubConsumerGroupInfoResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to