FileSASSignatureValues | @azure/storage-file-share

ONLY AVAILABLE IN NODE.JS RUNTIME.

FileSASSignatureValues is used to help generating File service SAS tokens for shares or files.

export

Hierarchy

FileSASSignatureValues

Index

Properties

Optional cacheControl

cacheControl: undefined | string

Optional. The cache-control header for the SAS.

memberof: FileSASSignatureValues

Optional contentDisposition

contentDisposition: undefined | string

Optional. The content-disposition header for the SAS.

memberof: FileSASSignatureValues

Optional contentEncoding

contentEncoding: undefined | string

Optional. The content-encoding header for the SAS.

memberof: FileSASSignatureValues

Optional contentLanguage

contentLanguage: undefined | string

Optional. The content-language header for the SAS.

memberof: FileSASSignatureValues

Optional contentType

contentType: undefined | string

Optional. The content-type header for the SAS.

memberof: FileSASSignatureValues

Optional expiresOn

expiresOn: Date

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

memberof: FileSASSignatureValues

Optional filePath

filePath: undefined | string

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

memberof: FileSASSignatureValues

Optional identifier

identifier: undefined | string

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
memberof: FileSASSignatureValues

Optional ipRange

ipRange: SasIPRange

Optional. IP ranges allowed in this SAS.

memberof: FileSASSignatureValues

Optional permissions

permissions: FileSASPermissions

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.

memberof: FileSASSignatureValues

Optional protocol

protocol: SASProtocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

memberof: FileSASSignatureValues

shareName

shareName: string

The name of the share the SAS user may access.

memberof: FileSASSignatureValues

Optional startsOn

startsOn: Date

Optional. When the SAS will take effect.

memberof: FileSASSignatureValues

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.

memberof: FileSASSignatureValues