Skip to content

Latest commit

 

History

History
162 lines (123 loc) · 3.31 KB

File metadata and controls

162 lines (123 loc) · 3.31 KB
external help file online version schema ms.assetid
Microsoft.WindowsAzure.Commands.Storage.dll-Help.xml
2.0.0
F3A0F9A3-F786-4249-BE22-761A16104B0F

Remove-AzureStorageQueue

SYNOPSIS

Removes a storage queue.

SYNTAX

Remove-AzureStorageQueue [-Name] <String> [-Force] [-PassThru] [-Context <AzureStorageContext>]
 [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-AzureStorageQueue cmdlet removes a storage queue.

EXAMPLES

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.

PARAMETERS

-Name

Specifies the name of the queue to remove.

Type: String
Parameter Sets: (All)
Aliases: N, Queue

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Indicates that this cmdlet returns a Boolean that reflects the success of the operation. By default, this cmdlet does not return a value.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Context

Specifies the Azure storage context. To obtain the storage context, the New-AzureStorageContext cmdlet.

Type: AzureStorageContext
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-PipelineVariable

Stores the value of the current pipeline element as a variable, for any named command as it flows through the pipeline.

Type: String
Parameter Sets: (All)
Aliases: pv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Get-AzureStorageQueue

New-AzureStorageQueue