Share via

FileSASSignatureValues interface

  • Reference
Package:
@azure/storage-file-share

ONLY AVAILABLE IN NODE.JS RUNTIME.

FileSASSignatureValues 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.
expiresOn

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.

See https://docs.microsoft.com/en-us/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 either ShareSASPermissions or 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.
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

cacheControl

Optional. The cache-control header for the SAS.

cacheControl?: string

Property Value

string

contentDisposition

Optional. The content-disposition header for the SAS.

contentDisposition?: string

Property Value

string

contentEncoding

Optional. The content-encoding header for the SAS.

contentEncoding?: string

Property Value

string

contentLanguage

Optional. The content-language header for the SAS.

contentLanguage?: string

Property Value

string

contentType

Optional. The content-type header for the SAS.

contentType?: 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

filePath

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

filePath?: string

Property Value

string

identifier

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

See https://docs.microsoft.com/en-us/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 either ShareSASPermissions or FileSASPermissions depending on the resource being accessed for help constructing the permissions string.

permissions?: FileSASPermissions | ShareSASPermissions

Property Value

FileSASPermissions | ShareSASPermissions

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

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