SASQueryParameters class

Reference

Package:: @azure/storage-file-share

Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly by the user; it is only generated by the AccountSASSignatureValues and FileSASSignatureValues types. Once generated, it can be encoded into a toString() and appended to a URL directly (though caution should be taken here in case there are existing query parameters, which might affect the appropriate means of appending these query parameters).

NOTE: Instances of this class are immutable.

Constructors

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string)

Creates an instance of SASQueryParameters.

Properties

cacheControl	Value for cache-control header in Blob/File Service SAS.
contentDisposition	Value for content-disposition header in Blob/File Service SAS.
contentEncoding	Value for content-encoding header in Blob/File Service SAS.
contentLanguage	Value for content-length header in Blob/File Service SAS.
contentType	Value for content-type header in Blob/File Service SAS.
expiresOn	Optional only when identifier is provided. The expiry time for this SAS token.
identifier	Optional. The signed identifier (only for FileSASSignatureValues). See https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Optional. IP range allowed for this SAS.
permissions	Optional only when identifier is provided. Please refer to AccountSASPermissions, FileSASPermissions, or ShareSASPermissions for more details.
protocol	Optional. The allowed HTTP protocol(s).
resource	Optional. The storage share or file path (only for FileSASSignatureValues).
resourceTypes	Optional. The storage resource types being accessed (only for Account SAS). Please refer to AccountSASResourceTypes for more details.
services	Optional. The storage services being accessed (only for Account SAS). Please refer to AccountSASServices for more details.
signature	The signature for the SAS token.
startsOn	Optional. The start time for this SAS token.
version	The storage API version.

Methods

toString()

Encodes all SAS query parameters into a string that can be appended to a URL.

Constructor Details

Creates an instance of SASQueryParameters.

new SASQueryParameters(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string, cacheControl?: string, contentDisposition?: string, contentEncoding?: string, contentLanguage?: string, contentType?: string)

Parameters

version: string

Representing the storage version

signature: string

Representing the signature for the SAS token

permissions: string

Representing the storage permissions

services: string

Representing the storage services being accessed (only for Account SAS)

resourceTypes: string

Representing the storage resource types being accessed (only for Account SAS)

protocol: SASProtocol

Representing the allowed HTTP protocol(s)

startsOn: Date

Representing the start time for this SAS token

expiresOn: Date

Representing the expiry time for this SAS token

ipRange: SasIPRange

Representing the range of valid IP addresses for this SAS token

identifier: string

Representing the signed identifier (only for Service SAS)

resource: string

Representing the storage container or blob (only for Service SAS)

cacheControl: string

Representing the cache-control header (only for Blob/File Service SAS)

contentDisposition: string

Representing the content-disposition header (only for Blob/File Service SAS)

contentEncoding: string

Representing the content-encoding header (only for Blob/File Service SAS)

contentLanguage: string

Representing the content-language header (only for Blob/File Service SAS)

contentType: string

Representing the content-type header (only for Blob/File Service SAS)

Property Details

Value for cache-control header in Blob/File Service SAS.

cacheControl?: string

Property Value

string

Value for content-disposition header in Blob/File Service SAS.

contentDisposition?: string

Property Value

string

Value for content-encoding header in Blob/File Service SAS.

contentEncoding?: string

Property Value

string

Value for content-length header in Blob/File Service SAS.

contentLanguage?: string

Property Value

string

Value for content-type header in Blob/File Service SAS.

contentType?: string

Property Value

string

Optional only when identifier is provided. The expiry time for this SAS token.

expiresOn?: Date

Property Value

Date

Optional. The signed identifier (only for FileSASSignatureValues).

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

identifier?: string

Property Value

string

Optional. IP range allowed for this SAS.

undefined | SasIPRange ipRange

Property Value

undefined | SasIPRange

Optional only when identifier is provided. Please refer to AccountSASPermissions, FileSASPermissions, or ShareSASPermissions for more details.

permissions?: string

Property Value

string

Optional. The allowed HTTP protocol(s).

protocol?: SASProtocol

Property Value

SASProtocol

Optional. The storage share or file path (only for FileSASSignatureValues).

resource?: string

Property Value

string

Optional. The storage resource types being accessed (only for Account SAS). Please refer to AccountSASResourceTypes for more details.

resourceTypes?: string

Property Value

string

Optional. The storage services being accessed (only for Account SAS). Please refer to AccountSASServices for more details.

services?: string

Property Value

string

The signature for the SAS token.

signature: string

Property Value

string

Optional. The start time for this SAS token.

startsOn?: Date

Property Value

Date

The storage API version.

version: string

Property Value

string

Method Details

Encodes all SAS query parameters into a string that can be appended to a URL.

function toString(): string

Returns

string

SASQueryParameters class

Constructors

Properties

Methods

Constructor Details

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string)

Parameters

Property Details

cacheControl

Property Value

contentDisposition

Property Value

contentEncoding

Property Value

contentLanguage

Property Value

contentType

Property Value

expiresOn

Property Value

identifier

Property Value

ipRange

Property Value

permissions

Property Value

protocol

Property Value

resource

Property Value

resourceTypes

Property Value

services

Property Value

signature

Property Value

startsOn

Property Value

version

Property Value

Method Details

toString()

Returns

Additional resources