CloudBlobClient Class

Reference

Definition

Namespace:: Microsoft.Azure.Storage.Blob

Assembly:: Microsoft.Azure.Storage.Blob.dll

Package:: Microsoft.Azure.Storage.Blob v11.2.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a client-side logical representation of Microsoft Azure Blob storage.

public class CloudBlobClient

type CloudBlobClient = class

Public Class CloudBlobClient

Inheritance: Object
CloudBlobClient

Constructors

CloudBlobClient(StorageUri, StorageCredentials, DelegatingHandler)	Initializes a new instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.
CloudBlobClient(Uri, DelegatingHandler)	Initializes a new instance of the CloudBlobClient class using the specified Blob service endpoint and anonymous credentials.
CloudBlobClient(Uri, StorageCredentials, DelegatingHandler)	Initializes a new instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.

Properties

AuthenticationScheme	Gets or sets the authentication scheme to use to sign HTTP requests.
BaseUri	Gets the base URI for the Blob service client at the primary location.
BufferManager	Gets or sets a buffer manager that implements the IBufferManager interface, specifying a buffer pool for use with operations against the Blob service client.
Credentials	Gets the account credentials used to create the Blob service client.
DefaultDelimiter	Gets or sets the default delimiter that may be used to create a virtual directory structure of blobs.
DefaultRequestOptions	Gets or sets the default request options for requests made via the Blob service client.
RetryPolicy	Obsolete. Gets or sets the default retry policy for requests made via the Blob service client.
StorageUri	Gets the Blob service endpoints for both the primary and secondary locations.

Methods

BeginGetAccountProperties(AsyncCallback, Object)	Begins an asynchronous operation to get account properties for the Blob service.
BeginGetAccountProperties(BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get account properties for the Blob service.
BeginGetBlobReferenceFromServer(StorageUri, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get a reference to a blob.
BeginGetBlobReferenceFromServer(Uri, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get a reference to a blob.
BeginGetBlobReferenceFromServer(Uri, AsyncCallback, Object)	Begins an asynchronous operation to get a reference to a blob.
BeginGetServiceProperties(AsyncCallback, Object)	Begins an asynchronous operation to get service properties for the Blob service.
BeginGetServiceProperties(BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get service properties for the Blob service.
BeginGetServiceStats(AsyncCallback, Object)	Begins an asynchronous operation to get service stats for the secondary Blob service endpoint.
BeginGetServiceStats(BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get service stats for the secondary Blob service endpoint.
BeginGetUserDelegationKey(DateTimeOffset, DateTimeOffset, AccessCondition, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get a user delegation key for generating user-delegation-based shared access signature tokens.
BeginGetUserDelegationKey(DateTimeOffset, DateTimeOffset, AsyncCallback, Object)	Begins an asynchronous operation to get a user delegation key for generating user-delegation-based shared access signature tokens.
BeginListBlobsSegmented(String, BlobContinuationToken, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.
BeginListBlobsSegmented(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.
BeginListContainersSegmented(BlobContinuationToken, AsyncCallback, Object)	Begins an asynchronous request to return a result segment containing a collection of containers.
BeginListContainersSegmented(String, BlobContinuationToken, AsyncCallback, Object)	Begins an asynchronous request to return a result segment containing a collection of containers.
BeginListContainersSegmented(String, ContainerListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to return a result segment containing a collection of containers whose names begin with the specified prefix.
BeginSetServiceProperties(ServiceProperties, AsyncCallback, Object)	Begins an asynchronous operation to set service properties for the Blob service.
BeginSetServiceProperties(ServiceProperties, BlobRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to set service properties for the Blob service.
EndGetAccountProperties(IAsyncResult)	Ends an asynchronous operation to get account properties for the Blob service.
EndGetBlobReferenceFromServer(IAsyncResult)	Ends an asynchronous operation to get a reference to a blob.
EndGetServiceProperties(IAsyncResult)	Ends an asynchronous operation to get service properties for the Blob service.
EndGetServiceStats(IAsyncResult)	Ends an asynchronous operation to get service stats for the secondary Blob service endpoint.
EndGetUserDelegationKey(IAsyncResult)	Ends an asynchronous operation to get a user delegation key for generating user-delegation-based shared access signature tokens.
EndListBlobsSegmented(IAsyncResult)	Ends an asynchronous operation to return a result segment containing a collection of blob items in the container.
EndListContainersSegmented(IAsyncResult)	Ends an asynchronous operation to return a result segment containing a collection of containers.
EndSetServiceProperties(IAsyncResult)	Ends an asynchronous operation to set service properties for the Blob service.
ExecuteBatchAsync(BatchOperation, BlobRequestOptions, OperationContext, CancellationToken)	Performs a batched operation request, returning the responses for each suboperation.
GetAccountProperties(BlobRequestOptions, OperationContext)	Gets account properties for the Blob service.
GetAccountPropertiesAsync()	Initiates an asynchronous operation to get account properties for the Blob service.
GetAccountPropertiesAsync(BlobRequestOptions, OperationContext)	Initiates an asynchronous operation to get account properties for the Blob service.
GetAccountPropertiesAsync(BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get account properties for the Blob service.
GetAccountPropertiesAsync(CancellationToken)	Initiates an asynchronous operation to get account properties for the Blob service.
GetBlobReferenceFromServer(StorageUri, AccessCondition, BlobRequestOptions, OperationContext)	Gets a reference to a blob.
GetBlobReferenceFromServer(Uri, AccessCondition, BlobRequestOptions, OperationContext)	Gets a reference to a blob.
GetBlobReferenceFromServerAsync(StorageUri, AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that gets a reference to a blob.
GetBlobReferenceFromServerAsync(StorageUri, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that gets a reference to a blob.
GetBlobReferenceFromServerAsync(Uri)	Initiates an asynchronous operation that gets a reference to a blob.
GetBlobReferenceFromServerAsync(Uri, AccessCondition, BlobRequestOptions, OperationContext)	Returns a Task<TResult> object that gets a reference to a blob.
GetBlobReferenceFromServerAsync(Uri, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that gets a reference to a blob.
GetBlobReferenceFromServerAsync(Uri, CancellationToken)	Initiates an asynchronous operation that gets a reference to a blob.
GetContainerReference(String)	Returns a reference to a CloudBlobContainer object with the specified name.
GetRootContainerReference()	Returns a reference to the root container.
GetServiceProperties(BlobRequestOptions, OperationContext)	Gets service properties for the Blob service.
GetServicePropertiesAsync()	Initiates an asynchronous operation to get service properties for the Blob service.
GetServicePropertiesAsync(BlobRequestOptions, OperationContext)	Initiates an asynchronous operation to get service properties for the Blob service.
GetServicePropertiesAsync(BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get service properties for the Blob service.
GetServicePropertiesAsync(CancellationToken)	Initiates an asynchronous operation to get service properties for the Blob service.
GetServiceStats(BlobRequestOptions, OperationContext)	Gets service stats for the secondary Blob service endpoint.
GetServiceStatsAsync()	Initiates an asynchronous operation to get service stats for the secondary Blob service endpoint.
GetServiceStatsAsync(BlobRequestOptions, OperationContext)	Initiates an asynchronous operation to get service stats for the secondary Blob service endpoint.
GetServiceStatsAsync(BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get service stats for the secondary Blob service endpoint.
GetServiceStatsAsync(CancellationToken)	Initiates an asynchronous operation to get service stats for the secondary Blob service endpoint.
GetUserDelegationKey(DateTimeOffset, DateTimeOffset, AccessCondition, BlobRequestOptions, OperationContext)	Gets a user delegation key for generating user-delegation-based shared access signature tokens.
GetUserDelegationKeyAsync(DateTimeOffset, DateTimeOffset)	Gets a user delegation key for generating user-delegation-based shared access signature tokens asynchronously.
GetUserDelegationKeyAsync(DateTimeOffset, DateTimeOffset, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Gets a user delegation key for generating user-delegation-based shared access signature tokens asynchronously.
ListBlobs(String, Boolean, BlobListingDetails, BlobRequestOptions, OperationContext)	Returns an enumerable collection of blobs in the container, retrieved lazily.
ListBlobsSegmented(String, BlobContinuationToken)	Returns a result segment containing a collection of blob items in the container.
ListBlobsSegmented(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)	Returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, BlobContinuationToken)	Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, BlobContinuationToken, CancellationToken)	Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.
ListContainers(String, ContainerListingDetails, BlobRequestOptions, OperationContext)	Returns an enumerable collection of containers whose names begin with the specified prefix and that are retrieved lazily.
ListContainersSegmented(BlobContinuationToken)	Returns a result segment containing a collection of CloudBlobContainer objects.
ListContainersSegmented(String, BlobContinuationToken)	Returns a result segment containing a collection of CloudBlobContainer objects.
ListContainersSegmented(String, ContainerListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)	Returns a result segment containing a collection of containers whose names begin with the specified prefix.
ListContainersSegmentedAsync(BlobContinuationToken)	Initiates an asynchronous operation to return a result segment containing a collection of containers.
ListContainersSegmentedAsync(BlobContinuationToken, CancellationToken)	Initiates an asynchronous operation to return a result segment containing a collection of containers.
ListContainersSegmentedAsync(String, BlobContinuationToken)	Initiates an asynchronous operation to return a result segment containing a collection of containers.
ListContainersSegmentedAsync(String, BlobContinuationToken, CancellationToken)	Initiates an asynchronous operation to return a result segment containing a collection of containers.
ListContainersSegmentedAsync(String, ContainerListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation to return a result segment containing a collection of containers.
ListContainersSegmentedAsync(String, ContainerListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to return a result segment containing a collection of containers.
SetServiceProperties(ServiceProperties, BlobRequestOptions, OperationContext)	Sets service properties for the Blob service.
SetServicePropertiesAsync(ServiceProperties)	Initiates an asynchronous operation that sets service properties for the Blob service.
SetServicePropertiesAsync(ServiceProperties, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that sets service properties for the Blob service.
SetServicePropertiesAsync(ServiceProperties, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that sets service properties for the Blob service.
SetServicePropertiesAsync(ServiceProperties, CancellationToken)	Initiates an asynchronous operation that sets service properties for the Blob service.

Applies to