Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueueSASSignatureValues

Package version

ONLY AVAILABLE IN NODE.JS RUNTIME.

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

export
class

QueueSASSignatureValues

Hierarchy

  • QueueSASSignatureValues

Index

Properties

Optional expiresOn

expiresOn: Date

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

type

{Date}

memberof

QueueSASSignatureValues

Optional identifier

identifier: undefined | string

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

see

https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

type

{string}

memberof

QueueSASSignatureValues

Optional ipRange

ipRange: SasIPRange

Optional. IP ranges allowed in this SAS.

type

{SasIPRange}

memberof

QueueSASSignatureValues

Optional permissions

permissions: QueueSASPermissions

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

type

{QueueSASPermissions}

memberof

QueueSASSignatureValues

Optional protocol

protocol: SASProtocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

type

{SASProtocol}

memberof

QueueSASSignatureValues

queueName

queueName: string

The name of the queue the SAS user may access.

type

{string}

memberof

QueueSASSignatureValues

Optional startsOn

startsOn: Date

Optional. When the SAS will take effect.

type

{Date}

memberof

QueueSASSignatureValues

Optional version

version: undefined | string

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

type

{string}

memberof

QueueSASSignatureValues

Generated using TypeDoc