QueueGenerateSasUrlOptions interface

Package:

@azure/storage-queue

Options to configure <xref:QueueClient.generateSasUrl> operation.

Properties

expiresOn	Optional only when identifier is provided. The time after which the SAS will no longer work.
identifier	Optional. The name of the access policy on the queue this SAS references if any.
ipRange	Optional. IP ranges allowed in this SAS.
permissions	Optional only when identifier is provided. Please refer to <xref:QueueSASPermissions> for help constructing the permissions string.
protocol	Optional. SAS protocols, HTTPS only or HTTPSandHTTP
startsOn	Optional. When the SAS will take effect.
version	The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

Property Details

expiresOn

Optional only when identifier is provided. The time after which the SAS will no longer work.

expiresOn?: Date

Property Value

Date

identifier

Optional. The name of the access policy on the queue this SAS references if any.

identifier?: string

Property Value

string

ipRange

Optional. IP ranges allowed in this SAS.

ipRange?: SasIPRange

Property Value

SasIPRange

permissions

Optional only when identifier is provided. Please refer to <xref:QueueSASPermissions> for help constructing the permissions string.

permissions?: QueueSASPermissions

Property Value

QueueSASPermissions

protocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

protocol?: SASProtocol

Property Value

SASProtocol

startsOn

Optional. When the SAS will take effect.

startsOn?: Date

Property Value

Date

version

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

version?: string

Property Value

string