IAccountSASSignatureValues interface

Package:

@azure/storage-file

ONLY AVAILABLE IN NODE.JS RUNTIME.

IAccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set appropriately, call generateSASQueryParameters() to obtain a representation of the SAS which can actually be applied to file urls. Note: that both this class and SASQueryParameters exist because the former is mutable and a logical representation while the latter is immutable and used to generate actual REST requests.

See https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 for more conceptual information on SAS See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas for descriptions of the parameters, including which are required

Properties

expiryTime	The time after which the SAS will no longer work.
ipRange	Optional. IP range allowed.
permissions	Specifies which operations the SAS user may perform. Please refer to AccountSASPermissions for help constructing the permissions string.
protocol	Optional. SAS protocols allowed.
resourceTypes	The values that indicate the resource types accessible with this SAS. Please refer to AccountSASResourceTypes to construct this value.
services	The values that indicate the services accessible with this SAS. Please refer to AccountSASServices to construct this value.
startTime	Optional. When the SAS will take effect.
version	If not provided, this defaults to the service version targeted by this version of the library.

Property Details

expiryTime

The time after which the SAS will no longer work.

expiryTime: Date

Property Value

Date

ipRange

Optional. IP range allowed.

ipRange?: IIPRange

Property Value

IIPRange

permissions

Specifies which operations the SAS user may perform. Please refer to AccountSASPermissions for help constructing the permissions string.

permissions: string

Property Value

string

protocol

Optional. SAS protocols allowed.

protocol?: SASProtocol

Property Value

SASProtocol

resourceTypes

The values that indicate the resource types accessible with this SAS. Please refer to AccountSASResourceTypes to construct this value.

resourceTypes: string

Property Value

string

services

The values that indicate the services accessible with this SAS. Please refer to AccountSASServices to construct this value.

services: string

Property Value

string

startTime

Optional. When the SAS will take effect.

startTime?: Date

Property Value

Date

version

If not provided, this defaults to the service version targeted by this version of the library.

version?: string

Property Value

string