Get-AzureStorageQueue

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

Get-AzureStorageQueue

Lists storage queues.

Parameter Set: QueueName
Get-AzureStorageQueue [[-Name] <String> ] [-Context <AzureStorageContext> ] [ <CommonParameters>]

Parameter Set: QueuePrefix
Get-AzureStorageQueue -Prefix <String> [-Context <AzureStorageContext> ] [ <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.

Lists storage queues.

-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

-Name<String>

Specifies a name. If no name is specified, the cmdlet gets a list of all the queues. If a full or partial name is specified, the cmdlet gets all queues that match the name pattern.

Aliases

N,Queue

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Prefix<String>

Specifies a prefix used in the name of the queues you want to get.

Aliases

none

Required?

true

Position?

named

Default Value

none

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 gets a list of all storage queues for the current subscription.

C:\PS>Get-AzureStorageQueue

Example 2

This example uses a wildcard to get a list of storage queues whose name begins with ‘queue’.

C:\PS>Get-AzureStorageQueue queue*

Example 3

This example uses the Prefix parameter to get a list of storage queues whose name begins with ‘queue’.

C:\PS>Get-AzureStorageQueue -Prefix queue

New-AzureStorageQueue

Remove-AzureStorageQueue