BlobDownloadResponseParsed interface

パッケージ:

@azure/storage-blob

ダウンロード 操作の応答データが含まれています。

Extends

BlobDownloadResponseModel

プロパティ

objectReplicationDestinationPolicyId	宛先 BLOB のオブジェクト レプリケーション ポリシー ID。
objectReplicationSourceProperties	解析されたオブジェクト レプリケーション ポリシー ID、ルール ID、およびソース BLOB の状態。

継承されたプロパティ

acceptRanges	サービスが部分的な BLOB コンテンツの要求をサポートすることを示します。
blobBody	ブラウザーのみ ブラウザー BLOB としての応答本文。 常に node.jsで undefined。
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 応答ヘッダー フィールドは、応答ペイロードを処理する方法に関する追加情報を伝達します。また、追加のメタデータを添付するために使用することもできます。 たとえば、添付ファイルに設定した場合、ユーザー エージェントは応答を表示せず、代わりに指定された 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 のコピー操作の宛先になっていない場合、または SET BLOB プロパティ、Put Blob、または Put Block List を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。
copyId	このコピー操作の文字列識別子。 [BLOB のプロパティの取得] でこのコピー操作の状態を確認するか、[Abort Copy BLOB]\(BLOB の中止\) に渡して保留中のコピーを中止します。
copyProgress	コピーされたバイト数と、この BLOB がコピー先 BLOB であった最後に試行された BLOB のコピー操作のソース内の合計バイト数が含まれます。 コピーされた 0 バイトと Content-Length バイトの間を表示できます。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または SET BLOB プロパティ、Put BLOB、または Put Block List を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。
copySource	この BLOB がコピー先 BLOB であった最後に試行された BLOB のコピー操作で使用されたソース BLOB またはファイルを指定する、最大 2 KB の長さの URL。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または SET BLOB プロパティ、Put BLOB、または Put Block List を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。
copyStatus	x-ms-copy-id で識別されるコピー操作の状態。
copyStatusDescription	x-ms-copy-status が失敗または保留中の場合にのみ表示されます。 最後の致命的または非致命的なコピー操作の失敗の原因について説明します。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または SET BLOB プロパティ、Put BLOB、または Put Block List を使用して終了した 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) を持つヘッダーが返され、値はレプリケーションの状態になります (完了、失敗など)。
readableStreamBody	NODEJS のみ node.js 読み取り可能ストリームとしての応答本文。 常にブラウザーで undefined します。
requestId	このヘッダーは、作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。
tagCount	BLOB に関連付けられているタグの数
version	要求の実行に使用される BLOB サービスのバージョンを示します。 このヘッダーは、バージョン 2009-09-19 以降に対して行われた要求に対して返されます。
versionId	BLOB を一意に識別するサービスによって返される DateTime 値。 このヘッダーの値は BLOB のバージョンを示し、このバージョンの BLOB にアクセスするために後続の要求で使用できます。

プロパティの詳細

objectReplicationDestinationPolicyId

宛先 BLOB のオブジェクト レプリケーション ポリシー ID。

objectReplicationDestinationPolicyId?: string

プロパティ値

string

objectReplicationSourceProperties

解析されたオブジェクト レプリケーション ポリシー ID、ルール ID、およびソース BLOB の状態。

objectReplicationSourceProperties?: ObjectReplicationPolicy[]

プロパティ値

ObjectReplicationPolicy[]

継承されたプロパティの詳細

acceptRanges

サービスが部分的な BLOB コンテンツの要求をサポートすることを示します。

acceptRanges?: string

プロパティ値

string

BlobDownloadResponseModel.acceptRanges から継承された

blobBody

ブラウザーのみ

ブラウザー BLOB としての応答本文。 常に node.jsで undefined。

blobBody?: Promise<Blob>

プロパティ値

Promise<Blob>

BlobDownloadResponseModel.blobBody から継承された

blobCommittedBlockCount

BLOB に存在するコミット済みブロックの数。 このヘッダーは、追加 BLOB に対してのみ返されます。

blobCommittedBlockCount?: number

プロパティ値

number

BlobDownloadResponseModel.blobCommittedBlockCount から継承された

blobContentMD5

BLOB に MD5 ハッシュがあり、要求に範囲ヘッダー (Range または x-ms-range) が含まれている場合、この応答ヘッダーは BLOB 全体の MD5 値の値と共に返されます。 この値は Content-MD5 ヘッダーで返される値と等しい場合と等しくない場合があり、後者は要求された範囲から計算されます

blobContentMD5?: Uint8Array

プロパティ値

Uint8Array

BlobDownloadResponseModel.blobContentMD5 から継承されます

blobSequenceNumber

ページ BLOB の現在のシーケンス番号。 ブロック BLOB または追加 BLOB の場合、このヘッダーは返されません

blobSequenceNumber?: number

プロパティ値

number

から継承 BlobDownloadResponseModel.blobSequenceNumber

blobType

BLOB の種類。

blobType?: BlobType

プロパティ値

BlobType

から継承 BlobDownloadResponseModel.blobType

cacheControl

このヘッダーは、BLOB に対して以前に指定された場合に返されます。

cacheControl?: string

プロパティ値

string

BlobDownloadResponseModel.cacheControl から継承された

clientRequestId

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

clientRequestId?: string

プロパティ値

string

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

contentCrc64?: Uint8Array

プロパティ値

Uint8Array

BlobDownloadResponseModel.contentCrc64 から継承された

contentDisposition

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

contentDisposition?: string

プロパティ値

string

BlobDownloadResponseModel.contentDisposition から継承された

contentEncoding

このヘッダーは、Content-Encoding 要求ヘッダーに指定された値を返します。

contentEncoding?: string

プロパティ値

string

BlobDownloadResponseModel.contentEncoding から継承された

contentLanguage

このヘッダーは、Content-Language 要求ヘッダーに指定された値を返します。

contentLanguage?: string

プロパティ値

string

BlobDownloadResponseModel.contentLanguage から継承された

contentLength

応答本文に存在するバイト数。

contentLength?: number

プロパティ値

number

BlobDownloadResponseModel.contentLength から継承された

contentMD5

BLOB に MD5 ハッシュがあり、この操作で完全な BLOB を読み取る場合は、クライアントがメッセージ コンテンツの整合性を確認できるように、この応答ヘッダーが返されます。

contentMD5?: Uint8Array

プロパティ値

Uint8Array

BlobDownloadResponseModel.contentMD5 から継承された

contentRange

クライアントが 'Range' 要求ヘッダーを設定して BLOB のサブセットを要求した場合に返されるバイト範囲を示します。

contentRange?: string

プロパティ値

string

BlobDownloadResponseModel.contentRange から継承された

contentType

応答の本文のメディアの種類。 ダウンロード BLOB の場合、これは 'application/octet-stream' です

contentType?: string

プロパティ値

string

BlobDownloadResponseModel.contentType から継承された

copyCompletedOn

この BLOB が宛先 BLOB であった、最後に試行された BLOB のコピー操作の終了時刻。 この値は、コピーの完了、中止、または失敗の時刻を指定できます。 このヘッダーは、コピーが保留中の場合、この BLOB が BLOB のコピー操作の宛先になっていない場合、または SET BLOB プロパティ、Put Blob、または Put Block List を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。

copyCompletedOn?: Date

プロパティ値

Date

BlobDownloadResponseModel.copyCompletedOn から継承された

copyId

このコピー操作の文字列識別子。 [BLOB のプロパティの取得] でこのコピー操作の状態を確認するか、[Abort Copy BLOB]\(BLOB の中止\) に渡して保留中のコピーを中止します。

copyId?: string

プロパティ値

string

blobDownloadResponseModel.copyId から継承

copyProgress

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

copyProgress?: string

プロパティ値

string

BlobDownloadResponseModel.copyProgress から継承された

copySource

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

copySource?: string

プロパティ値

string

BlobDownloadResponseModel.copySource から継承された

copyStatus

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

copyStatus?: CopyStatusType

プロパティ値

CopyStatusType

BlobDownloadResponseModel.copyStatus から継承された

copyStatusDescription

x-ms-copy-status が失敗または保留中の場合にのみ表示されます。 最後の致命的または非致命的なコピー操作の失敗の原因について説明します。 このヘッダーは、BLOB のコピー操作でこの BLOB がコピー先になっていない場合、または SET BLOB プロパティ、Put BLOB、または Put Block List を使用して終了した BLOB のコピー操作の後にこの BLOB が変更された場合は表示されません。

copyStatusDescription?: string

プロパティ値

string

BlobDownloadResponseModel.copyStatusDescription から継承されます

createdOn

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

createdOn?: Date

プロパティ値

Date

BlobDownloadResponseModel.createdOn から継承された

date

応答が開始された時刻を示すサービスによって生成された UTC 日付/時刻値

date?: Date

プロパティ値

Date

から継承 BlobDownloadResponseModel.date

encryptionKeySha256

BLOB の暗号化に使用される暗号化キーの SHA-256 ハッシュ。 このヘッダーは、BLOB が顧客指定のキーで暗号化された場合にのみ返されます。

encryptionKeySha256?: string

プロパティ値

string

BlobDownloadResponseModel.encryptionKeySha256 から継承された

encryptionScope

BLOB の内容とアプリケーション メタデータの暗号化に使用される暗号化スコープの名前を返します。 このヘッダーが存在しないことは、既定のアカウント暗号化スコープの使用を意味します。

encryptionScope?: string

プロパティ値

string

BlobDownloadResponseModel.encryptionScope から継承された

errorCode

エラー コード

errorCode?: string

プロパティ値

string

BlobDownloadResponseModel.errorCode から継承された

etag

ETag には、条件付きで操作を実行するために使用できる値が含まれています。 要求バージョンが 2011-08-18 以降の場合、ETag 値は引用符で囲まれます。

etag?: string

プロパティ値

string

から継承 BlobDownloadResponseModel.etag

immutabilityPolicyExpiresOn

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

immutabilityPolicyExpiresOn?: Date

プロパティ値

Date

BlobDownloadResponseModel.immutabilityPolicyExpiresOn から継承されます

immutabilityPolicyMode

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

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

プロパティ値

BlobImmutabilityPolicyMode

BlobDownloadResponseModel.immutabilityPolicyMode から継承された

isCurrentVersion

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

isCurrentVersion?: boolean

プロパティ値

boolean

BlobDownloadResponseModel.isCurrentVersion から継承された

isSealed

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

isSealed?: boolean

プロパティ値

boolean

BlobDownloadResponseModel.isSealed から継承された

isServerEncrypted

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

isServerEncrypted?: boolean

プロパティ値

boolean

から継承 BlobDownloadResponseModel.isServerEncrypted

lastAccessed

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

lastAccessed?: Date

プロパティ値

Date

BlobDownloadResponseModel.lastAccessed から継承された

lastModified

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

lastModified?: Date

プロパティ値

Date

BlobDownloadResponseModel.lastModified から継承された

leaseDuration

BLOB がリースされるときに、リースの期間が無限か固定かを指定します。

leaseDuration?: LeaseDurationType

プロパティ値

LeaseDurationType

から継承 BlobDownloadResponseModel.leaseDuration

leaseState

BLOB のリース状態。

leaseState?: LeaseStateType

プロパティ値

LeaseStateType

BlobDownloadResponseModel.leaseState から継承された

leaseStatus

BLOB の現在のリース状態。

leaseStatus?: LeaseStatusType

プロパティ値

LeaseStatusType

BlobDownloadResponseModel.leaseStatus から継承された

legalHold

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

legalHold?: boolean

プロパティ値

boolean

BlobDownloadResponseModel.legalHold から継承された

metadata

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

プロパティ値

{[propertyName: string]: string}

BlobDownloadResponseModel.metadata から継承された

objectReplicationPolicyId

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

objectReplicationPolicyId?: string

プロパティ値

string

BlobDownloadResponseModel.objectReplicationPolicyId から継承された

objectReplicationRules

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

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

プロパティ値

{[propertyName: string]: string}

BlobDownloadResponseModel.objectReplicationRules から継承された

readableStreamBody

NODEJS のみ

node.js 読み取り可能ストリームとしての応答本文。 常にブラウザーで undefined します。

readableStreamBody?: ReadableStream

プロパティ値

ReadableStream

BlobDownloadResponseModel.readableStreamBody から継承された

requestId

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

requestId?: string

プロパティ値

string

BlobDownloadResponseModel.requestId から継承された

tagCount

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

tagCount?: number

プロパティ値

number

BlobDownloadResponseModel.tagCount から継承された

version

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

version?: string

プロパティ値

string

BlobDownloadResponseModel.version から継承された

versionId

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

versionId?: string

プロパティ値

string

から継承 BlobDownloadResponseModel.versionId