Edit

Share via


Get-AzStorageQueue

Lists storage queues.

Syntax

QueueName (Default)

Get-AzStorageQueue
    [[-Name] <String>]
    [-Context <IStorageContext>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

QueuePrefix

Get-AzStorageQueue
    -Prefix <String>
    [-Context <IStorageContext>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzStorageQueue cmdlet lists storage queues associated with an Azure Storage account.

Examples

Example 1: List all Azure Storage queues

Get-AzStorageQueue

This command gets a list of all storage queues for the current Storage account.

Example 2: List Azure Storage queues using a wildcard character

Get-AzStorageQueue -Name queue*

This command uses a wildcard character to get a list of storage queues whose name starts with queue.

Example 3: List Azure Storage queues using queue name prefix

Get-AzStorageQueue -Prefix "queue"

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

Parameters

-Context

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

Parameter properties

Type:IStorageContext
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:True
DontShow:False
Aliases:N, Queue

Parameter sets

QueueName
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Prefix

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

QueuePrefix
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

IStorageContext

Outputs

AzureStorageQueue