Package version:

Class SASQueryParameters

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

constructor

Properties

cacheControl? contentDisposition? contentEncoding? contentLanguage? contentType? expiresOn? identifier? permissions? protocol? resource? resourceTypes? services? signature startsOn? version

Accessors

ipRange

Methods

toString

Constructors

constructor

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

  • Creates an instance of SASQueryParameters.

    Parameters

    • version: string

      Representing the storage version

    • signature: string

      Representing the signature for the SAS token

    • Optionalpermissions: string

      Representing the storage permissions

    • Optionalservices: string

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

    • OptionalresourceTypes: string

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

    • Optionalprotocol: SASProtocol

      Representing the allowed HTTP protocol(s)

    • OptionalstartsOn: Date

      Representing the start time for this SAS token

    • OptionalexpiresOn: Date

      Representing the expiry time for this SAS token

    • OptionalipRange: SasIPRange

      Representing the range of valid IP addresses for this SAS token

    • Optionalidentifier: string

      Representing the signed identifier (only for Service SAS)

    • Optionalresource: string

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

    • OptionalcacheControl: string

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

    • OptionalcontentDisposition: string

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

    • OptionalcontentEncoding: string

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

    • OptionalcontentLanguage: string

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

    • OptionalcontentType: string

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

    Returns SASQueryParameters

Properties

Optional ReadonlycacheControl

cacheControl?: string

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

Optional ReadonlycontentDisposition

contentDisposition?: string

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

Optional ReadonlycontentEncoding

contentEncoding?: string

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

Optional ReadonlycontentLanguage

contentLanguage?: string

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

Optional ReadonlycontentType

contentType?: string

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

Optional ReadonlyexpiresOn

expiresOn?: Date

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

Optional Readonlyidentifier

identifier?: string

Optional. The signed identifier (only for FileSASSignatureValues).

See

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

Optional Readonlypermissions

permissions?: string

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

Optional Readonlyprotocol

protocol?: SASProtocol

Optional. The allowed HTTP protocol(s).

Optional Readonlyresource

resource?: string

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

Optional ReadonlyresourceTypes

resourceTypes?: string

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

Optional Readonlyservices

services?: string

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

Readonlysignature

signature: string

The signature for the SAS token.

Optional ReadonlystartsOn

startsOn?: Date

Optional. The start time for this SAS token.

Readonlyversion

version: string

The storage API version.

Accessors

ipRange

Methods

toString

Settings

Member Visibility