Package version:

Interface FileDownloadHeaders

Defines headers for File_download operation.

interface FileDownloadHeaders {
    acceptRanges?: string;
    cacheControl?: string;
    contentDisposition?: string;
    contentEncoding?: string;
    contentLanguage?: string;
    contentLength?: number;
    contentMD5?: Uint8Array;
    contentRange?: string;
    contentType?: string;
    copyCompletedOn?: Date;
    copyId?: string;
    copyProgress?: string;
    copySource?: string;
    copyStatus?: CopyStatusType;
    copyStatusDescription?: string;
    date?: Date;
    errorCode?: string;
    etag?: string;
    fileAttributes?: string;
    fileChangeOn?: Date;
    fileContentMD5?: Uint8Array;
    fileCreatedOn?: Date;
    fileId?: string;
    fileLastWriteOn?: Date;
    fileParentId?: string;
    filePermissionKey?: string;
    isServerEncrypted?: boolean;
    lastModified?: Date;
    leaseDuration?: LeaseDurationType;
    leaseState?: LeaseStateType;
    leaseStatus?: LeaseStatusType;
    metadata?: {
        [propertyName: string]: string;
    };
    posixProperties?: FilePosixProperties;
    requestId?: string;
    version?: string;
}

Properties

acceptRanges? cacheControl? contentDisposition? contentEncoding? contentLanguage? contentLength? contentMD5? contentRange? contentType? copyCompletedOn? copyId? copyProgress? copySource? copyStatus? copyStatusDescription? date? errorCode? etag? fileAttributes? fileChangeOn? fileContentMD5? fileCreatedOn? fileId? fileLastWriteOn? fileParentId? filePermissionKey? isServerEncrypted? lastModified? leaseDuration? leaseState? leaseStatus? metadata? posixProperties? requestId? version?

Properties

OptionalacceptRanges

acceptRanges?: string

Indicates that the service supports requests for partial file content.

OptionalcacheControl

cacheControl?: string

Returned if it was previously specified for the file.

OptionalcontentDisposition

contentDisposition?: string

Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response.

OptionalcontentEncoding

contentEncoding?: string

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

OptionalcontentLanguage

contentLanguage?: string

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

If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header.

OptionalcontentRange

contentRange?: string

Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header.

OptionalcontentType

contentType?: string

The content type specified for the file. The default content type is 'application/octet-stream'

OptionalcopyCompletedOn

copyCompletedOn?: Date

Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt.

OptionalcopyId

copyId?: string

String identifier for the last attempted Copy File operation where this file was the destination file.

OptionalcopyProgress

copyProgress?: string

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied.

OptionalcopySource

copySource?: string

URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file.

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 cause of fatal or non-fatal copy operation failure.

Optionaldate

date?: Date

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

OptionalerrorCode

errorCode?: string

Error Code

Optionaletag

etag?: string

The ETag contains a value that you can use to perform operations conditionally, in quotes.

OptionalfileAttributes

fileAttributes?: string

Attributes set for the file.

OptionalfileChangeOn

fileChangeOn?: Date

Change time for the file.

OptionalfileContentMD5

fileContentMD5?: Uint8Array

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.

OptionalfileCreatedOn

fileCreatedOn?: Date

Creation time for the file.

OptionalfileId

fileId?: string

The fileId of the file.

OptionalfileLastWriteOn

fileLastWriteOn?: Date

Last write time for the file.

OptionalfileParentId

fileParentId?: string

The parent fileId of the file.

OptionalfilePermissionKey

filePermissionKey?: string

Key of the permission set for the file.

OptionalisServerEncrypted

isServerEncrypted?: boolean

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

OptionallastModified

lastModified?: Date

Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time.

OptionalleaseDuration

leaseDuration?: LeaseDurationType

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

OptionalleaseState

leaseState?: LeaseStateType

Lease state of the file.

OptionalleaseStatus

leaseStatus?: LeaseStatusType

The current lease status of the file.

Optionalmetadata

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

A set of name-value pairs associated with this file as user-defined metadata.

OptionalposixProperties

posixProperties?: FilePosixProperties

Properties of NFS files.

OptionalrequestId

requestId?: string

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

Optionalversion

version?: string

Indicates the version of the File service used to execute the request.

Settings

Member Visibility