Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DataLakeSASSignatureValues

Package version

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.

export

Hierarchy

  • DataLakeSASSignatureValues

Index

Properties

Optional agentObjectId

agentObjectId: undefined | string

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.

memberof

DataLakeSASSignatureValues

Optional cacheControl

cacheControl: undefined | string

Optional. The cache-control header for the SAS.

memberof

DataLakeSASSignatureValues

Optional contentDisposition

contentDisposition: undefined | string

Optional. The content-disposition header for the SAS.

memberof

DataLakeSASSignatureValues

Optional contentEncoding

contentEncoding: undefined | string

Optional. The content-encoding header for the SAS.

memberof

DataLakeSASSignatureValues

Optional contentLanguage

contentLanguage: undefined | string

Optional. The content-language header for the SAS.

memberof

DataLakeSASSignatureValues

Optional contentType

contentType: undefined | string

Optional. The content-type header for the SAS.

memberof

DataLakeSASSignatureValues

Optional correlationId

correlationId: undefined | string

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.

memberof

DataLakeSASSignatureValues

Optional directoryDepth

directoryDepth: undefined | number

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.

memberof

DataLakeSASSignatureValues

Optional expiresOn

expiresOn: Date

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

memberof

DataLakeSASSignatureValues

fileSystemName

fileSystemName: string

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

memberof

DataLakeSASSignatureValues

Optional identifier

identifier: undefined | string

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

memberof

DataLakeSASSignatureValues

Optional ipRange

ipRange: SasIPRange

Optional. IP ranges allowed in this SAS.

memberof

DataLakeSASSignatureValues

Optional isDirectory

isDirectory: undefined | false | true

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.

memberof

DataLakeSASSignatureValues

Optional pathName

pathName: undefined | string

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

memberof

DataLakeSASSignatureValues

Optional 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.

memberof

DataLakeSASSignatureValues

Optional preauthorizedAgentObjectId

preauthorizedAgentObjectId: undefined | string

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.

memberof

DataLakeSASSignatureValues

Optional protocol

protocol: SASProtocol

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

memberof

DataLakeSASSignatureValues

Optional snapshotTime

snapshotTime: undefined | string

Optional. Snapshot timestamp string the SAS user may access. Only supported from API version 2018-11-09.

memberof

DataLakeSASSignatureValues

Optional startsOn

startsOn: Date

Optional. When the SAS will take effect.

memberof

DataLakeSASSignatureValues

Optional version

version: undefined | string

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

memberof

DataLakeSASSignatureValues

Generated using TypeDoc