EventHubsClusterCollection Class

Definition

A class representing a collection of EventHubsClusterResource and their operations. Each EventHubsClusterResource in the collection will belong to the same instance of ResourceGroupResource. To get an EventHubsClusterCollection instance call the GetEventHubsClusters method from an instance of ResourceGroupResource.

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

Constructors

EventHubsClusterCollection()

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

Creates or updates an instance of an Event Hubs Cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
  • Operation Id: Clusters_CreateOrUpdate
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
CreateOrUpdateAsync(WaitUntil, String, EventHubsClusterData, CancellationToken)

Creates or updates an instance of an Event Hubs Cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
  • Operation Id: Clusters_CreateOrUpdate
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
Get(String, CancellationToken)

Gets the resource description of the specified Event Hubs Cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
GetAll(CancellationToken)

Lists the available Event Hubs Clusters within an ARM resource group

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters
  • Operation Id: Clusters_ListByResourceGroup
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
GetAllAsync(CancellationToken)

Lists the available Event Hubs Clusters within an ARM resource group

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters
  • Operation Id: Clusters_ListByResourceGroup
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
GetAsync(String, CancellationToken)

Gets the resource description of the specified Event Hubs Cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}
  • Operation Id: Clusters_Get
  • Default Api Version: 2024-01-01
  • Resource: EventHubsClusterResource
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<EventHubsClusterResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<EventHubsClusterResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to