IFileSASSignatureValues interface

Package:

@azure/storage-file

ONLY AVAILABLE IN NODE.JS RUNTIME. IFileSASSignatureValues is used to help generating File service SAS tokens for shares or files.

Properties

cacheControl	Optional. The cache-control header for the SAS.
contentDisposition	Optional. The content-disposition header for the SAS.
contentEncoding	Optional. The content-encoding header for the SAS.
contentLanguage	Optional. The content-language header for the SAS.
contentType	Optional. The content-type header for the SAS.
expiryTime	Optional only when identifier is provided. The time after which the SAS will no longer work.
filePath	Optional. The path of the file like, "directory/FileName" or "FileName".
identifier	Optional. The name of the access policy on the share this SAS references if any.
ipRange	Optional. IP ranges allowed in this SAS.
permissions	Optional only when identifier is provided. Please refer to either <xref:ShareSASPermissions> or <xref:FileSASPermissions> depending on the resource being accessed for help constructing the permissions string.
protocol	Optional. SAS protocols, HTTPS only or HTTPSandHTTP
shareName	The name of the share the SAS user may access.
startTime	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

cacheControl

Optional. The cache-control header for the SAS.

cacheControl?: undefined | string

Property Value

undefined | string

contentDisposition

Optional. The content-disposition header for the SAS.

contentDisposition?: undefined | string

Property Value

undefined | string

contentEncoding

Optional. The content-encoding header for the SAS.

contentEncoding?: undefined | string

Property Value

undefined | string

contentLanguage

Optional. The content-language header for the SAS.

contentLanguage?: undefined | string

Property Value

undefined | string

contentType

Optional. The content-type header for the SAS.

contentType?: undefined | string

Property Value

undefined | string

expiryTime

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

expiryTime?: Date

Property Value

Date

filePath

Optional. The path of the file like, "directory/FileName" or "FileName".

filePath?: undefined | string

Property Value

undefined | string

identifier

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

identifier?: undefined | string

Property Value

undefined | string

ipRange

Optional. IP ranges allowed in this SAS.

ipRange?: IIPRange

Property Value

IIPRange

permissions

Optional only when identifier is provided. Please refer to either <xref:ShareSASPermissions> or <xref:FileSASPermissions> depending on the resource being accessed for help constructing the permissions string.

permissions?: undefined | string

Property Value

undefined | string

protocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

protocol?: SASProtocol

Property Value

SASProtocol

shareName

The name of the share the SAS user may access.

shareName: string

Property Value

string

startTime

Optional. When the SAS will take effect.

startTime?: 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?: undefined | string

Property Value

undefined | string