Remove-​Azure​Rm​Redis​Cache

Removes a Redis Cache.

Syntax

Remove-AzureRmRedisCache
      -Name <String>
      -ResourceGroupName <String>
      [-Force]
      [-PassThru]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Remove-AzureRmRedisCache cmdlet removes an Azure Redis Cache.

Examples

Example 1: Remove a Redis Cache and return the result

PS C:\>Remove-AzureRmRedisCache -ResourceGroupName "ResourceGroup03" -Name "myCache" -Force -PassThru
True

This command removes a Redis Cache and displays whether the operation is successful.

Example 2: Remove a Redis Cache and do not display the result

PS C:\>Remove-AzureRmRedisCache -ResourceGroupName "ResourceGroup03" -Name "myCache" -Force

This command removes a Redis Cache. Because the PassThru parameter is not specified, the result of the operation is not displayed.

Required Parameters

-Name

Specifies the name of the Redis Cache to remove.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of the resource group that contains the Redis Cache to remove.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

You can pipe input to this cmdlet by name, but not by value.

Outputs

Boolean

Returns $True if no exception occurs.