Share via


BlobDownloadDetails Class

Definition

Details returned when downloading a Blob.

public class BlobDownloadDetails
type BlobDownloadDetails = class
Public Class BlobDownloadDetails
Inheritance
BlobDownloadDetails

Constructors

BlobDownloadDetails()

Properties

AcceptRanges

Indicates that the service supports requests for partial blob content.

BlobCommittedBlockCount

The number of committed blocks present in the blob. This header is returned only for append blobs.

BlobContentHash

If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range

BlobSequenceNumber

The current sequence number for a page blob. This header is not returned for block blobs or append blobs

BlobType

The blob's type.

CacheControl

This header is returned if it was previously specified for the blob.

ContentDisposition

This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified.

ContentEncoding

This header returns the value that was specified for the Content-Encoding request header

ContentHash

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

ContentLanguage

This header returns the value that was specified for the Content-Language request header.

ContentLength

The number of bytes present in the response body.

ContentRange

Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.

The format of the Content-Range is expected to comeback in the following format. [unit] [start]-[end]/[blobSize] (e.g. bytes 1024-3071/10240)

The [end] value will be the inclusive last byte (e.g. header "bytes 0-7/8" is the entire 8-byte blob).

ContentType

The media type of the body of the response. For Download Blob this is 'application/octet-stream'

CopyCompletedOn

Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

CopyId

String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.

CopyProgress

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

CopySource

URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

CopyStatus

State of the copy operation identified by x-ms-copy-id.

CopyStatusDescription

Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

CreatedOn

Returns the date and time the blob was created on.

EncryptionKeySha256

The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key.

EncryptionScope

The encryption scope used to encrypt the blob.

ETag

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

HasLegalHold

Indicates if the blob has a legal hold.

ImmutabilityPolicy

The BlobImmutabilityPolicy associated with the blob.

IsSealed

If this blob is sealed.

IsServerEncrypted

The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted).

LastAccessed

Returns the date and time the blob was read or written to.

LastModified

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

LeaseDuration

When a blob is leased, specifies whether the lease is of infinite or fixed duration.

LeaseState

Lease state of the blob.

LeaseStatus

The current lease status of the blob.

Metadata

x-ms-meta

ObjectReplicationDestinationPolicyId

Object Replication Policy Id. This value is only set when the policy id

ObjectReplicationSourceProperties

x-ms-or

TagCount

The number of tags associated with the blob.

VersionId

A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob.

Applies to