Class AppendBlobClient

The AppendBlobClient allows you to manipulate Azure Storage append blobs.

An append blob is comprised of blocks and is optimized for append operations. When you modify an append blob, blocks are added to the end of the blob only, via the AppendBlockAsync(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation. Updating or deleting of existing blocks is not supported. Unlike a block blob, an append blob does not expose its block IDs.

Each block in an append blob can be a different size. Beginning with x-ms-version 2022-11-02, the maximum append size is 100 MB. For previous versions, the maximum append size is 4 MB. Append blobs can include up to 50,000 blocks.

Inheritance
System.Object
BlobBaseClient
AppendBlobClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Storage.Blobs.dll
Syntax
public class AppendBlobClient : Azure.Storage.Blobs.Specialized.BlobBaseClient

Constructors

AppendBlobClient()

Initializes a new instance of the AppendBlobClient class for mocking.

Declaration
protected AppendBlobClient ();

AppendBlobClient(Uri, BlobClientOptions)

Initializes a new instance of the AppendBlobClient class.

Declaration
public AppendBlobClient (Uri blobUri, Azure.Storage.Blobs.BlobClientOptions options = null);
Parameters
System.Uri blobUri

A System.Uri referencing the append blob that includes the name of the account, the name of the container, and the name of the blob. This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}".
BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

AppendBlobClient(String, String, String)

Initializes a new instance of the AppendBlobClient class.

Declaration
public AppendBlobClient (string connectionString, string blobContainerName, string blobName);
Parameters
System.String connectionString

A connection string includes the authentication information required for your application to access data in an Azure Storage account at runtime.

For more information, Configure Azure Storage connection strings
System.String blobContainerName

The name of the container containing this append blob.
System.String blobName

The name of this append blob.

AppendBlobClient(Uri, AzureSasCredential, BlobClientOptions)

Initializes a new instance of the AppendBlobClient class.

Declaration
public AppendBlobClient (Uri blobUri, Azure.AzureSasCredential credential, Azure.Storage.Blobs.BlobClientOptions options = null);
Parameters
System.Uri blobUri

A System.Uri referencing the append blob that includes the name of the account, the name of the container, and the name of the blob. This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}". Must not contain shared access signature, which should be passed in the second parameter.
Azure.AzureSasCredential credential

The shared access signature credential used to sign requests.
BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.
Remarks

This constructor should only be used when shared access signature needs to be updated during lifespan of this client.

AppendBlobClient(Uri, TokenCredential, BlobClientOptions)

Initializes a new instance of the AppendBlobClient class.

Declaration
public AppendBlobClient (Uri blobUri, Azure.Core.TokenCredential credential, Azure.Storage.Blobs.BlobClientOptions options = null);
Parameters
System.Uri blobUri

A System.Uri referencing the append blob that includes the name of the account, the name of the container, and the name of the blob. This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}".
Azure.Core.TokenCredential credential

The token credential used to sign requests.
BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

AppendBlobClient(Uri, StorageSharedKeyCredential, BlobClientOptions)

Initializes a new instance of the AppendBlobClient class.

Declaration
public AppendBlobClient (Uri blobUri, Azure.Storage.StorageSharedKeyCredential credential, Azure.Storage.Blobs.BlobClientOptions options = null);
Parameters
System.Uri blobUri

A System.Uri referencing the append blob that includes the name of the account, the name of the container, and the name of the blob. This is likely to be similar to "https://{account_name}.blob.core.windows.net/{container_name}/{blob_name}".
Azure.Storage.StorageSharedKeyCredential credential

The shared key credential used to sign requests.
BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

AppendBlobClient(String, String, String, BlobClientOptions)

Initializes a new instance of the AppendBlobClient class.

Declaration
public AppendBlobClient (string connectionString, string blobContainerName, string blobName, Azure.Storage.Blobs.BlobClientOptions options);
Parameters
System.String connectionString

A connection string includes the authentication information required for your application to access data in an Azure Storage account at runtime.

For more information, Configure Azure Storage connection strings
System.String blobContainerName

The name of the container containing this append blob.
System.String blobName

The name of this append blob.
BlobClientOptions options

Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Properties

AppendBlobMaxAppendBlockBytes

Gets the maximum number of bytes that can be sent in a call to AppendBlock.

Declaration
public virtual int AppendBlobMaxAppendBlockBytes { get; }
Property Value
System.Int32

AppendBlobMaxBlocks

Gets the maximum number of blocks allowed in an append blob.

Declaration
public virtual int AppendBlobMaxBlocks { get; }
Property Value
System.Int32

Methods

AppendBlock(Stream, AppendBlobAppendBlockOptions, CancellationToken)

The AppendBlock(Stream, AppendBlobAppendBlockOptions, CancellationToken) operation commits a new block of data, represented by the contentSystem.IO.Stream, to the end of the existing append blob. The AppendBlock(Stream, AppendBlobAppendBlockOptions, CancellationToken) operation is only permitted if the blob was created as an append blob.

For more information, see Append Block.

Declaration
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobAppendInfo> AppendBlock (System.IO.Stream content, Azure.Storage.Blobs.Models.AppendBlobAppendBlockOptions options = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.IO.Stream content

A System.IO.Stream containing the content of the block to append.
AppendBlobAppendBlockOptions options

Optional parameters.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
Azure.Response<BlobAppendInfo>

A Azure.Response describing the state of the updated append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

AppendBlock(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken)

The AppendBlock(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation commits a new block of data, represented by the contentSystem.IO.Stream, to the end of the existing append blob. The AppendBlock(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation is only permitted if the blob was created as an append blob.

For more information, see Append Block.

Declaration
[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobAppendInfo> AppendBlock (System.IO.Stream content, byte[] transactionalContentHash, Azure.Storage.Blobs.Models.AppendBlobRequestConditions conditions, IProgress<long> progressHandler, System.Threading.CancellationToken cancellationToken);
Parameters
System.IO.Stream content

A System.IO.Stream containing the content of the block to append.
System.Byte[] transactionalContentHash

Optional MD5 hash of the block content. This hash is used to verify the integrity of the block during transport. When this hash is specified, the storage service compares the hash of the content that has arrived with this value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the operation will fail with a Azure.RequestFailedException.
AppendBlobRequestConditions conditions

Optional AppendBlobRequestConditions to add conditions on appending content to this append blob.
System.IProgress<System.Int64> progressHandler

Optional System.IProgress to provide progress updates about data transfers.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
Azure.Response<BlobAppendInfo>

A Azure.Response describing the state of the updated append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

AppendBlockAsync(Stream, AppendBlobAppendBlockOptions, CancellationToken)

The AppendBlockAsync(Stream, AppendBlobAppendBlockOptions, CancellationToken) operation commits a new block of data, represented by the contentSystem.IO.Stream, to the end of the existing append blob. The AppendBlockAsync(Stream, AppendBlobAppendBlockOptions, CancellationToken) operation is only permitted if the blob was created as an append blob.

For more information, see Append Block.

Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobAppendInfo>> AppendBlockAsync (System.IO.Stream content, Azure.Storage.Blobs.Models.AppendBlobAppendBlockOptions options = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.IO.Stream content

A System.IO.Stream containing the content of the block to append.
AppendBlobAppendBlockOptions options

Optional parameters.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<Azure.Response<BlobAppendInfo>>

A Azure.Response describing the state of the updated append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

AppendBlockAsync(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken)

The AppendBlockAsync(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation commits a new block of data, represented by the contentSystem.IO.Stream, to the end of the existing append blob. The AppendBlockAsync(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation is only permitted if the blob was created as an append blob.

For more information, see Append Block.

Declaration
[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobAppendInfo>> AppendBlockAsync (System.IO.Stream content, byte[] transactionalContentHash, Azure.Storage.Blobs.Models.AppendBlobRequestConditions conditions, IProgress<long> progressHandler, System.Threading.CancellationToken cancellationToken);
Parameters
System.IO.Stream content

A System.IO.Stream containing the content of the block to append.
System.Byte[] transactionalContentHash

Optional MD5 hash of the block content. This hash is used to verify the integrity of the block during transport. When this hash is specified, the storage service compares the hash of the content that has arrived with this value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the operation will fail with a Azure.RequestFailedException.
AppendBlobRequestConditions conditions

Optional AppendBlobRequestConditions to add conditions on appending content to this append blob.
System.IProgress<System.Int64> progressHandler

Optional System.IProgress to provide progress updates about data transfers.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<Azure.Response<BlobAppendInfo>>

A Azure.Response describing the state of the updated append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

AppendBlockFromUri(Uri, AppendBlobAppendBlockFromUriOptions, CancellationToken)

The AppendBlockFromUri(Uri, AppendBlobAppendBlockFromUriOptions, CancellationToken) operation commits a new block of data, represented by the sourceUri, to the end of the existing append blob. The AppendBlockFromUri(Uri, AppendBlobAppendBlockFromUriOptions, CancellationToken) operation is only permitted if the blob was created as an append blob.

For more information, see Append Block From URL.

Declaration
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobAppendInfo> AppendBlockFromUri (Uri sourceUri, Azure.Storage.Blobs.Models.AppendBlobAppendBlockFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Uri sourceUri

Specifies the System.Uri of the source blob. The value may be a System.Uri of up to 2 KB in length that specifies a blob. The source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.
AppendBlobAppendBlockFromUriOptions options

Optional parameters. AppendBlobAppendBlockFromUriOptions.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
Azure.Response<BlobAppendInfo>

A Azure.Response describing the state of the updated append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

AppendBlockFromUri(Uri, HttpRange, Byte[], AppendBlobRequestConditions, AppendBlobRequestConditions, CancellationToken)

The AppendBlockFromUriAsync(Uri, HttpRange, Byte[], AppendBlobRequestConditions, AppendBlobRequestConditions, CancellationToken) operation commits a new block of data, represented by the sourceUri, to the end of the existing append blob. The AppendBlockFromUriAsync(Uri, HttpRange, Byte[], AppendBlobRequestConditions, AppendBlobRequestConditions, CancellationToken) operation is only permitted if the blob was created as an append blob.

For more information, see Append Block From URL.

Declaration
[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobAppendInfo> AppendBlockFromUri (Uri sourceUri, Azure.HttpRange sourceRange, byte[] sourceContentHash, Azure.Storage.Blobs.Models.AppendBlobRequestConditions conditions, Azure.Storage.Blobs.Models.AppendBlobRequestConditions sourceConditions, System.Threading.CancellationToken cancellationToken);
Parameters
System.Uri sourceUri

Specifies the System.Uri of the source blob. The value may be a System.Uri of up to 2 KB in length that specifies a blob. The source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.
Azure.HttpRange sourceRange

Optionally only upload the bytes of the blob in the sourceUri in the specified range. If this is not specified, the entire source blob contents are uploaded as a single append block.
System.Byte[] sourceContentHash

Optional MD5 hash of the append block content from the sourceUri. This hash is used to verify the integrity of the block during transport of the data from the Uri. When this hash is specified, the storage service compares the hash of the content that has arrived from the sourceUri with this value. Note that this md5 hash is not stored with the blob. If the two hashes do not match, the operation will fail with a Azure.RequestFailedException.
AppendBlobRequestConditions conditions

Optional AppendBlobRequestConditions to add conditions on the copying of data to this append blob.
AppendBlobRequestConditions sourceConditions

Optional AppendBlobRequestConditions to add conditions on the copying of data from this source blob.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
Azure.Response<BlobAppendInfo>

A Azure.Response describing the state of the updated append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

AppendBlockFromUriAsync(Uri, HttpRange, Byte[], AppendBlobRequestConditions, AppendBlobRequestConditions, CancellationToken)

The AppendBlockFromUriAsync(Uri, HttpRange, Byte[], AppendBlobRequestConditions, AppendBlobRequestConditions, CancellationToken) operation commits a new block of data, represented by the sourceUri, to the end of the existing append blob. The AppendBlockFromUriAsync(Uri, HttpRange, Byte[], AppendBlobRequestConditions, AppendBlobRequestConditions, CancellationToken) operation is only permitted if the blob was created as an append blob.

For more information, see Append Block From URL.

Declaration
[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobAppendInfo>> AppendBlockFromUriAsync (Uri sourceUri, Azure.HttpRange sourceRange, byte[] sourceContentHash, Azure.Storage.Blobs.Models.AppendBlobRequestConditions conditions, Azure.Storage.Blobs.Models.AppendBlobRequestConditions sourceConditions, System.Threading.CancellationToken cancellationToken);
Parameters
System.Uri sourceUri

Specifies the System.Uri of the source blob. The value may be a System.Uri of up to 2 KB in length that specifies a blob. The source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.
Azure.HttpRange sourceRange

Optionally only upload the bytes of the blob in the sourceUri in the specified range. If this is not specified, the entire source blob contents are uploaded as a single append block.
System.Byte[] sourceContentHash

Optional MD5 hash of the append block content from the sourceUri. This hash is used to verify the integrity of the block during transport of the data from the Uri. When this hash is specified, the storage service compares the hash of the content that has arrived from the sourceUri with this value. Note that this md5 hash is not stored with the blob. If the two hashes do not match, the operation will fail with a Azure.RequestFailedException.
AppendBlobRequestConditions conditions

Optional AppendBlobRequestConditions to add conditions on the copying of data to this append blob.
AppendBlobRequestConditions sourceConditions

Optional AppendBlobRequestConditions to add conditions on the copying of data from this source blob.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<Azure.Response<BlobAppendInfo>>

A Azure.Response describing the state of the updated append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

AppendBlockFromUriAsync(Uri, AppendBlobAppendBlockFromUriOptions, CancellationToken)

The AppendBlockFromUriAsync(Uri, AppendBlobAppendBlockFromUriOptions, CancellationToken) operation commits a new block of data, represented by the sourceUri, to the end of the existing append blob. The AppendBlockFromUriAsync(Uri, AppendBlobAppendBlockFromUriOptions, CancellationToken) operation is only permitted if the blob was created as an append blob.

For more information, see Append Block From URL.

Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobAppendInfo>> AppendBlockFromUriAsync (Uri sourceUri, Azure.Storage.Blobs.Models.AppendBlobAppendBlockFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Uri sourceUri

Specifies the System.Uri of the source blob. The value may be a System.Uri of up to 2 KB in length that specifies a blob. The source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.
AppendBlobAppendBlockFromUriOptions options

Optional parameters. AppendBlobAppendBlockFromUriOptions.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<Azure.Response<BlobAppendInfo>>

A Azure.Response describing the state of the updated append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Create(AppendBlobCreateOptions, CancellationToken)

The Create(AppendBlobCreateOptions, CancellationToken) operation creates a new 0-length append blob. The content of any existing blob is overwritten with the newly initialized append blob. To add content to the append blob, call the AppendBlock(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation.

Declaration
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo> Create (Azure.Storage.Blobs.Models.AppendBlobCreateOptions options, System.Threading.CancellationToken cancellationToken = null);
Parameters
AppendBlobCreateOptions options

Optional parameters.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
Azure.Response<BlobContentInfo>

A Azure.Response describing the newly created append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Create(BlobHttpHeaders, IDictionary<String,String>, AppendBlobRequestConditions, CancellationToken)

The Create(BlobHttpHeaders, IDictionary<String,String>, AppendBlobRequestConditions, CancellationToken) operation creates a new 0-length append blob. The content of any existing blob is overwritten with the newly initialized append blob. To add content to the append blob, call the AppendBlock(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation.

For more information, see Put Blob.

Declaration
[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo> Create (Azure.Storage.Blobs.Models.BlobHttpHeaders httpHeaders = null, System.Collections.Generic.IDictionary<string,string> metadata = null, Azure.Storage.Blobs.Models.AppendBlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
BlobHttpHeaders httpHeaders

Optional standard HTTP header properties that can be set for the new append blob.
System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this append blob.
AppendBlobRequestConditions conditions

Optional AppendBlobRequestConditions to add conditions on the creation of this new append blob.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
Azure.Response<BlobContentInfo>

A Azure.Response describing the newly created append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

CreateAsync(AppendBlobCreateOptions, CancellationToken)

The CreateAsync(AppendBlobCreateOptions, CancellationToken) operation creates a new 0-length append blob. The content of any existing blob is overwritten with the newly initialized append blob. To add content to the append blob, call the AppendBlock(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation.

Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>> CreateAsync (Azure.Storage.Blobs.Models.AppendBlobCreateOptions options, System.Threading.CancellationToken cancellationToken = null);
Parameters
AppendBlobCreateOptions options

Optional parameters.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<Azure.Response<BlobContentInfo>>

A Azure.Response describing the newly created append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

CreateAsync(BlobHttpHeaders, IDictionary<String,String>, AppendBlobRequestConditions, CancellationToken)

The CreateAsync(BlobHttpHeaders, IDictionary<String,String>, AppendBlobRequestConditions, CancellationToken) operation creates a new 0-length append blob. The content of any existing blob is overwritten with the newly initialized append blob. To add content to the append blob, call the AppendBlockAsync(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation.

For more information, see Put Blob.

Declaration
[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>> CreateAsync (Azure.Storage.Blobs.Models.BlobHttpHeaders httpHeaders = null, System.Collections.Generic.IDictionary<string,string> metadata = null, Azure.Storage.Blobs.Models.AppendBlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
BlobHttpHeaders httpHeaders

Optional standard HTTP header properties that can be set for the new append blob.
System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this append blob.
AppendBlobRequestConditions conditions

Optional AppendBlobRequestConditions to add conditions on the creation of this new append blob.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<Azure.Response<BlobContentInfo>>

A Azure.Response describing the newly created append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

CreateIfNotExists(AppendBlobCreateOptions, CancellationToken)

The CreateIfNotExists(AppendBlobCreateOptions, CancellationToken) operation creates a new 0-length append blob. If the append blob already exists, the content of the existing append blob will remain unchanged. To add content to the append blob, call the AppendBlockAsync(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation.

For more information, see Put Blob.

Declaration
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo> CreateIfNotExists (Azure.Storage.Blobs.Models.AppendBlobCreateOptions options, System.Threading.CancellationToken cancellationToken = null);
Parameters
AppendBlobCreateOptions options

Optional parameters.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
Azure.Response<BlobContentInfo>

If the append blob does not already exist, a Azure.Response describing the newly created append blob. Otherwise, null.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

CreateIfNotExists(BlobHttpHeaders, IDictionary<String,String>, CancellationToken)

The CreateIfNotExists(BlobHttpHeaders, IDictionary<String,String>, CancellationToken) operation creates a new 0-length append blob. If the append blob already exists, the content of the existing append blob will remain unchanged. To add content to the append blob, call the AppendBlockAsync(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation.

For more information, see Put Blob.

Declaration
[System.ComponentModel.EditorBrowsable]
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo> CreateIfNotExists (Azure.Storage.Blobs.Models.BlobHttpHeaders httpHeaders = null, System.Collections.Generic.IDictionary<string,string> metadata = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
BlobHttpHeaders httpHeaders

Optional standard HTTP header properties that can be set for the new append blob.
System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this append blob.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
Azure.Response<BlobContentInfo>

If the append blob does not already exist, a Azure.Response describing the newly created append blob. Otherwise, null.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

CreateIfNotExistsAsync(BlobHttpHeaders, IDictionary<String,String>, CancellationToken)

The CreateIfNotExistsAsync(BlobHttpHeaders, IDictionary<String,String>, CancellationToken) operation creates a new 0-length append blob. If the append blob already exists, the content of the existing append blob will remain unchanged. To add content to the append blob, call the AppendBlockAsync(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation.

For more information, see Put Blob.

Declaration
[System.ComponentModel.EditorBrowsable]
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>> CreateIfNotExistsAsync (Azure.Storage.Blobs.Models.BlobHttpHeaders httpHeaders = null, System.Collections.Generic.IDictionary<string,string> metadata = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
BlobHttpHeaders httpHeaders

Optional standard HTTP header properties that can be set for the new append blob.
System.Collections.Generic.IDictionary<System.String,System.String> metadata

Optional custom metadata to set for this append blob.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<Azure.Response<BlobContentInfo>>

If the append blob does not already exist, a Azure.Response describing the newly created append blob. Otherwise, null.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

CreateIfNotExistsAsync(AppendBlobCreateOptions, CancellationToken)

The CreateIfNotExistsAsync(AppendBlobCreateOptions, CancellationToken) operation creates a new 0-length append blob. If the append blob already exists, the content of the existing append blob will remain unchanged. To add content to the append blob, call the AppendBlockAsync(Stream, Byte[], AppendBlobRequestConditions, IProgress<Int64>, CancellationToken) operation.

For more information, see Put Blob.

Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobContentInfo>> CreateIfNotExistsAsync (Azure.Storage.Blobs.Models.AppendBlobCreateOptions options, System.Threading.CancellationToken cancellationToken = null);
Parameters
AppendBlobCreateOptions options

Optional parameters.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<Azure.Response<BlobContentInfo>>

If the append blob does not already exist, a Azure.Response describing the newly created append blob. Otherwise, null.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

OpenWrite(Boolean, AppendBlobOpenWriteOptions, CancellationToken)

Opens a stream for writing to the blob.

Declaration
public virtual System.IO.Stream OpenWrite (bool overwrite, Azure.Storage.Blobs.Models.AppendBlobOpenWriteOptions options = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Boolean overwrite

Whether an existing blob should be deleted and recreated.
AppendBlobOpenWriteOptions options

Optional parameters.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.IO.Stream

A stream to write to the Append Blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

OpenWriteAsync(Boolean, AppendBlobOpenWriteOptions, CancellationToken)

Opens a stream for writing to the blob.

Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<System.IO.Stream> OpenWriteAsync (bool overwrite, Azure.Storage.Blobs.Models.AppendBlobOpenWriteOptions options = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Boolean overwrite

Whether an existing blob should be deleted and recreated.
AppendBlobOpenWriteOptions options

Optional parameters.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<System.IO.Stream>

A stream to write to the Append Blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

Seal(AppendBlobRequestConditions, CancellationToken)

Seals the append blob, making it read only. Any subsequent appends will fail.

Declaration
public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobInfo> Seal (Azure.Storage.Blobs.Models.AppendBlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
AppendBlobRequestConditions conditions

Optional AppendBlobRequestConditions to add conditions on the sealing of this blob.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
Azure.Response<BlobInfo>

A Azure.Response describing the state of the sealed append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

SealAsync(AppendBlobRequestConditions, CancellationToken)

Seals the append blob, making it read only. Any subsequent appends will fail.

Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobInfo>> SealAsync (Azure.Storage.Blobs.Models.AppendBlobRequestConditions conditions = null, System.Threading.CancellationToken cancellationToken = null);
Parameters
AppendBlobRequestConditions conditions

Optional AppendBlobRequestConditions to add conditions on the sealing of this blob.
System.Threading.CancellationToken cancellationToken

Optional System.Threading.CancellationToken to propagate notifications that the operation should be cancelled.
Returns
System.Threading.Tasks.Task<Azure.Response<BlobInfo>>

A Azure.Response describing the state of the sealed append blob.
Remarks

A Azure.RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an System.AggregateException will be thrown, containing each failure instance.

WithCustomerProvidedKey(Nullable<CustomerProvidedKey>)

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

Declaration
public Azure.Storage.Blobs.Specialized.AppendBlobClient WithCustomerProvidedKey (Nullable<Azure.Storage.Blobs.Models.CustomerProvidedKey> customerProvidedKey);
Parameters
System.Nullable<CustomerProvidedKey> customerProvidedKey

The customer provided key.
Returns
AppendBlobClient

A new AppendBlobClient instance.
Remarks

Pass null to remove the customer provide key in the returned AppendBlobClient.

WithEncryptionScope(String)

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

Declaration
public Azure.Storage.Blobs.Specialized.AppendBlobClient WithEncryptionScope (string encryptionScope);
Parameters
System.String encryptionScope

The encryption scope.
Returns
AppendBlobClient

A new AppendBlobClient instance.
Remarks

Pass null to remove the encryption scope in the returned AppendBlobClient.

WithSnapshot(String)

Initializes a new instance of the AppendBlobClient class with an identical System.Uri source but the specified snapshot timestamp.

For more information, see Create a snapshot of a blob.

Declaration
public Azure.Storage.Blobs.Specialized.AppendBlobClient WithSnapshot (string snapshot);
Parameters
System.String snapshot

The snapshot identifier.
Returns
AppendBlobClient

A new AppendBlobClient instance.
Remarks

Pass null or empty string to remove the snapshot returning a URL

to the base blob.

WithVersion(String)

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

Declaration
public Azure.Storage.Blobs.Specialized.AppendBlobClient WithVersion (string versionId);
Parameters
System.String versionId

The version identifier.
Returns
AppendBlobClient

A new AppendBlobClient instance.
Remarks

Pass null or empty string to remove the version returning a URL

to the base blob.

Extension Methods