BlobDownloadResponseParsed interface

  • Ссылка
Пакет:
@azure/storage-blob

Содержит данные ответа для <xref:BlobClient.download> операции.

Extends

BlobDownloadHeaders & Object

Свойства

acceptRanges

Указывает, что служба поддерживает запросы для частичного содержимого большого двоичного объекта.
blobBody

BROWSER ONLY — текст ответа в виде большого двоичного объекта браузера. Всегда undefined в node.js.
blobCommittedBlockCount

Количество зафиксированных блоков, присутствующих в большом двоичном объекте. Этот заголовок возвращается только для добавочных BLOB-объектов.
blobContentMD5

Если большой двоичный объект имеет хэш MD5, а запрос содержит заголовок диапазона (Range или x-ms-range), этот заголовок ответа возвращается со значением MD5 всего большого двоичного объекта. Это значение может быть равно значению, возвращаемого в заголовке Content-MD5, при этом последнее вычисляется из запрошенного диапазона.
blobSequenceNumber

Текущий порядковый номер для страничного большого двоичного объекта. Этот заголовок не возвращается для блочных blob-объектов или добавочных BLOB-объектов
blobType

Тип большого двоичного объекта.
cacheControl

Заголовок возвращается в том случае, если он был ранее указан для большого двоичного объекта.
clientRequestId

Если в запросе отправляется заголовок идентификатора запроса клиента, этот заголовок будет присутствовать в ответе с тем же значением.
contentCrc64

Если запрос считывает указанный диапазон, а x-ms-range-get-content-crc64 имеет значение true, то запрос возвращает crc64 для диапазона, если размер диапазона меньше или равен 4 МБ. Если оба x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 указаны в одном запросе, произойдет сбой с ошибкой 400 (недопустимый запрос).
contentDisposition

Этот заголовок возвращает значение, указанное для заголовка "x-ms-blob-content-disposition". Поле ответа Content-Disposition содержит дополнительные сведения о том, как обрабатывать полезные данные ответа, а также может использоваться для вложения дополнительных метаданных. Например, если задано значение attachment, это означает, что агент пользователя не должен отображать ответ, а вместо этого отображает диалоговое окно Сохранить как с именем файла, отличного от имени большого двоичного объекта.
contentEncoding

Этот заголовок возвращает значение, указанное для заголовка запроса Content-Encoding.
contentLanguage

Этот заголовок возвращает значение, указанное для заголовка запроса Content-Language.
contentLength

Число байтов в тексте ответа.
contentMD5

Если большой двоичный объект имеет хэш MD5 и выполняется операция чтения полного большого двоичного объекта, этот заголовок ответа возвращается, чтобы клиент проверка для целостности содержимого сообщения.
contentRange

Указывает диапазон байтов, возвращаемых в случае, если клиент запросил подмножество большого двоичного объекта, задав заголовок запроса Range.
contentType

Тип носителя текста ответа. Для скачивания большого двоичного объекта это application/octet-stream.
copyCompletedOn

Время завершения последней попытки операции копирования BLOB-объекта, в которой этот blob-объект был целевым BLOB-объектом. Это значение может указывать время завершенной, отмененной или неуспешной попытки копирования. Этот заголовок не отображается, если копирование находится в ожидании, если этот BLOB-объект никогда не был назначением в операции копирования BLOB-объектов или если этот blob-объект был изменен после завершения операции копирования BLOB-объекта с помощью команды "Задать свойства BLOB-объекта", "Поместить BLOB-объект" или "Поместить список блоков".
copyId

Идентификатор строки для этой операции копирования. Используйте параметр Get Blob Properties для проверка состояние этой операции копирования или прервать копирование blob-объекта, чтобы прервать ожидающее копирование.
copyProgress

Содержит количество скопированных байтов и общее количество байтов в источнике в последней попытке операции копирования BLOB-объекта, где этот BLOB-объект был конечным BLOB-объектом. Может отображаться от 0 до байтов содержимого, скопированных. Этот заголовок не отображается, если этот BLOB-объект никогда не был назначением в операции копирования BLOB-объекта или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объекта с помощью команды Set Blob Properties, Put BLOB-объект или Put Block List
copySource

URL-адрес длиной до 2 КБ, указывающий исходный BLOB-объект или файл, использованный при последней попытке операции копирования BLOB-объекта, где этот BLOB-объект был целевым BLOB-объектом. Этот заголовок не отображается, если этот BLOB-объект никогда не был назначением в операции копирования BLOB-объектов или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объекта с помощью команды Set Blob Properties, Put BLOB-объекта или Put Block List.
copyStatus

Состояние операции копирования, определяемое x-ms-copy-id.
copyStatusDescription

Отображается только при сбое или ожидании x-ms-copy-status. Описывает причину последнего неустранимого или устранимого сбоя операции копирования. Этот заголовок не отображается, если этот BLOB-объект никогда не был назначением в операции копирования BLOB-объекта или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объекта с помощью команды Set Blob Properties, Put BLOB-объект или Put Block List
date

Значение даты и времени в формате UTC, созданное службой, которое указывает время, когда был инициирован ответ.
encryptionKeySha256

Хэш SHA-256 ключа шифрования, используемого для шифрования большого двоичного объекта. Этот заголовок возвращается только в том случае, если большой двоичный объект был зашифрован с помощью ключа, предоставленного клиентом.
encryptionScope

Возвращает имя область шифрования, используемого для шифрования содержимого BLOB-объекта и метаданных приложения. Обратите внимание, что отсутствие этого заголовка подразумевает использование область шифрования учетной записи по умолчанию.
errorCode

Код ошибки
etag

ETag содержит значение, которое позволяет выполнять операции условно. Если версия запроса 2011-08-18 или более поздняя, то значение ETag будет указано в кавычках.
immutabilityPolicyExpiresOn

Значение даты и времени в формате UTC, созданное службой, которое указывает время истечения срока действия политики неизменяемости BLOB-объектов.
immutabilityPolicyMode

Указывает режим политики неизменяемости.
isCurrentVersion

Значение этого заголовка указывает, является ли версия этого BLOB-объекта текущей версией. См. также заголовок x-ms-version-id.
isSealed

Если этот blob-объект запечатан
isServerEncrypted

Значение этого заголовка равно true, если данные большого двоичного объекта и метаданные приложения полностью зашифрованы с помощью указанного алгоритма. В противном случае устанавливается значение false (если большой двоичный объект незашифрован или если зашифрованы только части метаданных большого двоичного объекта или приложения).
lastAccessed

Значение даты и времени в формате UTC, созданное службой, указывающее время последнего чтения или записи большого двоичного объекта
lastModified

Возвращает дату и время последнего изменения контейнера. Любая операция, которая изменяет большой двоичный объект, включая обновление метаданных или свойств большого двоичного объекта, изменяет время последнего изменения большого двоичного объекта.
leaseDuration

Когда большой двоичный объект получил аренду, указывает, какой срок имеет аренда — конечный или бесконечный.
leaseState

Состояние аренды большого двоичного объекта.
leaseStatus

Текущее состояние аренды большого двоичного объекта.
legalHold

Указывает, присутствует ли удержание по юридическим причинам в большом двоичном объекте.
metadata
objectReplicationDestinationPolicyId

Идентификатор политики репликации объектов целевого BLOB-объекта.
objectReplicationPolicyId

Необязательный элемент. Допустимо только в том случае, если для контейнера хранилища и в целевом BLOB-объекте репликации включена репликация объектов.
objectReplicationRules

Необязательный элемент. Допустимо только в том случае, если для контейнера хранилища и в исходном BLOB-объекте репликации включена репликация объектов. При получении этого заголовка он возвращает заголовок с идентификатором политики и идентификатором правила (например, x-ms-or-policyid_ruleid), а значением будет состояние репликации (например, завершено, неудачно).
objectReplicationSourceProperties

Проанализированные идентификаторы политики репликации объектов, идентификаторы правил и состояние исходного BLOB-объекта.
readableStreamBody

NODEJS ONLY — текст ответа в виде node.js удобочитаемого потока. Всегда undefined в браузере.
requestId

Этот заголовок однозначно определяет выполненный запрос, его также можно использовать для устранения связанных с запросом неполадок.
tagCount

Количество тегов, связанных с большим двоичным объектом
version

Указывает версию службы BLOB-объектов, используемую для выполнения запроса. Этот заголовок возвращается для запросов, сделанных к версии 2009-09-19 и предшествующей.
versionId

Значение DateTime, возвращаемое службой, которое однозначно идентифицирует большой двоичный объект. Значение этого заголовка указывает версию большого двоичного объекта и может использоваться в последующих запросах для доступа к этой версии BLOB-объекта.

Сведения о свойстве

acceptRanges

Указывает, что служба поддерживает запросы для частичного содержимого большого двоичного объекта.

acceptRanges?: string

Значение свойства

string

blobBody

BROWSER ONLY — текст ответа в виде большого двоичного объекта браузера. Всегда undefined в node.js.

blobBody?: Promise<Blob>

Значение свойства

Promise<Blob>

blobCommittedBlockCount

Количество зафиксированных блоков, присутствующих в большом двоичном объекте. Этот заголовок возвращается только для добавочных BLOB-объектов.

blobCommittedBlockCount?: number

Значение свойства

number

blobContentMD5

Если большой двоичный объект имеет хэш MD5, а запрос содержит заголовок диапазона (Range или x-ms-range), этот заголовок ответа возвращается со значением MD5 всего большого двоичного объекта. Это значение может быть равно значению, возвращаемого в заголовке Content-MD5, при этом последнее вычисляется из запрошенного диапазона.

blobContentMD5?: Uint8Array

Значение свойства

Uint8Array

blobSequenceNumber

Текущий порядковый номер для страничного большого двоичного объекта. Этот заголовок не возвращается для блочных blob-объектов или добавочных BLOB-объектов

blobSequenceNumber?: number

Значение свойства

number

blobType

Тип большого двоичного объекта.

blobType?: BlobType

Значение свойства

BlobType

cacheControl

Заголовок возвращается в том случае, если он был ранее указан для большого двоичного объекта.

cacheControl?: string

Значение свойства

string

clientRequestId

Если в запросе отправляется заголовок идентификатора запроса клиента, этот заголовок будет присутствовать в ответе с тем же значением.

clientRequestId?: string

Значение свойства

string

contentCrc64

Если запрос считывает указанный диапазон, а x-ms-range-get-content-crc64 имеет значение true, то запрос возвращает crc64 для диапазона, если размер диапазона меньше или равен 4 МБ. Если оба 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, это означает, что агент пользователя не должен отображать ответ, а вместо этого отображает диалоговое окно Сохранить как с именем файла, отличного от имени большого двоичного объекта.

contentDisposition?: string

Значение свойства

string

contentEncoding

Этот заголовок возвращает значение, указанное для заголовка запроса Content-Encoding.

contentEncoding?: string

Значение свойства

string

contentLanguage

Этот заголовок возвращает значение, указанное для заголовка запроса Content-Language.

contentLanguage?: string

Значение свойства

string

contentLength

Число байтов в тексте ответа.

contentLength?: number

Значение свойства

number

contentMD5

Если большой двоичный объект имеет хэш MD5 и выполняется операция чтения полного большого двоичного объекта, этот заголовок ответа возвращается, чтобы клиент проверка для целостности содержимого сообщения.

contentMD5?: Uint8Array

Значение свойства

Uint8Array

contentRange

Указывает диапазон байтов, возвращаемых в случае, если клиент запросил подмножество большого двоичного объекта, задав заголовок запроса Range.

contentRange?: string

Значение свойства

string

contentType

Тип носителя текста ответа. Для скачивания большого двоичного объекта это application/octet-stream.

contentType?: string

Значение свойства

string

copyCompletedOn

Время завершения последней попытки операции копирования BLOB-объекта, в которой этот blob-объект был целевым BLOB-объектом. Это значение может указывать время завершенной, отмененной или неуспешной попытки копирования. Этот заголовок не отображается, если копирование находится в ожидании, если этот BLOB-объект никогда не был назначением в операции копирования BLOB-объектов или если этот blob-объект был изменен после завершения операции копирования BLOB-объекта с помощью команды "Задать свойства BLOB-объекта", "Поместить BLOB-объект" или "Поместить список блоков".

copyCompletedOn?: Date

Значение свойства

Date

copyId

Идентификатор строки для этой операции копирования. Используйте параметр Get Blob Properties для проверка состояние этой операции копирования или прервать копирование blob-объекта, чтобы прервать ожидающее копирование.

copyId?: string

Значение свойства

string

copyProgress

Содержит количество скопированных байтов и общее количество байтов в источнике в последней попытке операции копирования BLOB-объекта, где этот BLOB-объект был конечным BLOB-объектом. Может отображаться от 0 до байтов содержимого, скопированных. Этот заголовок не отображается, если этот BLOB-объект никогда не был назначением в операции копирования BLOB-объекта или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объекта с помощью команды Set Blob Properties, Put BLOB-объект или Put Block List

copyProgress?: string

Значение свойства

string

copySource

URL-адрес длиной до 2 КБ, указывающий исходный BLOB-объект или файл, использованный при последней попытке операции копирования BLOB-объекта, где этот BLOB-объект был целевым BLOB-объектом. Этот заголовок не отображается, если этот BLOB-объект никогда не был назначением в операции копирования BLOB-объектов или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объекта с помощью команды Set Blob Properties, Put BLOB-объекта или Put Block List.

copySource?: string

Значение свойства

string

copyStatus

Состояние операции копирования, определяемое x-ms-copy-id.

copyStatus?: CopyStatusType

Значение свойства

CopyStatusType

copyStatusDescription

Отображается только при сбое или ожидании x-ms-copy-status. Описывает причину последнего неустранимого или устранимого сбоя операции копирования. Этот заголовок не отображается, если этот BLOB-объект никогда не был назначением в операции копирования BLOB-объекта или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объекта с помощью команды Set Blob Properties, Put BLOB-объект или Put Block List

copyStatusDescription?: string

Значение свойства

string

date

Значение даты и времени в формате UTC, созданное службой, которое указывает время, когда был инициирован ответ.

date?: Date

Значение свойства

Date

encryptionKeySha256

Хэш SHA-256 ключа шифрования, используемого для шифрования большого двоичного объекта. Этот заголовок возвращается только в том случае, если большой двоичный объект был зашифрован с помощью ключа, предоставленного клиентом.

encryptionKeySha256?: string

Значение свойства

string

encryptionScope

Возвращает имя область шифрования, используемого для шифрования содержимого BLOB-объекта и метаданных приложения. Обратите внимание, что отсутствие этого заголовка подразумевает использование область шифрования учетной записи по умолчанию.

encryptionScope?: string

Значение свойства

string

errorCode

Код ошибки

errorCode?: string

Значение свойства

string

etag

ETag содержит значение, которое позволяет выполнять операции условно. Если версия запроса 2011-08-18 или более поздняя, то значение ETag будет указано в кавычках.

etag?: string

Значение свойства

string

immutabilityPolicyExpiresOn

Значение даты и времени в формате UTC, созданное службой, которое указывает время истечения срока действия политики неизменяемости BLOB-объектов.

immutabilityPolicyExpiresOn?: Date

Значение свойства

Date

immutabilityPolicyMode

Указывает режим политики неизменяемости.

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

Значение свойства

BlobImmutabilityPolicyMode

isCurrentVersion

Значение этого заголовка указывает, является ли версия этого BLOB-объекта текущей версией. См. также заголовок x-ms-version-id.

isCurrentVersion?: boolean

Значение свойства

boolean

isSealed

Если этот blob-объект запечатан

isSealed?: boolean

Значение свойства

boolean

isServerEncrypted

Значение этого заголовка равно true, если данные большого двоичного объекта и метаданные приложения полностью зашифрованы с помощью указанного алгоритма. В противном случае устанавливается значение false (если большой двоичный объект незашифрован или если зашифрованы только части метаданных большого двоичного объекта или приложения).

isServerEncrypted?: boolean

Значение свойства

boolean

lastAccessed

Значение даты и времени в формате UTC, созданное службой, указывающее время последнего чтения или записи большого двоичного объекта

lastAccessed?: Date

Значение свойства

Date

lastModified

Возвращает дату и время последнего изменения контейнера. Любая операция, которая изменяет большой двоичный объект, включая обновление метаданных или свойств большого двоичного объекта, изменяет время последнего изменения большого двоичного объекта.

lastModified?: Date

Значение свойства

Date

leaseDuration

Когда большой двоичный объект получил аренду, указывает, какой срок имеет аренда — конечный или бесконечный.

leaseDuration?: LeaseDurationType

Значение свойства

LeaseDurationType

leaseState

Состояние аренды большого двоичного объекта.

leaseState?: LeaseStateType

Значение свойства

LeaseStateType

leaseStatus

Текущее состояние аренды большого двоичного объекта.

leaseStatus?: LeaseStatusType

Значение свойства

LeaseStatusType

legalHold

Указывает, присутствует ли удержание по юридическим причинам в большом двоичном объекте.

legalHold?: boolean

Значение свойства

boolean

metadata 

metadata?: [key: string]: string

Значение свойства

[key: string]: string

objectReplicationDestinationPolicyId

Идентификатор политики репликации объектов целевого BLOB-объекта.

objectReplicationDestinationPolicyId?: string

Значение свойства

string

objectReplicationPolicyId

Необязательный элемент. Допустимо только в том случае, если для контейнера хранилища и в целевом BLOB-объекте репликации включена репликация объектов.

objectReplicationPolicyId?: string

Значение свойства

string

objectReplicationRules

Необязательный элемент. Допустимо только в том случае, если для контейнера хранилища и в исходном BLOB-объекте репликации включена репликация объектов. При получении этого заголовка он возвращает заголовок с идентификатором политики и идентификатором правила (например, x-ms-or-policyid_ruleid), а значением будет состояние репликации (например, завершено, неудачно).

objectReplicationRules?: [key: string]: string

Значение свойства

[key: string]: string

objectReplicationSourceProperties

Проанализированные идентификаторы политики репликации объектов, идентификаторы правил и состояние исходного BLOB-объекта.

objectReplicationSourceProperties?: ObjectReplicationPolicy[]

Значение свойства

ObjectReplicationPolicy[]

readableStreamBody

NODEJS ONLY — текст ответа в виде node.js удобочитаемого потока. Всегда undefined в браузере.

readableStreamBody?: ReadableStream

Значение свойства

ReadableStream

requestId

Этот заголовок однозначно определяет выполненный запрос, его также можно использовать для устранения связанных с запросом неполадок.

requestId?: string

Значение свойства

string

tagCount

Количество тегов, связанных с большим двоичным объектом

tagCount?: number

Значение свойства

number

version

Указывает версию службы BLOB-объектов, используемую для выполнения запроса. Этот заголовок возвращается для запросов, сделанных к версии 2009-09-19 и предшествующей.

version?: string

Значение свойства

string

versionId

Значение DateTime, возвращаемое службой, которое однозначно идентифицирует большой двоичный объект. Значение этого заголовка указывает версию большого двоичного объекта и может использоваться в последующих запросах для доступа к этой версии BLOB-объекта.

versionId?: string

Значение свойства

string