HciClusterCollection Class

Definition

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

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

Constructors

HciClusterCollection()

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

Create an HCI cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
  • Operation Id: Clusters_Create
  • Default Api Version: 2024-04-01
  • Resource: HciClusterResource
CreateOrUpdateAsync(WaitUntil, String, HciClusterData, CancellationToken)

Create an HCI cluster.

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

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Get HCI cluster.

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

List all HCI clusters in a resource group.

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

List all HCI clusters in a resource group.

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

Get HCI cluster.

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

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<HciClusterResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to