HciClusterCollection.GetIfExistsAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.ResourceManager.Hci

Assembly:: Azure.ResourceManager.Hci.dll

Package:: Azure.ResourceManager.Hci v1.2.0

Package:: Azure.ResourceManager.Hci v1.2.0-beta.1

Source:: HciClusterCollection.cs

Source:: HciClusterCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Hci.HciClusterResource>> GetIfExistsAsync (string clusterName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Hci.HciClusterResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Hci.HciClusterResource>>

Public Overridable Function GetIfExistsAsync (clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of HciClusterResource))

Parameters

clusterName: String

The name of the cluster.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<HciClusterResource>>

Exceptions

ArgumentException

clusterName is an empty string, and was expected to be non-empty.

ArgumentNullException

clusterName is null.

Applies to

Share via