@azure/storage-file-datalake package

  • Reference

Classes

AccountSASPermissions

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on an AccountSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.
AccountSASResourceTypes

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that resource type. Once all the values are set, this should be serialized with toString and set as the resources field on an AccountSASSignatureValues object. It is possible to construct the resources string without this class, but the order of the resources is particular and this class guarantees correctness.
AccountSASServices

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that service. Once all the values are set, this should be serialized with toString and set as the services field on an AccountSASSignatureValues object. It is possible to construct the services string without this class, but the order of the services is particular and this class guarantees correctness.
AnonymousCredential

AnonymousCredential provides a credentialPolicyCreator member used to create AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources or for use with Shared Access Signatures (SAS).
AnonymousCredentialPolicy

AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources or for use with Shared Access Signatures (SAS).
BaseRequestPolicy

The base class from which all request policies derive.
Credential

Credential is an abstract class for Azure Storage HTTP requests signing. This class will host an credentialPolicyCreator factory which generates CredentialPolicy.
CredentialPolicy

Credential policy used to sign HTTP(S) requests before sending. This is an abstract class.
DataLakeAclChangeFailedError

An error thrown when an operation is interrupted and can be continued later on.
DataLakeDirectoryClient

A DataLakeDirectoryClient represents a URL to the Azure Storage directory.
DataLakeFileClient

A DataLakeFileClient represents a URL to the Azure Storage file.
DataLakeFileSystemClient

A DataLakeFileSystemClient represents a URL to the Azure Storage file system allowing you to manipulate its directories and files.
DataLakeLeaseClient
DataLakePathClient

A DataLakePathClient represents a URL to the Azure Storage path (directory or file).
DataLakeSASPermissions

ONLY AVAILABLE IN NODE.JS RUNTIME.

This is a helper class to construct a string representing the permissions granted by a ServiceSAS. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on a DataLakeSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.
DataLakeServiceClient

DataLakeServiceClient allows you to manipulate Azure Data Lake service resources and file systems. The storage account provides the top-level namespace for the Data Lake service.
DirectorySASPermissions

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a directory. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on a DataLakeSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.
FileSystemSASPermissions

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on a DataLakeSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.
HttpHeaders

A collection of HTTP header key/value pairs.
Pipeline

A Pipeline class containing HTTP request policies. You can create a default Pipeline by calling newPipeline. Or you can create a Pipeline with your own policies by the constructor of Pipeline.

Refer to newPipeline and provided policies before implementing your customized Pipeline.
RequestPolicyOptions

Optional properties that can be used when creating a RequestPolicy.
RestError

An error resulting from an HTTP request to a service endpoint.
SASQueryParameters

Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly by the user; it is only generated by the AccountSASSignatureValues and <xref:BlobSASSignatureValues> types. Once generated, it can be encoded into a toString() and appended to a URL directly (though caution should be taken here in case there are existing query parameters, which might affect the appropriate means of appending these query parameters).

NOTE: Instances of this class are immutable.
StorageBrowserPolicy

StorageBrowserPolicy will handle differences between Node.js and browser runtime, including:

  1. Browsers cache GET/HEAD requests by adding conditional headers such as 'IF_MODIFIED_SINCE'. StorageBrowserPolicy is a policy used to add a timestamp query to GET/HEAD request URL thus avoid the browser cache.

  2. Remove cookie header for security

  3. Remove content-length header to avoid browsers warning
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
StorageRetryPolicy

Retry policy with exponential retry and linear retry implemented.
StorageRetryPolicyFactory

StorageRetryPolicyFactory is a factory class helping generating StorageRetryPolicy objects.
StorageSharedKeyCredential

ONLY AVAILABLE IN NODE.JS RUNTIME.

StorageSharedKeyCredential for account key authorization of Azure Storage service.
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key.
WebResource

Creates a new WebResource object.

This class provides an abstraction over a REST call by being library / implementation agnostic and wrapping the necessary properties to initiate a request.

Interfaces

AccessControlChangeCounters

AccessControlChangeCounters contains counts of operations that change Access Control Lists recursively.
AccessControlChangeError

Represents an entry that failed to update Access Control List during setAccessControlRecursive, updateAccessControlRecursive and removeAccessControlRecursive.
AccessControlChanges

AccessControlChanges contains batch and cumulative counts of operations that change Access Control Lists recursively. Additionally it exposes path entries that failed to update while these operations progress.
AccessPolicy
AccountSASSignatureValues

ONLY AVAILABLE IN NODE.JS RUNTIME.

AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set appropriately, call generateAccountSASQueryParameters to obtain a representation of the SAS which can actually be applied to data lake urls. Note: that both this class and SASQueryParameters exist because the former is mutable and a logical representation while the latter is immutable and used to generate actual REST requests.

See https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 for more conceptual information on SAS See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas for descriptions of the parameters, including which are required
BlobHierarchyListSegment
BlobItemModel

An Azure Storage blob
BlobPrefix
BlobPropertiesModel

Properties of a blob
CommonGenerateSasUrlOptions

Common options of the FileSystemGenerateSasUrlOptions, DirectoryGenerateSasUrlOptions and FileGenerateSasUrlOptions.
CommonOptions

An interface for options common to every remote operation.
CpkInfo

Parameter group
DataLakeRequestConditions

Parameter group
DataLakeSASSignatureValues

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

Storage Service Properties.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

An interface for options common to every remote operation.
DirectoryCreateIfNotExistsResponse

Contains response data for the createIfNotExists operation.
DirectoryCreateOptions
DirectoryCreateResponse

Contains response data for the create operation.
DirectoryGenerateSasUrlOptions

Options to configure generateSasUrl operation.
FileAppendOptions

An interface for options common to every remote operation.
FileCreateIfNotExistsOptions

An interface for options common to every remote operation.
FileCreateIfNotExistsResponse

Contains response data for the createIfNotExists operation.
FileCreateOptions

An interface for options common to every remote operation.
FileCreateResponse

Contains response data for the create operation.
FileFlushOptions

An interface for options common to every remote operation.
FileGenerateSasUrlOptions

Options to configure generateSasUrl operation.
FileParallelUploadOptions

Option interface for Data Lake file - Upload operations

See:
FileQueryCsvTextConfiguration

Options to query file with CSV format.
FileQueryError

File query error type.
FileQueryJsonTextConfiguration

Options to query file with JSON format.
FileQueryOptions

Option interface for Data Lake file - query operations

See:
FileQueryParquetConfiguration

Options to query file with Parquet format.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Option interface for Data Lake file - readToBuffer operations

See:
FileSetExpiryHeaders

Defines headers for Path_setExpiry operation.
FileSetExpiryOptions

Option interface for the setExpiry operation.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Contains response data for the createIfNotExists operation.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Contains response data for the deleteIfExists operation.
FileSystemDeleteOptions

An interface for options common to every remote operation.
FileSystemEncryptionScope

Options to specify encryption scope on a file system.
FileSystemExistsOptions

Option interface for Data Lake file system exists operations

See:
FileSystemGenerateSasUrlOptions

Options to configure generateSasUrl operation.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

An interface for options common to every remote operation.
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions

An interface for options common to every remote operation.
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Defines headers for FileSystem_listBlobHierarchySegment operation.
FileSystemListPathsHeaders

Defines headers for FileSystem_listPaths operation.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

An interface for options common to every remote operation.
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions

An interface for options common to every remote operation.
FileSystemUndeletePathOption

An interface for options common to every remote operation.
HttpOperationResponse

Wrapper object for http request and response. Deserialized object is stored in the parsedBody property when the response body is received in JSON or XML.
IHttpClient

An interface that can send HttpRequests and receive promised HttpResponses.
Lease

The details for a specific lease.
LeaseAccessConditions

Parameter group
LeaseOperationOptions

Configures lease operations.
ListBlobsHierarchySegmentResponse

An enumeration of blobs
ListDeletedPathsOptions

An interface for options common to every remote operation.
ListDeletedPathsSegmentOptions

An interface for options common to every remote operation.
ListFileSystemsSegmentResponse
ListPathsOptions

An interface for options common to every remote operation.
ListPathsSegmentOptions

An interface for options common to every remote operation.
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

Defines headers for Path_appendData operation.
PathChangeAccessControlRecursiveOptions

Options type for setAccessControlRecursive, updateAccessControlRecursive and removeAccessControlRecursive.
PathChangeAccessControlRecursiveResponse

Response type for setAccessControlRecursive, updateAccessControlRecursive and removeAccessControlRecursive.
PathCreateHeaders

Defines headers for Path_create operation.
PathCreateHttpHeaders
PathCreateIfNotExistsOptions

An interface for options common to every remote operation.
PathCreateIfNotExistsResponse

Contains response data for the createIfNotExists operation.
PathCreateOptions

An interface for options common to every remote operation.
PathDeleteHeaders

Defines headers for Path_delete operation.
PathDeleteIfExistsResponse

Contains response data for the deleteIfExists operation.
PathDeleteOptions

An interface for options common to every remote operation.
PathExistsOptions

Option interface for Data Lake directory/file exists operations

See:
PathFlushDataHeaders

Defines headers for Path_flushData operation.
PathGetAccessControlHeaders
PathGetAccessControlOptions

An interface for options common to every remote operation.
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Defines headers for Path_getProperties operation.
PathGetPropertiesOptions

An interface for options common to every remote operation.
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions

An interface for options common to every remote operation.
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Defines headers for Path_setAccessControl operation.
PathSetAccessControlOptions

An interface for options common to every remote operation.
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions

An interface for options common to every remote operation.
PathSetMetadataHeaders
PathSetMetadataOptions

An interface for options common to every remote operation.
PathSetPermissionsOptions

An interface for options common to every remote operation.
PathUndeleteHeaders

Defines headers for Path_undelete operation.
PathUpdateHeaders

Defines headers for Path_update operation.
PipelineOptions

Option interface for Pipeline constructor.
RawAccessPolicy
RemovePathAccessControlItem
RequestPolicy

The underlying structure of a request policy.
RolePermissions
SASQueryParametersOptions

Options to construct SASQueryParameters.
SasIPRange

Allowed IP range for a SAS.
ServiceGenerateAccountSasUrlOptions

Options to configure generateAccountSasUrl operation.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

An interface for options common to every remote operation.
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Options to configure undeleteFileSystem.
SignedIdentifier
StoragePipelineOptions

Options interface for the newPipeline function.
StorageRetryOptions

Storage Blob retry options interface.
UserDelegationKey
UserDelegationKeyModel

A user delegation key

Type Aliases

AccessControlType
CopyStatusType
CredentialPolicyCreator

A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
DataLakeServiceGetPropertiesResponse

Contains response data for the getProperties operation.
EncryptionAlgorithmType

Defines values for EncryptionAlgorithmType.
<xref:KnownEncryptionAlgorithmType> can be used interchangeably with EncryptionAlgorithmType, this enum contains the known values that the service supports.

Know values supported by the service

None
AES256
FileAppendResponse

Contains response data for the appendData operation.
FileExpiryMode

Defines values for PathExpiryOptions.
FileFlushResponse

Contains response data for the flushData operation.
FileQueryArrowConfiguration

Options to query file with Apache Arrow format. Only valid for outputTextConfiguration.
FileReadResponse
FileSetExpiryResponse

Contains response data for the setExpiry operation.
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

Contains response data for the <xref:DataLakeServiceClient.renameFileSystem> operation.
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

Contains response data for the undeleteFileSystem operation.
HttpRequestBody

Possible HTTP request body types
LeaseDurationType
LeaseOperationResponse

Contains the response data for operations that create, modify, or delete a lease.

See <xref:BlobLeaseClient>.
LeaseStateType
LeaseStatusType
ListPathsSegmentResponse

Contains response data for the listPaths operation.
ModifiedAccessConditions
PathCreateResponse

Contains response data for the create operation.
PathDeleteResponse

Contains response data for the delete operation.
PathGetAccessControlResponse
PathGetPropertiesActionModel

Defines values for PathGetPropertiesAction.
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

Defines values for PathRenameMode.
PathResourceTypeModel

Defines values for PathResourceType.
PathSetAccessControlResponse

Contains response data for the setAccessControl operation.
PathSetHttpHeadersResponse
PathSetMetadataResponse
PublicAccessType
RequestPolicyFactory

Creates a new RequestPolicy per-request that uses the provided nextPolicy.
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

Contains response data for the listContainersSegment operation.
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

Options to configure <xref:DataLakeServiceClient.renameFileSystem>.

Enums

PathGetPropertiesAction

Defines values for PathGetPropertiesAction. Possible values include: 'getAccessControl', 'getStatus'
PathRenameMode

Defines values for PathRenameMode. Possible values include: 'legacy', 'posix'
PathResourceType

Defines values for PathResourceType. Possible values include: 'directory', 'file'
SASProtocol

Protocols for generated SAS.
StorageDataLakeAudience

Defines the known cloud audiences for Storage.
StorageRetryPolicyType

RetryPolicy types.

Functions

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Create a new serialization RequestPolicyCreator that will serialized HTTP request bodies as they pass through the HTTP pipeline.
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ONLY AVAILABLE IN NODE.JS RUNTIME.

Generates a SASQueryParameters object which contains all SAS query parameters needed to make an actual REST request.

See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

ONLY AVAILABLE IN NODE.JS RUNTIME.

Creates an instance of SASQueryParameters.

Only accepts required settings needed to create a SAS. For optional settings please set corresponding properties directly, such as permissions, startsOn and identifier.

WARNING: When identifier is not provided, permissions and expiresOn are required. You MUST assign value to identifier or expiresOn & permissions manually if you initial with this constructor.

Fill in the required details before running the following snippets.

Example

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

// Fill in the required details before running the snippet.

Example

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

ONLY AVAILABLE IN NODE.JS RUNTIME.

Creates an instance of SASQueryParameters. WARNING: identifier will be ignored when generating user delegation SAS, permissions and expiresOn are required.

Example

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
getDataLakeServiceAccountAudience(string)
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Creates a new Pipeline object with Credential provided.

Function Details

deserializationPolicy(DeserializationContentTypes, SerializerOptions)

Create a new serialization RequestPolicyCreator that will serialized HTTP request bodies as they pass through the HTTP pipeline.

function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory

Parameters

deserializationContentTypes
DeserializationContentTypes
parsingOptions
SerializerOptions

Returns

RequestPolicyFactory

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ONLY AVAILABLE IN NODE.JS RUNTIME.

Generates a SASQueryParameters object which contains all SAS query parameters needed to make an actual REST request.

See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameters

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Returns

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

ONLY AVAILABLE IN NODE.JS RUNTIME.

Creates an instance of SASQueryParameters.

Only accepts required settings needed to create a SAS. For optional settings please set corresponding properties directly, such as permissions, startsOn and identifier.

WARNING: When identifier is not provided, permissions and expiresOn are required. You MUST assign value to identifier or expiresOn & permissions manually if you initial with this constructor.

Fill in the required details before running the following snippets.

Example

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

// Fill in the required details before running the snippet.

Example

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameters

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Returns

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

ONLY AVAILABLE IN NODE.JS RUNTIME.

Creates an instance of SASQueryParameters. WARNING: identifier will be ignored when generating user delegation SAS, permissions and expiresOn are required.

Example

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

Parameters

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Return value of blobServiceClient.getUserDelegationKey()

accountName

string

Returns

SASQueryParameters

getDataLakeServiceAccountAudience(string) 

function getDataLakeServiceAccountAudience(storageAccountName: string): string

Parameters

storageAccountName

string

Returns

string

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Creates a new Pipeline object with Credential provided.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Parameters

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.

pipelineOptions
StoragePipelineOptions

Optional. Options.

Returns

Pipeline

A new Pipeline object.