Remove-AzureStorageQueue

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Remove-AzureStorageQueue

Remove the specified storage queues.

Parameter Set: Default
Remove-AzureStorageQueue [-Name] <String> [-Context <AzureStorageContext> ] [-Force] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]

This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.

-Context<AzureStorageContext>

Specifies the Windows Azure storage context. You can create it by using the New-AzureStorageContext cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Force

Removes the queue without prompting for confirmation.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Queue name

Aliases

N,Queue

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Outputs a boolean value that indicates whether the command succeeded.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Example 1

This example removes a queue named ‘queueabc’.

C:\PS>Remove-AzureStorageQueue queueabc

Example 2

This example uses a wildcard with the Name parameter to get all tables that match the pattern ‘queue’ and then passes the result on the pipeline to remove the tables.

C:\PS>Get-AzureStorageQueue queue* | Remove-AzureStorageQueue

New-AzureStorageQueue

Get-AzureStorageQueue