Share via

DataLakeSASSignatureValues interface

  • Reference
Package:
@azure/storage-file-datalake

ONLY AVAILABLE IN NODE.JS RUNTIME.

DataLakeSASSignatureValues is used to help generating Blob and DataLake service SAS tokens for containers, blobs, filesystem, directories and files.

Properties

agentObjectId

Optional. Beginning in version 2020-02-10, specifies the Unauthorized AAD Object Id in GUID format. The AAD Object Id of a user that is assumed to be unauthorized by the owner of the user delegation key. The Azure Storage Service will perform an additional POSIX ACL check to determine if the user is authorized to perform the requested operation. This cannot be used in conjuction with preauthorizedAgentObjectId. This is only used for User Delegation SAS.
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.
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.
directoryDepth

Optional. Beginning in version 2020-02-10, indicate the depth of the directory specified in the canonicalizedresource field of the string-to-sign. The depth of the directory is the number of directories beneath the root folder.
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.
fileSystemName

The name of the file system the SAS user may access.
identifier

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

Optional. Beginning in version 2020-02-10, this value defines whether or not the pathName is a directory. If this value is set to true, the Path is a Directory for a Directory SAS. If set to false or default, the Path is a File Path for a File Path SAS.
pathName

Optional. The path name of the directory or file SAS user may access. Required if snapshotTime is provided.
permissions

Optional only when identifier is provided. Please refer to FileSystemSASPermissions, DirectorySASPermissions or DataLakeSASPermissions 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 cannot be used in conjuction with agentObjectId. 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.

Property Details

agentObjectId

Optional. Beginning in version 2020-02-10, specifies the Unauthorized AAD Object Id in GUID format. The AAD Object Id of a user that is assumed to be unauthorized by the owner of the user delegation key. The Azure Storage Service will perform an additional POSIX ACL check to determine if the user is authorized to perform the requested operation. This cannot be used in conjuction with preauthorizedAgentObjectId. This is only used for User Delegation SAS.

agentObjectId?: string

Property Value

string

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

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

directoryDepth

Optional. Beginning in version 2020-02-10, indicate the depth of the directory specified in the canonicalizedresource field of the string-to-sign. The depth of the directory is the number of directories beneath the root folder.

directoryDepth?: number

Property Value

number

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

fileSystemName

The name of the file system the SAS user may access.

fileSystemName: string

Property Value

string

identifier

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

isDirectory

Optional. Beginning in version 2020-02-10, this value defines whether or not the pathName is a directory. If this value is set to true, the Path is a Directory for a Directory SAS. If set to false or default, the Path is a File Path for a File Path SAS.

isDirectory?: boolean

Property Value

boolean

pathName

Optional. The path name of the directory or file SAS user may access. Required if snapshotTime is provided.

pathName?: string

Property Value

string

permissions

Optional only when identifier is provided. Please refer to FileSystemSASPermissions, DirectorySASPermissions or DataLakeSASPermissions depending on the resource being accessed for help constructing the permissions string.

permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

Property Value

DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions

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 cannot be used in conjuction with agentObjectId. 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