Get-AzRedisEnterpriseCache
Gets information about a Redis Enterprise cluster and its associated databases.
Syntax
ListBySubscriptionId (Default)
Get-AzRedisEnterpriseCache
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzRedisEnterpriseCache
-ResourceGroupName <String>
-ClusterName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
ListByResourceGroup
Get-AzRedisEnterpriseCache
-ResourceGroupName <String>
[-SubscriptionId <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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ListByResourceGroup
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SubscriptionId
The ID of the target subscription.
Parameter properties
| Type: | String[] |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
