New-AzureStorageQueueSASToken

Generates a shared access signature token 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

New-AzureStorageQueueSASToken
   [-Name] <String>
   -Policy <String>
   [-Protocol <SharedAccessProtocol>]
   [-IPAddressOrRange <String>]
   [-StartTime <DateTime>]
   [-ExpiryTime <DateTime>]
   [-FullUri]
   [-Context <IStorageContext>]
   [<CommonParameters>]
New-AzureStorageQueueSASToken
   [-Name] <String>
   [-Permission <String>]
   [-Protocol <SharedAccessProtocol>]
   [-IPAddressOrRange <String>]
   [-StartTime <DateTime>]
   [-ExpiryTime <DateTime>]
   [-FullUri]
   [-Context <IStorageContext>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Generate a queue SAS token with full permission

PS C:\>New-AzureStorageQueueSASToken -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-AzureStorageContext cmdlet.

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

Specifies when the shared access signature is no longer valid.

Type:DateTime
Position:Named
Default value:None
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
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
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
Accept pipeline input:True
Accept wildcard characters:False
-Permission

Specifies permissions for a storage queue.

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

Specifies an Azure stored access policy.

Type:String
Position:Named
Default value:None
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:SharedAccessProtocol
Accepted values:HttpsOnly, HttpsOrHttp
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-StartTime

Specifies when the shared access signature becomes valid.

Type:DateTime
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 'Name' accepts value of type 'String' from the pipeline

Outputs

String