BlobQueryHeaders interface

套件:

@azure/storage-blob

定義Blob_query作業的標頭。

屬性

acceptRanges	表示服務支援部分 Blob 內容的要求。
blobCommittedBlockCount	Blob 中存在的已認可區塊數目。 此標頭只會針對附加 Blob 傳回。
blobContentMD5	如果 Blob 具有 MD5 哈希，而且要求包含 range 標頭 (Range 或 x-ms-range) ，則會傳回此回應標頭，其值為整個 Blob 的 MD5 值。 此值不一定等於 Content-MD5 標頭中傳回的值，後者是從要求的範圍計算而來
blobSequenceNumber	分頁 Blob 目前的序號。 區塊 Blob 或附加 Blob 不會傳回此標頭
blobType	Blob 的類型。
cacheControl	如果之前已指定 Blob，則會傳回此標頭。
clientRequestId	如果在要求中傳送用戶端要求標識符標頭，此標頭將會出現在具有相同值的回應中。
contentCrc64	如果要求是讀取指定的範圍，而且 x-ms-range-get-content-crc64 設定為 true，則只要範圍大小小於或等於 4 MB，要求就會傳回 crc64。 如果在相同的要求中指定 x-ms-range-get-content-crc64 & x-ms-range-get-content-md5，則會失敗並出現 400 (不正確的要求) 。
contentDisposition	此標頭會傳回為 'x-ms-blob-content-disposition' 標頭指定的值。 Content-Disposition 回應標頭欄位會傳達如何處理響應承載的其他資訊，也可用來附加其他元數據。 例如，如果設定為附件，表示使用者代理程式不應該顯示回應，而是顯示檔名以外的檔名的 [另存新檔] 對話方塊。
contentEncoding	此標頭會傳回為 Content-Encoding 要求標頭指定的值
contentLanguage	此標頭會傳回為 Content-Language 要求標頭指定的值。
contentLength	回應主體中現有的位元組數目。
contentMD5	如果 Blob 具有 MD5 哈希，而且此作業是讀取完整的 Blob，則會傳回此回應標頭，讓用戶端可以檢查訊息內容完整性。
contentRange	指出客戶端藉由設定 『Range』 要求標頭要求 Blob 子集時所傳回的位元組範圍。
contentType	回應主體的媒體類型。 針對下載 Blob，這是'application/octet-stream'
copyCompletionTime	上次嘗試複製 Blob 作業的結束時間，其中此 Blob 是目的地 Blob。 此值可指定完成、中止或複製嘗試失敗的時間。 如果複製擱置中、如果此 Blob 從未成為複製 Blob 作業中的目的地，或是此 Blob 在結束複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 修改此 Blob 作業，則不會出現此標頭。
copyId	此複製作業的字串識別碼。 搭配取得 Blob 屬性來檢查此複製作業的狀態，或傳遞至中止複製 Blob 以中止暫止的複本。
copyProgress	包含上次嘗試複製 Blob 作業中複製的位元組數目，以及此 Blob 為目的地 Blob 之上次嘗試複製 Blob 作業中的位元組總數。 可以顯示複製的介於 0 和 Content-Length 位元組之間。 如果此 Blob 從未成為複製 Blob 作業中的目的地，或是此 Blob 在結束複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 修改此 Blob 作業之後，就不會顯示此標頭
copySource	長度上限為 2 KB 的 URL，指定上次嘗試複製 Blob 作業所使用的來源 Blob 或檔案，其中此 Blob 是目的地 Blob。 如果此 Blob 從未是複製 Blob 作業中的目的地，或是此 Blob 在結束複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 修改此 Blob 作業之後，就不會顯示此標頭。
copyStatus	x-ms-copy-id 所識別的複製作業狀態。
copyStatusDescription	只有在 x-ms-copy-status 失敗或擱置時才會出現。 針對上次嚴重或不嚴重複製的作業，描述其失敗的原因。 如果此 Blob 從未成為複製 Blob 作業中的目的地，或是此 Blob 在結束複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 修改此 Blob 作業之後，就不會顯示此標頭
date	服務所產生的 UTC 日期/時間值，指出起始響應的時間
encryptionKeySha256	用來加密 Blob 之加密金鑰的 SHA-256 哈希。 只有當 Blob 使用客戶提供的金鑰加密時，才會傳回此標頭。
encryptionScope	傳回用來加密 Blob 內容和應用程式元數據的加密範圍名稱。 請注意，缺少此標頭表示使用預設帳戶加密範圍。
errorCode	錯誤碼
etag	ETag 包含的值可讓您依條件執行作業。 如果要求版本為 2011-08-18 或更新版本，ETag 值會加上引號。
isServerEncrypted	如果 Blob 資料和應用程式元資料使用指定的演算法完全加密，此標頭的值會設定為 true。 否則，當 Blob 未加密時，此值會設定為 false (，或者，如果只有 blob/應用程式元數據的部分會加密) 。
lastModified	傳回上次修改容器的日期和時間。 修改 Blob 的任何作業 (包括 Blob 更新的中繼資料或屬性)，都會變更 Blob 上次修改的時間。
leaseDuration	租用 Blob 時，指定租用期為無限或固定時間。
leaseState	Blob 的租用狀態。
leaseStatus	Blob 的目前租用狀態。
metadata
requestId	此標頭可唯一識別提出的要求，而且可用來進行要求的疑難排解。
version	指出用於執行要求的 Blob 服務版本。 對 2009-09-19 (含) 以上版本提出要求會傳回此標頭。

屬性詳細資料

acceptRanges

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

acceptRanges?: string

屬性值

string

blobCommittedBlockCount

Blob 中存在的已認可區塊數目。 此標頭只會針對附加 Blob 傳回。

blobCommittedBlockCount?: number

屬性值

number

blobContentMD5

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

blobContentMD5?: Uint8Array

屬性值

Uint8Array

blobSequenceNumber

分頁 Blob 目前的序號。 區塊 Blob 或附加 Blob 不會傳回此標頭

blobSequenceNumber?: number

屬性值

number

blobType

Blob 的類型。

blobType?: BlobType

屬性值

BlobType

cacheControl

如果之前已指定 Blob，則會傳回此標頭。

cacheControl?: string

屬性值

string

clientRequestId

如果在要求中傳送用戶端要求標識符標頭，此標頭將會出現在具有相同值的回應中。

clientRequestId?: string

屬性值

string

contentCrc64

如果要求是讀取指定的範圍，而且 x-ms-range-get-content-crc64 設定為 true，則只要範圍大小小於或等於 4 MB，要求就會傳回 crc64。 如果在相同的要求中指定 x-ms-range-get-content-crc64 & x-ms-range-get-content-md5，則會失敗並出現 400 (不正確的要求) 。

contentCrc64?: Uint8Array

屬性值

Uint8Array

contentDisposition

此標頭會傳回為 'x-ms-blob-content-disposition' 標頭指定的值。 Content-Disposition 回應標頭欄位會傳達如何處理響應承載的其他資訊，也可用來附加其他元數據。 例如，如果設定為附件，表示使用者代理程式不應該顯示回應，而是顯示檔名以外的檔名的 [另存新檔] 對話方塊。

contentDisposition?: string

屬性值

string

contentEncoding

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

contentEncoding?: string

屬性值

string

contentLanguage

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

contentLanguage?: string

屬性值

string

contentLength

回應主體中現有的位元組數目。

contentLength?: number

屬性值

number

contentMD5

如果 Blob 具有 MD5 哈希，而且此作業是讀取完整的 Blob，則會傳回此回應標頭，讓用戶端可以檢查訊息內容完整性。

contentMD5?: Uint8Array

屬性值

Uint8Array

contentRange

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

contentRange?: string

屬性值

string

contentType

回應主體的媒體類型。 針對下載 Blob，這是'application/octet-stream'

contentType?: string

屬性值

string

copyCompletionTime

上次嘗試複製 Blob 作業的結束時間，其中此 Blob 是目的地 Blob。 此值可指定完成、中止或複製嘗試失敗的時間。 如果複製擱置中、如果此 Blob 從未成為複製 Blob 作業中的目的地，或是此 Blob 在結束複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 修改此 Blob 作業，則不會出現此標頭。

copyCompletionTime?: Date

屬性值

Date

copyId

此複製作業的字串識別碼。 搭配取得 Blob 屬性來檢查此複製作業的狀態，或傳遞至中止複製 Blob 以中止暫止的複本。

copyId?: string

屬性值

string

copyProgress

包含上次嘗試複製 Blob 作業中複製的位元組數目，以及此 Blob 為目的地 Blob 之上次嘗試複製 Blob 作業中的位元組總數。 可以顯示複製的介於 0 和 Content-Length 位元組之間。 如果此 Blob 從未成為複製 Blob 作業中的目的地，或是此 Blob 在結束複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 修改此 Blob 作業之後，就不會顯示此標頭

copyProgress?: string

屬性值

string

copySource

長度上限為 2 KB 的 URL，指定上次嘗試複製 Blob 作業所使用的來源 Blob 或檔案，其中此 Blob 是目的地 Blob。 如果此 Blob 從未是複製 Blob 作業中的目的地，或是此 Blob 在結束複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 修改此 Blob 作業之後，就不會顯示此標頭。

copySource?: string

屬性值

string

copyStatus

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

copyStatus?: CopyStatusType

屬性值

CopyStatusType

copyStatusDescription

只有在 x-ms-copy-status 失敗或擱置時才會出現。 針對上次嚴重或不嚴重複製的作業，描述其失敗的原因。 如果此 Blob 從未成為複製 Blob 作業中的目的地，或是此 Blob 在結束複製 Blob 作業之後使用 [設定 Blob 屬性]、[放置 Blob] 或 [放置區塊清單] 修改此 Blob 作業之後，就不會顯示此標頭

copyStatusDescription?: string

屬性值

string

date

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

date?: Date

屬性值

Date

encryptionKeySha256

用來加密 Blob 之加密金鑰的 SHA-256 哈希。 只有當 Blob 使用客戶提供的金鑰加密時，才會傳回此標頭。

encryptionKeySha256?: string

屬性值

string

encryptionScope

傳回用來加密 Blob 內容和應用程式元數據的加密範圍名稱。 請注意，缺少此標頭表示使用預設帳戶加密範圍。

encryptionScope?: string

屬性值

string

errorCode

錯誤碼

errorCode?: string

屬性值

string

etag

ETag 包含的值可讓您依條件執行作業。 如果要求版本為 2011-08-18 或更新版本，ETag 值會加上引號。

etag?: string

屬性值

string

isServerEncrypted

如果 Blob 資料和應用程式元資料使用指定的演算法完全加密，此標頭的值會設定為 true。 否則，當 Blob 未加密時，此值會設定為 false (，或者，如果只有 blob/應用程式元數據的部分會加密) 。

isServerEncrypted?: boolean

屬性值

boolean

lastModified

傳回上次修改容器的日期和時間。 修改 Blob 的任何作業 (包括 Blob 更新的中繼資料或屬性)，都會變更 Blob 上次修改的時間。

lastModified?: Date

屬性值

Date

leaseDuration

租用 Blob 時，指定租用期為無限或固定時間。

leaseDuration?: LeaseDurationType

屬性值

LeaseDurationType

leaseState

Blob 的租用狀態。

leaseState?: LeaseStateType

屬性值

LeaseStateType

leaseStatus

Blob 的目前租用狀態。

leaseStatus?: LeaseStatusType

屬性值

LeaseStatusType

metadata

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

屬性值

{[propertyName: string]: string}

requestId

此標頭可唯一識別提出的要求，而且可用來進行要求的疑難排解。

requestId?: string

屬性值

string

version

指出用於執行要求的 Blob 服務版本。 對 2009-09-19 (含) 以上版本提出要求會傳回此標頭。

version?: string

屬性值

string