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

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, preauthorizedAgentObjectId?: undefined | string, correlationId?: undefined | string, encryptionScope?: undefined | string): SASQueryParameters
  • new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions): 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)

    • Optional userDelegationKey: UserDelegationKey

      Representing the user delegation key properties

    • Optional preauthorizedAgentObjectId: undefined | string

      Representing the authorized AAD Object ID (only for User Delegation SAS)

    • Optional correlationId: undefined | string

      Representing the correlation ID (only for User Delegation SAS)

    • Optional encryptionScope: undefined | string

      -

    Returns SASQueryParameters

  • Creates an instance of SASQueryParameters.

    Parameters

    • version: string

      Representing the storage version

    • signature: string

      Representing the signature for the SAS token

    • Optional options: SASQueryParametersOptions

      Optional. Options to construct the SASQueryParameters.

    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 correlationId

correlationId: undefined | string

A GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access. This is only used for User Delegation SAS.

Optional encryptionScope

encryptionScope: undefined | string

Optional. Encryption scope to use when sending requests authorized with this SAS URI.

Optional expiresOn

expiresOn: Date

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

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

Optional permissions

permissions: undefined | string

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

Optional preauthorizedAgentObjectId

preauthorizedAgentObjectId: undefined | string

Authorized AAD Object ID in GUID format. The AAD Object ID of a user authorized by the owner of the User Delegation Key to perform the action granted by the SAS. The Azure Storage service will ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission check for the user specified in this value will be performed. This is only used for User Delegation SAS.

Optional protocol

protocol: SASProtocol

Optional. The allowed HTTP protocol(s).

Optional resource

resource: undefined | string

Optional. Specifies which resources are accessible via the SAS (only for BlobSASSignatureValues).

see

https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

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

Generated using TypeDoc