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

DataLakeFileClient class

参考

包:: @azure/storage-file-datalake

DataLakeFileClient 表示 Azure 存储文件的 URL。

扩展: DataLakePathClient

构造函数

DataLakeFileClient(string, Pipeline)	从 URL 和管道创建 DataLakeFileClient 的实例。
DataLakeFileClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	从 URL 和凭据创建 DataLakeFileClient 的实例。

属性

fileSystemName	当前文件系统的名称。
name	当前路径的名称（目录或文件）。

继承属性

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

方法

append(RequestBodyType, number, number, FileAppendOptions)	上传要追加到文件的数据。数据只能追加到文件中。若要向文件应用永久上传的数据，请调用刷新。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
create(FileCreateOptions)	创建文件。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
create(PathResourceTypeModel, PathCreateOptions)	创建文件。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(FileCreateIfNotExistsOptions)	创建文件（如果该文件尚不存在）。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	创建文件（如果该文件尚不存在）。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
flush(number, FileFlushOptions)	刷新以前追加到文件中的数据（写入）。
generateSasStringToSign(FileGenerateSasUrlOptions)	仅适用于使用共享密钥凭据构造的客户端。根据传入的客户端属性和参数，生成用于为服务共享访问签名（SAS） URI 签名的字符串。 SAS 由客户端的共享密钥凭据签名。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileGenerateSasUrlOptions)	仅适用于使用共享密钥凭据构造的客户端。基于传入的客户端属性和参数生成服务共享访问签名（SAS） URI。 SAS 由客户端的共享密钥凭据签名。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)	根据传入的客户端属性和参数，生成用于为服务共享访问签名（SAS） URI 签名的字符串。 SAS 由输入用户委托密钥签名。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)	基于传入的客户端属性和参数生成服务共享访问签名（SAS） URI。 SAS 由输入用户委托密钥签名。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
query(string, FileQueryOptions)	快速查询 JSON 或 CSV 格式化文件。示例用法（Node.js）： // Query and convert a file to a string const queryResponse = await fileClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryResponse.readableStreamBody)).toString(); console.log("Query file content:", downloaded); async function streamToBuffer(readableStream) { return new Promise((resolve, reject) => { const chunks = []; readableStream.on("data", (data) => { chunks.push(data instanceof Buffer ? data : Buffer.from(data)); }); readableStream.on("end", () => { resolve(Buffer.concat(chunks)); }); readableStream.on("error", reject); }); }
read(number, number, FileReadOptions)	从服务下载文件，包括其元数据和属性。在 Node.js中，数据在可读流 readableStreamBody 中返回在浏览器中，数据在 promise contentAsBlob 中返回请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob 示例用法（Node.js）： // Download and convert a file to a string const downloadResponse = await fileClient.read(); const downloaded = await streamToBuffer(downloadResponse.readableStreamBody); console.log("Downloaded file content:", downloaded.toString()); async function streamToBuffer(readableStream) { return new Promise((resolve, reject) => { const chunks = []; readableStream.on("data", (data) => { chunks.push(data instanceof Buffer ? data : Buffer.from(data)); }); readableStream.on("end", () => { resolve(Buffer.concat(chunks)); }); readableStream.on("error", reject); }); } 示例用法（浏览器）： `// Download and convert a file to a string const downloadResponse = await fileClient.read(); const downloaded = await blobToString(await downloadResponse.contentAsBlob); console.log("Downloaded file content", downloaded); async function blobToString(blob: Blob): Promise<string> { const fileReader = new FileReader(); return new Promise<string>((resolve, reject) => { fileReader.onloadend = (ev: any) => { resolve(ev.target!.result); }; fileReader.onerror = reject; fileReader.readAsText(blob); }); }`
readToBuffer(Buffer, number, number, FileReadToBufferOptions)	仅在NODE.JS运行时中可用。将 Data Lake 文件并行读取到缓冲区。偏移量和计数是可选的，为两者传递 0 以读取整个文件。警告：由于 Node.js/V8 的限制，缓冲区只能支持 32 位系统上最多一千兆字节的文件或 64 位系统上的大约 2 GB 文件。对于大于此大小的文件，请考虑 readToFile。
readToBuffer(number, number, FileReadToBufferOptions)	仅在NODE.JS运行时中可用将 Data Lake 文件并行读取到缓冲区。偏移量和计数是可选的，为两者传递 0 以读取整个文件警告：由于 Node.js/V8 的限制，缓冲区只能支持 32 位系统上最多一千兆字节的文件或 64 位系统上的大约 2 GB 文件。对于大于此大小的文件，请考虑 readToFile。
readToFile(string, number, number, FileReadOptions)	仅在NODE.JS运行时中可用。将 Data Lake 文件下载到本地文件。如果给定的文件路径已退出，则失败。偏移量和计数是可选的，分别传递 0 和未定义以下载整个文件。
setExpiry(FileExpiryMode, FileSetExpiryOptions)	设置文件的到期时间，一旦达到该时间，文件就会被删除。
upload(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	将缓冲区（Node.js）/Blob/ArrayBuffer/ArrayBufferView 上传到文件。
uploadFile(string, FileParallelUploadOptions)	仅在NODE.JS运行时中可用。将本地文件上传到 Data Lake 文件。
uploadStream(Readable, FileParallelUploadOptions)	仅在NODE.JS运行时中可用。将 Node.js 可读流上传到 Data Lake 文件中。此方法将尝试创建文件，然后按区块开始上传区块。请确保流的潜在大小不超过FILE_MAX_SIZE_BYTES，并且可能的区块数不会超过BLOCK_BLOB_MAX_BLOCKS。性能改进提示：输入流 highWaterMark 最好使用 options.chunkSize 参数设置相同的值，这将避免 Buffer.concat（）操作。

继承的方法

delete(boolean, PathDeleteOptions)	删除当前路径（目录或文件）。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
deleteIfExists(boolean, PathDeleteOptions)	如果存在，请删除当前路径（目录或文件）。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	如果此客户端表示的 Data Lake 文件存在，则返回 true;否则为 false。注意：请谨慎使用此函数，因为现有文件可能被其他客户端或应用程序删除。反之亦然，此函数完成后，其他客户端或应用程序可能会添加新文件。
getAccessControl(PathGetAccessControlOptions)	返回路径（文件目录）的访问控制数据。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
getDataLakeLeaseClient(string)	获取管理路径（目录或文件）上的租约的 DataLakeLeaseClient。
getProperties(PathGetPropertiesOptions)	返回路径（目录或文件）的所有用户定义的元数据、标准 HTTP 属性和系统属性。警告：响应中返回的 `metadata` 对象将具有小写形式的键，即使它们最初包含大写字符也是如此。这不同于 dataLakeFileSystemClient 方法返回的元数据键，这些元数据键使用 `includeMetadata` 选项列出路径，该选项将保留其原始大小写。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	在同一文件系统中移动目录或文件。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	将目录或文件移动到另一个文件系统。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	删除路径和子路径上的访问控制。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	设置路径（文件目录）的访问控制数据。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	设置路径和子路径上的访问控制。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	在路径（目录或文件）上设置系统属性。如果未提供任何值，或者未为指定的 Blob HTTP 标头提供任何值，则清除不带值的这些 blob HTTP 标头。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setMetadata(Metadata, PathSetMetadataOptions)	将指定路径（文件目录）的用户定义元数据设置为一个或多个名称值对。如果未提供任何选项，或者参数中未定义任何元数据，将删除路径元数据。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setPermissions(PathPermissions, PathSetPermissionsOptions)	设置路径上的文件权限。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
toDirectoryClient()	如果当前路径是目录，请将当前 DataLakePathClient 转换为 DataLakeDirectoryClient。
toFileClient()	如果当前路径为文件，请将当前 DataLakePathClient 转换为 DataLakeFileClient。
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	修改路径和子路径上的访问控制。请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

构造函数详细信息

DataLakeFileClient(string, Pipeline)

从 URL 和管道创建 DataLakeFileClient 的实例。

new DataLakeFileClient(url: string, pipeline: Pipeline)

参数

url: string

指向 Azure 存储 Data Lake 文件的客户端字符串，例如“https://myaccount.dfs.core.windows.net/filesystem/file"。如果使用 AnonymousCredential（如“https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString"），则可以追加 SAS。

pipeline: Pipeline

调用 newPipeline（）以创建默认管道，或提供自定义管道。

DataLakeFileClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

从 URL 和凭据创建 DataLakeFileClient 的实例。

new DataLakeFileClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

参数

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

自选。用于配置 HTTP 管道的选项。

属性详细信息

fileSystemName

当前文件系统的名称。

string fileSystemName

属性值

string

name

当前路径的名称（目录或文件）。

string name

属性值

string

继承属性详细信息

accountName

accountName: string

属性值

string

继承自DataLakePathClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

属性值

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

继承自DataLakePathClient.credential

url

编码的 URL 字符串值。

url: string

属性值

string

继承自DataLakePathClient.url

方法详细信息

append(RequestBodyType, number, number, FileAppendOptions)

上传要追加到文件的数据。数据只能追加到文件中。若要向文件应用永久上传的数据，请调用刷新。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function append(body: RequestBodyType, offset: number, length: number, options?: FileAppendOptions): Promise<FileAppendResponse>

参数

body: HttpRequestBody

要上传的内容。

offset: number

追加偏移量（以字节为单位）。

length: number

要追加的内容长度（以字节为单位）。

options: FileAppendOptions

自选。追加数据时的选项。

Promise<FileAppendResponse>

create(FileCreateOptions)

创建文件。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(options?: FileCreateOptions): Promise<FileCreateResponse>

参数

options: FileCreateOptions

自选。创建文件时的选项。

Promise<FileCreateResponse>

create(PathResourceTypeModel, PathCreateOptions)

创建文件。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>

参数

resourceType: PathResourceTypeModel

资源类型必须为 DataLakeFileClient 的“file”。

options: PathCreateOptions

自选。创建文件时的选项。

Promise<PathCreateResponse>

createIfNotExists(FileCreateIfNotExistsOptions)

创建文件（如果该文件尚不存在）。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(options?: FileCreateIfNotExistsOptions): Promise<FileCreateIfNotExistsResponse>

参数

options: FileCreateIfNotExistsOptions

自选。创建文件时的选项。

Promise<FileCreateIfNotExistsResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

创建文件（如果该文件尚不存在）。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

参数

resourceType: PathResourceTypeModel

资源类型必须为 DataLakeFileClient 的“file”。

options: PathCreateIfNotExistsOptions

Promise<PathCreateIfNotExistsResponse>

flush(number, FileFlushOptions)

刷新以前追加到文件中的数据（写入）。

function flush(position: number, options?: FileFlushOptions): Promise<FileFlushResponse>

参数

position: number

要刷新的文件位置。此参数允许调用方并行上传数据，并控制将数据追加到文件的顺序。上传要追加到文件的数据以及将数据刷新到文件时，需要用到该文件。该值必须是要追加数据的位置。上载的数据不会立即刷新或写入文件。若要刷新，以前上传的数据必须连续，位置参数必须指定并等于写入所有数据后文件长度，并且请求中不得包含请求实体正文。

options: FileFlushOptions

自选。刷新数据时的选项。

Promise<FileFlushResponse>

generateSasStringToSign(FileGenerateSasUrlOptions)

仅适用于使用共享密钥凭据构造的客户端。

根据传入的客户端属性和参数，生成用于为服务共享访问签名（SAS） URI 签名的字符串。 SAS 由客户端的共享密钥凭据签名。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

参数

options: FileGenerateSasUrlOptions

可选参数。

string

由此客户端表示的资源的 URI 组成的 SAS URI，后跟生成的 SAS 令牌。

generateSasUrl(FileGenerateSasUrlOptions)

仅适用于使用共享密钥凭据构造的客户端。

基于传入的客户端属性和参数生成服务共享访问签名（SAS） URI。 SAS 由客户端的共享密钥凭据签名。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: FileGenerateSasUrlOptions): Promise<string>

参数

options: FileGenerateSasUrlOptions

可选参数。

Promise<string>

由此客户端表示的资源的 URI 组成的 SAS URI，后跟生成的 SAS 令牌。

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

根据传入的客户端属性和参数，生成用于为服务共享访问签名（SAS） URI 签名的字符串。 SAS 由输入用户委托密钥签名。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

参数

options: FileGenerateSasUrlOptions

可选参数。

userDelegationKey: UserDelegationKey

返回值 blobServiceClient.getUserDelegationKey()

string

由此客户端表示的资源的 URI 组成的 SAS URI，后跟生成的 SAS 令牌。

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

基于传入的客户端属性和参数生成服务共享访问签名（SAS） URI。 SAS 由输入用户委托密钥签名。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: FileGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

参数

options: FileGenerateSasUrlOptions

可选参数。

userDelegationKey: UserDelegationKey

返回值 blobServiceClient.getUserDelegationKey()

Promise<string>

由此客户端表示的资源的 URI 组成的 SAS URI，后跟生成的 SAS 令牌。

query(string, FileQueryOptions)

快速查询 JSON 或 CSV 格式化文件。

示例用法（Node.js）：

// Query and convert a file to a string
const queryResponse = await fileClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryResponse.readableStreamBody)).toString();
console.log("Query file content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: FileQueryOptions): Promise<FileReadResponse>

参数

query: string

options: FileQueryOptions

Promise<FileReadResponse>

read(number, number, FileReadOptions)

从服务下载文件，包括其元数据和属性。

在 Node.js中，数据在可读流 readableStreamBody 中返回
在浏览器中，数据在 promise contentAsBlob 中返回

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

示例用法（Node.js）：

// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
console.log("Downloaded file content:", downloaded.toString());

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

示例用法（浏览器）：

// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await blobToString(await downloadResponse.contentAsBlob);
console.log("Downloaded file content", downloaded);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

function read(offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

参数

offset: number

自选。偏移到读取文件，默认值为 0。

count: number

自选。要读取的字节数，默认值将从偏移量读取到末尾。

options: FileReadOptions

自选。读取文件时的选项。

Promise<FileReadResponse>

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

仅在NODE.JS运行时中可用。

将 Data Lake 文件并行读取到缓冲区。偏移量和计数是可选的，为两者传递 0 以读取整个文件。

警告：由于 Node.js/V8 的限制，缓冲区只能支持 32 位系统上最多一千兆字节的文件或 64 位系统上的大约 2 GB 文件。对于大于此大小的文件，请考虑 readToFile。

function readToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

参数

buffer: Buffer

要填充的缓冲区，长度必须大于计数

offset: number

要读取的 Data Lake 文件的位置

count: number

要读取的数据量。传递未定义时将读取到末尾

options: FileReadToBufferOptions

Promise<Buffer>

readToBuffer(number, number, FileReadToBufferOptions)

仅在NODE.JS运行时中可用

将 Data Lake 文件并行读取到缓冲区。偏移量和计数是可选的，为两者传递 0 以读取整个文件

function readToBuffer(offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>

参数

offset: number

要读取的 Data Lake 文件的位置（以字节为单位）

count: number

要读取的数据量（以字节为单位）。传递未定义时将读取到末尾

options: FileReadToBufferOptions

Promise<Buffer>

readToFile(string, number, number, FileReadOptions)

仅在NODE.JS运行时中可用。

将 Data Lake 文件下载到本地文件。如果给定的文件路径已退出，则失败。偏移量和计数是可选的，分别传递 0 和未定义以下载整个文件。

function readToFile(filePath: string, offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>

参数

filePath: string

offset: number

要下载的文件的位置。

count: number

要下载的数据量。传递未定义时，将下载到末尾。

options: FileReadOptions

读取 Data Lake 文件的选项。

Promise<FileReadResponse>

文件读取操作的响应数据，但已将 readableStreamBody 设置为未定义，因为它的内容已读取并写入到指定路径的本地文件中。

setExpiry(FileExpiryMode, FileSetExpiryOptions)

设置文件的到期时间，一旦达到该时间，文件就会被删除。

function setExpiry(mode: FileExpiryMode, options?: FileSetExpiryOptions): Promise<FileSetExpiryResponse>

参数

mode: FileExpiryMode

options: FileSetExpiryOptions

Promise<FileSetExpiryResponse>

upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

将缓冲区（Node.js）/Blob/ArrayBuffer/ArrayBufferView 上传到文件。

function upload(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

参数

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer（Node）、Blob、ArrayBuffer 或 ArrayBufferView

options: FileParallelUploadOptions

Promise<FileUploadResponse>

uploadFile(string, FileParallelUploadOptions)

仅在NODE.JS运行时中可用。

将本地文件上传到 Data Lake 文件。

function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

参数

filePath: string

本地文件的完整路径

options: FileParallelUploadOptions

Promise<FileUploadResponse>

uploadStream(Readable, FileParallelUploadOptions)

仅在NODE.JS运行时中可用。

将 Node.js 可读流上传到 Data Lake 文件中。此方法将尝试创建文件，然后按区块开始上传区块。请确保流的潜在大小不超过FILE_MAX_SIZE_BYTES，并且可能的区块数不会超过BLOCK_BLOB_MAX_BLOCKS。

性能改进提示：

输入流 highWaterMark 最好使用 options.chunkSize 参数设置相同的值，这将避免 Buffer.concat（）操作。

function uploadStream(stream: Readable, options?: FileParallelUploadOptions): Promise<FileUploadResponse>

参数

stream: Readable

Node.js 可读流。

options: FileParallelUploadOptions

Promise<FileUploadResponse>

继承的方法详细信息

delete(boolean, PathDeleteOptions)

删除当前路径（目录或文件）。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

参数

recursive: boolean

仅当资源是目录时才必需且有效。如果为“true”，将删除目录下的所有路径。

options: PathDeleteOptions

自选。删除路径时的选项。

Promise<PathDeleteResponse>

继承自DataLakePathClient.delete

deleteIfExists(boolean, PathDeleteOptions)

如果存在，请删除当前路径（目录或文件）。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

参数

recursive: boolean

仅当资源是目录时才必需且有效。如果为“true”，将删除目录下的所有路径。

options: PathDeleteOptions

Promise<PathDeleteIfExistsResponse>

继承自DataLakePathClient.deleteIfExists

exists(PathExistsOptions)

如果此客户端表示的 Data Lake 文件存在，则返回 true;否则为 false。

注意：请谨慎使用此函数，因为现有文件可能被其他客户端或应用程序删除。反之亦然，此函数完成后，其他客户端或应用程序可能会添加新文件。

function exists(options?: PathExistsOptions): Promise<boolean>

参数

options: PathExistsOptions

“存在”操作的选项。

Promise<boolean>

继承自DataLakePathClient.exists

getAccessControl(PathGetAccessControlOptions)

返回路径（文件目录）的访问控制数据。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

参数

options: PathGetAccessControlOptions

自选。获取文件访问控制时的选项。

Promise<PathGetAccessControlResponse>

继承自DataLakePathClient.getAccessControl

getDataLakeLeaseClient(string)

获取管理路径（目录或文件）上的租约的 DataLakeLeaseClient。

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

参数

proposeLeaseId: string

自选。初始建议的租约 ID。

DataLakeLeaseClient

继承自DataLakePathClient.getDataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

返回路径（目录或文件）的所有用户定义的元数据、标准 HTTP 属性和系统属性。

警告：响应中返回的 metadata 对象将具有小写形式的键，即使它们最初包含大写字符也是如此。这不同于 dataLakeFileSystemClient 方法返回的元数据键，这些元数据键使用 includeMetadata 选项列出路径，该选项将保留其原始大小写。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

参数

options: PathGetPropertiesOptions

自选。获取路径属性时的选项。

Promise<PathGetPropertiesResponse>

继承自DataLakePathClient.getProperties

move(string, PathMoveOptions)

在同一文件系统中移动目录或文件。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

参数

destinationPath: string

目标目录路径，如“directory”或文件路径“directory/file”。如果 destinationPath 使用 SAS 进行身份验证，请将 SAS 添加到目标路径，例如“directory/file？sasToken”。

options: PathMoveOptions

自选。移动目录或文件时的选项。

Promise<PathMoveResponse>

继承自DataLakePathClient.move

move(string, string, PathMoveOptions)

将目录或文件移动到另一个文件系统。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

参数

destinationFileSystem: string

目标文件系统，如“filesystem”。

destinationPath: string

目标目录路径（如“directory”或文件路径“directory/file”）如果 destinationPath 使用 SAS 进行身份验证，请将 SAS 添加到目标路径，例如“directory/file？sasToken”。

options: PathMoveOptions

自选。移动目录或文件时的选项。

Promise<PathMoveResponse>

继承自DataLakePathClient.move

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

删除路径和子路径上的访问控制。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

参数

acl: RemovePathAccessControlItem[]

文件或目录的 POSIX 访问控制列表。

options: PathChangeAccessControlRecursiveOptions

自选。选项

Promise<PathChangeAccessControlRecursiveResponse>

继承自DataLakePathClient.removeAccessControlRecursive

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

设置路径（文件目录）的访问控制数据。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

参数

acl: PathAccessControlItem[]

文件或目录的 POSIX 访问控制列表。

options: PathSetAccessControlOptions

自选。设置路径访问控制时的选项。

Promise<PathSetAccessControlResponse>

继承自DataLakePathClient.setAccessControl

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

设置路径和子路径上的访问控制。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

参数

acl: PathAccessControlItem[]

文件或目录的 POSIX 访问控制列表。

options: PathChangeAccessControlRecursiveOptions

自选。选项

Promise<PathChangeAccessControlRecursiveResponse>

继承自DataLakePathClient.setAccessControlRecursive

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

在路径（目录或文件）上设置系统属性。

如果未提供任何值，或者未为指定的 Blob HTTP 标头提供任何值，则清除不带值的这些 blob HTTP 标头。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

参数

httpHeaders: PathHttpHeaders

options: PathSetHttpHeadersOptions

Promise<PathSetHttpHeadersResponse>

继承自DataLakePathClient.setHttpHeaders

setMetadata(Metadata, PathSetMetadataOptions)

将指定路径（文件目录）的用户定义元数据设置为一个或多个名称值对。

如果未提供任何选项，或者参数中未定义任何元数据，将删除路径元数据。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

参数

metadata: Metadata

自选。将现有元数据替换为此值。如果未提供任何值，将删除现有元数据。

options: PathSetMetadataOptions

自选。设置路径元数据时的选项。

Promise<PathSetMetadataResponse>

继承自DataLakePathClient.setMetadata

setPermissions(PathPermissions, PathSetPermissionsOptions)

设置路径上的文件权限。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

参数

permissions: PathPermissions

文件所有者、文件拥有组和其他文件的 POSIX 访问权限。

options: PathSetPermissionsOptions

自选。设置路径权限时的选项。

Promise<PathSetPermissionsResponse>

继承自DataLakePathClient.setPermissions

toDirectoryClient()

如果当前路径是目录，请将当前 DataLakePathClient 转换为 DataLakeDirectoryClient。

function toDirectoryClient(): DataLakeDirectoryClient

DataLakeDirectoryClient

继承自DataLakePathClient.toDirectoryClient

toFileClient()

如果当前路径为文件，请将当前 DataLakePathClient 转换为 DataLakeFileClient。

function toFileClient(): DataLakeFileClient

DataLakeFileClient

继承自DataLakePathClient.toFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

修改路径和子路径上的访问控制。

请参阅 https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

参数

acl: PathAccessControlItem[]

文件或目录的 POSIX 访问控制列表。

options: PathChangeAccessControlRecursiveOptions

自选。选项

Promise<PathChangeAccessControlRecursiveResponse>

继承自DataLakePathClient.updateAccessControlRecursive

通过

DataLakeFileClient class

构造函数

属性

继承属性

方法

继承的方法

构造函数详细信息

DataLakeFileClient(string, Pipeline)

参数

DataLakeFileClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

参数

属性详细信息

fileSystemName

属性值

name

属性值

继承属性详细信息

accountName

属性值

credential

属性值

url

属性值

方法详细信息

append(RequestBodyType, number, number, FileAppendOptions)

参数

返回

create(FileCreateOptions)

参数

返回

create(PathResourceTypeModel, PathCreateOptions)

参数

返回

createIfNotExists(FileCreateIfNotExistsOptions)

参数

返回

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

参数

返回

flush(number, FileFlushOptions)

参数

返回

generateSasStringToSign(FileGenerateSasUrlOptions)

参数

返回

generateSasUrl(FileGenerateSasUrlOptions)

参数

返回

generateUserDelegationSasStringToSign(FileGenerateSasUrlOptions, UserDelegationKey)

参数

返回

generateUserDelegationSasUrl(FileGenerateSasUrlOptions, UserDelegationKey)

参数

返回

query(string, FileQueryOptions)

参数

返回

read(number, number, FileReadOptions)

参数

返回

readToBuffer(Buffer, number, number, FileReadToBufferOptions)

参数

返回

readToBuffer(number, number, FileReadToBufferOptions)

参数

返回

readToFile(string, number, number, FileReadOptions)

参数

返回

setExpiry(FileExpiryMode, FileSetExpiryOptions)

参数

返回

upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

参数

返回

uploadFile(string, FileParallelUploadOptions)

参数

返回

uploadStream(Readable, FileParallelUploadOptions)