Package version:

Interface SASQueryParametersOptions

Options to construct SASQueryParameters.

interface SASQueryParametersOptions {
    cacheControl?: string;
    contentDisposition?: string;
    contentEncoding?: string;
    contentLanguage?: string;
    contentType?: string;
    correlationId?: string;
    delegatedUserObjectId?: string;
    encryptionScope?: string;
    expiresOn?: any;
    identifier?: string;
    ipRange?: SasIPRange;
    permissions?: string;
    preauthorizedAgentObjectId?: string;
    protocol?: SASProtocol;
    resource?: string;
    resourceTypes?: string;
    services?: string;
    startsOn?: any;
    userDelegationKey?: any;
}

Properties

cacheControl? contentDisposition? contentEncoding? contentLanguage? contentType? correlationId? delegatedUserObjectId? encryptionScope? expiresOn? identifier? ipRange? permissions? preauthorizedAgentObjectId? protocol? resource? resourceTypes? services? startsOn? userDelegationKey?

Properties

OptionalcacheControl

cacheControl?: string

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

OptionalcontentDisposition

contentDisposition?: string

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

OptionalcontentEncoding

contentEncoding?: string

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

OptionalcontentLanguage

contentLanguage?: string

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

OptionalcontentType

contentType?: string

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

OptionalcorrelationId

correlationId?: 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.

OptionaldelegatedUserObjectId

delegatedUserObjectId?: string

Optional. Beginning in version 2025-07-05, this value specifies the Entra ID of the user would is authorized to use the resulting SAS URL. The resulting SAS URL must be used in conjunction with an Entra ID token that has been issued to the user specified in this value.

OptionalencryptionScope

encryptionScope?: string

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

OptionalexpiresOn

expiresOn?: any

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

Optionalidentifier

identifier?: string

Optional. The signed identifier (only for BlobSASSignatureValues).

See

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

OptionalipRange

ipRange?: SasIPRange

Optional. IP ranges allowed in this SAS.

Optionalpermissions

permissions?: string

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

OptionalpreauthorizedAgentObjectId

preauthorizedAgentObjectId?: 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 signedUnauthorizedUserObjectId. This is only used for User Delegation SAS.

Optionalprotocol

protocol?: SASProtocol

Optional. The allowed HTTP protocol(s).

Optionalresource

resource?: string

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

See

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

OptionalresourceTypes

resourceTypes?: string

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

Optionalservices

services?: string

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

OptionalstartsOn

startsOn?: any

Optional. The start time for this SAS token.

OptionaluserDelegationKey

userDelegationKey?: any

User delegation key properties.

Settings

Member Visibility