Share via


FileDownloadDetails Class

Definition

Properties returned when downloading a File.

public class FileDownloadDetails
type FileDownloadDetails = class
Public Class FileDownloadDetails
Inheritance
FileDownloadDetails

Properties

AcceptRanges

Indicates that the service supports requests for partial file content.

AccessControlList

Optional. The POSIX access control list for the file or directory.

CacheControl

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

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 file name specified.

ContentEncoding

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

ContentHash

If the file 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 file'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

ContentLanguage

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

ContentRange

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

The format of the Content-Range is expected to comeback in the following format. [unit] [start]-[end]/[FileSize] (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 file).

CopyCompletedOn

Conclusion time of the last attempted Copy Blob operation where this file was the destination file. 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 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.

EncryptionContext

Encryption context of the file. Encryption context is metadata that is not encrypted when stored on the file. The primary application of this field is to store non-encrypted data that can be used to derive the customer-provided key for a file.

EncryptionKeySha256

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

ETag

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

IsServerEncrypted

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

LastModified

Returns the DateTimeOffset the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file.

LeaseDuration

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

LeaseState

Lease state of the file.

LeaseStatus

The current lease status of the file.

Metadata

The file's metadata.

Applies to