SASQueryParametersOptions | @azure/storage-blob

Options to construct SASQueryParameters.

Hierarchy

SASQueryParametersOptions

Index

Properties

Optional cacheControl

cacheControl: undefined | string

Value for cache-control header in Blob/File Service SAS.

Optional contentDisposition

contentDisposition: undefined | string

Value for content-disposition header in Blob/File Service SAS.

Optional contentEncoding

contentEncoding: undefined | string

Value for content-encoding header in Blob/File Service SAS.

Optional contentLanguage

contentLanguage: undefined | string

Value for content-length header in Blob/File Service SAS.

Optional contentType

contentType: undefined | string

Value for content-type header in Blob/File Service SAS.

Optional correlationId

correlationId: undefined | string

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.

Optional encryptionScope

encryptionScope: undefined | string

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

Optional expiresOn

expiresOn: Date

Optional only when identifier is provided. The expiry time for this SAS token.

Optional identifier

identifier: undefined | string

Optional. The signed identifier (only for BlobSASSignatureValues).

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

Optional ipRange

ipRange: SasIPRange

Optional. IP ranges allowed in this SAS.

Optional permissions

permissions: undefined | string

Optional only when identifier is provided. Please refer to AccountSASPermissions, BlobSASPermissions, or ContainerSASPermissions for more details.

Optional preauthorizedAgentObjectId

preauthorizedAgentObjectId: undefined | string

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 cannot be used in conjuction with {@link signedUnauthorizedUserObjectId}. This is only used for User Delegation SAS.

Optional protocol

protocol: SASProtocol

Optional. The allowed HTTP protocol(s).

Optional resource

resource: undefined | string

Optional. Specifies which resources are accessible via the SAS (only for BlobSASSignatureValues).

see: https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

Optional resourceTypes

resourceTypes: undefined | string

Optional. The storage resource types being accessed (only for Account SAS). Please refer to AccountSASResourceTypes for more details.

Optional services

services: undefined | string

Optional. The storage services being accessed (only for Account SAS). Please refer to AccountSASServices for more details.

Optional startsOn

startsOn: Date

Optional. The start time for this SAS token.

Optional userDelegationKey

userDelegationKey: UserDelegationKey

User delegation key properties.