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

BlobBaseClient 类

定义

BlobBaseClient 允许操作 Azure 存储 Blob。

public class BlobBaseClient
type BlobBaseClient = class
Public Class BlobBaseClient
继承
BlobBaseClient
派生

构造函数

BlobBaseClient()

初始化 BlobBaseClient 类的新实例。

BlobBaseClient(String, String, String)

初始化 BlobBaseClient 类的新实例。

BlobBaseClient(String, String, String, BlobClientOptions)

初始化 BlobBaseClient 类的新实例。

BlobBaseClient(Uri, AzureSasCredential, BlobClientOptions)

初始化 BlobBaseClient 类的新实例。

BlobBaseClient(Uri, BlobClientOptions)

初始化 BlobBaseClient 类的新实例。

BlobBaseClient(Uri, StorageSharedKeyCredential, BlobClientOptions)

初始化 BlobBaseClient 类的新实例。

BlobBaseClient(Uri, TokenCredential, BlobClientOptions)

初始化 BlobBaseClient 类的新实例。

属性

AccountName

获取与 Blob 客户端对应的存储帐户名称。

BlobContainerName

获取与 Blob 客户端对应的容器名称。

CanGenerateSasUri

确定客户端是否能够生成 SAS。 如果客户端使用 StorageSharedKeyCredential进行身份验证。

Name

获取 Blob 的名称。

Uri

获取 Blob 的主 Uri 终结点。

方法

AbortCopyFromUri(String, BlobRequestConditions, CancellationToken)

AbortCopyFromUri(String, BlobRequestConditions, CancellationToken) 操作中止挂起 CopyFromUriOperation的 ,并将此 blob 保留为零长度和完整元数据。

有关详细信息,请参阅 中止复制 Blob

AbortCopyFromUriAsync(String, BlobRequestConditions, CancellationToken)

AbortCopyFromUriAsync(String, BlobRequestConditions, CancellationToken) 操作中止挂起 CopyFromUriOperation的 ,并将此 blob 保留为零长度和完整元数据。

有关详细信息,请参阅 中止复制 Blob

CreateSnapshot(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

CreateSnapshot(IDictionary<String,String>, BlobRequestConditions, CancellationToken) 操作创建 Blob 的只读快照。

有关详细信息,请参阅 快照 Blob

CreateSnapshotAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

CreateSnapshotAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken) 操作创建 Blob 的只读快照。

有关详细信息,请参阅 快照 Blob

Delete(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

Delete(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) 操作标记要删除的指定 Blob 或快照。 稍后在垃圾回收期间删除 Blob,这可能需要几分钟时间。

请注意,要删除 Blob,必须删除其所有快照。 可以使用 同时 IncludeSnapshots删除这两者。

有关详细信息,请参阅 删除 Blob

DeleteAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

DeleteAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) 操作标记要删除的指定 Blob 或快照。 稍后在垃圾回收期间删除 Blob,这可能需要几分钟时间。

请注意,要删除 Blob,必须删除其所有快照。 可以使用 同时 IncludeSnapshots删除这两者。

有关详细信息,请参阅 删除 Blob

DeleteIfExists(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

如果 blob 存在,则DeleteIfExists(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)操作将标记指定的 blob 或快照进行删除。 稍后在垃圾回收期间删除 Blob,这可能需要几分钟时间。

请注意,要删除 Blob,必须删除其所有快照。 可以使用 同时 IncludeSnapshots删除这两者。

有关详细信息,请参阅 删除 Blob

DeleteIfExistsAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

如果 blob 存在,则DeleteIfExistsAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)操作将标记指定的 blob 或快照进行删除。 稍后在垃圾回收期间删除 Blob,这可能需要几分钟时间。

请注意,要删除 Blob,必须删除其所有快照。 可以使用 同时 IncludeSnapshots删除这两者。

有关详细信息,请参阅 删除 Blob

DeleteImmutabilityPolicy(CancellationToken)

删除与 Blob 关联的不可变性策略。 请注意,必须在存储帐户上启用 Blob 版本控制,并且 Blob 必须位于启用了版本控制的不可变存储的容器中,才能调用此 API。

DeleteImmutabilityPolicyAsync(CancellationToken)

删除与 Blob 关联的不可变性策略。 请注意,必须在存储帐户上启用 Blob 版本控制,并且 Blob 必须位于启用了版本控制的不可变存储的容器中,才能调用此 API。

DownloadContent()

操作 DownloadContent() 从服务下载 Blob,包括其元数据和属性。

有关详细信息,请参阅 获取 Blob

DownloadContent(BlobDownloadOptions, CancellationToken)

操作 DownloadContent(BlobDownloadOptions, CancellationToken) 从服务下载 Blob,包括其元数据和属性。

有关详细信息,请参阅 获取 Blob

DownloadContent(CancellationToken)

操作 DownloadContent(CancellationToken) 从服务下载 Blob,包括其元数据和属性。

有关详细信息,请参阅 获取 Blob

DownloadContentAsync()

操作 DownloadContentAsync() 从服务下载 Blob,包括其元数据和属性。

有关详细信息,请参阅 获取 Blob

DownloadContentAsync(BlobDownloadOptions, CancellationToken)

操作 DownloadContentAsync(BlobDownloadOptions, CancellationToken) 从服务下载 Blob,包括其元数据和属性。

有关详细信息,请参阅 获取 Blob

DownloadContentAsync(CancellationToken)

操作 DownloadContentAsync(CancellationToken) 从服务下载 Blob,包括其元数据和属性。

有关详细信息,请参阅 获取 Blob

DownloadStreaming(BlobDownloadOptions, CancellationToken)

操作 DownloadStreaming(BlobDownloadOptions, CancellationToken) 从服务下载 Blob,包括其元数据和属性。

有关详细信息,请参阅 获取 Blob

DownloadStreamingAsync(BlobDownloadOptions, CancellationToken)

操作 DownloadStreamingAsync(BlobDownloadOptions, CancellationToken) 从服务下载 Blob,包括其元数据和属性。

有关详细信息,请参阅 获取 Blob

DownloadTo(Stream)

操作 DownloadTo(Stream) 使用并行请求下载 Blob,并将内容 destination写入 。

DownloadTo(Stream, BlobDownloadToOptions, CancellationToken)

操作 Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadTo(System.String,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken) 使用并行请求下载 Blob,并将内容 options.Path.Path 写入 或 options.Stream.Stream

DownloadTo(Stream, CancellationToken)

操作 DownloadTo(Stream, CancellationToken) 使用并行请求下载 Blob,并将内容 destination写入 。

DownloadTo(String)

操作 DownloadTo(String) 使用并行请求下载 Blob,并将内容 path写入 。

DownloadTo(String, BlobDownloadToOptions, CancellationToken)

操作 Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadTo(System.String,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken) 使用并行请求下载 Blob,并将内容 options.Path.Path 写入 或 options.Stream.Stream

DownloadTo(String, CancellationToken)

操作 DownloadTo(String, CancellationToken) 使用并行请求下载 Blob,并将内容 path写入 。

DownloadToAsync(Stream)

DownloadToAsync(Stream)使用并行请求下载 Blob,并将内容destination写入 。

DownloadToAsync(Stream, BlobDownloadToOptions, CancellationToken)

操作 Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadToAsync(System.IO.Stream,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken) 使用并行请求下载 Blob,并将内容 options.Path.Path 写入 或 options.Stream.Stream

DownloadToAsync(Stream, CancellationToken)

操作 DownloadToAsync(Stream, CancellationToken) 使用并行请求下载 Blob,并将内容 destination写入 。

DownloadToAsync(String)

DownloadToAsync(String)使用并行请求下载 Blob,并将内容path写入 。

DownloadToAsync(String, BlobDownloadToOptions, CancellationToken)

操作 Azure.Storage.Blobs.Specialized.BlobBaseClient.DownloadToAsync(System.IO.Stream,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken) 使用并行请求下载 Blob,并将内容 options.Path.Path 写入 或 options.Stream.Stream

DownloadToAsync(String, CancellationToken)

操作 DownloadToAsync(String, CancellationToken) 使用并行请求下载 Blob,并将内容 path写入 。

Exists(CancellationToken)

Exists(CancellationToken)可以对 调用 BlobBaseClient 操作,以查看关联的 blob 是否存在于存储服务中存储帐户的容器中。

ExistsAsync(CancellationToken)

ExistsAsync(CancellationToken)可以对 调用 BlobBaseClient 操作,以查看关联的 Blob 是否存在于存储服务中存储帐户的容器中。

GenerateSasUri(BlobSasBuilder)

返回 GenerateSasUri(BlobSasBuilder) 一个 , Uri 根据客户端属性和生成器生成 Blob 服务共享访问签名 (SAS) URI。 SAS 由客户端的共享密钥凭据签名。

若要检查客户端是否能够对服务 Sas 进行签名,请参阅 CanGenerateSasUri

有关详细信息,请参阅 构造服务 SAS

GenerateSasUri(BlobSasPermissions, DateTimeOffset)

返回 GenerateSasUri(BlobSasPermissions, DateTimeOffset) 一个 , Uri 根据传递的客户端属性和参数, (SAS) URI 生成 Blob 服务共享访问签名。 SAS 由客户端的共享密钥凭据签名。

若要检查客户端是否能够对服务 Sas 进行签名,请参阅 CanGenerateSasUri

有关详细信息,请参阅 构造服务 SAS

GetBlobLeaseClientCore(String)

初始化 BlobLeaseClient 类的新实例。

GetCopyAuthorizationHeaderAsync(BlobBaseClient, CancellationToken)

获取 用于BlobBaseClientHttpAuthorization在执行服务到服务复制时传递授权的 ,其中需要 OAuth 对源进行身份验证。

GetParentBlobContainerClientCore()

创建一个指向此BlobBaseClient父容器的新BlobContainerClient。 新的 BlockBlobClient 使用与 相同的请求策略管道 BlobBaseClient

GetProperties(BlobRequestConditions, CancellationToken)

GetProperties(BlobRequestConditions, CancellationToken) 操作返回 Blob 的所有用户定义的元数据、标准 HTTP 属性和系统属性。 它不返回 Blob 的内容。

有关详细信息,请参阅 获取 Blob 属性

GetPropertiesAsync(BlobRequestConditions, CancellationToken)

GetPropertiesAsync(BlobRequestConditions, CancellationToken) 操作返回 Blob 的所有用户定义的元数据、标准 HTTP 属性和系统属性。 它不返回 Blob 的内容。

有关详细信息,请参阅 获取 Blob 属性

GetTags(BlobRequestConditions, CancellationToken)

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

有关详细信息,请参阅 获取 Blob 标记

GetTagsAsync(BlobRequestConditions, CancellationToken)

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

有关详细信息,请参阅 获取 Blob 标记

OpenRead(BlobOpenReadOptions, CancellationToken)

打开一个流以便从 Blob 读取。 流只会在被读取时下载 Blob。

OpenReadAsync(BlobOpenReadOptions, CancellationToken)

打开一个流以便从 Blob 读取。 流只会在被读取时下载 Blob。

SetAccessTier(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken)

操作 SetAccessTier(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) 在 Blob 上设置层。 在高级存储帐户中的页 Blob 和 Blob 存储或常规用途 v2 帐户中的块 Blob 上,允许此操作。

高级页 Blob 的层确定 Blob 允许的大小、IOPS 和带宽。 块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 有关块 Blob 级别分层 Blob 存储层的详细信息。

有关设置层的详细信息,请参阅 Blob 存储层

SetAccessTierAsync(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken)

操作 SetAccessTierAsync(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) 在 Blob 上设置层。 在高级存储帐户中的页 Blob 和 Blob 存储或常规用途 v2 帐户中的块 Blob 上,允许此操作。

高级页 Blob 的层确定 Blob 允许的大小、IOPS 和带宽。 块 Blob 的层确定热/冷/存档存储类型。 此操作不会更新 Blob 的 ETag。 有关块 Blob 级别分层 Blob 存储层的详细信息。

有关设置层的详细信息,请参阅 Blob 存储层

SetHttpHeaders(BlobHttpHeaders, BlobRequestConditions, CancellationToken)

SetHttpHeaders(BlobHttpHeaders, BlobRequestConditions, CancellationToken) 操作在 Blob 上设置系统属性。

有关详细信息,请参阅 设置 Blob 属性

SetHttpHeadersAsync(BlobHttpHeaders, BlobRequestConditions, CancellationToken)

SetHttpHeadersAsync(BlobHttpHeaders, BlobRequestConditions, CancellationToken) 操作在 Blob 上设置系统属性。

有关详细信息,请参阅 设置 Blob 属性

SetImmutabilityPolicy(BlobImmutabilityPolicy, BlobRequestConditions, CancellationToken)

设置 Blob、Blob 快照或 Blob 版本的不可变性策略。 请注意,必须在存储帐户上启用 Blob 版本控制,并且 Blob 必须位于具有不可变存储且已启用版本控制的容器中,才能调用此 API。

SetImmutabilityPolicyAsync(BlobImmutabilityPolicy, BlobRequestConditions, CancellationToken)

设置 Blob、Blob 快照或 Blob 版本的不可变性策略。 请注意,必须在存储帐户上启用 Blob 版本控制,并且 Blob 必须位于具有不可变存储且已启用版本控制的容器中,才能调用此 API。

SetLegalHold(Boolean, CancellationToken)

对 Blob 设置法定保留。 请注意,必须在存储帐户上启用 Blob 版本控制,并且 Blob 必须位于具有不可变存储且已启用版本控制的容器中,才能调用此 API。

SetLegalHoldAsync(Boolean, CancellationToken)

对 Blob 设置法定保留。 请注意,必须在存储帐户上启用 Blob 版本控制,并且 Blob 必须位于具有不可变存储且已启用版本控制的容器中,才能调用此 API。

SetMetadata(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

SetMetadata(IDictionary<String,String>, BlobRequestConditions, CancellationToken)操作将指定 Blob 的用户定义元数据设置为一个或多个名称/值对。

有关详细信息,请参阅 设置 Blob 元数据

SetMetadataAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

SetMetadataAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)操作将指定 Blob 的用户定义元数据设置为一个或多个名称/值对。

有关详细信息,请参阅 设置 Blob 元数据

SetTags(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

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

有关详细信息,请参阅 设置 Blob 标记

SetTagsAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

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

有关详细信息,请参阅 设置 Blob 标记

StartCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken)

StartCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken) 操作开始将数据从 异步 source 复制到此 Blob。 可以检查Azure.Storage.Blobs.Models.BlobProperties.CopyStatusGetProperties(BlobRequestConditions, CancellationToken) 返回的 ,以确定复制是否已完成。

有关详细信息,请参阅 复制 Blob

StartCopyFromUriAsync(Uri, BlobCopyFromUriOptions, CancellationToken)

Azure.Storage.Blobs.Specialized.BlobBaseClient.StartCopyFromUri(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Nullable{Azure.Storage.Blobs.Models.AccessTier},Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.Blobs.Models.BlobRequestConditions,System.Nullable{Azure.Storage.Blobs.Models.RehydratePriority},System.Threading.CancellationToken) 操作开始将数据从 异步 source 复制到此 Blob。 可以检查Azure.Storage.Blobs.Models.BlobProperties.CopyStatusGetPropertiesAsync(BlobRequestConditions, CancellationToken) 返回的 ,以确定复制是否已完成。

有关详细信息,请参阅 复制 Blob

SyncCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken)

从 URL 复制 Blob 操作将 Blob 同步复制到存储帐户内的目标,源 Blob 大小最大为 256 MiB。 此 API 从版本 2018-03-28 开始可用。 从 URL 复制 Blob 操作的源可以是任何 Azure 存储帐户中任何提交的块 Blob,该帐户是公共的,也可以是使用共享访问签名授权的。

源 Blob 的大小最大长度为 256 MiB。

有关详细信息,请参阅 从 URL 复制 Blob

SyncCopyFromUriAsync(Uri, BlobCopyFromUriOptions, CancellationToken)

从 URL 复制 Blob 操作将 Blob 同步复制到存储帐户内的目标,源 Blob 大小最大为 256 MiB。 此 API 从版本 2018-03-28 开始可用。 从 URL 复制 Blob 操作的源可以是任何 Azure 存储帐户中任何提交的块 Blob,该帐户是公共的,也可以是使用共享访问签名授权的。

源 Blob 的大小最大长度为 256 MiB。

有关详细信息,请参阅 从 URL 复制 Blob

Undelete(CancellationToken)

Undelete(CancellationToken) 操作还原软删除的 Blob 以及任何关联的软删除快照的内容和元数据。

有关详细信息,请参阅 取消删除 Blob

UndeleteAsync(CancellationToken)

UndeleteAsync(CancellationToken) 操作还原软删除的 Blob 以及任何关联的软删除快照的内容和元数据。

有关详细信息,请参阅 取消删除 Blob

WithCustomerProvidedKey(Nullable<CustomerProvidedKey>)

使用相同的Uri源但指定的 customerProvidedKey初始化 类的新实例BlobBaseClient

WithEncryptionScope(String)

使用相同的Uri源但指定的 encryptionScope初始化 类的新实例BlobBaseClient

WithSnapshot(String)

使用相同的Uri源但指定的snapshot时间戳初始化 类的新实例BlobBaseClient

有关详细信息,请参阅 创建 blob 的快照

WithSnapshotCore(String)

创建具有相同Uri源但指定snapshot时间戳的 类的新实例BlobBaseClient

WithVersion(String)

使用相同的Uri源但指定的versionId时间戳初始化 类的新实例BlobBaseClient

扩展方法

GetBlobLeaseClient(BlobBaseClient, String)

初始化 BlobLeaseClient 类的新实例。

GetParentBlobContainerClient(BlobBaseClient)

创建一个指向此BlobBaseClient父容器的新BlobContainerClient。 新的 BlockBlobClient 使用与 相同的请求策略管道 BlobBaseClient

适用于