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
 

Remove-AzureRedisCache

Remove-AzureRedisCache

microsoft.azure.commands.rediscache.dll

Synopsis

Remove redis cache if exists.

Syntax

Remove-AzureRedisCache [-Name] [-ResourceGroupName] [-Force] [-PassThru] [<CommonParameters>]

Detailed Description

The Remove-AzureRedisCache cmdlet removes a redis cache if it exists.

Parameters

-Name <String>

Name of the redis cache to remove.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ResourceGroupName <String>

Name of the resource group of the cache to remove.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

When the Force parameter is provided, the cache is removed without any confirmation prompts.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

By default Remove-AzureRedisCache removes the cache and does not return any value. If the PassThru parameter is provided then Remove-AzureRedisCache returns a boolean value indicating the success of the operation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Boolean

Notes

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

Examples

Example 1: Remove a redis cache with PassThru

This command removes a redis cache.

          PS C:\>Remove-AzureRedisCache -ResourceGroupName myGroup -Name mycache -Force -PassThru
          True

        

Example 2: Remove a redis cache without PassThru

This command removes a redis cache.

          PS C:\>Remove-AzureRedisCache -ResourceGroupName myGroup -Name mycache -Force
        

Online Version