<PackageReference Include="Azure.Storage.Blobs" Version="12.25.1" />

Azure.Storage.Blobs.BlobClient

public class BlobClient : BlobBaseClient
The BlobClient allows you to manipulate Azure Storage blobs.
protected BlobClient()

Initializes a new instance of the BlobClient class for mocking.

public BlobClient(string connectionString, string blobContainerName, string blobName)

Initializes a new instance of the BlobClient class.

public BlobClient(string connectionString, string blobContainerName, string blobName, BlobClientOptions options)

Initializes a new instance of the BlobClient class.

public BlobClient(Uri blobUri, BlobClientOptions options = null)

Initializes a new instance of the BlobClient class.

public BlobClient(Uri blobUri, StorageSharedKeyCredential credential, BlobClientOptions options = null)

Initializes a new instance of the BlobClient class.

public BlobClient(Uri blobUri, AzureSasCredential credential, BlobClientOptions options = null)

Initializes a new instance of the BlobClient class.

public BlobClient(Uri blobUri, TokenCredential credential, BlobClientOptions options = null)

Initializes a new instance of the BlobClient class.

public virtual Stream OpenWrite(bool overwrite, BlobOpenWriteOptions options = null, CancellationToken cancellationToken = default)

Opens a stream for writing to the blob. If the blob exists, it will be overwritten.

public virtual Task<Stream> OpenWriteAsync(bool overwrite, BlobOpenWriteOptions options = null, CancellationToken cancellationToken = default)

Opens a stream for writing to the blob. If the blob exists, it will be overwritten.

public virtual Response<BlobContentInfo> Upload(Stream content)

The Upload operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(BinaryData content)

The Upload operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(string path)

The Upload operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(Stream content, CancellationToken cancellationToken)

The Upload operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(BinaryData content, CancellationToken cancellationToken)

The Upload operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(string path, CancellationToken cancellationToken)

The Upload operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(Stream content, bool overwrite = false, CancellationToken cancellationToken = default)

The Upload operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(BinaryData content, bool overwrite = false, CancellationToken cancellationToken = default)

The Upload operation creates a new block blob or throws if the blob already exists. Setting overwrite to true allows updating the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(string path, bool overwrite = false, CancellationToken cancellationToken = default)

The Upload operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(Stream content, BlobUploadOptions options, CancellationToken cancellationToken = default)

The Upload operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through Conditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(BinaryData content, BlobUploadOptions options, CancellationToken cancellationToken = default)

The Upload operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through Conditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(Stream content, BlobHttpHeaders httpHeaders = null, IDictionary<string, string> metadata = null, BlobRequestConditions conditions = null, IProgress<long> progressHandler = null, AccessTier? accessTier = default, StorageTransferOptions transferOptions = default, CancellationToken cancellationToken = default)

The Upload operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through BlobRequestConditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, Put Blob.

public virtual Response<BlobContentInfo> Upload(string path, BlobUploadOptions options, CancellationToken cancellationToken = default)

The Upload operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through Conditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Response<BlobContentInfo> Upload(string path, BlobHttpHeaders httpHeaders = null, IDictionary<string, string> metadata = null, BlobRequestConditions conditions = null, IProgress<long> progressHandler = null, AccessTier? accessTier = default, StorageTransferOptions transferOptions = default, CancellationToken cancellationToken = default)

The Upload operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through BlobRequestConditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(Stream content)

The UploadAsync operation creates a new block blob or throws an exception if the blob already exists. Updating an existing block blob overwrites any existing metadata on the blob. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(BinaryData content)

The UploadAsync operation creates a new block blob or throws an exception if the blob already exists. Updating an existing block blob overwrites any existing metadata on the blob. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(string path)

The UploadAsync operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(Stream content, CancellationToken cancellationToken)

The UploadAsync operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(BinaryData content, CancellationToken cancellationToken)

The UploadAsync operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(string path, CancellationToken cancellationToken)

The UploadAsync operation creates a new block blob or throws if the blob already exists. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(Stream content, bool overwrite = false, CancellationToken cancellationToken = default)

The UploadAsync operation creates a new block blob or throws if the blob already exists. Setting overwrite to true allows updating the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(BinaryData content, bool overwrite = false, CancellationToken cancellationToken = default)

The UploadAsync operation creates a new block blob or throws if the blob already exists. Setting overwrite to true allows updating the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(string path, bool overwrite = false, CancellationToken cancellationToken = default)

The UploadAsync operation creates a new block blob or throws if the blob already exists. Setting overwrite to true allows updating the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(Stream content, BlobUploadOptions options, CancellationToken cancellationToken = default)

The UploadAsync operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through Conditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(BinaryData content, BlobUploadOptions options, CancellationToken cancellationToken = default)

The UploadAsync operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through Conditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(Stream content, BlobHttpHeaders httpHeaders = null, IDictionary<string, string> metadata = null, BlobRequestConditions conditions = null, IProgress<long> progressHandler = null, AccessTier? accessTier = default, StorageTransferOptions transferOptions = default, CancellationToken cancellationToken = default)

The UploadAsync operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through BlobRequestConditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public virtual Task<Response<BlobContentInfo>> UploadAsync(string path, BlobUploadOptions options, CancellationToken cancellationToken = default)

The UploadAsync operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through Conditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob..

public virtual Task<Response<BlobContentInfo>> UploadAsync(string path, BlobHttpHeaders httpHeaders = null, IDictionary<string, string> metadata = null, BlobRequestConditions conditions = null, IProgress<long> progressHandler = null, AccessTier? accessTier = default, StorageTransferOptions transferOptions = default, CancellationToken cancellationToken = default)

The UploadAsync operation overwrites the contents of the blob, creating a new block blob if none exists. Overwriting an existing block blob replaces any existing metadata on the blob. Set access conditions through BlobRequestConditions to avoid overwriting existing data. For partial block blob updates and other advanced features, please see BlockBlobClient. To create or modify page or append blobs, please see PageBlobClient or AppendBlobClient. For more information, see Put Blob.

public BlobClient WithCustomerProvidedKey(CustomerProvidedKey? customerProvidedKey)

Initializes a new instance of the BlobClient class with an identical Uri source but the specified customerProvidedKey.

public BlobClient WithEncryptionScope(string encryptionScope)

Initializes a new instance of the BlobClient class with an identical Uri source but the specified encryptionScope.

public BlobClient WithSnapshot(string snapshot)

Initializes a new instance of the BlobClient class with an identical Uri source but the specified snapshot timestamp. For more information, see Create a snapshot of a blob.

public BlobClient WithVersion(string versionId)

Initializes a new instance of the BlobClient class with an identical Uri source but the specified versionId timestamp.