通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/storage-file-datalake package

类

AccountSASPermissions

仅在NODE.JS运行时中可用。 这是一个帮助程序类，用于构造表示 AccountSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 序列化此值，并将其设置为 <xref:AccountSASSignatureValues> 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。
AccountSASResourceTypes

仅在NODE.JS运行时中可用。 这是一个帮助程序类，用于构造表示 AccountSAS 可访问的资源的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该资源类型的访问权限。 设置所有值后，应使用 toString 序列化此值，并将其设置为 <xref:AccountSASSignatureValues> 对象上的资源字段。 可以构造没有此类的资源字符串，但资源的顺序是特定的，此类保证正确性。
AccountSASServices

仅在NODE.JS运行时中可用。 这是一个帮助程序类，用于构造表示 AccountSAS 可访问的服务的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予对该服务的访问权限。 设置所有值后，应使用 toString 序列化此值，并将其设置为 <xref:AccountSASSignatureValues> 对象上的服务字段。 可以构造没有此类的服务字符串，但服务的顺序是特定的，此类保证正确性。
AnonymousCredential

AnonymousCredential 提供 credentialPolicyCreator 成员，用于创建 AnonymousCredentialPolicy 对象。 AnonymousCredentialPolicy 与 HTTP（S） 请求一起使用，这些请求读取公共资源或用于共享访问签名（SAS）。
AnonymousCredentialPolicy

AnonymousCredentialPolicy 与 HTTP（S） 请求一起使用，这些请求读取公共资源或用于共享访问签名（SAS）。
Credential

凭据是 Azure 存储 HTTP 请求签名的抽象类。 此类将托管生成 CredentialPolicy 的 credentialPolicyCreator 工厂。
CredentialPolicy

用于在发送之前对 HTTP（S） 请求进行签名的凭据策略。 这是一个抽象类。
DataLakeAclChangeFailedError

作中断时引发的错误，以后可以继续。
DataLakeDirectoryClient

DataLakeDirectoryClient 表示 Azure 存储目录的 URL。
DataLakeFileClient

DataLakeFileClient 表示 Azure 存储文件的 URL。
DataLakeFileSystemClient

DataLakeFileSystemClient 表示 Azure 存储文件系统的 URL，允许你作其目录和文件。
DataLakeLeaseClient
DataLakePathClient

DataLakePathClient 表示 Azure 存储路径（目录或文件）的 URL。
DataLakeSASPermissions

仅在NODE.JS运行时中可用。 这是一个帮助程序类，用于构造表示 ServiceSAS 授予的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 序列化此值，并将其设置为 <xref:DataLakeSASSignatureValues> 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。
DataLakeServiceClient

DataLakeServiceClient 允许你作 Azure Data Lake 服务资源和文件系统。 存储帐户为 Data Lake 服务提供顶级命名空间。
DirectorySASPermissions

这是一个帮助程序类，用于构造表示 ServiceSAS 授予目录的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 序列化此值，并将其设置为 <xref:DataLakeSASSignatureValues> 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。
FileSystemSASPermissions

这是一个帮助程序类，用于构造表示 ServiceSAS 授予给容器的权限的字符串。 将值设置为 true 意味着使用这些权限的任何 SAS 都将授予该作的权限。 设置所有值后，应使用 toString 序列化此值，并将其设置为 <xref:DataLakeSASSignatureValues> 对象的权限字段。 可以构造不带此类的权限字符串，但权限的顺序是特定的，此类保证正确性。
Pipeline

包含 HTTP 请求策略的 Pipeline 类。 可以通过调用 <xref:newPipeline>来创建默认管道。 或者，可以通过管道构造函数创建自己的策略的管道。 在实现自定义管道之前，请参阅 <xref:newPipeline> 和提供的策略。
SASQueryParameters

表示构成 Azure 存储 SAS 查询参数的组件。 此类型不是由用户直接构造的;它仅由 <xref:AccountSASSignatureValues> 和 <xref:BlobSASSignatureValues> 类型生成。 生成后，可以将其编码为 <xref:String> 并直接追加到 URL（不过，如果存在现有的查询参数，这可能会影响追加这些查询参数的适当方式），应谨慎使用。 注意：此类的实例是不可变的。
StorageBrowserPolicy

StorageBrowserPolicy 将处理 Node.js 和浏览器运行时之间的差异，包括：

  1. 浏览器通过添加条件标头（如“IF_MODIFIED_SINCE”）来缓存 GET/HEAD 请求。 StorageBrowserPolicy 是一种策略，用于将时间戳查询添加到 GET/HEAD 请求 URL，从而避免浏览器缓存。

  2. 删除 Cookie 标头以安全

  3. 删除内容长度标头以避免浏览器警告
StorageBrowserPolicyFactory

StorageBrowserPolicyFactory 是帮助生成 StorageBrowserPolicy 对象的工厂类。
StorageClient

StorageClient 表示 <xref:BlobServiceClient>、<xref:ContainerClient> 等的基于 URL 类。
StorageClientContext
StorageRetryPolicy

实现指数重试和线性重试的重试策略。
StorageRetryPolicyFactory

StorageRetryPolicyFactory 是一个工厂类，可帮助生成 <xref:StorageRetryPolicy> 对象。
StorageSharedKeyCredential

仅在NODE.JS运行时中可用。 Azure 存储服务的帐户密钥授权的 StorageSharedKeyCredential。
StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy 是用于使用共享密钥对 HTTP 请求进行签名的策略。

接口

AccessControlChangeCounters

AccessControlChangeCounters 包含以递归方式更改访问控制列表的作计数。
AccessControlChangeError

表示在 setAccessControlRecursive、updateAccessControlRecursive 和 removeAccessControlRecursive期间未能更新访问控制列表的条目。
AccessControlChanges

AccessControlChanges 包含以递归方式更改访问控制列表的作的批处理和累积计数。 此外，它还公开这些作进行时未能更新的路径条目。
AccessPolicy
AccountSASSignatureValues

仅在NODE.JS运行时中可用。 AccountSASSignatureValues 用于为 Azure 存储帐户生成共享访问签名（SAS）。 正确设置此处的所有值后，调用 <xref:generateAccountSASQueryParameters> 以获取实际可应用于 Data Lake URL 的 SAS 表示形式。 注意：此类和 <xref:SASQueryParameters> 都存在，因为前者是可变的，而逻辑表示形式是不可变的，用于生成实际的 REST 请求。
BlobHierarchyListSegment
BlobItemModel

Azure 存储 Blob
BlobPrefix
BlobPropertiesModel

Blob 的属性
CommonGenerateSasUrlOptions

<xref:FileSystemGenerateSasUrlOptions>、<xref:DirectoryGenerateSasUrlOptions> 和 <xref:FileGenerateSasUrlOptions>的常见选项。
CommonOptions

每个远程作通用选项的接口。
DataLakeRequestConditions
DataLakeSASSignatureValues

仅在NODE.JS运行时中可用。 DataLakeSASSignatureValues 用于帮助为容器、Blob、文件系统、目录和文件生成 Blob 和 DataLake 服务 SAS 令牌。
DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions
DirectoryCreateIfNotExistsResponse
DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

用于配置 <xref:DataLakeDirectoryClient.generateSasUrl>作的选项。
FileAppendOptions
FileCreateIfNotExistsOptions
FileCreateIfNotExistsResponse
FileCreateOptions
FileCreateResponse
FileFlushOptions
FileGenerateSasUrlOptions

用于配置 <xref:DataLakeFileClient.generateSasUrl>作的选项。
FileParallelUploadOptions

Data Lake 文件的选项接口 - 上传作请参阅：

  • <xref:DataLakeFileClient.upload>
  • <xref:DataLakeFileClient.uploadFile>
  • <xref:DataLakeFileClient.uploadStream>
FileQueryCsvTextConfiguration

使用 CSV 格式查询文件的选项。
FileQueryError

文件查询错误类型。
FileQueryJsonTextConfiguration

用于查询 JSON 格式的文件的选项。
FileQueryOptions

Data Lake 文件的选项接口 - 查询作请参阅：

  • <xref:DataLakeFileClient.query>
FileQueryParquetConfiguration

使用 Parquet 格式查询文件的选项。
FileReadHeaders
FileReadOptions
FileReadToBufferOptions

Data Lake 文件的选项接口 - readToBuffer作请参阅：

  • <xref:DataLakeFileClient.readToBuffer>
FileSetExpiryHeaders

定义Path_setExpiry作的标头。
FileSetExpiryOptions

<xref:DataLakeFileClient.setExpiry>作的选项接口。
FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

包含 <xref:DataLakeFileSystemClient.createIfNotExists>作的响应数据。
FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

包含 <xref:DataLakeFileSystemClient.deleteIfExists>作的响应数据。
FileSystemDeleteOptions
FileSystemExistsOptions

Data Lake 文件系统的选项接口存在作，请参阅：

  • <xref:DataLakeFileSystemClient.exists>
FileSystemGenerateSasUrlOptions

用于配置 <xref:DataLakeFileSystemClient.generateSasUrl>作的选项。
FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions
FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions
FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

定义FileSystem_listBlobHierarchySegment作的标头。
FileSystemListPathsHeaders

定义FileSystem_listPaths作的标头。
FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions
FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions
FileSystemUndeletePathOption
ListBlobsHierarchySegmentResponse

Blob 的枚举
ListDeletedPathsOptions
ListDeletedPathsSegmentOptions
ListFileSystemsSegmentResponse
ListPathsOptions
ListPathsSegmentOptions
Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

定义Path_appendData作的标头。
PathChangeAccessControlRecursiveOptions

setAccessControlRecursive、updateAccessControlRecursive 和 removeAccessControlRecursive的选项类型。
PathChangeAccessControlRecursiveResponse

setAccessControlRecursive、updateAccessControlRecursive 和 removeAccessControlRecursive的响应类型。
PathCreateHeaders

定义Path_create作的标头。
PathCreateHttpHeaders
PathCreateIfNotExistsOptions
PathCreateIfNotExistsResponse

包含 <xref:DataLakePathClient.createIfNotExists>作的响应数据。
PathCreateOptions
PathDeleteHeaders

定义Path_delete作的标头。
PathDeleteIfExistsResponse

包含 <xref:DataLakePathClient.deleteIfExists>作的响应数据。
PathDeleteOptions
PathExistsOptions

Data Lake 目录/文件的选项接口存在作，请参阅：

  • <xref:DataLakePathClient.exists>
PathFlushDataHeaders

定义Path_flushData作的标头。
PathGetAccessControlHeaders
PathGetAccessControlOptions
PathGetPropertiesHeaders
PathGetPropertiesHeadersModel

定义Path_getProperties作的标头。
PathGetPropertiesOptions
PathHttpHeaders
PathList
PathListModel
PathModel
PathMoveOptions
PathPermissions
PathRemoveHeaders
PathSetAccessControlHeaders

定义Path_setAccessControl作的标头。
PathSetAccessControlOptions
PathSetHttpHeadersHeaders
PathSetHttpHeadersOptions
PathSetMetadataHeaders
PathSetMetadataOptions
PathSetPermissionsOptions
PathUndeleteHeaders

定义Path_undelete作的标头。
PathUpdateHeaders

定义Path_update作的标头。
PipelineOptions

管道构造函数的选项接口。
RawAccessPolicy
RemovePathAccessControlItem
RolePermissions
SASQueryParametersOptions

用于构造 <xref:SASQueryParameters>的选项。
SasIPRange

SAS 允许的 IP 范围。
ServiceGenerateAccountSasUrlOptions

用于配置 <xref:DataLakeServiceClient.generateAccountSasUrl>作的选项。
ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions
ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

用于配置 <xref:DataLakeServiceClient.undeleteFileSystem>的选项。
SignedIdentifier
StorageClientOptionalParams

可选参数。
StoragePipelineOptions

<xref:newPipeline> 函数的选项接口。
StorageRetryOptions

存储 Blob 重试选项接口。
UserDelegationKey

类型别名

AccessControlType
CopyStatusType
CredentialPolicyCreator

一个工厂函数，用于创建使用提供的 nextPolicy 的新 CredentialPolicy。
FileAppendResponse

包含 appendData作的响应数据。
FileExpiryMode

定义 PathExpiryOptions 的值。
FileQueryArrowConfiguration

使用 Apache Arrow 格式查询文件的选项。 仅适用于 <xref:FileQueryOptions.outputTextConfiguration>。
FileReadResponse
FileSetExpiryResponse

包含 setExpiry作的响应数据。
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

包含 <xref:DataLakeServiceClient.renameFileSystem>作的响应数据。
FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

包含 <xref:DataLakeServiceClient.undeleteFileSystem>作的响应数据。
LeaseDurationType
LeaseStateType
LeaseStatusType
ListPathsSegmentResponse

包含 listPaths作的响应数据。
ModifiedAccessConditions
PathCreateResponse

包含创建作的响应数据。
PathDeleteResponse

包含删除作的响应数据。
PathFlushDataResponse

包含 flushData作的响应数据。
PathGetAccessControlResponse
PathGetPropertiesActionModel

定义 PathGetPropertiesAction 的值。
PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

定义 PathRenameMode 的值。
PathResourceTypeModel

定义 PathResourceType 的值。
PathSetAccessControlResponse

包含 setAccessControl作的响应数据。
PathSetHttpHeadersResponse
PathSetMetadataResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

用于配置 <xref:DataLakeServiceClient.renameFileSystem>的选项。

枚举

PathGetPropertiesAction

定义 PathGetPropertiesAction 的值。 可能的值包括：“getAccessControl”、“getStatus”
PathRenameMode

定义 PathRenameMode 的值。 可能的值包括：“legacy”、“posix”
PathResourceType

定义 PathResourceType 的值。 可能的值包括：“directory”、“file”
SASProtocol

生成的 SAS 的协议。
StorageRetryPolicyType

RetryPolicy 类型。

函数

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

仅在NODE.JS运行时中可用。 生成一个 <xref:SASQueryParameters> 对象，该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。

仅接受创建 SAS 所需的设置。 对于可选设置，请直接设置相应的属性，例如权限、startsOn 和标识符。

警告：如果未提供标识符，则需要权限和 expiresOn。 如果最初使用此构造函数，则必须将值分配给标识符或 expiresOn & 权限。

在运行以下代码片段之前填写所需的详细信息。
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。 警告：生成用户委派 SAS、权限和 expiresOn 时，将忽略标识符。
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

使用提供的凭据创建新的 Pipeline 对象。

函数详细信息

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

仅在NODE.JS运行时中可用。 生成一个 <xref:SASQueryParameters> 对象，该对象包含发出实际 REST 请求所需的所有 SAS 查询参数。

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

参数

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

返回

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。

仅接受创建 SAS 所需的设置。 对于可选设置，请直接设置相应的属性，例如权限、startsOn 和标识符。

警告：如果未提供标识符，则需要权限和 expiresOn。 如果最初使用此构造函数，则必须将值分配给标识符或 expiresOn & 权限。

在运行以下代码片段之前填写所需的详细信息。

function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

参数

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

返回

SASQueryParameters

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

仅在NODE.JS运行时中可用。 创建 SASQueryParameters 的实例。 警告：生成用户委派 SAS、权限和 expiresOn 时，将忽略标识符。

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

参数

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

返回值 blobServiceClient.getUserDelegationKey()

accountName

string

返回

SASQueryParameters

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

使用提供的凭据创建新的 Pipeline 对象。

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

参数

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

例如 AnonymousCredential、StorageSharedKeyCredential 或任何来自 @azure/identity 包的凭据，用于对服务的请求进行身份验证。 还可以提供实现 TokenCredential 接口的对象。 如果未指定，则使用 AnonymousCredential。

pipelineOptions
StoragePipelineOptions

自选。 选项。

返回

Pipeline

新的 Pipeline 对象。