RedisExtensions.GetRedisAsync Method

Definition

Gets a Redis cache (resource description).

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
  • Operation Id: Redis_Get
  • Default Api Version: 2023-08-01
  • Resource: RedisResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Redis.RedisResource>> GetRedisAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string name, System.Threading.CancellationToken cancellationToken = default);
static member GetRedisAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Redis.RedisResource>>
<Extension()>
Public Function GetRedisAsync (resourceGroupResource As ResourceGroupResource, name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RedisResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

name
String

The name of the Redis cache.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or name is null.

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

Applies to