IBlobSASSignatureValues interface

Package:

@azure/storage-blob

ONLY AVAILABLE IN NODE.JS RUNTIME. IBlobSASSignatureValues 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 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.
expiryTime	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.
ipRange	Optional. IP ranges allowed in this SAS.
permissions	Optional only when identifier is provided. Please refer to either <xref:ContainerSASPermissions> or <xref:BlobSASPermissions> depending on the resource being accessed for help constructing the permissions string.
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.
startTime	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.

Property Details

blobName

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

blobName?: undefined | string

Property Value

undefined | string

cacheControl

Optional. The cache-control header for the SAS.

cacheControl?: undefined | string

Property Value

undefined | 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?: undefined | string

Property Value

undefined | string

contentEncoding

Optional. The content-encoding header for the SAS.

contentEncoding?: undefined | string

Property Value

undefined | string

contentLanguage

Optional. The content-language header for the SAS.

contentLanguage?: undefined | string

Property Value

undefined | string

contentType

Optional. The content-type header for the SAS.

contentType?: undefined | string

Property Value

undefined | string

expiryTime

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

expiryTime?: Date

Property Value

Date

identifier

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

identifier?: undefined | string

Property Value

undefined | string

ipRange

Optional. IP ranges allowed in this SAS.

ipRange?: IIPRange

Property Value

IIPRange

permissions

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

permissions?: undefined | string

Property Value

undefined | 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?: undefined | string

Property Value

undefined | string

startTime

Optional. When the SAS will take effect.

startTime?: 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?: undefined | string

Property Value

undefined | string