Share via

@azure/storage-file-datalake package

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 <xref: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 <xref: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 <xref: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).
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 <xref: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 <xref: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 <xref: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.
Pipeline

A Pipeline class containing HTTP request policies. You can create a default Pipeline by calling <xref:newPipeline>. Or you can create a Pipeline with your own policies by the constructor of Pipeline. Refer to <xref:newPipeline> and provided policies before implementing your customized Pipeline.
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 <xref:AccountSASSignatureValues> and <xref:BlobSASSignatureValues> types. Once generated, it can be encoded into a <xref:String> 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.
StorageClient

A StorageClient represents a based URL class for <xref:BlobServiceClient>, <xref:ContainerClient> and etc.
StorageClientContext
StorageRetryPolicy

Retry policy with exponential retry and linear retry implemented.
StorageRetryPolicyFactory

StorageRetryPolicyFactory is a factory class helping generating <xref: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.

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 <xref:generateAccountSASQueryParameters> to obtain a representation of the SAS which can actually be applied to data lake urls. Note: that both this class and <xref:SASQueryParameters> exist because the former is mutable and a logical representation while the latter is immutable and used to generate actual REST requests.
BlobHierarchyListSegment
BlobItemModel

An Azure Storage blob
BlobPrefix
BlobPropertiesModel

Properties of a blob
CommonGenerateSasUrlOptions

Common options of the <xref:FileSystemGenerateSasUrlOptions>, <xref:DirectoryGenerateSasUrlOptions> and <xref:FileGenerateSasUrlOptions>.
CommonOptions

An interface for options common to every remote operation.
DataLakeRequestConditions
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.
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions
DirectoryCreateIfNotExistsResponse
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

Options to configure <xref:DataLakeDirectoryClient.generateSasUrl> operation.
FileAppendOptions
FileCreateIfNotExistsOptions
FileCreateIfNotExistsResponse
FileCreateOptions
FileCreateResponse
FileFlushOptions
FileGenerateSasUrlOptions

Options to configure <xref:DataLakeFileClient.generateSasUrl> operation.
FileParallelUploadOptions

Option interface for Data Lake file - Upload operations See:

  • <xref:DataLakeFileClient.upload>
  • <xref:DataLakeFileClient.uploadFile>
  • <xref:DataLakeFileClient.uploadStream>
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:

  • <xref:DataLakeFileClient.query>
FileQueryParquetConfiguration

Options to query file with Parquet format.
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Option interface for Data Lake file - readToBuffer operations See:

  • <xref:DataLakeFileClient.readToBuffer>
FileSetExpiryHeaders

Defines headers for Path_setExpiry operation.
FileSetExpiryOptions

Option interface for the <xref:DataLakeFileClient.setExpiry> operation.
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

Contains response data for the <xref:DataLakeFileSystemClient.createIfNotExists> operation.
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

Contains response data for the <xref:DataLakeFileSystemClient.deleteIfExists> operation.
FileSystemDeleteOptions
FileSystemExistsOptions

Option interface for Data Lake file system exists operations See:

  • <xref:DataLakeFileSystemClient.exists>
FileSystemGenerateSasUrlOptions

Options to configure <xref:DataLakeFileSystemClient.generateSasUrl> operation.
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

Defines headers for FileSystem_listBlobHierarchySegment operation.
FileSystemListPathsHeaders

Defines headers for FileSystem_listPaths operation.
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions
FileSystemUndeletePathOption
ListBlobsHierarchySegmentResponse

An enumeration of blobs
ListDeletedPathsOptions
ListDeletedPathsSegmentOptions
ListFileSystemsSegmentResponse
ListPathsOptions
ListPathsSegmentOptions
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
PathCreateIfNotExistsResponse

Contains response data for the <xref:DataLakePathClient.createIfNotExists> operation.
PathCreateOptions
PathDeleteHeaders

Defines headers for Path_delete operation.
PathDeleteIfExistsResponse

Contains response data for the <xref:DataLakePathClient.deleteIfExists> operation.
PathDeleteOptions
PathExistsOptions

Option interface for Data Lake directory/file exists operations See:

  • <xref:DataLakePathClient.exists>
PathFlushDataHeaders

Defines headers for Path_flushData operation.
PathGetAccessControlHeaders
PathGetAccessControlOptions
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

Defines headers for Path_getProperties operation.
PathGetPropertiesOptions
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

Defines headers for Path_setAccessControl operation.
PathSetAccessControlOptions
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions
PathSetMetadataHeaders
PathSetMetadataOptions
PathSetPermissionsOptions
PathUndeleteHeaders

Defines headers for Path_undelete operation.
PathUpdateHeaders

Defines headers for Path_update operation.
PipelineOptions

Option interface for Pipeline constructor.
RawAccessPolicy
RemovePathAccessControlItem
RolePermissions
SASQueryParametersOptions

Options to construct <xref:SASQueryParameters>.
SasIPRange

Allowed IP range for a SAS.
ServiceGenerateAccountSasUrlOptions

Options to configure <xref:DataLakeServiceClient.generateAccountSasUrl> operation.
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

Options to configure <xref:DataLakeServiceClient.undeleteFileSystem>.
SignedIdentifier
StorageClientOptionalParams

Optional parameters.
StoragePipelineOptions

Options interface for the <xref:newPipeline> function.
StorageRetryOptions

Storage Blob retry options interface.
UserDelegationKey

Type Aliases

AccessControlType
CopyStatusType
CredentialPolicyCreator

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

Contains response data for the appendData operation.
FileExpiryMode

Defines values for PathExpiryOptions.
FileQueryArrowConfiguration

Options to query file with Apache Arrow format. Only valid for <xref:FileQueryOptions.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 <xref:DataLakeServiceClient.undeleteFileSystem> operation.
LeaseDurationType
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.
PathFlushDataResponse

Contains response data for the flushData 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
ServiceGetUserDelegationKeyResponse
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.
StorageRetryPolicyType

RetryPolicy types.

Functions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ONLY AVAILABLE IN NODE.JS RUNTIME. Generates a <xref:SASQueryParameters> object which contains all SAS query parameters needed to make an actual REST request.
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.
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.
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Creates a new Pipeline object with Credential provided.

Function Details

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ONLY AVAILABLE IN NODE.JS RUNTIME. Generates a <xref:SASQueryParameters> object which contains all SAS query parameters needed to make an actual REST request.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

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.

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

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.

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

Parameters

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

Return value of blobServiceClient.getUserDelegationKey()

accountName

string

Returns

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Creates a new Pipeline object with Credential provided.

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

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.