BlobQueryHeaders interface

パッケージ:

@azure/storage-blob

Blob_query操作のヘッダーを定義します。

プロパティ

acceptRanges	サービスが BLOB コンテンツの一部に対する要求をサポートすることを示します。
blobCommittedBlockCount	BLOB に存在するコミット済みブロックの数。 このヘッダーは、追加 BLOB に対してのみ返されます。
blobContentMD5	BLOB に MD5 ハッシュがあり、要求に範囲ヘッダー (Range または x-ms-range) が含まれている場合、この応答ヘッダーは BLOB 全体の MD5 値の値で返されます。 この値は Content-MD5 ヘッダーで返される値と等しい場合と等しくない場合があり、後者は要求された範囲から計算されます
blobSequenceNumber	ページ BLOB の現在のシーケンス番号。 このヘッダーは、ブロック BLOB または追加 BLOB には返されません
blobType	BLOB の型。
cacheControl	このヘッダーは、BLOB に対して指定されていた場合に返されます。
clientRequestId	クライアント要求 ID ヘッダーが要求で送信された場合、このヘッダーは同じ値を持つ応答に存在します。
contentCrc64	要求が指定された範囲を読み取る場合、x-ms-range-get-content-crc64 が true に設定されている場合、範囲サイズが 4 MB 以下である限り、要求は範囲の crc64 を返します。 x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 の両方が同じ要求で指定されている場合、400(Bad Request) で失敗します。
contentDisposition	このヘッダーは、'x-ms-blob-content-disposition' ヘッダーに指定された値を返します。 Content-Disposition 応答ヘッダー フィールドは、応答ペイロードを処理する方法に関する追加情報を伝達します。また、追加のメタデータを添付するために使用することもできます。 たとえば、添付ファイルに設定すると、ユーザー エージェントは応答を表示せず、代わりに、指定された BLOB 名以外のファイル名を含む [名前を付けて保存] ダイアログを表示する必要があることを示します。
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 のコピー操作のコピー先になっていない場合、または SET BLOB Properties、Put Blob、または Put Block List を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。
copyId	このコピー操作の文字列の識別子。 Get Blob Properties と共に使用して、このコピー操作の状態をチェックするか、[Blob のコピーの中止] に渡して保留中のコピーを中止します。
copyProgress	コピーされたバイト数と、この BLOB がコピー先 BLOB であった最後に試行された BLOB のコピー操作のソース内の合計バイト数が含まれます。 コピーされた 0 バイトと Content-Length バイトの間を表示できます。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または BLOB のプロパティの設定、Put Blob、または Put Block List を使用した BLOB のコピー操作が終了した後にこの BLOB が変更された場合は表示されません。
copySource	URL の長さは最大 2 KB で、この BLOB がコピー先 BLOB であった最後に試行された BLOB のコピー操作で使用されたソース BLOB またはファイルを指定します。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または BLOB のプロパティの設定、Put Blob、または Put Block List を使用した BLOB のコピー操作が終了した後にこの BLOB が変更された場合は表示されません。
copyStatus	x-ms-copy-id で識別されるコピー操作の状態。
copyStatusDescription	x-ms-copy-status が失敗または保留中の場合にのみ表示されます。 最後に発生した致命的な、または致命的ではないコピー操作のエラーの原因について説明します。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または BLOB のプロパティの設定、Put Blob、または Put Block List を使用した BLOB のコピー操作が終了した後にこの BLOB が変更された場合は表示されません。
date	応答が開始された時刻を示すサービスによって生成される UTC 日付/時刻値
encryptionKeySha256	BLOB の暗号化に使用される暗号化キーの SHA-256 ハッシュ。 このヘッダーは、BLOB が顧客指定のキーで暗号化された場合にのみ返されます。
encryptionScope	BLOB の内容とアプリケーション メタデータの暗号化に使用される暗号化スコープの名前を返します。 このヘッダーが存在しないことは、既定のアカウント暗号化スコープの使用を意味します。
errorCode	エラー コード
etag	ETag には、条件に基づく操作の実行に使用できる値が含まれます。 要求バージョンが 2011-08-18 またはそれ以降である場合、ETag 値は引用符で囲まれます。
isServerEncrypted	指定したアルゴリズムを使用して BLOB データとアプリケーション メタデータが完全に暗号化されている場合、このヘッダーの値は true に設定されます。 それ以外の場合、値は false に設定されます (BLOB が暗号化されていない場合、または 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 または 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

クライアント要求 ID ヘッダーが要求で送信された場合、このヘッダーは同じ値を持つ応答に存在します。

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(Bad Request) で失敗します。

contentCrc64?: Uint8Array

プロパティ値

Uint8Array

contentDisposition

このヘッダーは、'x-ms-blob-content-disposition' ヘッダーに指定された値を返します。 Content-Disposition 応答ヘッダー フィールドは、応答ペイロードを処理する方法に関する追加情報を伝達します。また、追加のメタデータを添付するために使用することもできます。 たとえば、添付ファイルに設定すると、ユーザー エージェントは応答を表示せず、代わりに、指定された BLOB 名以外のファイル名を含む [名前を付けて保存] ダイアログを表示する必要があることを示します。

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 のコピー操作のコピー先になっていない場合、または SET BLOB Properties、Put Blob、または Put Block List を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。

copyCompletionTime?: Date

プロパティ値

Date

copyId

このコピー操作の文字列の識別子。 Get Blob Properties と共に使用して、このコピー操作の状態をチェックするか、[Blob のコピーの中止] に渡して保留中のコピーを中止します。

copyId?: string

プロパティ値

string

copyProgress

コピーされたバイト数と、この BLOB がコピー先 BLOB であった最後に試行された BLOB のコピー操作のソース内の合計バイト数が含まれます。 コピーされた 0 バイトと Content-Length バイトの間を表示できます。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または BLOB のプロパティの設定、Put Blob、または Put Block List を使用した BLOB のコピー操作が終了した後にこの BLOB が変更された場合は表示されません。

copyProgress?: string

プロパティ値

string

copySource

URL の長さは最大 2 KB で、この BLOB がコピー先 BLOB であった最後に試行された BLOB のコピー操作で使用されたソース BLOB またはファイルを指定します。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または BLOB のプロパティの設定、Put Blob、または Put Block List を使用した BLOB のコピー操作が終了した後にこの BLOB が変更された場合は表示されません。

copySource?: string

プロパティ値

string

copyStatus

x-ms-copy-id で識別されるコピー操作の状態。

copyStatus?: CopyStatusType

プロパティ値

CopyStatusType

copyStatusDescription

x-ms-copy-status が失敗または保留中の場合にのみ表示されます。 最後に発生した致命的な、または致命的ではないコピー操作のエラーの原因について説明します。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または BLOB のプロパティの設定、Put Blob、または Put Block List を使用した 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 に設定されます。 それ以外の場合、値は false に設定されます (BLOB が暗号化されていない場合、または 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?: [key: string]: string

プロパティ値

[key: string]: string

requestId

このヘッダーは要求を一意に識別するので、要求のトラブルシューティングに使用できます。

requestId?: string

プロパティ値

string

version

要求の実行に使用する BLOB サービスのバージョンを示します。 このヘッダーはバージョン 2009-09-19 以降で行った要求に対して返されます。

version?: string

プロパティ値

string