Share via

SASQueryParameters class

  • Reference
Package:
@azure/storage-file

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 <xref:IAccountSASSignatureValues> and <xref:IFileSASSignatureValues> types. Once generated, it can be encoded into a {@code String} 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, undefined | string, undefined | string, undefined | string, SASProtocol, Date, Date, IIPRange, undefined | string, undefined | string, undefined | string, undefined | string, undefined | string, undefined | string, undefined | 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.
expiryTime

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

Optional. The signed identifier (only for <xref:IFileSASSignatureValues>).
ipRange

Optional. IP range allowed for this SAS.
permissions

Optional only when identifier is provided. Please refer to <xref:AccountSASPermissions>, <xref:FileSASPermissions>, or <xref:ShareSASPermissions> for more details.
protocol

Optional. The allowed HTTP protocol(s).
resource

Optional. The storage share or file path (only for <xref:IFileSASSignatureValues>).
resourceTypes

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

Optional. The storage services being accessed (only for Account SAS). Please refer to <xref:AccountSASServices> for more details.
signature

The signature for the SAS token.
startTime

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

SASQueryParameters(string, string, undefined | string, undefined | string, undefined | string, SASProtocol, Date, Date, IIPRange, undefined | string, undefined | string, undefined | string, undefined | string, undefined | string, undefined | string, undefined | string)

Creates an instance of SASQueryParameters.

new SASQueryParameters(version: string, signature: string, permissions?: undefined | string, services?: undefined | string, resourceTypes?: undefined | string, protocol?: SASProtocol, startTime?: Date, expiryTime?: Date, ipRange?: IIPRange, identifier?: undefined | string, resource?: undefined | string, cacheControl?: undefined | string, contentDisposition?: undefined | string, contentEncoding?: undefined | string, contentLanguage?: undefined | string, contentType?: undefined | string)

Parameters

version

string

Representing the storage version

signature

string

Representing the signature for the SAS token

permissions

undefined | string

services

undefined | string

resourceTypes

undefined | string

protocol
SASProtocol
startTime

Date

expiryTime

Date

ipRange
IIPRange
identifier

undefined | string

resource

undefined | string

cacheControl

undefined | string

contentDisposition

undefined | string

contentEncoding

undefined | string

contentLanguage

undefined | string

contentType

undefined | string

Property Details

cacheControl

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

cacheControl?: undefined | string

Property Value

undefined | string

contentDisposition

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

contentDisposition?: undefined | string

Property Value

undefined | string

contentEncoding

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

contentEncoding?: undefined | string

Property Value

undefined | string

contentLanguage

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

contentLanguage?: undefined | string

Property Value

undefined | string

contentType

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

contentType?: undefined | string

Property Value

undefined | string

expiryTime

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

expiryTime?: Date

Property Value

Date

identifier

Optional. The signed identifier (only for <xref:IFileSASSignatureValues>).

identifier?: undefined | string

Property Value

undefined | string

ipRange

Optional. IP range allowed for this SAS.

ipRange: IIPRange | undefined

Property Value

IIPRange | undefined

permissions

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

permissions?: undefined | string

Property Value

undefined | string

protocol

Optional. The allowed HTTP protocol(s).

protocol?: SASProtocol

Property Value

SASProtocol

resource

Optional. The storage share or file path (only for <xref:IFileSASSignatureValues>).

resource?: undefined | string

Property Value

undefined | string

resourceTypes

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

resourceTypes?: undefined | string

Property Value

undefined | string

services

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

services?: undefined | string

Property Value

undefined | string

signature

The signature for the SAS token.

signature: string

Property Value

string

startTime

Optional. The start time for this SAS token.

startTime?: Date

Property Value

Date

version

The storage API version.

version: string

Property Value

string

Method Details

toString()

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

function toString()

Returns

string