Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureRedisCache

Get-AzureRedisCache

microsoft.azure.commands.rediscache.dll

Synopsis

Gets details about a single cache or all caches in the specified resource group or all caches in the current subscription.

Syntax

Get-AzureRedisCache [-Name] [-ResourceGroupName] [<CommonParameters>]

Detailed Description

The Get-AzureRedisCache cmdlet gets the details about a cache or caches depending on input parameters. If both ResourceGroupName and Name parameters are provided then Get-AzureRedisCache will return details about the specific cache name provided.

If only ResourceGroupName is provided than it will return details about all caches in the specified resource group.

If no parameters are given than it will return details about all caches the current subscription.

Parameters

-Name <String>

The name of the cache. When this parameter is provided along with ResourceGroupName, Get-AzureRedisCache returns the details for the cache.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ResourceGroupName <String>

The name of the resource group that contains the cache or caches. If ResourceGroupName is provided with Name then Get-AzureRedisCache returns the details of the cache specified by Name. If only the ResourceGroup parameter is provided, then details for all caches in the resource group are returned.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Azure.Commands.RedisCache.Models.RedisCacheAttributes

Notes

The Get-AzureRedisCache cmdlet is included in the Azure Resource Manager module beginning in module version 0.8.9.

Examples

Example 1: Get specific redis cache by name

This command gets details about the specified redis cache.

PS C:\>Get-AzureRedisCache -ResourceGroupName myGroup -Name myexists
          
          ResourceGroupName : myGroup
          Id                : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myexists
          Location          : North Central US
          Name              : myexists
          Type              : Microsoft.Cache/Redis
          HostName          : myexists.redis.cache.windows.net
          Port              : 6379
          ProvisioningState : succeeded
          SslPort           : 6380
          MaxMemoryPolicy   : VolatileTTL
          RedisVersion      : 2.8
          Size              : 1GB
          Sku               : Basic
          
        

Example 2: Get all redis caches in a specific resource group

This command gets details about all redis caches in the specified resource group.

          PS C:\>Get-AzureRedisCache -ResourceGroupName myGroup
          
          ResourceGroupName : myGroup
          Id                : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myexists
          Location          : North Central US
          Name              : myexists
          Type              : Microsoft.Cache/Redis
          HostName          : myexists.redis.cache.windows.net
          Port              : 6379
          ProvisioningState : succeeded
          SslPort           : 6380
          MaxMemoryPolicy   : VolatileTTL
          RedisVersion      : 2.8
          Size              : 1GB
          Sku               : Basic

          ResourceGroupName : myGroup
          Id                : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myearlier
          Location          : North Central US
          Name              : myearlier
          Type              : Microsoft.Cache/Redis
          HostName          : myearlier.redis.cache.windows.net
          Port              : 6379
          ProvisioningState : succeeded
          SslPort           : 6380
          MaxMemoryPolicy   : VolatileTTL
          RedisVersion      : 2.8
          Size              : 250MB
          Sku               : Standard
          
        

Example 3: Get all redis caches in the current subscription

This command gets details about all redis caches in the current subscription.

          PS C:\>Get-AzureRedisCache
          
          ResourceGroupName : myGroup
          Id                : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myexists
          Location          : North Central US
          Name              : myexists
          Type              : Microsoft.Cache/Redis
          HostName          : myexists.redis.cache.windows.net
          Port              : 6379
          ProvisioningState : succeeded
          SslPort           : 6380
          MaxMemoryPolicy   : VolatileTTL
          RedisVersion      : 2.8
          Size              : 1GB
          Sku               : Basic

          ResourceGroupName : myGroup
          Id                : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup/providers/Microsoft.Cache/Redis/myearlier
          Location          : North Central US
          Name              : myearlier
          Type              : Microsoft.Cache/Redis
          HostName          : myearlier.redis.cache.windows.net
          Port              : 6379
          ProvisioningState : succeeded
          SslPort           : 6380
          MaxMemoryPolicy   : VolatileTTL
          RedisVersion      : 2.8
          Size              : 250MB
          Sku               : Standard

          ResourceGroupName : myGroup2
          Id                : /subscriptions/a559b6fd-3a84-40bb-a450-b0db5ed37dfe/resourceGroups/myGroup2/providers/Microsoft.Cache/Redis/myearlier2
          Location          : North Central US
          Name              : myearlier2
          Type              : Microsoft.Cache/Redis
          HostName          : myearlier2.redis.cache.windows.net
          Port              : 6379
          ProvisioningState : succeeded
          SslPort           : 6380
          MaxMemoryPolicy   : VolatileTTL
          RedisVersion      : 2.8
          Size              : 250MB
          Sku               : Basic
          
        

Online Version