Share via


RedisEnterpriseExtensions.GetRedisEnterpriseClusterAsync Method

Definition

Gets information about a Redis Enterprise cluster

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}
  • Operation Id: RedisEnterprise_Get
  • Default Api Version: 2024-09-01-preview
  • Resource: RedisEnterpriseClusterResource
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 instance the method will execute against.

clusterName
String

The name of the Redis Enterprise cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or clusterName is null.

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

Applies to