BlobDownloadHeaders interface
Defines headers for Blob_download operation.
| accept |
Indicates that the service supports requests for partial blob content. |
| blob |
The number of committed blocks present in the blob. This header is returned only for append blobs. |
| blob |
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 |
| blob |
The current sequence number for a page blob. This header is not returned for block blobs or append blobs |
| blob |
The blob's type. |
| cache |
This header is returned if it was previously specified for the blob. |
| client |
If a client request id header is sent in the request, this header will be present in the response with the same value. |
| content |
If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request). |
| content |
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. |
| content |
This header returns the value that was specified for the Content-Encoding request header |
| content |
This header returns the value that was specified for the Content-Language request header. |
| content |
The number of bytes present in the response body. |
| contentMD5 | 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. |
| content |
Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header. |
| content |
The media type of the body of the response. For Download Blob this is 'application/octet-stream' |
| copy |
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. |
| copy |
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. |
| copy |
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 |
| copy |
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. |
| copy |
State of the copy operation identified by x-ms-copy-id. |
| copy |
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 |
| created |
Returns the date and time the blob was created. |
| date | UTC date/time value generated by the service that indicates the time at which the response was initiated |
| encryption |
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. |
| encryption |
Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. |
| error |
Error Code |
| 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. |
| immutability |
UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire. |
| immutability |
Indicates immutability policy mode. |
| is |
The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header. |
| is |
If this blob has been sealed |
| is |
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). |
| last |
UTC date/time value generated by the service that indicates the time at which the blob was last read or written to |
| last |
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. |
| lease |
When a blob is leased, specifies whether the lease is of infinite or fixed duration. |
| lease |
Lease state of the blob. |
| lease |
The current lease status of the blob. |
| legal |
Indicates if a legal hold is present on the blob. |
| metadata | |
| object |
Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication. |
| object |
Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed). |
| request |
This header uniquely identifies the request that was made and can be used for troubleshooting the request. |
| tag |
The number of tags associated with the blob |
| version | Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. |
| version |
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. |
Indicates that the service supports requests for partial blob content.
acceptRanges?: stringProperty Value
string
The number of committed blocks present in the blob. This header is returned only for append blobs.
blobCommittedBlockCount?: numberProperty Value
number
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
blobContentMD5?: Uint8ArrayProperty Value
Uint8Array
The current sequence number for a page blob. This header is not returned for block blobs or append blobs
blobSequenceNumber?: numberProperty Value
number
This header is returned if it was previously specified for the blob.
cacheControl?: stringProperty Value
string
If a client request id header is sent in the request, this header will be present in the response with the same value.
clientRequestId?: stringProperty Value
string
If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request).
contentCrc64?: Uint8ArrayProperty Value
Uint8Array
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.
contentDisposition?: stringProperty Value
string
This header returns the value that was specified for the Content-Encoding request header
contentEncoding?: stringProperty Value
string
This header returns the value that was specified for the Content-Language request header.
contentLanguage?: stringProperty Value
string
The number of bytes present in the response body.
contentLength?: numberProperty Value
number
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.
contentMD5?: Uint8ArrayProperty Value
Uint8Array
Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.
contentRange?: stringProperty Value
string
The media type of the body of the response. For Download Blob this is 'application/octet-stream'
contentType?: stringProperty Value
string
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.
copyCompletedOn?: DateProperty Value
Date
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.
copyId?: stringProperty Value
string
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
copyProgress?: stringProperty Value
string
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.
copySource?: stringProperty Value
string
State of the copy operation identified by x-ms-copy-id.
copyStatus?: CopyStatusTypeProperty Value
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
copyStatusDescription?: stringProperty Value
string
Returns the date and time the blob was created.
createdOn?: DateProperty Value
Date
UTC date/time value generated by the service that indicates the time at which the response was initiated
date?: DateProperty Value
Date
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.
encryptionKeySha256?: stringProperty Value
string
Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope.
encryptionScope?: stringProperty Value
string
Error Code
errorCode?: stringProperty Value
string
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.
etag?: stringProperty Value
string
UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.
immutabilityPolicyExpiresOn?: DateProperty Value
Date
Indicates immutability policy mode.
immutabilityPolicyMode?: BlobImmutabilityPolicyModeProperty Value
The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header.
isCurrentVersion?: booleanProperty Value
boolean
If this blob has been sealed
isSealed?: booleanProperty Value
boolean
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).
isServerEncrypted?: booleanProperty Value
boolean
UTC date/time value generated by the service that indicates the time at which the blob was last read or written to
lastAccessed?: DateProperty Value
Date
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.
lastModified?: DateProperty Value
Date
When a blob is leased, specifies whether the lease is of infinite or fixed duration.
leaseDuration?: LeaseDurationTypeProperty Value
The current lease status of the blob.
leaseStatus?: LeaseStatusTypeProperty Value
Indicates if a legal hold is present on the blob.
legalHold?: booleanProperty Value
boolean
metadata?: {[propertyName: string]: string}Property Value
{[propertyName: string]: string}
Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication.
objectReplicationPolicyId?: stringProperty Value
string
Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed).
objectReplicationRules?: {[propertyName: string]: string}Property Value
{[propertyName: string]: string}
This header uniquely identifies the request that was made and can be used for troubleshooting the request.
requestId?: stringProperty Value
string
The number of tags associated with the blob
tagCount?: numberProperty Value
number
Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
version?: stringProperty Value
string
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.
versionId?: stringProperty Value
string