Package version:

Interface BlobSASSignatureValues

ONLY AVAILABLE IN NODE.JS RUNTIME.

BlobSASSignatureValues is used to help generating Blob service SAS tokens for containers or blobs.

interface BlobSASSignatureValues {
    blobName?: string;
    cacheControl?: string;
    containerName: string;
    contentDisposition?: string;
    contentEncoding?: string;
    contentLanguage?: string;
    contentType?: string;
    correlationId?: string;
    delegatedUserObjectId?: string;
    encryptionScope?: string;
    expiresOn?: any;
    identifier?: string;
    ipRange?: SasIPRange;
    permissions?: BlobSASPermissions | ContainerSASPermissions;
    preauthorizedAgentObjectId?: string;
    protocol?: SASProtocol;
    snapshotTime?: string;
    startsOn?: any;
    version?: string;
    versionId?: string;
}

Properties

blobName? cacheControl? containerName contentDisposition? contentEncoding? contentLanguage? contentType? correlationId? delegatedUserObjectId? encryptionScope? expiresOn? identifier? ipRange? permissions? preauthorizedAgentObjectId? protocol? snapshotTime? startsOn? version? versionId?

Properties

OptionalblobName

blobName?: string

Optional. The blob name of the SAS user may access. Required if snapshotTime or versionId is provided.

OptionalcacheControl

cacheControl?: string

Optional. The cache-control header for the SAS.

containerName

containerName: string

The name of the container the SAS user may access.

OptionalcontentDisposition

contentDisposition?: string

Optional. The content-disposition header for the SAS.

OptionalcontentEncoding

contentEncoding?: string

Optional. The content-encoding header for the SAS.

OptionalcontentLanguage

contentLanguage?: string

Optional. The content-language header for the SAS.

OptionalcontentType

contentType?: string

Optional. The content-type header for the SAS.

OptionalcorrelationId

correlationId?: string

Optional. Beginning in version 2020-02-10, this is 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 time after which the SAS will no longer work.

Optionalidentifier

identifier?: string

Optional. The name of the access policy on the container this SAS references if any.

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?: BlobSASPermissions | ContainerSASPermissions

Optional only when identifier is provided. Please refer to either ContainerSASPermissions or BlobSASPermissions depending on the resource being accessed for help constructing the permissions string.

OptionalpreauthorizedAgentObjectId

preauthorizedAgentObjectId?: string

Optional. Beginning in version 2020-02-10, specifies the 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.

Optionalprotocol

protocol?: SASProtocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

OptionalsnapshotTime

snapshotTime?: string

Optional. Snapshot timestamp string the SAS user may access. Only supported from API version 2018-11-09.

OptionalstartsOn

startsOn?: any

Optional. When the SAS will take effect.

Optionalversion

version?: string

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

OptionalversionId

versionId?: string

Optional. VersionId of the blob version the SAS user may access. Only supported from API version 2019-10-10.

Settings

Member Visibility