Package version:

Interface FileSASSignatureValues

ONLY AVAILABLE IN NODE.JS RUNTIME.

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

interface FileSASSignatureValues {
    cacheControl?: string;
    contentDisposition?: string;
    contentEncoding?: string;
    contentLanguage?: string;
    contentType?: string;
    expiresOn?: Date;
    filePath?: string;
    identifier?: string;
    ipRange?: SasIPRange;
    permissions?: FileSASPermissions | ShareSASPermissions;
    protocol?: SASProtocol;
    shareName: string;
    startsOn?: Date;
    version?: string;
}

Properties

cacheControl? contentDisposition? contentEncoding? contentLanguage? contentType? expiresOn? filePath? identifier? ipRange? permissions? protocol? shareName startsOn? version?

Properties

OptionalcacheControl

cacheControl?: string

Optional. The cache-control header for the SAS.

OptionalcontentDisposition

contentDisposition?: string

Optional. The content-disposition header for the SAS.

OptionalcontentEncoding

contentEncoding?: string

Optional. The content-encoding header for the SAS.

OptionalcontentLanguage

contentLanguage?: string

Optional. The content-language header for the SAS.

OptionalcontentType

contentType?: string

Optional. The content-type header for the SAS.

OptionalexpiresOn

expiresOn?: Date

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

OptionalfilePath

filePath?: string

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

Optionalidentifier

identifier?: string

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

See

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

OptionalipRange

ipRange?: SasIPRange

Optional. IP ranges allowed in this SAS.

Optionalpermissions

permissions?: FileSASPermissions | ShareSASPermissions

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.

Optionalprotocol

protocol?: SASProtocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

shareName

shareName: string

The name of the share the SAS user may access.

OptionalstartsOn

startsOn?: Date

Optional. When the SAS will take effect.

Optionalversion

version?: string

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

Settings

Member Visibility