Remove-AzStorageQueue

Reference

Module:: Az.Storage

Removes a storage queue.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Remove-AzStorageQueue
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-Context <IStorageContext>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzStorageQueue cmdlet removes a storage queue.

Examples

Example 1: Remove a storage queue by name

PS C:\>Remove-AzStorageQueue "ContosoQueue01"

This command removes a queue named ContosoQueue01.

Example 2: Remove multiple storage queues

PS C:\>Get-AzStorageQueue "Contoso*" | Remove-AzStorageQueue

This command removes all queues with names that start with Contoso.

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

-Context

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

Type:	IStorageContext
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
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

-Name

Specifies the name of the queue to remove.

Type:	String
Aliases:	N, Queue
Position:	0
Default value:	None
Accept pipeline input:	True
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
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

String

IStorageContext

Outputs

Boolean