Edit

Share via

Get-AzureStorageQueueStoredAccessPolicy

  • Reference
Module:
Azure.Storage

Gets the stored access policy or policies for an Azure storage queue.

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-AzureStorageQueueStoredAccessPolicy
   [-Queue] <String>
   [[-Policy] <String>]
   [-Context <IStorageContext>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureStorageQueueStoredAccessPolicy cmdlet lists the stored access policy or policies for an Azure storage queue.

Examples

Example 1: Get a stored access policy in the queue

PS C:\>Get-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy12"

This command gets the access policy named Policy12 in the storage queue named MyQueue.

Example 2: Get all stored access policies in the queue

PS C:\>Get-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue"

This command gets all stored access policies in the queue named MyQueue.

Parameters

-Context

Specifies the Azure storage context. To obtain a storage context, use 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

-Policy

Specifies a stored access policy, which includes the permissions for this Shared Access Signature (SAS) token.

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

-Queue

Specifies the Azure storage queue name.

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

Inputs

String

IStorageContext

Outputs

SharedAccessQueuePolicy