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

CloudBlobClient 类

包:

com.microsoft.azure.storage.blob

• java.lang.Object
• • ServiceClient
  • • com.microsoft.azure.storage.blob.CloudBlobClient

public class CloudBlobClient extends ServiceClient

提供用于访问 Microsoft Azure Blob 服务的客户端。

此类提供对 Blob 服务的访问点。 服务客户端封装 BLOB 服务的基本 URI。 如果服务客户端将用于经过身份验证的访问，则它也会封装用于访问存储帐户的凭据。

构造函数摘要

构造函数	说明
CloudBlobClient(final StorageUri baseUri)	使用指定的 Blob 服务终结点和匿名凭据创建 类的实例。
CloudBlobClient(final StorageUri storageUri, StorageCredentials credentials)	使用指定的 Blob 服务终结点和帐户凭据创建 类的实例。
CloudBlobClient(final URI baseUri)	使用指定的 Blob 服务终结点和匿名凭据创建 类的实例。
CloudBlobClient(final URI baseUri, StorageCredentials credentials)	使用指定的 Blob 服务终结点和帐户凭据创建 类的实例。

方法摘要

修饰符和类型	方法和描述
AccountInformation	downloadAccountInfo() 获取与存储帐户相关的信息。
AccountInformation	downloadAccountInfo(BlobRequestOptions options, OperationContext opContext) 获取与存储帐户相关的信息。
StorageRequest<ServiceClient, Void, AccountInformation>	downloadAccountInformationImpl(final RequestOptions options)
final ServiceProperties	downloadServiceProperties() 检索给定存储服务的当前 ServiceProperties 值。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。
final ServiceProperties	downloadServiceProperties(BlobRequestOptions options, OperationContext opContext) 检索给定存储服务的当前 ServiceProperties 值。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。
<P, T> Map<P, T>	executeBatch(BlobBatchOperation<P, T> batch) 对 Blob 服务执行预构造的批处理操作。 有关构造 Blob 批处理请求的详细信息，请参阅 BlobBatchOperation<P,R>。
<P, T> Map<P, T>	executeBatch(BlobBatchOperation<P, T> batch, BlobRequestOptions requestOptions, OperationContext operationContext) 对 Blob 服务执行预构造的批处理操作。 有关构造 Blob 批处理请求的详细信息，请参阅 BlobBatchOperation<P,R>。
CloudBlobContainer	getContainerReference(final String containerName) 获取具有 CloudBlobContainer 指定名称的对象。
BlobRequestOptions	getDefaultRequestOptions() BlobRequestOptions获取用于与此关联的请求的
String	getDirectoryDelimiter() 返回用于云 Blob 目录的默认分隔符的值。 默认值为“/”。
ServiceStats	getServiceStats() 查询 服务。ServiceStats
ServiceStats	getServiceStats(BlobRequestOptions options, OperationContext opContext) 查询给定的存储服务。ServiceStats
UserDelegationKey	getUserDelegationKey(Date keyStart, Date keyEnd) 基于此客户端的 oauth 凭据请求新的用户委派密钥。
UserDelegationKey	getUserDelegationKey(Date keyStart, Date keyEnd, BlobRequestOptions options, OperationContext opContext) 基于此客户端的 oauth 凭据请求新的用户委派密钥。
boolean	isUsePathStyleUris() 指示是否正在使用路径样式 URI。
Iterable<CloudBlobContainer>	listContainers() 返回此 Blob 服务客户端的 Blob 容器的可枚举集合。
Iterable<CloudBlobContainer>	listContainers(final String prefix) 返回 Blob 容器的可枚举集合，其名称以此 Blob 服务客户端的指定前缀开头。
Iterable<CloudBlobContainer>	listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext) 使用指定的详细信息设置、请求选项和操作上下文返回 Blob 容器的可枚举集合，其名称以此 Blob 服务客户端的指定前缀开头。
ResultSegment<CloudBlobContainer>	listContainersSegmented() 返回此 Blob 服务客户端的 Blob 容器可枚举集合的结果段。
ResultSegment<CloudBlobContainer>	listContainersSegmented(final String prefix) 返回 Blob 容器的可枚举集合的结果段，该集合的名称以此 Blob 服务客户端的指定前缀开头。
ResultSegment<CloudBlobContainer>	listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext) 返回 Blob 容器的可枚举集合的结果段，该集合的名称以此 Blob 服务客户端的指定前缀开头，使用指定的列表详细信息选项、请求选项和操作上下文。
void	setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions) BlobRequestOptions设置用于与此对象关联的任何请求的 。
void	setDirectoryDelimiter(final String directoryDelimiter) 设置用于云 Blob 目录的默认分隔符的值。
void	uploadServiceProperties(final ServiceProperties properties) 将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。
void	uploadServiceProperties(final ServiceProperties properties, BlobRequestOptions options, OperationContext opContext) 将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

继承成员

ServiceClient.credentials ServiceClient.downloadServicePropertiesImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getCredentials() ServiceClient.getEndpoint() ServiceClient.getServiceStatsImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getStorageUri() ServiceClient.ServiceClient(final StorageUri storageUri, final StorageCredentials credentials) ServiceClient.setCredentials(final StorageCredentials credentials) ServiceClient.setStorageUri(final StorageUri storageUri) ServiceClient.uploadServicePropertiesImpl(final ServiceProperties properties, final RequestOptions options, final OperationContext opContext, final boolean signAsTable)

构造函数详细信息

CloudBlobClient

public CloudBlobClient(final StorageUri baseUri)

使用指定的 Blob 服务终结点和匿名凭据创建 类的实例。

Parameters:

baseUri - 一个 StorageUri 对象，表示用于创建客户端的 Blob 服务终结点。

CloudBlobClient

public CloudBlobClient(final StorageUri storageUri, StorageCredentials credentials)

使用指定的 Blob 服务终结点和帐户凭据创建 类的实例。

Parameters:

storageUri - 一个 StorageUri 对象，表示用于创建客户端的 Blob 服务终结点。

credentials - 一个 StorageCredentials 表示帐户凭据的 对象。

CloudBlobClient

public CloudBlobClient(final URI baseUri)

使用指定的 Blob 服务终结点和匿名凭据创建 类的实例。

Parameters:

baseUri - 一个 java.net.URI 对象，表示用于创建客户端的 Blob 服务终结点。

CloudBlobClient

public CloudBlobClient(final URI baseUri, StorageCredentials credentials)

使用指定的 Blob 服务终结点和帐户凭据创建 类的实例。

Parameters:

baseUri - 一个 java.net.URI 对象，表示用于创建客户端的 Blob 服务终结点。

credentials - 一个 StorageCredentials 表示帐户凭据的 对象。

方法详细信息

downloadAccountInfo

public AccountInformation downloadAccountInfo()

获取与存储帐户相关的信息。

Returns:

AccountInformation给定存储帐户的 对象。

Throws:

StorageException - 如果发生存储服务错误。

downloadAccountInfo

public AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)

获取与存储帐户相关的信息。

Parameters:

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

AccountInformation给定存储帐户的 对象。

Throws:

StorageException - 如果发生存储服务错误。

downloadAccountInformationImpl

protected StorageRequest downloadAccountInformationImpl(final RequestOptions options)

Parameters:

options

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

检索给定存储服务的当前 ServiceProperties 值。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Returns:

表示 ServiceProperties 服务的当前配置的对象。

Throws:

StorageException - 如果发生存储服务错误。

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(BlobRequestOptions options, OperationContext opContext)

检索给定存储服务的当前 ServiceProperties 值。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Parameters:

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

表示 ServiceProperties 服务的当前配置的对象。

Throws:

StorageException - 如果发生存储服务错误。

executeBatch

public Map executeBatch(BlobBatchOperation batch)

对 Blob 服务执行预构造的批处理操作。 有关构造 Blob 批处理请求的详细信息，请参阅 BlobBatchOperation<P,R>。

Parameters:

batch - 要执行的一批操作。

Returns:

从批处理中的父对象到该父对象的响应的映射。

Throws:

BatchException - 如果批处理上的一个或多个单独请求失败，则引发此存储异常子集。

StorageException - 如果服务出错，则引发。

executeBatch

public Map executeBatch(BlobBatchOperation batch, BlobRequestOptions requestOptions, OperationContext operationContext)

对 Blob 服务执行预构造的批处理操作。 有关构造 Blob 批处理请求的详细信息，请参阅 BlobBatchOperation<P,R>。

Parameters:

batch - 要执行的一批操作。

requestOptions - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

operationContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

从批处理中的父对象到该父对象的响应的映射。

Throws:

BatchException - 如果批处理上的一个或多个单独请求失败，则引发此存储异常子集。

StorageException - 如果服务出错，则引发。

getContainerReference

public CloudBlobContainer getContainerReference(final String containerName)

获取具有 CloudBlobContainer 指定名称的对象。

Parameters:

containerName - 容器的名称，它必须遵守容器命名规则。 容器名称不应包含 /) (的任何路径分隔符。 容器名称必须为小写，长度在 3-63 个字符之间，并且必须以字母或数字开头。 容器名称只能包含字母、数字和短划线 ( ) 字符。

Returns:

对 CloudBlobContainer 对象的引用。

Throws:

URISyntaxException - 如果基于 containerName 构造的资源 URI 无效。

StorageException - 如果发生存储服务错误。

getDefaultRequestOptions

public BlobRequestOptions getDefaultRequestOptions()

BlobRequestOptions获取用于与此关联的请求的

Returns:

包含 BlobRequestOptions 由此使用的值的对象 CloudBlobClient

getDirectoryDelimiter

public String getDirectoryDelimiter()

返回用于云 Blob 目录的默认分隔符的值。 默认值为“/”。

Returns:

一个 String ，它表示默认分隔符的值。

getServiceStats

public ServiceStats getServiceStats()

查询 服务。ServiceStats

Returns:

ServiceStats给定存储服务的 对象。

Throws:

StorageException - 如果发生存储服务错误。

getServiceStats

public ServiceStats getServiceStats(BlobRequestOptions options, OperationContext opContext)

查询给定的存储服务。ServiceStats

Parameters:

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

ServiceStats给定存储服务的 对象。

Throws:

StorageException - 如果发生存储服务错误。

getUserDelegationKey

public UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd)

基于此客户端的 oauth 凭据请求新的用户委派密钥。

Parameters:

keyStart - 所请求密钥有效性的开始时间。

keyEnd - 所请求密钥有效性的结束时间。

Returns:

请求的密钥。

Throws:

StorageException

getUserDelegationKey

public UserDelegationKey getUserDelegationKey(Date keyStart, Date keyEnd, BlobRequestOptions options, OperationContext opContext)

基于此客户端的 oauth 凭据请求新的用户委派密钥。

Parameters:

keyStart - 所请求密钥有效性的开始时间。

keyEnd - 所请求密钥有效性的结束时间。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

请求的密钥。

Throws:

StorageException

isUsePathStyleUris

protected boolean isUsePathStyleUris()

指示是否正在使用路径样式 URI。

Returns:

true 如果使用路径样式 URI，则为 ;否则为 false。

listContainers

public Iterable listContainers()

返回此 Blob 服务客户端的 Blob 容器的可枚举集合。

Returns:

延迟检索的 CloudBlobContainer 对象的可枚举集合，表示此客户端的容器。

listContainers

public Iterable listContainers(final String prefix)

返回 Blob 容器的可枚举集合，其名称以此 Blob 服务客户端的指定前缀开头。

Parameters:

prefix - 一个 String ，它表示容器名称前缀。

Returns:

延迟检索的 CloudBlobContainer 对象的可枚举集合，表示名称以指定前缀开头的此客户端的容器。

listContainers

public Iterable listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)

使用指定的详细信息设置、请求选项和操作上下文返回 Blob 容器的可枚举集合，其名称以此 Blob 服务客户端的指定前缀开头。

Parameters:

prefix - 一个 String ，它表示容器名称前缀。

detailsIncluded - 一个 ContainerListingDetails 值，该值指示是否将返回容器元数据。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

延迟检索的 CloudBlobContainer 对象的可枚举集合，表示此客户端的容器。

listContainersSegmented

public ResultSegment listContainersSegmented()

返回此 Blob 服务客户端的 Blob 容器可枚举集合的结果段。

Returns:

一个 ResultSegment<T> 对象，该对象包含表示此客户端容器的 CloudBlobContainer 可枚举对象集合的段。

Throws:

StorageException - 如果发生存储服务错误。

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix)

返回 Blob 容器的可枚举集合的结果段，该集合的名称以此 Blob 服务客户端的指定前缀开头。

Parameters:

prefix - 一个 String ，它表示容器名称的前缀。

Returns:

一个 ResultSegment<T> 对象，该对象包含对象可枚举集合的 CloudBlobContainer 段，这些对象代表其名称以指定前缀开头的容器。

Throws:

StorageException - 如果发生存储服务错误。

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)

返回 Blob 容器的可枚举集合的结果段，该集合的名称以此 Blob 服务客户端的指定前缀开头，使用指定的列表详细信息选项、请求选项和操作上下文。

Parameters:

prefix - 一个 String ，它表示容器名称的前缀。

detailsIncluded - 一个 ContainerListingDetails 值，该值指示是否将返回容器元数据。

maxResults - 要检索的最大结果数。 如果 null 或大于 5000，服务器将返回最多 5,000 个项。 必须至少为 1。

continuationToken - 一个 ResultContinuation 对象，该对象表示上一个列表操作返回的继续标记。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

一个 ResultSegment<T> 对象，该对象包含表示此 Blob 服务客户端容器的 CloudBlobContainer 可枚举对象集合的段。

Throws:

StorageException - 如果发生存储服务错误。

setDefaultRequestOptions

public void setDefaultRequestOptions(BlobRequestOptions defaultRequestOptions)

BlobRequestOptions设置用于与此对象关联的任何请求的 。

Parameters:

defaultRequestOptions - 一个 BlobRequestOptions 指定要使用的选项的 对象。

setDirectoryDelimiter

public void setDirectoryDelimiter(final String directoryDelimiter)

设置用于云 Blob 目录的默认分隔符的值。

Parameters:

directoryDelimiter - 一个 String ，指定默认目录分隔符的值。

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Parameters:

properties - 一个 ServiceProperties 对象，该对象指定要上传的服务属性。

Throws:

StorageException - 如果发生存储服务错误。

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties, BlobRequestOptions options, OperationContext opContext)

将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Parameters:

properties - 一个 ServiceProperties 对象，该对象指定要上传的服务属性。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。