ShareFileClient class

创建 ShareFileClient 的实例。

new ShareFileClient(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions)

参数

创建 ShareFileClient 的实例。

new ShareFileClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

参数

文件的名称

string name

属性值

文件的完整路径

string path

属性值

与此文件客户端对应的共享名称

string shareName

属性值

accountName: string

属性值

继承自 StorageClient.accountName

URL 字符串值。

url: string

属性值

继承自 StorageClient.url

中止挂起的复制文件作，并将目标文件保留为零长度和完整元数据。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/abort-copy-file

function abortCopyFromURL(copyId: string, options?: FileAbortCopyFromURLOptions): Promise<FileAbortCopyResponse>

参数

返回

清除指定的范围并释放该范围存储中使用的空间。

function clearRange(offset: number, contentLength: number, options?: FileClearRangeOptions): Promise<FileUploadRangeResponse>

参数

返回

创建新文件或替换文件。 请注意，它仅初始化没有内容的文件。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/create-file

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

参数

返回

文件创建作的响应数据。

示例用法：

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

仅限 NFS。 创建指向由路径指定的文件文件的硬链接。

function createHardLink(targetFile: string, options?: FileCreateHardLinkOptions): Promise<FileCreateHardLinkResponse>

参数

返回

从存储帐户中删除该文件。 成功删除文件时，会立即从存储帐户的索引中删除该文件，并且客户端不再可访问该文件。 在垃圾回收期间，文件的数据稍后会从服务中删除。

如果文件在 SMB 客户端上打开，则删除文件将失败，状态代码为 409（冲突）和错误代码 SharingViolation。

共享快照不支持删除文件，这是共享的只读副本。 尝试对共享快照执行此作将失败，但 400 （InvalidQueryParameterValue）

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2

function delete(options?: FileDeleteOptions): Promise<FileDeleteResponse>

参数

返回

文件删除作的响应数据。

从存储帐户中删除该文件（如果存在）。 成功删除文件时，会立即从存储帐户的索引中删除该文件，并且客户端不再可访问该文件。 在垃圾回收期间，文件的数据稍后会从服务中删除。

如果文件在 SMB 客户端上打开，则删除文件将失败，状态代码为 409（冲突）和错误代码 SharingViolation。

共享快照不支持删除文件，这是共享的只读副本。 尝试对共享快照执行此作将失败，但 400 （InvalidQueryParameterValue）

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2

function deleteIfExists(options?: FileDeleteOptions): Promise<FileDeleteIfExistsResponse>

参数

返回

从系统读取或下载文件，包括其元数据和属性。

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

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

function download(offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

参数

返回

文件下载作的响应数据。

示例用法（Node.js）：

// Download a file to a string
const downloadFileResponse = await fileClient.download();
console.log(
  "Downloaded file content:",
  (await streamToBuffer(downloadFileResponse.readableStreamBody)).toString()}
);

// A helper method used to read a Node.js readable stream into string
async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(typeof data === "string" ? Buffer.from(data) : data);
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

示例用法（浏览器）：

// Download a file to a string
const downloadFileResponse = await fileClient.download(0);
console.log(
  "Downloaded file content:",
  await blobToString(await downloadFileResponse.blobBody)}
);

// A helper method used to convert a browser Blob into string.
export 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);
  });
}

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

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

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

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

参数

返回

仅在NODE.JS运行时中可用

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

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

function downloadToBuffer(offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

参数

返回

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

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

function downloadToFile(filePath: string, offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

参数

返回

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

如果指定的文件存在，则返回 true;否则为 false。

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

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

参数

返回

强制关闭文件的所有句柄。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles

function forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>

参数

返回

强制关闭文件的特定句柄。

请参阅 https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles

function forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>

参数

返回

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

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

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

参数

返回

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

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

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

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

function generateSasUrl(options: FileGenerateSasUrlOptions): string

参数

返回

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

返回文件的所有用户定义的元数据、标准 HTTP 属性和系统属性。 它不返回文件的内容。

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

function getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>

参数

返回

文件获取属性作的响应数据。

返回文件的有效范围列表。

function getRangeList(options?: FileGetRangeListOptions): Promise<FileGetRangeListResponse>

参数

返回

返回上一个共享快照与此文件之间的差异的范围列表。

function getRangeListDiff(prevShareSnapshot: string, options?: FileGetRangeListOptions): Promise<FileGetRangeListDiffResponse>

参数

返回

获取管理文件租约的 ShareLeaseClient。

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

参数

返回

用于管理文件租约的新 ShareLeaseClient 对象。

返回异步可迭代迭代器以列出所有句柄。 在指定的帐户下。

.byPage（） 返回异步可迭代迭代器以列出页面中的句柄。

function listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

参数

返回

重命名文件。 此 API 仅支持在同一共享中重命名文件。

function rename(destinationPath: string, options?: FileRenameOptions): Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

参数

返回

文件重命名作的响应数据。

示例用法：

// Rename the file
await fileClient.rename(destinationPath);
console.log("Renamed file successfully!");

调整文件大小。

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

function resize(length: number, options?: FileResizeOptions): Promise<FileSetHTTPHeadersResponse>

参数

返回

文件集 HTTP 标头作的响应数据。

设置文件的 HTTP 标头。

如果未提供任何选项，或者未为选项中的文件 HTTP 标头提供任何值，则清除不带值的这些文件 HTTP 标头。

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

function setHttpHeaders(fileHttpHeaders?: FileHttpHeaders, options?: FileSetHttpHeadersOptions): Promise<FileSetHTTPHeadersResponse>

参数

返回

文件集 HTTP 标头作的响应数据。

更新指定文件的用户定义的元数据。

如果未在选项参数中定义任何元数据，将删除文件元数据。

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

function setMetadata(metadata?: Metadata, options?: FileSetMetadataOptions): Promise<FileSetMetadataResponse>

参数

返回

文件集元数据作的响应数据。

设置文件的属性。

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

function setProperties(properties?: FileProperties): Promise<SetPropertiesResponse>

参数

返回

将 Blob 或文件复制到存储帐户中的目标文件。

function startCopyFromURL(copySource: string, options?: FileStartCopyOptions): Promise<FileStartCopyResponse>

参数

返回

创建新的 Azure 文件或替换现有的 Azure 文件，然后将 Buffer（Node）/Blob/ArrayBuffer/ArrayBufferView 上传到该文件。

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

参数

返回

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

创建新的 Azure 文件或替换现有的 Azure 文件，然后将本地文件上传到该文件。

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

参数

返回

将字节范围上传到文件。 只能在现有文件上调用此作。 它不会更改文件的大小、属性或元数据。 必须同时指定范围的开始和计数。 该范围的大小最大为 4 MB。

function uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>

参数

返回

文件上传范围作的响应数据。

示例用法：

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

将字节范围上传到从另一个文件的 URL 读取内容的文件。 该范围的大小最大为 4 MB。

function uploadRangeFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: FileUploadRangeFromURLOptions): Promise<FileUploadRangeFromURLResponse>

参数

返回

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

接受 Node.js 可读流工厂，并将块中上传到 Azure 文件。 可读流工厂必须从定义的偏移量返回 Node.js 可读流。 偏移量是要上传的 Azure 文件中的偏移量。

function uploadResetableStream(streamFactory: (offset: number, count?: number) => ReadableStream, size: number, options?: FileParallelUploadOptions): Promise<void>

参数

返回

仅在浏览器中可用。

将浏览器 Blob 对象上传到 Azure 文件。 需要 blobFactory 作为数据源，该数据源需要返回具有提供的偏移量和大小的 Blob 对象。

function uploadSeekableBlob(blobFactory: (offset: number, size: number) => Blob, size: number, options?: FileParallelUploadOptions): Promise<void>

参数

返回

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

创建新的 Azure 文件或替换现有的 Azure 文件，然后将 Node.js 可读流上传到其中。 此方法将尝试创建 Azure 文件，然后按区块开始上传区块。 区块的大小由 bufferSize 参数定义。 请确保流的潜在大小不会超过文件大小。

性能改进提示：

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

function uploadStream(stream: Readable, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>

参数

返回

创建一个新的 ShareFileClient 对象，该对象与源相同，但具有指定的共享快照时间戳。 提供“”将删除快照，并将 URL 返回到基本 ShareFileClient。

function withShareSnapshot(shareSnapshot: string): ShareFileClient

参数

返回

与源相同的新 ShareFileClient 对象，但具有指定的共享快照时间戳。