FileGenerateSasUrlOptions interface

Package:

@azure/storage-file-share

Options to configure generateSasUrl operation.

Extends

CommonGenerateSasUrlOptions

Properties

permissions

Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS.

Inherited 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.
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 share 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

permissions

Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS.

permissions?: FileSASPermissions

Property Value

FileSASPermissions

Inherited Property Details

cacheControl

Optional. The cache-control header for the SAS.

cacheControl?: string

Property Value

string

Inherited From CommonGenerateSasUrlOptions.cacheControl

contentDisposition

Optional. The content-disposition header for the SAS.

contentDisposition?: string

Property Value

string

Inherited From CommonGenerateSasUrlOptions.contentDisposition

contentEncoding

Optional. The content-encoding header for the SAS.

contentEncoding?: string

Property Value

string

Inherited From CommonGenerateSasUrlOptions.contentEncoding

contentLanguage

Optional. The content-language header for the SAS.

contentLanguage?: string

Property Value

string

Inherited From CommonGenerateSasUrlOptions.contentLanguage

contentType

Optional. The content-type header for the SAS.

contentType?: string

Property Value

string

Inherited From CommonGenerateSasUrlOptions.contentType

expiresOn

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

expiresOn?: Date

Property Value

Date

Inherited From CommonGenerateSasUrlOptions.expiresOn

identifier

Optional. The name of the access policy on the share 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

Inherited From CommonGenerateSasUrlOptions.identifier

ipRange

Optional. IP ranges allowed in this SAS.

ipRange?: SasIPRange

Property Value

SasIPRange

Inherited From CommonGenerateSasUrlOptions.ipRange

protocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

protocol?: SASProtocol

Property Value

SASProtocol

Inherited From CommonGenerateSasUrlOptions.protocol

startsOn

Optional. When the SAS will take effect.

startsOn?: Date

Property Value

Date

Inherited From CommonGenerateSasUrlOptions.startsOn

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

Inherited From CommonGenerateSasUrlOptions.version