Share via

CommonGenerateSasUrlOptions interface

  • Reference
Package:
@azure/storage-blob

Common options of BlobGenerateSasUrlOptions and ContainerGenerateSasUrlOptions.

Properties

cacheControl

Optional. The cache-control header for the SAS.
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.
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.
protocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP
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.

Property Details

cacheControl

Optional. The cache-control header for the SAS.

cacheControl?: 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

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

protocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

protocol?: SASProtocol

Property Value

SASProtocol

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