FileDownloadHeaders interface

套件:

@azure/storage-file-share

定義File_download作業的標頭。

屬性

acceptRanges	表示服務支援部分檔案內容的要求。
cacheControl	如果先前已為檔案指定，則傳回 。
contentDisposition	傳回為 『x-ms-content-disposition』 標頭指定的值，並指定如何處理回應。
contentEncoding	傳回為 Content-Encoding 要求標頭指定的值。
contentLanguage	傳回為 Content-Language 要求標頭指定的值。
contentLength	響應主體中存在的位元組數目。
contentMD5	如果檔案具有 MD5 哈希，而且要求是讀取完整檔案，則會傳回此回應標頭，讓用戶端可以檢查訊息內容完整性。 如果要求是讀取指定的範圍，且 'x-ms-range-get-content-md5' 設定為 true，則只要範圍大小小於或等於 4 MB，要求就會傳回該範圍的 MD5 哈希。 如果這兩組條件都不是 true，則 'Content-MD5' 標頭不會傳回任何值。
contentRange	指出客戶端藉由設定 Range 要求標頭來要求檔案子集時所傳回的位元組範圍。
contentType	為檔案指定的內容類型。 默認內容類型為 'application/octet-stream'
copyCompletedOn	上次嘗試複製檔案作業的結束時間，此檔案是目的地檔案。 這個值可以指定完成、中止或失敗複製嘗試的時間。
copyId	上次嘗試複製檔案作業的字元串標識符，其中此檔案是目的地檔案。
copyProgress	包含上次嘗試複製的複製檔案作業中複製的位元組數目，以及來源中的位元組總數，而此檔案是目的地檔案。 可以顯示複製的介於 0 和 Content-Length 位元組之間。
copySource	長度高達 2KB 的 URL，指定上次嘗試複製檔案作業中使用的來源檔案，而此檔案是目的地檔案。
copyStatus	'x-ms-copy-id' 所識別之複製作業的狀態。
copyStatusDescription	只有在 x-ms-copy-status 失敗或擱置時才會出現。 描述嚴重或非嚴重複製作業失敗的原因。
date	服務所產生的 UTC 日期/時間值，指出回應起始的時間。
errorCode	錯誤碼
etag	ETag 包含值，您可以用引號來有條件地執行作業。
fileAttributes	為檔案設定的屬性。
fileChangeOn	變更檔案的時間。
fileContentMD5	如果檔案具有 MD5 哈希，而且如果要求包含範圍標頭（Range 或 x-ms-range），則會傳回此回應標頭，且其值為整個檔案的 MD5 值。 這個值不一定等於 Content-MD5 標頭中傳回的值，後者是從要求的範圍計算而來。
fileCreatedOn	檔案的建立時間。
fileId	檔案的 fileId。
fileLastWriteOn	檔案的上次寫入時間。
fileParentId	檔案的父 fileId。
filePermissionKey	檔案之許可權集的索引鍵。
isServerEncrypted	如果檔案數據和應用程式元數據使用指定的演算法完全加密，則此標頭的值會設定為 true。 否則，此值會設定為 false （當檔案未加密時，或只有部分檔案/應用程式元數據已加密時）。
lastModified	傳回上次修改檔案的日期和時間。 修改檔案或其屬性的任何作業會更新上次修改的時間。
leaseDuration	當檔案租用時，指定租用是無限期還是固定持續時間。
leaseState	檔案的租用狀態。
leaseStatus	檔案目前的租用狀態。
metadata	與這個檔案相關聯的一組名稱/值組做為使用者定義元數據。
posixProperties	NFS 檔案的屬性。
requestId	此標頭可唯一識別已提出並可用於對要求進行疑難解答的要求。
version	指出用來執行要求的檔案服務版本。

屬性詳細資料

acceptRanges

表示服務支援部分檔案內容的要求。

acceptRanges?: string

屬性值

string

cacheControl

如果先前已為檔案指定，則傳回 。

cacheControl?: string

屬性值

string

contentDisposition

傳回為 『x-ms-content-disposition』 標頭指定的值，並指定如何處理回應。

contentDisposition?: string

屬性值

string

contentEncoding

傳回為 Content-Encoding 要求標頭指定的值。

contentEncoding?: string

屬性值

string

contentLanguage

傳回為 Content-Language 要求標頭指定的值。

contentLanguage?: string

屬性值

string

contentLength

響應主體中存在的位元組數目。

contentLength?: number

屬性值

number

contentMD5

如果檔案具有 MD5 哈希，而且要求是讀取完整檔案，則會傳回此回應標頭，讓用戶端可以檢查訊息內容完整性。 如果要求是讀取指定的範圍，且 'x-ms-range-get-content-md5' 設定為 true，則只要範圍大小小於或等於 4 MB，要求就會傳回該範圍的 MD5 哈希。 如果這兩組條件都不是 true，則 'Content-MD5' 標頭不會傳回任何值。

contentMD5?: Uint8Array

屬性值

Uint8Array

contentRange

指出客戶端藉由設定 Range 要求標頭來要求檔案子集時所傳回的位元組範圍。

contentRange?: string

屬性值

string

contentType

為檔案指定的內容類型。 默認內容類型為 'application/octet-stream'

contentType?: string

屬性值

string

copyCompletedOn

上次嘗試複製檔案作業的結束時間，此檔案是目的地檔案。 這個值可以指定完成、中止或失敗複製嘗試的時間。

copyCompletedOn?: Date

屬性值

Date

copyId

上次嘗試複製檔案作業的字元串標識符，其中此檔案是目的地檔案。

copyId?: string

屬性值

string

copyProgress

包含上次嘗試複製的複製檔案作業中複製的位元組數目，以及來源中的位元組總數，而此檔案是目的地檔案。 可以顯示複製的介於 0 和 Content-Length 位元組之間。

copyProgress?: string

屬性值

string

copySource

長度高達 2KB 的 URL，指定上次嘗試複製檔案作業中使用的來源檔案，而此檔案是目的地檔案。

copySource?: string

屬性值

string

copyStatus

'x-ms-copy-id' 所識別之複製作業的狀態。

copyStatus?: CopyStatusType

屬性值

CopyStatusType

copyStatusDescription

只有在 x-ms-copy-status 失敗或擱置時才會出現。 描述嚴重或非嚴重複製作業失敗的原因。

copyStatusDescription?: string

屬性值

string

date

服務所產生的 UTC 日期/時間值，指出回應起始的時間。

date?: Date

屬性值

Date

errorCode

錯誤碼

errorCode?: string

屬性值

string

etag

ETag 包含值，您可以用引號來有條件地執行作業。

etag?: string

屬性值

string

fileAttributes

為檔案設定的屬性。

fileAttributes?: string

屬性值

string

fileChangeOn

變更檔案的時間。

fileChangeOn?: Date

屬性值

Date

fileContentMD5

如果檔案具有 MD5 哈希，而且如果要求包含範圍標頭（Range 或 x-ms-range），則會傳回此回應標頭，且其值為整個檔案的 MD5 值。 這個值不一定等於 Content-MD5 標頭中傳回的值，後者是從要求的範圍計算而來。

fileContentMD5?: Uint8Array

屬性值

Uint8Array

fileCreatedOn

檔案的建立時間。

fileCreatedOn?: Date

屬性值

Date

fileId

檔案的 fileId。

fileId?: string

屬性值

string

fileLastWriteOn

檔案的上次寫入時間。

fileLastWriteOn?: Date

屬性值

Date

fileParentId

檔案的父 fileId。

fileParentId?: string

屬性值

string

filePermissionKey

檔案之許可權集的索引鍵。

filePermissionKey?: string

屬性值

string

isServerEncrypted

如果檔案數據和應用程式元數據使用指定的演算法完全加密，則此標頭的值會設定為 true。 否則，此值會設定為 false （當檔案未加密時，或只有部分檔案/應用程式元數據已加密時）。

isServerEncrypted?: boolean

屬性值

boolean

lastModified

傳回上次修改檔案的日期和時間。 修改檔案或其屬性的任何作業會更新上次修改的時間。

lastModified?: Date

屬性值

Date

leaseDuration

當檔案租用時，指定租用是無限期還是固定持續時間。

leaseDuration?: LeaseDurationType

屬性值

LeaseDurationType

leaseState

檔案的租用狀態。

leaseState?: LeaseStateType

屬性值

LeaseStateType

leaseStatus

檔案目前的租用狀態。

leaseStatus?: LeaseStatusType

屬性值

LeaseStatusType

metadata

與這個檔案相關聯的一組名稱/值組做為使用者定義元數據。

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

屬性值

{[propertyName: string]: string}

posixProperties

NFS 檔案的屬性。

posixProperties?: FilePosixProperties

屬性值

FilePosixProperties

requestId

此標頭可唯一識別已提出並可用於對要求進行疑難解答的要求。

requestId?: string

屬性值

string

version

指出用來執行要求的檔案服務版本。

version?: string

屬性值

string