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

BlobClient class

包:

@azure/storage-blob

BlobClient 表示 Azure 存储 Blob 的 URL;blob 可以是块 Blob、追加 blob 或页 Blob。

Extends

StorageClient

构造函数

BlobClient(string, PipelineLike)	创建 BlobClient 的实例。 此方法接受指向 blob 的编码 URL 或非编码 URL。 编码的 URL 字符串不会转义两次，只会转义 URL 路径中的特殊字符。 Blob 名称是否包含 ？ 或 % blob 名称必须在 URL 中编码。
BlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	创建 BlobClient 的实例。 此方法接受指向 blob 的编码 URL 或非编码 URL。 编码的 URL 字符串不会转义两次，只会转义 URL 路径中的特殊字符。 Blob 名称是否包含 ？ 或 % blob 名称必须在 URL 中编码。
BlobClient(string, string, string, StoragePipelineOptions)	从连接字符串创建 BlobClient 的实例。

属性

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

继承属性

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

方法

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	中止挂起的异步复制 Blob 操作，并将目标 Blob 保留为零长度和完整元数据。 版本 2012-02-12 及更新。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	将 Blob 异步复制到存储帐户内的目标。 此方法返回一个长时间运行的操作轮询程序，使你可以无限期地等待复制完成。 还可以通过在轮询器上调用 cancelOperation 副本，在副本完成之前取消该副本。 请注意，如果操作在第一个请求中完成，并且尝试取消已完成的副本将导致引发错误，则不会调用 onProgress 回调。 在版本 2012-02-12 及更高版本中，复制 Blob 操作的源可以是任何 Azure 存储帐户中的已提交的 Blob。 从版本 2015-02-21 开始，复制 Blob 操作的源可以是任何 Azure 存储帐户中的 Azure 文件。 只有创建于 2012 年 6 月 7 日或之后的存储帐户才允许 Blob 复制操作从其他存储帐户中进行复制。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob 使用自动轮询的示例： const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone(); 使用手动轮询的示例： const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult(); 使用进度更新的示例： const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); 使用更改轮询间隔的示例 (默认 15 秒) ： const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone(); 使用复制取消的示例： const copyPoller = await blobClient.beginCopyFromURL('url'); // cancel operation after starting it. try { await copyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError await copyPoller.getResult(); } catch (err) { if (err.name === 'PollerCancelledError') { console.log('The copy was cancelled.'); } }
createSnapshot(BlobCreateSnapshotOptions)	创建 Blob 的只读快照。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)	标记要删除的指定 Blob 或快照。 该 Blob 将在稍后的垃圾回收期间删除。 请注意，要删除 Blob，必须删除其所有快照。 可以使用删除 Blob 操作同时删除这两者。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)	将指定的 Blob 或快照标记为要删除（如果存在）。 该 Blob 将在稍后的垃圾回收期间删除。 请注意，要删除 Blob，必须删除其所有快照。 可以使用删除 Blob 操作同时删除这两者。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	删除 Blob 上的不可变策略。
download(number, number, BlobDownloadOptions)	从系统读取或下载 Blob，包括其元数据和属性。 还可以调用获取 Blob 来读取快照。 在 Node.js 中，数据在可读流可读StreamBody 中返回 在浏览器中，数据在 promise blobBody 中返回 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	仅在 NODE.JS RUNTIME 中可用。 将 Azure Blob 并行下载到缓冲区。 偏移量和计数是可选的，如果未提供，则下载整个 Blob。 警告：由于Node.js/V8 的限制，缓冲区在 32 位系统上最多只能支持大约 1 GB 的文件，在 64 位系统上只能支持大约 2 GB 的文件。 对于大于此大小的 Blob，请考虑 downloadToFile。
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	仅在 NODE.JS RUNTIME 中可用。 将 Azure Blob 并行下载到缓冲区。 偏移量和计数是可选的，如果未提供，则下载整个 Blob。 警告：由于Node.js/V8 的限制，缓冲区在 32 位系统上最多只能支持大约 1 GB 的文件，在 64 位系统上只能支持大约 2 GB 的文件。 对于大于此大小的 Blob，请考虑 downloadToFile。
downloadToFile(string, number, number, BlobDownloadOptions)	仅在 NODE.JS RUNTIME 中可用。 将 Azure Blob 下载到本地文件。 如果给定的文件路径已退出，则失败。 偏移量和计数是可选的，分别传递 0 和未定义以下载整个 Blob。
exists(BlobExistsOptions)	如果此客户端表示的 Azure Blob 资源存在，则返回 true;否则为 false。 注意：请谨慎使用此函数，因为现有 Blob 可能被其他客户端或应用程序删除。 反之亦然，此函数完成后，其他客户端或应用程序可能会添加新的 Blob。
generateSasUrl(BlobGenerateSasUrlOptions)	仅适用于使用共享密钥凭据构造的 BlobClient。 根据传入的客户端属性和参数， (SAS) URI 生成 Blob 服务共享访问签名。 SAS 由客户端的共享密钥凭据签名。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAppendBlobClient()	创建 AppendBlobClient 对象。
getBlobLeaseClient(string)	获取管理 Blob 上的租约的 BlobLeaseClient 。
getBlockBlobClient()	创建 BlockBlobClient 对象。
getPageBlobClient()	创建 PageBlobClient 对象。
getProperties(BlobGetPropertiesOptions)	返回 Blob 的所有用户定义的元数据、标准 HTTP 属性和系统属性。 它不返回 Blob 的内容。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties 警告：响应 metadata 中返回的对象将具有小写的键，即使它们最初包含大写字符。 这不同于 ContainerClient 方法返回的元数据键，后者使用 includeMetadata 选项列出 Blob，该选项将保留其原始大小写。
getTags(BlobGetTagsOptions)	获取与基础 Blob 关联的标记。
setAccessTier(string, BlobSetTierOptions)	设置 Blob 上的层。 在高级存储帐户中的页 Blob 上和 blob 存储帐户中的块 blob 上允许此操作， (本地冗余存储仅) 。 高级页 Blob 的层确定 Blob 允许的大小、IOPS 和带宽。 块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	在 blob 上设置系统属性。 如果未提供任何值，或者没有为指定的 Blob HTTP 标头提供值，则会清除这些没有值的 Blob HTTP 标头。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	在 Blob 上设置不可变策略。
setLegalHold(boolean, BlobSetLegalHoldOptions)	对 Blob 设置法定保留。
setMetadata(Metadata, BlobSetMetadataOptions)	将特定 blob 的用户定义元数据设置为一个或多个名称/值对。 如果未提供任何选项，或者参数中未定义任何元数据，则将删除 Blob 元数据。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)	设置基础 Blob 上的标记。 一个 Blob 最多可以有 10 个标记。 标记键必须介于 1 到 128 个字符之间。 标记值必须介于 0 到 256 个字符之间。 有效的标记键和值字符包括小写字母和大写字母、 (0-9) 、空格 (“) ”，以及 (“+”) ，减去 (“-”) ，句点 (”。) ，正斜杠 ('/') ，冒号 ('：') ，等于 ('=') ，并下划线 ('_') 。
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	同步复制自 URL 操作将 Blob 或 Internet 资源复制到新 Blob。 在复制完成之前，它不会返回响应。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	还原软删除的 Blob 以及任何关联的软删除快照的内容和元数据。 仅版本 2017-07-29 或更高版本支持取消删除 Blob。 请参见https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withSnapshot(string)	创建与源相同但具有指定快照时间戳的新 BlobClient 对象。 提供“”将删除快照并将客户端返回到基本 Blob。
withVersion(string)	创建一个新的 BlobClient 对象，该对象指向此 Blob 的某个版本。 提供“”将删除 versionId 并将客户端返回到基本 Blob。

构造函数详细信息

BlobClient(string, PipelineLike)

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

new BlobClient(url: string, pipeline: PipelineLike)

参数

url

string

指向 Azure 存储 blob 的 URL 字符串，例如“https://myaccount.blob.core.windows.net/mycontainer/blob"”。 如果使用 AnonymousCredential，则可以追加 SAS，例如“https://myaccount.blob.core.windows.net/mycontainer/blob?sasString"”。 此方法接受指向 blob 的编码 URL 或非编码 URL。 编码的 URL 字符串不会转义两次，只会转义 URL 路径中的特殊字符。 但是，如果 Blob 名称包含 ？ 或 % blob 名称必须在 URL 中编码。 例如名为“my？blob%”的 Blob，URL 应为“https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25"”。

pipeline

PipelineLike

调用 newPipeline () 以创建默认管道或提供自定义管道。

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

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

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

参数

url

string

指向 Azure 存储 Blob 服务的客户端字符串，例如“https://myaccount.blob.core.windows.net"”。 如果使用 AnonymousCredential，则可以追加 SAS，例如“https://myaccount.blob.core.windows.net?sasString"”。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options

StoragePipelineOptions

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

BlobClient(string, string, string, StoragePipelineOptions)

从连接字符串创建 BlobClient 的实例。

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

参数

connectionString

string

Azure 存储帐户的帐户连接字符串或 SAS 连接字符串。 [ 注意 - 帐户连接字符串只能在NODE.JS运行时中使用。 ] 帐户连接字符串示例 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS 连接字符串示例 - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

容器名称。

blobName

string

Blob 名称。

options

StoragePipelineOptions

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

属性详细信息

containerName

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

string containerName

属性值

string

name

Blob 的名称。

string name

属性值

string

继承属性详细信息

accountName

accountName: string

属性值

string

继承自 StorageClient.accountName

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

属性值

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

继承自 StorageClient.credential

url

编码的 URL 字符串值。

url: string

属性值

string

继承自 StorageClient.url

方法详细信息

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

请参见https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

参数

copyId

string

复制自 URL 操作的 ID。

options

BlobAbortCopyFromURLOptions

Blob 中止复制自 URL 操作的可选选项。

返回

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

将 Blob 异步复制到存储帐户内的目标。 此方法返回一个长时间运行的操作轮询程序，使你可以无限期地等待复制完成。 还可以通过在轮询器上调用 cancelOperation 副本，在副本完成之前取消该副本。 请注意，如果操作在第一个请求中完成，并且尝试取消已完成的副本将导致引发错误，则不会调用 onProgress 回调。

在版本 2012-02-12 及更高版本中，复制 Blob 操作的源可以是任何 Azure 存储帐户中的已提交的 Blob。 从版本 2015-02-21 开始，复制 Blob 操作的源可以是任何 Azure 存储帐户中的 Azure 文件。 只有创建于 2012 年 6 月 7 日或之后的存储帐户才允许 Blob 复制操作从其他存储帐户中进行复制。

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

使用自动轮询的示例：

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

使用手动轮询的示例：

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

使用进度更新的示例：

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

使用更改轮询间隔的示例 (默认 15 秒) ：

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

使用复制取消的示例：

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

参数

copySource

string

指向源 Azure Blob/文件的 url。

options

BlobBeginCopyFromURLOptions

Blob“从 URL 开始复制”操作的可选选项。

返回

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot(BlobCreateSnapshotOptions)

创建 Blob 的只读快照。

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

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

参数

options

BlobCreateSnapshotOptions

Blob 创建快照操作的可选选项。

返回

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

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

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

参数

options

BlobDeleteOptions

Blob 删除操作的可选选项。

返回

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

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

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

参数

options

BlobDeleteOptions

Blob 删除操作的可选选项。

返回

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

删除 Blob 上的不可变策略。

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

参数

options

BlobDeleteImmutabilityPolicyOptions

用于在 Blob 上删除不可变策略的可选选项。

返回

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

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

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

参数

offset

number

要从哪个位置下载 Blob，大于或等于 0

count

number

要下载的数据量，大于 0。 未定义时将下载到末尾

options

BlobDownloadOptions

Blob 下载操作的可选选项。

示例用法 (Node.js) ：

// 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);
  });
}

返回

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

仅在 NODE.JS RUNTIME 中可用。

将 Azure Blob 并行下载到缓冲区。 偏移量和计数是可选的，如果未提供，则下载整个 Blob。

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

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

参数

buffer

Buffer

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

offset

number

从块 blob 的哪个位置下载 (（以字节为单位）)

count

number

要下载的数据 (（以字节为单位）) 。 传递未定义时，将下载到末尾

options

BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

返回

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

仅在 NODE.JS RUNTIME 中可用。

将 Azure Blob 并行下载到缓冲区。 偏移量和计数是可选的，如果未提供，则下载整个 Blob。

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

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

参数

offset

number

从块 blob 的哪个位置下载 (（以字节为单位）)

count

number

要下载的数据 (（以字节为单位）) 。 传递未定义时，将下载到末尾

options

BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

返回

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

仅在 NODE.JS RUNTIME 中可用。

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

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

参数

filePath

string

offset

number

要从哪个位置下载块 Blob。

count

number

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

options

BlobDownloadOptions

Blob 下载选项的选项。

返回

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

如果此客户端表示的 Azure Blob 资源存在，则返回 true;否则为 false。

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

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

参数

options

BlobExistsOptions

“存在”操作的选项。

返回

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

仅适用于使用共享密钥凭据构造的 BlobClient。

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

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

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

参数

options

BlobGenerateSasUrlOptions

可选参数。

返回

Promise<string>

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

getAppendBlobClient()

创建 AppendBlobClient 对象。

function getAppendBlobClient(): AppendBlobClient

返回

AppendBlobClient

getBlobLeaseClient(string)

获取管理 Blob 上的租约的 BlobLeaseClient 。

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

参数

proposeLeaseId

string

初始建议租约 ID。

返回

BlobLeaseClient

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

getBlockBlobClient()

创建 BlockBlobClient 对象。

function getBlockBlobClient(): BlockBlobClient

返回

BlockBlobClient

getPageBlobClient()

创建 PageBlobClient 对象。

function getPageBlobClient(): PageBlobClient

返回

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

警告：响应 metadata 中返回的对象将具有小写的键，即使它们最初包含大写字符。 这不同于 ContainerClient 方法返回的元数据键，后者使用 includeMetadata 选项列出 Blob，该选项将保留其原始大小写。

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

参数

options

BlobGetPropertiesOptions

获取属性操作的可选选项。

返回

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

参数

options

BlobGetTagsOptions

返回

Promise<BlobGetTagsResponse>

setAccessTier(string, BlobSetTierOptions)

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

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

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

参数

tier

string

要对 Blob 设置的层。 有效值为热、冷或存档。

options

BlobSetTierOptions

Blob 集层操作的可选选项。

返回

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

在 blob 上设置系统属性。

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

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

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

参数

blobHTTPHeaders

BlobHTTPHeaders

如果未提供任何值，或者没有为指定的 Blob HTTP 标头提供值，则会清除这些没有值的 Blob HTTP 标头。 要设置的常见标头是 blobContentType 使浏览器能够基于文件类型提供功能。

options

BlobSetHTTPHeadersOptions

Blob 设置 HTTP 标头操作的可选选项。

返回

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

在 Blob 上设置不可变策略。

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

参数

immutabilityPolicy

BlobImmutabilityPolicy

options

BlobSetImmutabilityPolicyOptions

用于在 Blob 上设置不可变性策略的可选选项。

返回

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

对 Blob 设置法定保留。

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

参数

legalHoldEnabled

boolean

options

BlobSetLegalHoldOptions

用于在 Blob 上设置法定保留的可选选项。

返回

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

将特定 blob 的用户定义元数据设置为一个或多个名称/值对。

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

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

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

参数

metadata

Metadata

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

options

BlobSetMetadataOptions

“设置元数据”操作的可选选项。

返回

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

参数

tags

Tags

options

BlobSetTagsOptions

返回

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

请参见https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

参数

copySource

string

要从中复制的源 URL、共享访问签名 (SAS) 身份验证可能需要

options

BlobSyncCopyFromURLOptions

返回

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

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

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

参数

options

BlobUndeleteOptions

Blob 取消删除操作的可选选项。

返回

Promise<BlobUndeleteResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlobClient

参数

snapshot

string

快照时间戳。

返回

BlobClient

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

withVersion(string)

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

function withVersion(versionId: string): BlobClient

参数

versionId

string

versionId。

返回

BlobClient

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