Share via

QueueSASSignatureValues interface

Package:
@azure/storage-queue

ONLY AVAILABLE IN NODE.JS RUNTIME.

QueueSASSignatureValues is used to help generating Queue service SAS tokens for queues.

Properties

delegatedUserObjectId

Optional. Beginning in version 2025-07-05, this value specifies the Entra ID of the user who is authorized to use the resulting SAS URL. The resulting SAS URL must be used in conjunction with an Entra ID token that has been issued to the user specified in this value.
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.

See https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
ipRange

Optional. IP ranges allowed in this SAS.
permissions

Optional only when identifier is provided. Please refer to QueueSASPermissions being accessed for help constructing the permissions string.
protocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP
queueName

The name of the queue the SAS user may access.
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

delegatedUserObjectId

Optional. Beginning in version 2025-07-05, this value specifies the Entra ID of the user who is authorized to use the resulting SAS URL. The resulting SAS URL must be used in conjunction with an Entra ID token that has been issued to the user specified in this value.

delegatedUserObjectId?: string

Property Value

string

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.

See https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy

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 QueueSASPermissions being accessed for help constructing the permissions string.

permissions?: QueueSASPermissions

Property Value

QueueSASPermissions

protocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

protocol?: SASProtocol

Property Value

SASProtocol

queueName

The name of the queue the SAS user may access.

queueName: string

Property Value

string

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