< Back

Set-AzureStorageQueueStoredAccessPolicy

Tue Jan 29, 2019 9:28 pm

NAME Set-AzureStorageQueueStoredAccessPolicy



SYNOPSIS

Sets a stored access policy for an Azure storage queue.





SYNTAX

Set-AzureStorageQueueStoredAccessPolicy [-Queue] <String> [-Policy] <String> [-Context <IStorageContext>] [-ExpiryTime <DateTime>] [-NoExpiryTime]

[-NoStartTime] [-Permission <String>] [-StartTime <DateTime>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-Context <IStorageContext>

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



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-ExpiryTime <DateTime>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-NoExpiryTime [<SwitchParameter>]

Indicates that the access policy has no expiration date.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-NoStartTime [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Permission <String>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Policy <String>

Specifies the name for the stored access policy.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Queue <String>

Specifies the Azure storage queue name.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-StartTime <DateTime>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

IStorageContext

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



String

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





OUTPUTS

System.String







NOTES









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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... cesspolicy

Get-AzureStorageQueueStoredAccessPolicy

New-AzureStorageQueueStoredAccessPolicy

Remove-AzureStorageQueueStoredAccessPolicy