BlobDownloadHeaders interface

パッケージ:

@azure/storage-blob

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

プロパティ

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 (無効な要求) で失敗します。
contentDisposition	このヘッダーは、'x-ms-blob-content-disposition' ヘッダーに指定された値を返します。 Content-Disposition 応答ヘッダー フィールドは、応答ペイロードを処理する方法に関する追加情報を伝達し、追加のメタデータを添付するために使用することもできます。 たとえば、attachment に設定した場合、ユーザー エージェントは応答を表示せず、代わりに、指定された BLOB 名以外のファイル名を含む [名前を付けて保存] ダイアログを表示することを示します。
contentEncoding	このヘッダーは、Content-Encoding 要求ヘッダーに指定された値を返します
contentLanguage	このヘッダーは、Content-Language 要求ヘッダーに指定された値を返します。
contentLength	応答本文に含まれるバイト数。
contentMD5	BLOB に MD5 ハッシュがあり、この操作で完全な BLOB を読み取る場合、クライアントがメッセージ コンテンツの整合性をチェックできるように、この応答ヘッダーが返されます。
contentRange	クライアントが 'Range' 要求ヘッダーを設定して BLOB のサブセットを要求した場合に返されるバイト範囲を示します。
contentType	応答の本文のメディアの種類。 ダウンロード BLOB の場合、これは 'application/octet-stream' です
copyCompletedOn	この BLOB がコピー先 BLOB であった最後に試行された BLOB のコピー操作の終了時刻。 この値は、完了、中止、または失敗したコピー試行の時刻を示します。 このヘッダーは、コピーが保留中の場合、この BLOB が BLOB のコピー操作のコピー先になっていない場合、または BLOB のプロパティの設定、BLOB の配置、またはブロック リストの配置を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。
copyId	このコピー操作の文字列の識別子。 Get BLOB プロパティと共に を使用して、このコピー操作の状態をチェックするか、[Abort Copy BLOB]\(BLOB のコピーの中止\) に渡して保留中のコピーを中止します。
copyProgress	コピーされたバイト数と、この BLOB がコピー先 BLOB であった最後に試行された BLOB のコピー操作のソース内の合計バイト数が含まれます。 コピーされた 0 バイトと Content-Length バイトの間を表示できます。 このヘッダーは、この BLOB が BLOB のコピー操作のコピー先になっていない場合、または BLOB のプロパティの設定、BLOB の配置、またはブロック リストの配置を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。
copySource	この BLOB が宛先 BLOB であった最後に試行された BLOB のコピー操作で使用されたソース BLOB またはファイルを指定する最大 2 KB の長さの URL。 このヘッダーは、この BLOB が BLOB のコピー操作のコピー先になっていない場合や、BLOB のプロパティの設定、BLOB の配置、またはブロック リストの配置を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。
copyStatus	x-ms-copy-id によって識別されるコピー操作の状態。
copyStatusDescription	x-ms-copy-status が失敗または保留中の場合にのみ表示されます。 最後に発生した致命的な、または致命的ではないコピー操作のエラーの原因について説明します。 このヘッダーは、この BLOB が BLOB のコピー操作のコピー先になっていない場合、または BLOB のプロパティの設定、BLOB の配置、またはブロック リストの配置を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。
createdOn	BLOB が作成された日時を返します。
date	応答が開始された時刻を示すサービスによって生成された UTC 日付/時刻値
encryptionKeySha256	BLOB の暗号化に使用される暗号化キーの SHA-256 ハッシュ。 このヘッダーは、BLOB が顧客が指定したキーで暗号化された場合にのみ返されます。
encryptionScope	BLOB の内容とアプリケーション メタデータの暗号化に使用される暗号化スコープの名前を返します。 このヘッダーがない場合は、既定のアカウント暗号化スコープを使用することを意味します。
errorCode	エラー コード
etag	ETag には、条件に基づく操作の実行に使用できる値が含まれます。 要求バージョンが 2011-08-18 またはそれ以降である場合、ETag 値は引用符で囲まれます。
immutabilityPolicyExpiresOn	BLOB 不変ポリシーの有効期限が切れる時刻を示すサービスによって生成される UTC 日付/時刻値。
immutabilityPolicyMode	不変ポリシー モードを示します。
isCurrentVersion	このヘッダーの値は、この BLOB のバージョンが現在のバージョンであるかどうかを示します。「x-ms-version-id ヘッダー」も参照してください。
isSealed	この BLOB がシールされている場合
isServerEncrypted	指定したアルゴリズムを使用して BLOB データとアプリケーション メタデータが完全に暗号化されている場合、このヘッダーの値は true に設定されます。 それ以外の場合、値は false に設定されます (BLOB が暗号化されていない場合、または BLOB/アプリケーション メタデータの一部のみが暗号化されている場合)。
lastAccessed	BLOB が最後に読み取られたか書き込まれた時刻を示す、サービスによって生成された UTC 日付/時刻値
lastModified	コンテナーが最後に更新された日時を返します。 BLOB を変更する操作 (BLOB のメタデータまたはプロパティの更新など) を行うと、BLOB の最終更新時刻が変更されます。
leaseDuration	BLOB がリースされている場合に、リース期間が無限と固定のどちらであるかを指定します。
leaseState	BLOB のリースの状態。
leaseStatus	BLOB の現在のリース ステータス。
legalHold	BLOB に訴訟ホールドが存在するかどうかを示します。
metadata
objectReplicationPolicyId	省略可能。 オブジェクト レプリケーションがストレージ コンテナーとレプリケーションの宛先 BLOB で有効になっている場合にのみ有効です。
objectReplicationRules	省略可能。 オブジェクト レプリケーションがストレージ コンテナーとレプリケーションのソース BLOB で有効になっている場合にのみ有効です。 このヘッダーを取得すると、ポリシー ID とルール ID (例: x-ms-or-policyid_ruleid) を持つヘッダーが返され、値はレプリケーションの状態になります (完了、失敗など)。
requestId	このヘッダーは要求を一意に識別するので、要求のトラブルシューティングに使用できます。
tagCount	BLOB に関連付けられているタグの数
version	要求の実行に使用する BLOB サービスのバージョンを示します。 このヘッダーはバージョン 2009-09-19 以降で行った要求に対して返されます。
versionId	BLOB を一意に識別するサービスによって返される DateTime 値。 このヘッダーの値は BLOB のバージョンを示し、後続の要求でこのバージョンの BLOB にアクセスするために使用できます。

プロパティの詳細

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 (無効な要求) で失敗します。

contentCrc64?: Uint8Array

プロパティ値

Uint8Array

contentDisposition

このヘッダーは、'x-ms-blob-content-disposition' ヘッダーに指定された値を返します。 Content-Disposition 応答ヘッダー フィールドは、応答ペイロードを処理する方法に関する追加情報を伝達し、追加のメタデータを添付するために使用することもできます。 たとえば、attachment に設定した場合、ユーザー エージェントは応答を表示せず、代わりに、指定された 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

copyCompletedOn

この BLOB がコピー先 BLOB であった最後に試行された BLOB のコピー操作の終了時刻。 この値は、完了、中止、または失敗したコピー試行の時刻を示します。 このヘッダーは、コピーが保留中の場合、この BLOB が BLOB のコピー操作のコピー先になっていない場合、または BLOB のプロパティの設定、BLOB の配置、またはブロック リストの配置を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。

copyCompletedOn?: Date

プロパティ値

Date

copyId

このコピー操作の文字列の識別子。 Get BLOB プロパティと共に を使用して、このコピー操作の状態をチェックするか、[Abort Copy BLOB]\(BLOB のコピーの中止\) に渡して保留中のコピーを中止します。

copyId?: string

プロパティ値

string

copyProgress

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

copyProgress?: string

プロパティ値

string

copySource

この BLOB が宛先 BLOB であった最後に試行された BLOB のコピー操作で使用されたソース BLOB またはファイルを指定する最大 2 KB の長さの URL。 このヘッダーは、この 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 が変更された場合は表示されません。

copyStatusDescription?: string

プロパティ値

string

createdOn

BLOB が作成された日時を返します。

createdOn?: Date

プロパティ値

Date

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

immutabilityPolicyExpiresOn

BLOB 不変ポリシーの有効期限が切れる時刻を示すサービスによって生成される UTC 日付/時刻値。

immutabilityPolicyExpiresOn?: Date

プロパティ値

Date

immutabilityPolicyMode

不変ポリシー モードを示します。

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

プロパティ値

BlobImmutabilityPolicyMode

isCurrentVersion

このヘッダーの値は、この BLOB のバージョンが現在のバージョンであるかどうかを示します。「x-ms-version-id ヘッダー」も参照してください。

isCurrentVersion?: boolean

プロパティ値

boolean

isSealed

この BLOB がシールされている場合

isSealed?: boolean

プロパティ値

boolean

isServerEncrypted

指定したアルゴリズムを使用して BLOB データとアプリケーション メタデータが完全に暗号化されている場合、このヘッダーの値は true に設定されます。 それ以外の場合、値は false に設定されます (BLOB が暗号化されていない場合、または BLOB/アプリケーション メタデータの一部のみが暗号化されている場合)。

isServerEncrypted?: boolean

プロパティ値

boolean

lastAccessed

BLOB が最後に読み取られたか書き込まれた時刻を示す、サービスによって生成された UTC 日付/時刻値

lastAccessed?: Date

プロパティ値

Date

lastModified

コンテナーが最後に更新された日時を返します。 BLOB を変更する操作 (BLOB のメタデータまたはプロパティの更新など) を行うと、BLOB の最終更新時刻が変更されます。

lastModified?: Date

プロパティ値

Date

leaseDuration

BLOB がリースされている場合に、リース期間が無限と固定のどちらであるかを指定します。

leaseDuration?: LeaseDurationType

プロパティ値

LeaseDurationType

leaseState

BLOB のリースの状態。

leaseState?: LeaseStateType

プロパティ値

LeaseStateType

leaseStatus

BLOB の現在のリース ステータス。

leaseStatus?: LeaseStatusType

プロパティ値

LeaseStatusType

legalHold

BLOB に訴訟ホールドが存在するかどうかを示します。

legalHold?: boolean

プロパティ値

boolean

metadata

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

プロパティ値

{[propertyName: string]: string}

objectReplicationPolicyId

省略可能。 オブジェクト レプリケーションがストレージ コンテナーとレプリケーションの宛先 BLOB で有効になっている場合にのみ有効です。

objectReplicationPolicyId?: string

プロパティ値

string

objectReplicationRules

省略可能。 オブジェクト レプリケーションがストレージ コンテナーとレプリケーションのソース BLOB で有効になっている場合にのみ有効です。 このヘッダーを取得すると、ポリシー ID とルール ID (例: x-ms-or-policyid_ruleid) を持つヘッダーが返され、値はレプリケーションの状態になります (完了、失敗など)。

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

プロパティ値

{[propertyName: string]: string}

requestId

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

requestId?: string

プロパティ値

string

tagCount

BLOB に関連付けられているタグの数

tagCount?: number

プロパティ値

number

version

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

version?: string

プロパティ値

string

versionId

BLOB を一意に識別するサービスによって返される DateTime 値。 このヘッダーの値は BLOB のバージョンを示し、後続の要求でこのバージョンの BLOB にアクセスするために使用できます。

versionId?: string

プロパティ値

string