RedisEnterpriseCacheExtensions.GetClusterAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.RedisEnterpriseCache

Assembly:: Azure.ResourceManager.RedisEnterpriseCache.dll

Package:: Azure.ResourceManager.RedisEnterpriseCache v1.0.0-beta.1

Source:: RedisEnterpriseCacheExtensions.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.

Gets information about a RedisEnterprise cluster Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName} Operation Id: RedisEnterprise_Get

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RedisEnterpriseCache.ClusterResource>> GetClusterAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, System.Threading.CancellationToken cancellationToken = default);

static member GetClusterAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RedisEnterpriseCache.ClusterResource>>

<Extension()>
Public Function GetClusterAsync (resourceGroupResource As ResourceGroupResource, clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ClusterResource))

Parameters

resourceGroupResource: ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

clusterName: String

The name of the RedisEnterprise cluster.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<ClusterResource>>

Exceptions

ArgumentException

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

ArgumentNullException

clusterName is null.

Applies to