Set-AzureStorageQueueStoredAccessPolicy

Sets a stored access policy for an Azure storage queue.

Important

You've reached a webpage for an outdated version of Azure PowerShell. All versions of the AzureRM PowerShell module are outdated, but not out of support. The Az PowerShell module is now the recommended PowerShell module for interacting with Azure. To get started with the Az PowerShell module, see Install Azure PowerShell. To learn how to migrate to the Az PowerShell module, see Migrate Azure PowerShell from AzureRM to Az.

Syntax

Set-AzureStorageQueueStoredAccessPolicy
   [-Queue] <String>
   [-Policy] <String>
   [-Permission <String>]
   [-StartTime <DateTime>]
   [-ExpiryTime <DateTime>]
   [-NoStartTime]
   [-NoExpiryTime]
   [-Context <IStorageContext>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzureStorageQueueStoredAccessPolicy cmdlet sets a stored access policy for an Azure storage queue.

Examples

Example 1: Set a stored access policy in the queue with full permission

PS C:\> Set-AzureStorageQueueStoredAccessPolicy -Queue "MyQueue" -Policy "Policy07" -Permission arup

This command sets an access policy named Policy07 for storage queue named MyQueue.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Context

Specifies an Azure storage context. To obtain a storage context, use the New-AzureStorageContext cmdlet.

Type:IStorageContext
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ExpiryTime

Specifies the time at which the stored access policy becomes invalid.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NoExpiryTime

Indicates that the access policy has no expiration date.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NoStartTime

Indicates that this cmdlet sets the start time to be $Null.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Permission

Specifies permissions in the stored access policy to access the storage queue.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Policy

Specifies the name for the stored access policy.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Queue

Specifies the Azure storage queue name.

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

Specifies the time at which the stored access policy becomes valid.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IStorageContext

Parameter 'Context' accepts value of type 'IStorageContext' from the pipeline

String

Parameter 'Queue' accepts value of type 'String' from the pipeline

Outputs

String