AppendBlobClient Class

Definition

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, up to a maximum of 4 MB, and an append blob can include up to 50,000 blocks. The maximum size of an append blob is therefore slightly more than 195 GB (4 MB X 50,000 blocks).

public class AppendBlobClient : Azure.Storage.Blobs.Specialized.BlobBaseClient
type AppendBlobClient = class
    inherit BlobBaseClient
Public Class AppendBlobClient
Inherits BlobBaseClient
Inheritance
AppendBlobClient

Constructors

AppendBlobClient()

Initializes a new instance of the AppendBlobClient class for mocking.

AppendBlobClient(String, String, String)

Initializes a new instance of the AppendBlobClient class.

AppendBlobClient(String, String, String, BlobClientOptions)

Initializes a new instance of the AppendBlobClient class.

AppendBlobClient(Uri, BlobClientOptions)

Initializes a new instance of the AppendBlobClient class.

AppendBlobClient(Uri, StorageSharedKeyCredential, BlobClientOptions)

Initializes a new instance of the AppendBlobClient class.

AppendBlobClient(Uri, TokenCredential, BlobClientOptions)

Initializes a new instance of the AppendBlobClient class.

Properties

AccountName

Gets the Storage account name corresponding to the blob client.

(Inherited from BlobBaseClient)
AppendBlobMaxAppendBlockBytes

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

AppendBlobMaxBlocks

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

BlobContainerName

Gets the container name corresponding to the blob client.

(Inherited from BlobBaseClient)
Name

Gets the name of the blob.

(Inherited from BlobBaseClient)
Uri

Gets the blob's primary Uri endpoint.

(Inherited from BlobBaseClient)

Methods

AbortCopyFromUri(String, BlobRequestConditions, CancellationToken)

The AbortCopyFromUri(String, BlobRequestConditions, CancellationToken) operation aborts a pending CopyFromUriOperation, and leaves a this blob with zero length and full metadata.

For more information, see Abort Copy Blob.

(Inherited from BlobBaseClient)
AbortCopyFromUriAsync(String, BlobRequestConditions, CancellationToken)

The AbortCopyFromUriAsync(String, BlobRequestConditions, CancellationToken) operation aborts a pending CopyFromUriOperation, and leaves a this blob with zero length and full metadata.

For more information, see Abort Copy Blob.

(Inherited from BlobBaseClient)
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 contentStream, 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.

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 contentStream, 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.

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

The AppendBlockFromUri(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 AppendBlockFromUri(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.

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.

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.

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.

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.

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.

CreateSnapshot(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

The CreateSnapshot(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation creates a read-only snapshot of a blob.

For more information, see Snapshot Blob.

(Inherited from BlobBaseClient)
CreateSnapshotAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

The CreateSnapshotAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation creates a read-only snapshot of a blob.

For more information, see Snapshot Blob.

(Inherited from BlobBaseClient)
Delete(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

The Delete(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection.

Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using IncludeSnapshots.

For more information, see Delete Blob.

(Inherited from BlobBaseClient)
DeleteAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

The DeleteAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection.

Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using IncludeSnapshots.

For more information, see Delete Blob.

(Inherited from BlobBaseClient)
DeleteIfExists(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

The DeleteIfExists(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion, if the blob exists. The blob is later deleted during garbage collection.

Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using IncludeSnapshots.

For more information, see Delete Blob.

(Inherited from BlobBaseClient)
DeleteIfExistsAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

The DeleteIfExistsAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) operation marks the specified blob or snapshot for deletion, if the blob exists. The blob is later deleted during garbage collection.

Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time using IncludeSnapshots.

For more information, see Delete Blob.

(Inherited from BlobBaseClient)
Download()

The Download() operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

(Inherited from BlobBaseClient)
Download(CancellationToken)

The Download(CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

(Inherited from BlobBaseClient)
Download(HttpRange, BlobRequestConditions, Boolean, CancellationToken)

The Download(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

(Inherited from BlobBaseClient)
DownloadAsync()

The DownloadAsync() operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

(Inherited from BlobBaseClient)
DownloadAsync(CancellationToken)

The DownloadAsync(CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

(Inherited from BlobBaseClient)
DownloadAsync(HttpRange, BlobRequestConditions, Boolean, CancellationToken)

The DownloadAsync(HttpRange, BlobRequestConditions, Boolean, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

(Inherited from BlobBaseClient)
DownloadTo(Stream)

The DownloadTo(Stream) operation downloads a blob using parallel requests, and writes the content to destination.

(Inherited from BlobBaseClient)
DownloadTo(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken)

The DownloadTo(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.

(Inherited from BlobBaseClient)
DownloadTo(Stream, CancellationToken)

The DownloadTo(Stream, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.

(Inherited from BlobBaseClient)
DownloadTo(String)

The DownloadTo(String) operation downloads a blob using parallel requests, and writes the content to path.

(Inherited from BlobBaseClient)
DownloadTo(String, BlobRequestConditions, StorageTransferOptions, CancellationToken)

The DownloadTo(String, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.

(Inherited from BlobBaseClient)
DownloadTo(String, CancellationToken)

The DownloadTo(String, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.

(Inherited from BlobBaseClient)
DownloadToAsync(Stream)

The DownloadToAsync(Stream) downloads a blob using parallel requests, and writes the content to destination.

(Inherited from BlobBaseClient)
DownloadToAsync(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken)

The DownloadToAsync(Stream, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.

(Inherited from BlobBaseClient)
DownloadToAsync(Stream, CancellationToken)

The DownloadToAsync(Stream, CancellationToken) operation downloads a blob using parallel requests, and writes the content to destination.

(Inherited from BlobBaseClient)
DownloadToAsync(String)

The DownloadToAsync(String) downloads a blob using parallel requests, and writes the content to path.

(Inherited from BlobBaseClient)
DownloadToAsync(String, BlobRequestConditions, StorageTransferOptions, CancellationToken)

The DownloadToAsync(String, BlobRequestConditions, StorageTransferOptions, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.

(Inherited from BlobBaseClient)
DownloadToAsync(String, CancellationToken)

The DownloadToAsync(String, CancellationToken) operation downloads a blob using parallel requests, and writes the content to path.

(Inherited from BlobBaseClient)
Exists(CancellationToken)

The Exists(CancellationToken) operation can be called on a BlobBaseClient to see if the associated blob exists in the container on the storage account in the storage service.

(Inherited from BlobBaseClient)
ExistsAsync(CancellationToken)

The ExistsAsync(CancellationToken) operation can be called on a BlobBaseClient to see if the associated blob exists in the container on the storage account in the storage service.

(Inherited from BlobBaseClient)
GetBlobLeaseClientCore(String)

Initializes a new instance of the BlobLeaseClient class.

(Inherited from BlobBaseClient)
GetProperties(BlobRequestConditions, CancellationToken)

The GetProperties(BlobRequestConditions, CancellationToken) operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.

For more information, see Get Blob Properties.

(Inherited from BlobBaseClient)
GetPropertiesAsync(BlobRequestConditions, CancellationToken)

The GetPropertiesAsync(BlobRequestConditions, CancellationToken) operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.

For more information, see Get Blob Properties.

(Inherited from BlobBaseClient)
GetTags(BlobRequestConditions, CancellationToken)

Gets the tags associated with the underlying blob.

For more information, see Get Blob Tags

(Inherited from BlobBaseClient)
GetTagsAsync(BlobRequestConditions, CancellationToken)

Gets the tags associated with the underlying blob.

For more information, see Get Blob Tags

(Inherited from BlobBaseClient)
OpenRead(BlobOpenReadOptions, CancellationToken)

Opens a stream for reading from the blob. The stream will only download the blob as the stream is read from.

(Inherited from BlobBaseClient)
OpenReadAsync(BlobOpenReadOptions, CancellationToken)

Opens a stream for reading from the blob. The stream will only download the blob as the stream is read from.

(Inherited from BlobBaseClient)
OpenWrite(Boolean, AppendBlobOpenWriteOptions, CancellationToken)

Opens a stream for writing to the blob.

OpenWriteAsync(Boolean, AppendBlobOpenWriteOptions, CancellationToken)

Opens a stream for writing to the blob.

Seal(AppendBlobRequestConditions, CancellationToken)

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

SealAsync(AppendBlobRequestConditions, CancellationToken)

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

SetAccessTier(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken)

The SetAccessTier(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage or general purpose v2 account.

A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. For detailed information about block blob level tiering Blob Storage Tiers.

For more information about setting the tier, see Blob Storage Tiers.

(Inherited from BlobBaseClient)
SetAccessTierAsync(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken)

The SetAccessTierAsync(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage or general purpose v2 account.

A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. For detailed information about block blob level tiering Blob Storage Tiers.

For more information about setting the tier, see Blob Storage Tiers.

(Inherited from BlobBaseClient)
SetHttpHeaders(BlobHttpHeaders, BlobRequestConditions, CancellationToken)

The SetHttpHeaders(BlobHttpHeaders, BlobRequestConditions, CancellationToken) operation sets system properties on the blob.

For more information, see Set Blob Properties.

(Inherited from BlobBaseClient)
SetHttpHeadersAsync(BlobHttpHeaders, BlobRequestConditions, CancellationToken)

The SetHttpHeadersAsync(BlobHttpHeaders, BlobRequestConditions, CancellationToken) operation sets system properties on the blob.

For more information, see Set Blob Properties.

(Inherited from BlobBaseClient)
SetMetadata(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

The SetMetadata(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation sets user-defined metadata for the specified blob as one or more name-value pairs.

For more information, see Set Blob Metadata.

(Inherited from BlobBaseClient)
SetMetadataAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

The SetMetadataAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken) operation sets user-defined metadata for the specified blob as one or more name-value pairs.

For more information, see Set Blob Metadata.

(Inherited from BlobBaseClient)
SetTags(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

Sets tags on the underlying blob. A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters. Valid tag key and value characters include lower and upper case letters, digits (0-9), space (' '), plus ('+'), minus ('-'), period ('.'), foward slash ('/'), colon (':'), equals ('='), and underscore ('_').

For more information, see Set Blob Tags.

(Inherited from BlobBaseClient)
SetTagsAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

Sets tags on the underlying blob. A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters. Valid tag key and value characters include lower and upper case letters, digits (0-9), space (' '), plus ('+'), minus ('-'), period ('.'), foward slash ('/'), colon (':'), equals ('='), and underscore ('_').

For more information, see Set Blob Tags.

(Inherited from BlobBaseClient)
StartCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken)

The StartCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken) operation begins an asynchronous copy of the data from the source to this blob. You can check the CopyStatus returned from the GetProperties(BlobRequestConditions, CancellationToken) to determine if the copy has completed.

For more information, see Copy Blob.

(Inherited from BlobBaseClient)
StartCopyFromUriAsync(Uri, BlobCopyFromUriOptions, CancellationToken)

The Azure.Storage.Blobs.Specialized.BlobBaseClient.StartCopyFromUri(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Nullable{Azure.Storage.Blobs.Models.AccessTier},Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.Blobs.Models.BlobRequestConditions,System.Nullable{Azure.Storage.Blobs.Models.RehydratePriority},System.Threading.CancellationToken) operation begins an asynchronous copy of the data from the source to this blob. You can check the CopyStatus returned from the GetPropertiesAsync(BlobRequestConditions, CancellationToken) to determine if the copy has completed.

For more information, see Copy Blob.

(Inherited from BlobBaseClient)
SyncCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken)

The Copy Blob From URL operation copies a blob to a destination within the storage account synchronously for source blob sizes up to 256 MB. This API is available starting in version 2018-03-28. The source for a Copy Blob From URL operation can be any committed block blob in any Azure storage account which is either public or authorized with a shared access signature.

The size of the source blob can be a maximum length of up to 256 MB.

For more information, see Copy Blob From URL.

(Inherited from BlobBaseClient)
SyncCopyFromUriAsync(Uri, BlobCopyFromUriOptions, CancellationToken)

The Copy Blob From URL operation copies a blob to a destination within the storage account synchronously for source blob sizes up to 256 MB. This API is available starting in version 2018-03-28. The source for a Copy Blob From URL operation can be any committed block blob in any Azure storage account which is either public or authorized with a shared access signature.

The size of the source blob can be a maximum length of up to 256 MB.

For more information, see Copy Blob From URL.

(Inherited from BlobBaseClient)
Undelete(CancellationToken)

The Undelete(CancellationToken) operation restores the contents and metadata of a soft deleted blob and any associated soft deleted snapshots.

For more information, see Undelete Blob.

(Inherited from BlobBaseClient)
UndeleteAsync(CancellationToken)

The UndeleteAsync(CancellationToken) operation restores the contents and metadata of a soft deleted blob and any associated soft deleted snapshots.

For more information, see Undelete Blob.

(Inherited from BlobBaseClient)
WithSnapshot(String)

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

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

WithSnapshotCore(String)

Creates a new instance of the BlobBaseClient class with an identical Uri source but the specified snapshot timestamp.

(Inherited from BlobBaseClient)
WithVersion(String)

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

Extension Methods

GetBlobLeaseClient(BlobBaseClient, String)

Initializes a new instance of the BlobLeaseClient class.

Applies to