Share via

BlobSASSignatureValues interface

  • Reference
Package:
@azure/storage-blob

ONLY AVAILABLE IN NODE.JS RUNTIME.

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

Properties

blobName

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

Optional. The cache-control header for the SAS.
containerName

The name of the container the SAS user may access.
contentDisposition

Optional. The content-disposition header for the SAS.
contentEncoding

Optional. The content-encoding header for the SAS.
contentLanguage

Optional. The content-language header for the SAS.
contentType

Optional. The content-type header for the SAS.
correlationId

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

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

Optional only when identifier is provided. The time after which the SAS will no longer work.
identifier

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

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

Optional. IP ranges allowed in this SAS.
permissions

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

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

Optional. SAS protocols, HTTPS only or HTTPSandHTTP
snapshotTime

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

Optional. When the SAS will take effect.
version

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

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

Property Details

blobName

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

blobName?: string

Property Value

string

cacheControl

Optional. The cache-control header for the SAS.

cacheControl?: string

Property Value

string

containerName

The name of the container the SAS user may access.

containerName: string

Property Value

string

contentDisposition

Optional. The content-disposition header for the SAS.

contentDisposition?: string

Property Value

string

contentEncoding

Optional. The content-encoding header for the SAS.

contentEncoding?: string

Property Value

string

contentLanguage

Optional. The content-language header for the SAS.

contentLanguage?: string

Property Value

string

contentType

Optional. The content-type header for the SAS.

contentType?: string

Property Value

string

correlationId

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.

correlationId?: string

Property Value

string

encryptionScope

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

encryptionScope?: string

Property Value

string

expiresOn

Optional only when identifier is provided. The time after which the SAS will no longer work.

expiresOn?: Date

Property Value

Date

identifier

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

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

identifier?: string

Property Value

string

ipRange

Optional. IP ranges allowed in this SAS.

ipRange?: SasIPRange

Property Value

SasIPRange

permissions

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.

permissions?: BlobSASPermissions | ContainerSASPermissions

Property Value

BlobSASPermissions | ContainerSASPermissions

preauthorizedAgentObjectId

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.

preauthorizedAgentObjectId?: string

Property Value

string

protocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

protocol?: SASProtocol

Property Value

SASProtocol

snapshotTime

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

snapshotTime?: string

Property Value

string

startsOn

Optional. When the SAS will take effect.

startsOn?: Date

Property Value

Date

version

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

version?: string

Property Value

string

versionId

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

versionId?: string

Property Value

string