Package version:

Interface BlobDownloadHeaders

Defines headers for Blob_download operation.

interface BlobDownloadHeaders {
    acceptRanges?: string;
    blobCommittedBlockCount?: number;
    blobContentMD5?: any;
    blobSequenceNumber?: number;
    blobType?: BlobType;
    cacheControl?: string;
    clientRequestId?: string;
    contentCrc64?: any;
    contentDisposition?: string;
    contentEncoding?: string;
    contentLanguage?: string;
    contentLength?: number;
    contentMD5?: any;
    contentRange?: string;
    contentType?: string;
    copyCompletedOn?: any;
    copyId?: string;
    copyProgress?: string;
    copySource?: string;
    copyStatus?: CopyStatusType;
    copyStatusDescription?: string;
    createdOn?: any;
    date?: any;
    encryptionKeySha256?: string;
    encryptionScope?: string;
    errorCode?: string;
    etag?: string;
    immutabilityPolicyExpiresOn?: any;
    immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
    isCurrentVersion?: boolean;
    isSealed?: boolean;
    isServerEncrypted?: boolean;
    lastAccessed?: any;
    lastModified?: any;
    leaseDuration?: LeaseDurationType;
    leaseState?: LeaseStateType;
    leaseStatus?: LeaseStatusType;
    legalHold?: boolean;
    metadata?: {
        [propertyName: string]: string;
    };
    objectReplicationPolicyId?: string;
    objectReplicationRules?: {
        [propertyName: string]: string;
    };
    requestId?: string;
    tagCount?: number;
    version?: string;
    versionId?: string;
}

Properties

acceptRanges? blobCommittedBlockCount? blobContentMD5? blobSequenceNumber? blobType? cacheControl? clientRequestId? contentCrc64? contentDisposition? contentEncoding? contentLanguage? contentLength? contentMD5? contentRange? contentType? copyCompletedOn? copyId? copyProgress? copySource? copyStatus? copyStatusDescription? createdOn? date? encryptionKeySha256? encryptionScope? errorCode? etag? immutabilityPolicyExpiresOn? immutabilityPolicyMode? isCurrentVersion? isSealed? isServerEncrypted? lastAccessed? lastModified? leaseDuration? leaseState? leaseStatus? legalHold? metadata? objectReplicationPolicyId? objectReplicationRules? requestId? tagCount? version? versionId?

Properties

OptionalacceptRanges

acceptRanges?: string

Indicates that the service supports requests for partial blob content.

OptionalblobCommittedBlockCount

blobCommittedBlockCount?: number

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

OptionalblobContentMD5

blobContentMD5?: any

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

OptionalblobSequenceNumber

blobSequenceNumber?: number

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

OptionalblobType

blobType?: BlobType

The blob's type.

OptionalcacheControl

cacheControl?: string

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

OptionalclientRequestId

clientRequestId?: string

If a client request id header is sent in the request, this header will be present in the response with the same value.

OptionalcontentCrc64

contentCrc64?: any

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).

OptionalcontentDisposition

contentDisposition?: string

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.

OptionalcontentEncoding

contentEncoding?: string

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

OptionalcontentLanguage

contentLanguage?: string

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

OptionalcontentLength

contentLength?: number

The number of bytes present in the response body.

OptionalcontentMD5

contentMD5?: any

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.

OptionalcontentRange

contentRange?: string

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

OptionalcontentType

contentType?: string

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

OptionalcopyCompletedOn

copyCompletedOn?: any

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.

OptionalcopyId

copyId?: string

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.

OptionalcopyProgress

copyProgress?: 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

OptionalcopySource

copySource?: 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.

OptionalcopyStatus

copyStatus?: CopyStatusType

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

OptionalcopyStatusDescription

copyStatusDescription?: string

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

OptionalcreatedOn

createdOn?: any

Returns the date and time the blob was created.

Optionaldate

date?: any

UTC date/time value generated by the service that indicates the time at which the response was initiated

OptionalencryptionKeySha256

encryptionKeySha256?: string

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.

OptionalencryptionScope

encryptionScope?: 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.

OptionalerrorCode

errorCode?: string

Error Code

Optionaletag

etag?: 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.

OptionalimmutabilityPolicyExpiresOn

immutabilityPolicyExpiresOn?: any

UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.

OptionalimmutabilityPolicyMode

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

Indicates immutability policy mode.

OptionalisCurrentVersion

isCurrentVersion?: boolean

The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header.

OptionalisSealed

isSealed?: boolean

If this blob has been sealed

OptionalisServerEncrypted

isServerEncrypted?: 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).

OptionallastAccessed

lastAccessed?: any

UTC date/time value generated by the service that indicates the time at which the blob was last read or written to

OptionallastModified

lastModified?: any

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.

OptionalleaseDuration

leaseDuration?: LeaseDurationType

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

OptionalleaseState

leaseState?: LeaseStateType

Lease state of the blob.

OptionalleaseStatus

leaseStatus?: LeaseStatusType

The current lease status of the blob.

OptionallegalHold

legalHold?: boolean

Indicates if a legal hold is present on the blob.

Optionalmetadata

metadata?: {
    [propertyName: string]: string;
}

OptionalobjectReplicationPolicyId

objectReplicationPolicyId?: string

Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication.

OptionalobjectReplicationRules

objectReplicationRules?: {
    [propertyName: string]: 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).

OptionalrequestId

requestId?: string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

OptionaltagCount

tagCount?: number

The number of tags associated with the blob

Optionalversion

version?: string

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.

OptionalversionId

versionId?: 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.

Settings

Member Visibility