< Back
Remove-AzureStorageQueue
Post
NAME Remove-AzureStorageQueue
SYNOPSIS
Removes a storage queue.
SYNTAX
Remove-AzureStorageQueue [-Name] <String> [-Context <IStorageContext>] [-Force] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureStorageQueue cmdlet removes a storage queue.
PARAMETERS
-Context <IStorageContext>
Specifies the Azure storage context. To obtain the storage context, the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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 queue to remove.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a Boolean that reflects the success of the operation. By default, this cmdlet does not return a value.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
String
Parameter 'Name' accepts value of type 'String' from the pipeline
OUTPUTS
System.Boolean
NOTES
Example 1: Remove a storage queue by name
PS C:\\>Remove-AzureStorageQueue "ContosoQueue01"
This command removes a queue named ContosoQueue01.
Example 2: Remove multiple storage queues
PS C:\\>Get-AzureStorageQueue "Contoso*" | Remove-AzureStorageQueue
This command removes all queues with names that start with Contoso.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... oragequeue
Get-AzureStorageQueue
New-AzureStorageQueue
SYNOPSIS
Removes a storage queue.
SYNTAX
Remove-AzureStorageQueue [-Name] <String> [-Context <IStorageContext>] [-Force] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureStorageQueue cmdlet removes a storage queue.
PARAMETERS
-Context <IStorageContext>
Specifies the Azure storage context. To obtain the storage context, the New-AzureStorageContext cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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 queue to remove.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns a Boolean that reflects the success of the operation. By default, this cmdlet does not return a value.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
IStorageContext
Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline
String
Parameter 'Name' accepts value of type 'String' from the pipeline
OUTPUTS
System.Boolean
NOTES
Example 1: Remove a storage queue by name
PS C:\\>Remove-AzureStorageQueue "ContosoQueue01"
This command removes a queue named ContosoQueue01.
Example 2: Remove multiple storage queues
PS C:\\>Get-AzureStorageQueue "Contoso*" | Remove-AzureStorageQueue
This command removes all queues with names that start with Contoso.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... oragequeue
Get-AzureStorageQueue
New-AzureStorageQueue