< Back
Remove-AzureRmRedisCache
Post
NAME Remove-AzureRmRedisCache
SYNOPSIS
Removes a Redis Cache.
SYNTAX
Remove-AzureRmRedisCache [-DefaultProfile <IAzureContextContainer>] [-Force] -Name <String> [-PassThru] [-ResourceGroupName <String>] [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmRedisCache cmdlet removes an Azure Redis Cache.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the Redis Cache to remove.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group that contains the Redis Cache to remove.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
You can pipe input to this cmdlet by name, but not by value.
OUTPUTS
Boolean
Returns $True if no exception occurs.
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rediscache
Get-AzureRmRedisCache
New-AzureRmRedisCache
Reset-AzureRmRedisCache
SYNOPSIS
Removes a Redis Cache.
SYNTAX
Remove-AzureRmRedisCache [-DefaultProfile <IAzureContextContainer>] [-Force] -Name <String> [-PassThru] [-ResourceGroupName <String>] [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmRedisCache cmdlet removes an Azure Redis Cache.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the Redis Cache to remove.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group that contains the Redis Cache to remove.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
You can pipe input to this cmdlet by name, but not by value.
OUTPUTS
Boolean
Returns $True if no exception occurs.
NOTES
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rediscache
Get-AzureRmRedisCache
New-AzureRmRedisCache
Reset-AzureRmRedisCache