<PackageReference Include="Microsoft.Azure.Storage.Blob" Version="11.2.1" />

Microsoft.Azure.Storage.Blob.CloudBlobClient

public class CloudBlobClient
Provides a client-side logical representation of Microsoft Azure Blob storage.
public AuthenticationScheme AuthenticationScheme { get; set; }

Gets or sets the authentication scheme to use to sign HTTP requests.

public Uri BaseUri { get; }

Gets the base URI for the Blob service client at the primary location.

public IBufferManager BufferManager { get; set; }

Gets or sets a buffer manager that implements the IBufferManager interface, specifying a buffer pool for use with operations against the Blob service client.

public StorageCredentials Credentials { get; }

Gets the account credentials used to create the Blob service client.

public string DefaultDelimiter { get; set; }

Gets or sets the default delimiter that may be used to create a virtual directory structure of blobs.

Gets or sets the default request options for requests made via the Blob service client.

public IRetryPolicy RetryPolicy { get; set; }

Gets or sets the default retry policy for requests made via the Blob service client.

public StorageUri StorageUri { get; }

Gets the Blob service endpoints for both the primary and secondary locations.

public CloudBlobClient(Uri baseUri, DelegatingHandler delegatingHandler = null)

Initializes a new instance of the CloudBlobClient class using the specified Blob service endpoint and anonymous credentials.

public CloudBlobClient(Uri baseUri, StorageCredentials credentials, DelegatingHandler delegatingHandler = null)

Initializes a new instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.

public CloudBlobClient(StorageUri storageUri, StorageCredentials credentials, DelegatingHandler delegatingHandler = null)

Initializes a new instance of the CloudBlobClient class using the specified Blob service endpoint and account credentials.

public virtual ICancellableAsyncResult BeginGetAccountProperties(AsyncCallback callback, object state)

Begins an asynchronous operation to get account properties for the Blob service.

public virtual ICancellableAsyncResult BeginGetAccountProperties(BlobRequestOptions requestOptions, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to get account properties for the Blob service.

public virtual ICancellableAsyncResult BeginGetBlobReferenceFromServer(Uri blobUri, AsyncCallback callback, object state)

Begins an asynchronous operation to get a reference to a blob.

public virtual ICancellableAsyncResult BeginGetBlobReferenceFromServer(Uri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to get a reference to a blob.

public virtual ICancellableAsyncResult BeginGetBlobReferenceFromServer(StorageUri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to get a reference to a blob.

public virtual ICancellableAsyncResult BeginGetServiceProperties(AsyncCallback callback, object state)

Begins an asynchronous operation to get service properties for the Blob service.

public virtual ICancellableAsyncResult BeginGetServiceProperties(BlobRequestOptions requestOptions, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to get service properties for the Blob service.

public virtual ICancellableAsyncResult BeginGetServiceStats(AsyncCallback callback, object state)

Begins an asynchronous operation to get service stats for the secondary Blob service endpoint.

public virtual ICancellableAsyncResult BeginGetServiceStats(BlobRequestOptions requestOptions, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to get service stats for the secondary Blob service endpoint.

public virtual ICancellableAsyncResult BeginGetUserDelegationKey(DateTimeOffset keyStart, DateTimeOffset keyEnd, AsyncCallback callback, object state)

Begins an asynchronous operation to get a user delegation key for generating user-delegation-based shared access signature tokens.

public virtual ICancellableAsyncResult BeginGetUserDelegationKey(DateTimeOffset keyStart, DateTimeOffset keyEnd, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to get a user delegation key for generating user-delegation-based shared access signature tokens.

public virtual ICancellableAsyncResult BeginListBlobsSegmented(string prefix, BlobContinuationToken currentToken, AsyncCallback callback, object state)

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.

public virtual ICancellableAsyncResult BeginListBlobsSegmented(string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to return a result segment containing a collection of blob items in the container.

public virtual ICancellableAsyncResult BeginListContainersSegmented(BlobContinuationToken continuationToken, AsyncCallback callback, object state)

Begins an asynchronous request to return a result segment containing a collection of containers.

public virtual ICancellableAsyncResult BeginListContainersSegmented(string prefix, BlobContinuationToken continuationToken, AsyncCallback callback, object state)

Begins an asynchronous request to return a result segment containing a collection of containers.

public virtual ICancellableAsyncResult BeginListContainersSegmented(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken continuationToken, BlobRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous request to return a result segment containing a collection of containers whose names begin with the specified prefix.

public virtual ICancellableAsyncResult BeginSetServiceProperties(ServiceProperties properties, AsyncCallback callback, object state)

Begins an asynchronous operation to set service properties for the Blob service.

public virtual ICancellableAsyncResult BeginSetServiceProperties(ServiceProperties properties, BlobRequestOptions requestOptions, OperationContext operationContext, AsyncCallback callback, object state)

Begins an asynchronous operation to set service properties for the Blob service.

public virtual AccountProperties EndGetAccountProperties(IAsyncResult asyncResult)

Ends an asynchronous operation to get account properties for the Blob service.

Ends an asynchronous operation to get a reference to a blob.

public virtual ServiceProperties EndGetServiceProperties(IAsyncResult asyncResult)

Ends an asynchronous operation to get service properties for the Blob service.

public virtual ServiceStats EndGetServiceStats(IAsyncResult asyncResult)

Ends an asynchronous operation to get service stats for the secondary Blob service endpoint.

public virtual UserDelegationKey EndGetUserDelegationKey(IAsyncResult asyncResult)

Ends an asynchronous operation to get a user delegation key for generating user-delegation-based shared access signature tokens.

Ends an asynchronous operation to return a result segment containing a collection of blob items in the container.

Ends an asynchronous operation to return a result segment containing a collection of containers.

public virtual void EndSetServiceProperties(IAsyncResult asyncResult)

Ends an asynchronous operation to set service properties for the Blob service.

public Task<IList<BlobBatchSubOperationResponse>> ExecuteBatchAsync(BatchOperation batchOperation, BlobRequestOptions requestOptions = null, OperationContext operationContext = null, CancellationToken cancellationToken = default)

Performs a batched operation request, returning the responses for each suboperation.

public virtual AccountProperties GetAccountProperties(BlobRequestOptions requestOptions = null, OperationContext operationContext = null)

Gets account properties for the Blob service.

public virtual Task<AccountProperties> GetAccountPropertiesAsync()

Initiates an asynchronous operation to get account properties for the Blob service.

public virtual Task<AccountProperties> GetAccountPropertiesAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to get account properties for the Blob service.

public virtual Task<AccountProperties> GetAccountPropertiesAsync(BlobRequestOptions requestOptions, OperationContext operationContext)

Initiates an asynchronous operation to get account properties for the Blob service.

public virtual Task<AccountProperties> GetAccountPropertiesAsync(BlobRequestOptions requestOptions, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to get account properties for the Blob service.

public virtual ICloudBlob GetBlobReferenceFromServer(Uri blobUri, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Gets a reference to a blob.

public virtual ICloudBlob GetBlobReferenceFromServer(StorageUri blobUri, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Gets a reference to a blob.

Initiates an asynchronous operation that gets a reference to a blob.

public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(Uri blobUri, CancellationToken cancellationToken)

Initiates an asynchronous operation that gets a reference to a blob.

public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(Uri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Returns a Task<T> object that gets a reference to a blob.

public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(Uri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation that gets a reference to a blob.

public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(StorageUri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation that gets a reference to a blob.

public virtual Task<ICloudBlob> GetBlobReferenceFromServerAsync(StorageUri blobUri, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation that gets a reference to a blob.

public virtual CloudBlobContainer GetContainerReference(string containerName)

Returns a reference to a CloudBlobContainer object with the specified name.

Returns a reference to the root container.

public virtual ServiceProperties GetServiceProperties(BlobRequestOptions requestOptions = null, OperationContext operationContext = null)

Gets service properties for the Blob service.

public virtual Task<ServiceProperties> GetServicePropertiesAsync()

Initiates an asynchronous operation to get service properties for the Blob service.

public virtual Task<ServiceProperties> GetServicePropertiesAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to get service properties for the Blob service.

public virtual Task<ServiceProperties> GetServicePropertiesAsync(BlobRequestOptions requestOptions, OperationContext operationContext)

Initiates an asynchronous operation to get service properties for the Blob service.

public virtual Task<ServiceProperties> GetServicePropertiesAsync(BlobRequestOptions requestOptions, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to get service properties for the Blob service.

public virtual ServiceStats GetServiceStats(BlobRequestOptions requestOptions = null, OperationContext operationContext = null)

Gets service stats for the secondary Blob service endpoint.

public virtual Task<ServiceStats> GetServiceStatsAsync()

Initiates an asynchronous operation to get service stats for the secondary Blob service endpoint.

public virtual Task<ServiceStats> GetServiceStatsAsync(CancellationToken cancellationToken)

Initiates an asynchronous operation to get service stats for the secondary Blob service endpoint.

public virtual Task<ServiceStats> GetServiceStatsAsync(BlobRequestOptions requestOptions, OperationContext operationContext)

Initiates an asynchronous operation to get service stats for the secondary Blob service endpoint.

public virtual Task<ServiceStats> GetServiceStatsAsync(BlobRequestOptions requestOptions, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to get service stats for the secondary Blob service endpoint.

public virtual UserDelegationKey GetUserDelegationKey(DateTimeOffset keyStart, DateTimeOffset keyEnd, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null)

Gets a user delegation key for generating user-delegation-based shared access signature tokens.

public virtual Task<UserDelegationKey> GetUserDelegationKeyAsync(DateTimeOffset keyStart, DateTimeOffset keyEnd)

Gets a user delegation key for generating user-delegation-based shared access signature tokens asynchronously.

public virtual Task<UserDelegationKey> GetUserDelegationKeyAsync(DateTimeOffset keyStart, DateTimeOffset keyEnd, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Gets a user delegation key for generating user-delegation-based shared access signature tokens asynchronously.

public virtual IEnumerable<IListBlobItem> ListBlobs(string prefix, bool useFlatBlobListing = false, BlobListingDetails blobListingDetails = 0, BlobRequestOptions options = null, OperationContext operationContext = null)

Returns an enumerable collection of blobs in the container, retrieved lazily.

public virtual BlobResultSegment ListBlobsSegmented(string prefix, BlobContinuationToken currentToken)

Returns a result segment containing a collection of blob items in the container.

public virtual BlobResultSegment ListBlobsSegmented(string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, OperationContext operationContext)

Returns a result segment containing a collection of blob items in the container.

public virtual Task<BlobResultSegment> ListBlobsSegmentedAsync(string prefix, BlobContinuationToken currentToken)

Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.

public virtual Task<BlobResultSegment> ListBlobsSegmentedAsync(string prefix, BlobContinuationToken currentToken, CancellationToken cancellationToken)

Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.

public virtual Task<BlobResultSegment> ListBlobsSegmentedAsync(string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.

public virtual Task<BlobResultSegment> ListBlobsSegmentedAsync(string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to return a result segment containing a collection of blob items in the container.

public virtual IEnumerable<CloudBlobContainer> ListContainers(string prefix = null, ContainerListingDetails detailsIncluded = 0, BlobRequestOptions options = null, OperationContext operationContext = null)

Returns an enumerable collection of containers whose names begin with the specified prefix and that are retrieved lazily.

Returns a result segment containing a collection of CloudBlobContainer objects.

public virtual ContainerResultSegment ListContainersSegmented(string prefix, BlobContinuationToken currentToken)

Returns a result segment containing a collection of CloudBlobContainer objects.

public virtual ContainerResultSegment ListContainersSegmented(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options = null, OperationContext operationContext = null)

Returns a result segment containing a collection of containers whose names begin with the specified prefix.

Initiates an asynchronous operation to return a result segment containing a collection of containers.

Initiates an asynchronous operation to return a result segment containing a collection of containers.

public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(string prefix, BlobContinuationToken continuationToken)

Initiates an asynchronous operation to return a result segment containing a collection of containers.

public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(string prefix, BlobContinuationToken continuationToken, CancellationToken cancellationToken)

Initiates an asynchronous operation to return a result segment containing a collection of containers.

public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken continuationToken, BlobRequestOptions options, OperationContext operationContext)

Initiates an asynchronous operation to return a result segment containing a collection of containers.

public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken continuationToken, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation to return a result segment containing a collection of containers.

public virtual void SetServiceProperties(ServiceProperties properties, BlobRequestOptions requestOptions = null, OperationContext operationContext = null)

Sets service properties for the Blob service.

public virtual Task SetServicePropertiesAsync(ServiceProperties properties)

Initiates an asynchronous operation that sets service properties for the Blob service.

public virtual Task SetServicePropertiesAsync(ServiceProperties properties, CancellationToken cancellationToken)

Initiates an asynchronous operation that sets service properties for the Blob service.

public virtual Task SetServicePropertiesAsync(ServiceProperties properties, BlobRequestOptions requestOptions, OperationContext operationContext)

Initiates an asynchronous operation that sets service properties for the Blob service.

public virtual Task SetServicePropertiesAsync(ServiceProperties properties, BlobRequestOptions requestOptions, OperationContext operationContext, CancellationToken cancellationToken)

Initiates an asynchronous operation that sets service properties for the Blob service.