RedisEnterpriseExtensions.GetRedisEnterpriseClusterAsync Method

Definition

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

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RedisEnterprise.RedisEnterpriseClusterResource>> GetRedisEnterpriseClusterAsync(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, System.Threading.CancellationToken cancellationToken = default);
static member GetRedisEnterpriseClusterAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.RedisEnterprise.RedisEnterpriseClusterResource>>
<Extension()>
Public Function GetRedisEnterpriseClusterAsync (resourceGroupResource As ResourceGroupResource, clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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

Exceptions

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

resourceGroupResource is null.

Applies to