Edit

Share via

Get-AzureStorageQueue

  • Reference
Module:
Azure.Storage

Lists storage queues.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

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

Examples

Example 1: List all Azure Storage queues

PS C:\>Get-AzureStorageQueue

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

Example 2: List Azure Storage queues using a wildcard character

PS C:\>Get-AzureStorageQueue -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

PS C:\>Get-AzureStorageQueue -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-AzureStorageContext cmdlet.

Type:IStorageContext
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Aliases:N, Queue
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Prefix

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

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

Inputs

String

IStorageContext

Outputs

AzureStorageQueue