Share via


RedisCollection Class

Definition

A class representing a collection of RedisResource and their operations. Each RedisResource in the collection will belong to the same instance of ResourceGroupResource. To get a RedisCollection instance call the GetRedis method from an instance of ResourceGroupResource.

public class RedisCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Redis.RedisResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Redis.RedisResource>
type RedisCollection = class
    inherit ArmCollection
    interface seq<RedisResource>
    interface IEnumerable
    interface IAsyncEnumerable<RedisResource>
Public Class RedisCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of RedisResource), IEnumerable(Of RedisResource)
Inheritance
RedisCollection
Implements

Constructors

RedisCollection()

Initializes a new instance of the RedisCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, RedisCreateOrUpdateContent, CancellationToken)

Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
  • Operation Id: Redis_Create
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
CreateOrUpdateAsync(WaitUntil, String, RedisCreateOrUpdateContent, CancellationToken)

Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
  • Operation Id: Redis_Create
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
  • Operation Id: Redis_Get
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
  • Operation Id: Redis_Get
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
Get(String, CancellationToken)

Gets a Redis cache (resource description).

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
  • Operation Id: Redis_Get
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
GetAll(CancellationToken)

Lists all Redis caches in a resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis
  • Operation Id: Redis_ListByResourceGroup
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
GetAllAsync(CancellationToken)

Lists all Redis caches in a resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis
  • Operation Id: Redis_ListByResourceGroup
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
GetAsync(String, CancellationToken)

Gets a Redis cache (resource description).

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
  • Operation Id: Redis_Get
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
  • Operation Id: Redis_Get
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}
  • Operation Id: Redis_Get
  • Default Api Version: 2024-03-01
  • Resource: RedisResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<RedisResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<RedisResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to