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 {@link 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, directoryDepth?: undefined | number, preauthorizedAgentObjectId?: undefined | string, agentObjectId?: undefined | string, correlationId?: undefined | string): SASQueryParameters
  • new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions): 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
    • Optional directoryDepth: undefined | number
    • Optional preauthorizedAgentObjectId: undefined | string
    • Optional agentObjectId: undefined | string
    • Optional correlationId: undefined | string

    Returns 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 options: SASQueryParametersOptions

    Returns SASQueryParameters

Properties

Optional agentObjectId

agentObjectId: undefined | string

Unauthorized AAD Object ID in GUID format. The AAD Object ID of a user that is assumed to be unauthorized by the owner of the User Delegation Key. The Azure Storage Service will perform an additional POSIX ACL check to determine if the user is authorized to perform the requested operation. This cannot be used in conjuction with {@link signedAuthorizedUserObjectId}. This is only used for User Delegation SAS.

memberof

SASQueryParameters

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

memberof

SASQueryParameters

Optional directoryDepth

directoryDepth: undefined | number

Indicate the depth of the directory specified in the canonicalizedresource field of the string-to-sign. The depth of the directory is the number of directories beneath the root folder.

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 {@link 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, {@link BlobSASPermissions}, or {@link ContainerSASPermissions} for more details.

memberof

SASQueryParameters

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 cannot be used in conjuction with {@link signedUnauthorizedUserObjectId}. This is only used for User Delegation SAS.

memberof

SASQueryParameters

Optional protocol

protocol: SASProtocol

Optional. The allowed HTTP protocol(s).

memberof

SASQueryParameters

Optional resource

resource: undefined | string

Optional. Specifies which resources are accessible via the SAS (only for {@link BlobSASSignatureValues}).

see

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

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

Generated using TypeDoc