New-AzStorageQueueSASToken

Reference

Module:: Az.Storage

Generates a shared access signature token for an Azure storage queue.

Syntax

New-AzStorageQueueSASToken
   [-Name] <String>
   -Policy <String>
   [-Protocol <String>]
   [-IPAddressOrRange <String>]
   [-StartTime <DateTime>]
   [-ExpiryTime <DateTime>]
   [-FullUri]
   [-Context <IStorageContext>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzStorageQueueSASToken
   [-Name] <String>
   [-Permission <String>]
   [-Protocol <String>]
   [-IPAddressOrRange <String>]
   [-StartTime <DateTime>]
   [-ExpiryTime <DateTime>]
   [-FullUri]
   [-Context <IStorageContext>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzStorageQueueSASToken cmdlet generates shared access signature token for an Azure storage queue.

Examples

Example 1: Generate a queue SAS token with full permission

New-AzStorageQueueSASToken -Name "Test" -Permission raup

This example generates a queue SAS token with full permission.

Parameters

-Context

Specifies the Azure storage context. You can create it by New-AzStorageContext 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

-ExpiryTime

Specifies when the shared access signature is no longer valid.

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FullUri

Indicates that this cmdlet return the full blob URI and the shared access signature token.

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

-IPAddressOrRange

Specifies the IP address or range of IP addresses from which to accept requests, such as 168.1.5.65 or 168.1.5.60-168.1.5.70. The range is inclusive.

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

-Name

Specifies an Azure storage queue name.

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

-Permission

Specifies permissions for a storage queue. It is important to note that this is a string, like raup (for Read, Add, Update and ProcessMessages).

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

-Policy

Specifies an Azure stored access policy.

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

-Protocol

Specifies the protocol permitted for a request. The acceptable values for this parameter are:

HttpsOnly
HttpsOrHttp The default value is HttpsOrHttp.

Type:	String
Accepted values:	HttpsOnly, HttpsOrHttp
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StartTime

Specifies when the shared access signature becomes valid.

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

IStorageContext

Outputs