PageBlobClient class

创建 PageBlobClient 的实例。

new PageBlobClient(url: string, pipeline: PipelineLike)

参数

创建 PageBlobClient 的实例。 此方法接受指向 blob 的编码 URL 或非编码 URL。 编码的 URL 字符串不会转义两次，只会转义 URL 路径中的特殊字符。 Blob 名称是否包含 ？ 或 % blob 名称必须在 URL 中编码。

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

参数

创建 PageBlobClient 的实例。

new PageBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

参数

accountName: string

属性值

与 Blob 关联的存储容器的名称。

string containerName

属性值

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

属性值

Blob 的名称。

string name

属性值

编码的 URL 字符串值。

url: string

属性值

中止挂起的异步复制 Blob 操作，并将目标 Blob 保留为零长度和完整元数据。 版本 2012-02-12 及更新。

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

参数

返回

将 Blob 异步复制到存储帐户内的目标。 此方法返回一个长时间运行的操作轮询程序，使你可以无限期地等待复制完成。 还可以通过在轮询器上调用 cancelOperation 副本，在副本完成之前取消该副本。 请注意，如果操作在第一个请求中完成，并且尝试取消已完成的副本将导致引发错误，则不会调用 onProgress 回调。 在版本 2012-02-12 及更高版本中，复制 Blob 操作的源可以是任何 Azure 存储帐户中的已提交的 Blob。 从版本 2015-02-21 开始，复制 Blob 操作的源可以是任何 Azure 存储帐户中的 Azure 文件。 只有创建于 2012 年 6 月 7 日或之后的存储帐户才允许 Blob 复制操作从其他存储帐户中进行复制。

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

参数

返回

从页 Blob 中释放指定的页。

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

参数

返回

页 Blob 清除页面操作的响应数据。

创建指定长度的页 Blob。 调用 uploadPages 将数据上传到页 Blob。

function create(size: number, options?: PageBlobCreateOptions)

参数

返回

页 Blob 创建操作的响应数据。

创建指定长度的页 Blob。 调用 uploadPages 将数据上传到页 Blob。 如果已存在同名的 Blob，现有 Blob 的内容将保持不变。

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

参数

返回

创建 Blob 的只读快照。

function createSnapshot(options?: BlobCreateSnapshotOptions)

参数

返回

标记要删除的指定 Blob 或快照。 该 Blob 将在稍后的垃圾回收期间删除。 请注意，要删除 Blob，必须删除其所有快照。 可以使用删除 Blob 操作同时删除这两者。

function delete(options?: BlobDeleteOptions)

参数

返回

将指定的 Blob 或快照标记为要删除（如果存在）。 该 Blob 将在稍后的垃圾回收期间删除。 请注意，要删除 Blob，必须删除其所有快照。 可以使用删除 Blob 操作同时删除这两者。

function deleteIfExists(options?: BlobDeleteOptions)

参数

返回

删除 Blob 上的不可变策略。

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

参数

返回

从系统读取或下载 Blob，包括其元数据和属性。 还可以调用获取 Blob 来读取快照。

• 在 Node.js 中，数据在可读流可读StreamBody 中返回
• 在浏览器中，数据在 promise blobBody 中返回

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

参数

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob 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 blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob 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);
  });
}

返回

仅在 NODE.JS RUNTIME 中可用。 将 Azure Blob 并行下载到缓冲区。 偏移量和计数是可选的，如果未提供，则下载整个 Blob。

警告：由于Node.js/V8 的限制，缓冲区在 32 位系统上最多只能支持大约 1 GB 的文件，在 64 位系统上只能支持大约 2 GB 的文件。 对于大于此大小的 Blob，请考虑 <xref:downloadToFile>。

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

参数

返回

仅在 NODE.JS RUNTIME 中可用。 将 Azure Blob 并行下载到缓冲区。 偏移量和计数是可选的，如果未提供，则下载整个 Blob。

警告：由于Node.js/V8 的限制，缓冲区在 32 位系统上最多只能支持大约 1 GB 的文件，在 64 位系统上只能支持大约 2 GB 的文件。 对于大于此大小的 Blob，请考虑 <xref:downloadToFile>。

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

参数

返回

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

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

参数

返回

Blob 下载操作的响应数据，但当 readableStreamBody 设置为 undefined 时，其内容已读取并写入指定路径处的本地文件。

如果此客户端表示的 Azure Blob 资源存在，则返回 true;否则为 false。 注意：请谨慎使用此函数，因为现有 Blob 可能被其他客户端或应用程序删除。 反之亦然，此函数完成后，其他客户端或应用程序可能会添加新的 Blob。

function exists(options?: BlobExistsOptions)

参数

返回

仅适用于使用共享密钥凭据构造的 BlobClient。 根据传入的客户端属性和参数， (SAS) URI 生成 Blob 服务共享访问签名。 SAS 由客户端的共享密钥凭据签名。

function generateSasUrl(options: BlobGenerateSasUrlOptions)

参数

返回

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

创建 AppendBlobClient 对象。

function getAppendBlobClient()

返回

获取 <xref:BlobLeaseClient> 管理 Blob 上的租约的 。

function getBlobLeaseClient(proposeLeaseId?: string)

参数

返回

一个新的 BlobLeaseClient 对象，用于管理 Blob 上的租约。

创建 BlockBlobClient 对象。

function getBlockBlobClient()

返回

创建 PageBlobClient 对象。

function getPageBlobClient()

返回

返回页 Blob 或页 Blob 快照的有效页范围列表。

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

参数

返回

页 Blob 获取范围操作的响应数据。

获取指定快照和此页 Blob 之间不同页范围的集合。

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

参数

返回

页 Blob 获取页范围差异操作的响应数据。

获取托管磁盘的指定快照和此页 Blob 之间不同页范围的集合。

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

参数

返回

页 Blob 获取页范围差异操作的响应数据。

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

function getProperties(options?: BlobGetPropertiesOptions)

参数

返回

获取与基础 Blob 关联的标记。

function getTags(options?: BlobGetTagsOptions)

参数

返回

将页 blob 调整为指定大小 (该大小必须是 512) 的倍数。

function resize(size: number, options?: PageBlobResizeOptions)

参数

返回

页面 Blob 大小调整操作的响应数据。

设置 Blob 上的层。 在高级存储帐户中的页 Blob 上和 blob 存储帐户中的块 blob 上允许此操作， (本地冗余存储仅) 。 高级页 Blob 的层确定 Blob 允许的大小、IOPS 和带宽。 块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

参数

返回

在 blob 上设置系统属性。 如果未提供任何值，或者没有为指定的 Blob HTTP 标头提供值，则会清除这些没有值的 Blob HTTP 标头。

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

参数

返回

在 Blob 上设置不可变策略。

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)

参数

返回

对 Blob 设置法定保留。

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)

参数

返回

将特定 blob 的用户定义元数据设置为一个或多个名称/值对。 如果未提供任何选项，或者参数中未定义任何元数据，则将删除 Blob 元数据。

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

参数

返回

设置基础 Blob 上的标记。 一个 Blob 最多可以有 10 个标记。 标记键必须介于 1 到 128 个字符之间。 标记值必须介于 0 到 256 个字符之间。 有效的标记键和值字符包括小写字母和大写字母、 (0-9) 、空格 (“) ”，以及 (“+”) ，减去 (“-”) ，句点 (”。) ，正斜杠 ('/') ，冒号 ('：') ，等于 ('=') ，并下划线 ('_') 。

function setTags(tags: Tags, options?: BlobSetTagsOptions)

参数

返回

开始一个操作，以启动从一页 Blob 的快照到此页 Blob 的增量复制。 复制快照，以便仅将以前复制的快照之间的差异更改传输到目标。 复制的快照是原始快照的完整副本，可以像往常一样从中读取或复制。

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

参数

返回

页 Blob 复制增量操作的响应数据。

同步复制自 URL 操作将 Blob 或 Internet 资源复制到新 Blob。 在复制完成之前，它不会返回响应。

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

参数

返回

还原软删除的 Blob 以及任何关联的软删除快照的内容和元数据。 仅版本 2017-07-29 或更高版本支持取消删除 Blob。

function undelete(options?: BlobUndeleteOptions)

参数

返回

设置页 Blob 的序列号。

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

参数

返回

页 Blob 更新序列号操作的响应数据。

将 1 页或更多页写入页 Blob。 开始偏移量和结束偏移量必须是 512 的倍数。

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

参数

返回

页 Blob 上传页面操作的响应数据。

“上传页面”操作将一系列页面写入页 Blob，其中的内容是从 URL 读取的。

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

参数

返回

创建与源相同但具有指定快照时间戳的新 PageBlobClient 对象。 提供“”将删除快照并将客户端返回到基本 Blob。

function withSnapshot(snapshot: string)

参数

返回

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

创建一个新的 BlobClient 对象，该对象指向此 Blob 的某个版本。 提供“”将删除 versionId 并将客户端返回到基本 Blob。

function withVersion(versionId: string)

参数

返回

指向此 Blob 版本的新 BlobClient 对象。