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 BlobSASSignatureValues 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.

export

Hierarchy

  • SASQueryParameters

Index

Constructors

Properties

Accessors

Methods

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, userDelegationKey?: UserDelegationKey): SASQueryParameters

  • Creates an instance of SASQueryParameters.

    memberof

    SASQueryParameters

    Parameters

    • version: string

      Representing the storage version

    • signature: string

      Representing the signature for the SAS token

    • Optional permissions: undefined | string
    • Optional services: undefined | string
    • Optional resourceTypes: undefined | string
    • Optional protocol: SASProtocol
    • Optional startsOn: Date
    • Optional expiresOn: Date
    • Optional ipRange: SasIPRange
    • Optional identifier: undefined | string
    • Optional resource: undefined | string
    • Optional cacheControl: undefined | string
    • Optional contentDisposition: undefined | string
    • Optional contentEncoding: undefined | string
    • Optional contentLanguage: undefined | string
    • Optional contentType: undefined | string
    • Optional userDelegationKey: UserDelegationKey

    Returns SASQueryParameters

Properties

Optional cacheControl

cacheControl: undefined | string

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

memberof

SASQueryParameters

Optional contentDisposition

contentDisposition: undefined | string

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

memberof

SASQueryParameters

Optional contentEncoding

contentEncoding: undefined | string

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

memberof

SASQueryParameters

Optional contentLanguage

contentLanguage: undefined | string

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

memberof

SASQueryParameters

Optional contentType

contentType: undefined | string

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

memberof

SASQueryParameters

Optional expiresOn

expiresOn: Date

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

memberof

SASQueryParameters

Optional identifier

identifier: undefined | string

Optional. The signed identifier (only for BlobSASSignatureValues).

see

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

memberof

SASQueryParameters

Optional permissions

permissions: undefined | string

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

memberof

SASQueryParameters

Optional protocol

protocol: SASProtocol

Optional. The allowed HTTP protocol(s).

memberof

SASQueryParameters

Optional resource

resource: undefined | string

Optional. The storage container or blob (only for BlobSASSignatureValues).

memberof

SASQueryParameters

Optional resourceTypes

resourceTypes: undefined | string

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

memberof

SASQueryParameters

Optional services

services: undefined | string

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

memberof

SASQueryParameters

signature

signature: string

The signature for the SAS token.

memberof

SASQueryParameters

Optional startsOn

startsOn: Date

Optional. The start time for this SAS token.

memberof

SASQueryParameters

version

version: string

The storage API version.

memberof

SASQueryParameters

Accessors

ipRange

Methods

toString

  • toString(): string

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

    memberof

    SASQueryParameters

    Returns string

Generated using TypeDoc