Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SASQueryParameters

Package version

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 {@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.

Hierarchy

  • SASQueryParameters

Index

Constructors

constructor

  • new SASQueryParameters(version: string, signature: string, permissions?: undefined | string, services?: undefined | string, resourceTypes?: undefined | string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: undefined | string, resource?: undefined | string, cacheControl?: undefined | string, contentDisposition?: undefined | string, contentEncoding?: undefined | string, contentLanguage?: undefined | string, contentType?: undefined | string): SASQueryParameters
  • Creates an instance of SASQueryParameters.

    Parameters

    • version: string

      Representing the storage version

    • signature: string

      Representing the signature for the SAS token

    • Optional permissions: undefined | string

      Representing the storage permissions

    • Optional services: undefined | string

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

    • Optional resourceTypes: undefined | string

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

    • Optional protocol: SASProtocol

      Representing the allowed HTTP protocol(s)

    • Optional startsOn: Date

      Representing the start time for this SAS token

    • Optional expiresOn: Date

      Representing the expiry time for this SAS token

    • Optional ipRange: SasIPRange

      Representing the range of valid IP addresses for this SAS token

    • Optional identifier: undefined | string

      Representing the signed identifier (only for Service SAS)

    • Optional resource: undefined | string

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

    • Optional cacheControl: undefined | string

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

    • Optional contentDisposition: undefined | string

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

    • Optional contentEncoding: undefined | string

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

    • Optional contentLanguage: undefined | string

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

    • Optional contentType: undefined | string

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

    Returns SASQueryParameters

Properties

Optional cacheControl

cacheControl: undefined | string

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

Optional contentDisposition

contentDisposition: undefined | string

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

Optional contentEncoding

contentEncoding: undefined | string

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

Optional contentLanguage

contentLanguage: undefined | string

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

Optional contentType

contentType: undefined | string

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

Optional expiresOn

expiresOn: Date

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

Optional identifier

identifier: undefined | string

Optional permissions

permissions: undefined | string

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

Optional protocol

protocol: SASProtocol

Optional. The allowed HTTP protocol(s).

Optional resource

resource: undefined | string

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

Optional resourceTypes

resourceTypes: undefined | string

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

Optional services

services: undefined | string

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

signature

signature: string

The signature for the SAS token.

Optional startsOn

startsOn: Date

Optional. The start time for this SAS token.

version

version: string

The storage API version.

Accessors

ipRange

Methods

toString

  • toString(): string
  • Encodes all SAS query parameters into a string that can be appended to a URL.

    Returns string

Generated using TypeDoc