RedisEnterpriseExtensions.GetRedisEnterpriseCluster Method

Definition

Namespace:

Azure.ResourceManager.RedisEnterprise

Assembly:

Azure.ResourceManager.RedisEnterprise.dll

Package:

Azure.ResourceManager.RedisEnterprise v1.3.0

Source:

RedisEnterpriseExtensions.cs

Gets information about a Redis Enterprise cluster <item> Mocking. To mock this method, please mock GetRedisEnterpriseCluster(String, CancellationToken) instead. </item>

public static Azure.Response<Azure.ResourceManager.RedisEnterprise.RedisEnterpriseClusterResource> GetRedisEnterpriseCluster(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, System.Threading.CancellationToken cancellationToken = default);

static member GetRedisEnterpriseCluster : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.RedisEnterprise.RedisEnterpriseClusterResource>

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

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource the method will execute against.

clusterName

String

The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<RedisEnterpriseClusterResource>

Exceptions

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.