Get-AzRedisEnterpriseCache

Module:

Az.RedisEnterpriseCache

Gets information about a Redis Enterprise cluster and its associated databases.

Syntax

Get-AzRedisEnterpriseCache
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzRedisEnterpriseCache
   [-SubscriptionId <String[]>]
   -ResourceGroupName <String>
   -ClusterName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzRedisEnterpriseCache
   [-SubscriptionId <String[]>]
   -ResourceGroupName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets information about a Redis Enterprise cluster and its associated databases.

Examples

Example 1: Get a Redis Enterprise cache by name

Get-AzRedisEnterpriseCache -ResourceGroupName "MyGroup" -Name "MyCache"

Location Name    Type                            Zone Database
-------- ----    ----                            ---- --------
West US  MyCache Microsoft.Cache/redisEnterprise      {default}

This command gets information about the Redis Enterprise cache named MyCache.

Example 2: List every Redis Enterprise cache in a resource group

Get-AzRedisEnterpriseCache -ResourceGroupName "MyGroup"

Location Name     Type                            Zone      Database
-------- ----     ----                            ----      --------
East US  MyCache1 Microsoft.Cache/redisEnterprise           {default}
East US  MyCache2 Microsoft.Cache/redisEnterprise {1, 2, 3} {default}

This command gets information about every Redis Enterprise cache in the specified resource group.

Example 3: List every Redis Enterprise cache in a subscription

Get-AzRedisEnterpriseCache

Location    Name     Type                            Zone      Database
--------    ----     ----                            ----      --------
East US     MyCache1 Microsoft.Cache/redisEnterprise           {default}
East US     MyCache2 Microsoft.Cache/redisEnterprise {1, 2, 3} {default}
West US     MyCache3 Microsoft.Cache/redisEnterprise           {default}
Central US  MyCache4 Microsoft.Cache/redisEnterprise {1, 2, 3} {default}

This command gets information about every Redis Enterprise cache in the current subscription.

Parameters

-ClusterName

The name of the Redis Enterprise cluster.

Type:	String
Aliases:	Name
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

ICluster