BlobDownloadHeaders interface

Пакет:

@azure/storage-blob

Определяет заголовки для операции Blob_download.

Свойства

acceptRanges	Указывает, что служба поддерживает запросы на частичное содержимое BLOB-объектов.
blobCommittedBlockCount	Число зафиксированных блоков, присутствующих в большом двоичном объекте. Этот заголовок возвращается только для больших двоичных объектов добавления.
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. Поле заголовка ответа "Ликвидация содержимого" передает дополнительные сведения о том, как обрабатывать полезные данные ответа, а также использовать для присоединения дополнительных метаданных. Например, если задано значение вложения, он указывает, что пользователь-агент не должен отображать ответ, а вместо этого показывать диалоговое окно "Сохранить как" с именем файла, отличном от указанного имени БОЛЬШОго двоичного объекта.
contentEncoding	Этот заголовок возвращает значение, указанное для заголовка запроса Content-Encoding
contentLanguage	Этот заголовок возвращает значение, указанное для заголовка запроса Content-Language.
contentLength	Количество байтов, присутствующих в тексте ответа.
contentMD5	Если большой двоичный объект имеет хэш MD5, и эта операция требует чтения полного большого двоичного объекта, этот заголовок ответа возвращается, чтобы клиент смог проверить целостность содержимого сообщения.
contentRange	Указывает диапазон байтов, возвращаемых в случае, если клиент запрашивал подмножество большого двоичного объекта, задав заголовок запроса Range.
contentType	Тип носителя текста ответа. Для скачивания BLOB-объектов используется "application/octet-stream"
copyCompletedOn	Время завершения последней попытки операции копирования BLOB-объектов, в которой этот большой двоичный объект был целевым BLOB-объектом. Это значение может указать время завершения, прерывания или неудачной попытки копирования. Этот заголовок не отображается, если копия ожидается, если этот большой двоичный объект никогда не был назначением в операции копирования BLOB-объектов или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объектов с помощью задания свойств BLOB-объектов, put BLOB-объектов или put Block List.
copyId	Идентификатор строки для этой операции копирования. Используйте для получения свойств BLOB-объектов для проверки состояния этой операции копирования или передачи в abort Copy BLOB-объект для прерывания ожидающей копии.
copyProgress	Содержит количество скопированных байтов и общее количество байтов в источнике в последней попытке копировать BLOB-объект, где этот большой двоичный объект был целевым BLOB-объектом. Может отображаться от 0 до байтов содержимого, скопированных. Этот заголовок не отображается, если этот большой двоичный объект никогда не был назначением в операции копирования BLOB-объектов или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объектов с помощью набора свойств BLOB-объектов, put BLOB-объектов или Put Block List
copySource	URL-адрес длиной до 2 КБ, указывающий исходный большой двоичный объект или файл, используемый в последней попытке копировать BLOB-объект, где этот большой двоичный объект был целевым BLOB-объектом. Этот заголовок не отображается, если этот большой двоичный объект никогда не был назначением в операции копирования BLOB-объектов или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объектов с помощью задания свойств BLOB-объектов, put BLOB-объектов или Put Block List.
copyStatus	Состояние операции копирования, определяемой x-ms-copy-id.
copyStatusDescription	Отображается только при сбое или ожидании состояния x-ms-copy-copy. Описывает причину последнего неустранимого или неустранимого сбоя операции копирования. Этот заголовок не отображается, если этот большой двоичный объект никогда не был назначением в операции копирования BLOB-объектов или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объектов с помощью набора свойств BLOB-объектов, put BLOB-объектов или Put Block List
date	Значение даты и времени в формате UTC, созданное службой, указывающее время, в течение которого был инициирован ответ.
encryptionKeySha256	Хэш SHA-256 ключа шифрования, используемый для шифрования большого двоичного объекта. Этот заголовок возвращается только в том случае, если большой двоичный объект был зашифрован с помощью предоставленного клиентом ключа.
encryptionScope	Возвращает имя области шифрования, используемой для шифрования содержимого BLOB-объектов и метаданных приложения. Обратите внимание, что отсутствие этого заголовка подразумевает использование области шифрования учетной записи по умолчанию.
errorCode	Код ошибки
etag	ETag содержит значение, которое можно использовать для условного выполнения операций. Если версия запроса — 2011-08-18 или более позднюю, значение ETag будет находиться в кавычках.
immutabilityPolicyExpiresOn	Значение даты и времени в формате UTC, созданное службой, указывающее время истечения срока действия политики неизменяемости большого двоичного объекта.
immutabilityPolicyMode	Указывает режим политики неизменяемости.
isCurrentVersion	Значение этого заголовка указывает, является ли версия этого большого двоичного объекта текущей версией, см. также заголовок x-ms-version-id.
isSealed	Если этот большой двоичный объект был запечатан
isServerEncrypted	Значение этого заголовка имеет значение true, если данные и метаданные большого двоичного объекта полностью шифруются с помощью указанного алгоритма. В противном случае значение имеет значение false (если большой двоичный объект не зашифрован или если шифруются только части метаданных большого двоичного объекта или приложения).
lastAccessed	Значение даты и времени в формате UTC, созданное службой, указывающее время последнего чтения или записи большого двоичного объекта в
lastModified	Возвращает дату и время последнего изменения контейнера. Любая операция, которая изменяет большой двоичный объект, включая обновление метаданных или свойств большого двоичного объекта, изменяет время последнего изменения большого двоичного объекта.
leaseDuration	При аренде большого двоичного объекта указывает, является ли аренда бесконечной или фиксированной длительностью.
leaseState	Состояние аренды большого двоичного объекта.
leaseStatus	Текущее состояние аренды большого двоичного объекта.
legalHold	Указывает, присутствует ли юридическое удержание в большом двоичном объекте.
metadata
objectReplicationPolicyId	Необязательный. Допустимо только в том случае, если репликация объектов включена для контейнера хранилища и целевого большого двоичного объекта репликации.
objectReplicationRules	Необязательный. Допустимо только в том случае, если репликация объектов включена для контейнера хранилища и исходного большого двоичного объекта репликации. При извлечении этого заголовка он вернет заголовок с идентификатором политики и идентификатором правила (например, x-ms-or-policyid_ruleid), а значение будет состоянием репликации (например, завершение, сбой).
requestId	Этот заголовок однозначно идентифицирует выполненный запрос и может использоваться для устранения неполадок запроса.
tagCount	Количество тегов, связанных с большим двоичным объектом
version	Указывает версию службы BLOB-объектов, используемую для выполнения запроса. Этот заголовок возвращается для запросов к версии 2009-09-19 и выше.
versionId	Значение DateTime, возвращаемое службой, которая однозначно идентифицирует большой двоичный объект. Значение этого заголовка указывает версию большого двоичного объекта и может использоваться в последующих запросах для доступа к этой версии большого двоичного объекта.

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

acceptRanges

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

acceptRanges?: string

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

string

blobCommittedBlockCount

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

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. Поле заголовка ответа "Ликвидация содержимого" передает дополнительные сведения о том, как обрабатывать полезные данные ответа, а также использовать для присоединения дополнительных метаданных. Например, если задано значение вложения, он указывает, что пользователь-агент не должен отображать ответ, а вместо этого показывать диалоговое окно "Сохранить как" с именем файла, отличном от указанного имени БОЛЬШОго двоичного объекта.

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

Тип носителя текста ответа. Для скачивания BLOB-объектов используется "application/octet-stream"

contentType?: string

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

string

copyCompletedOn

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

copyCompletedOn?: Date

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

Date

copyId

Идентификатор строки для этой операции копирования. Используйте для получения свойств BLOB-объектов для проверки состояния этой операции копирования или передачи в abort Copy BLOB-объект для прерывания ожидающей копии.

copyId?: string

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

string

copyProgress

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

copyProgress?: string

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

string

copySource

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

copySource?: string

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

string

copyStatus

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

copyStatus?: CopyStatusType

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

CopyStatusType

copyStatusDescription

Отображается только при сбое или ожидании состояния x-ms-copy-copy. Описывает причину последнего неустранимого или неустранимого сбоя операции копирования. Этот заголовок не отображается, если этот большой двоичный объект никогда не был назначением в операции копирования BLOB-объектов или если этот большой двоичный объект был изменен после завершения операции копирования BLOB-объектов с помощью набора свойств BLOB-объектов, 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, созданное службой, указывающее время истечения срока действия политики неизменяемости большого двоичного объекта.

immutabilityPolicyExpiresOn?: Date

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

Date

immutabilityPolicyMode

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

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

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

BlobImmutabilityPolicyMode

isCurrentVersion

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

isCurrentVersion?: boolean

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

boolean

isSealed

Если этот большой двоичный объект был запечатан

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

objectReplicationPolicyId

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

objectReplicationPolicyId?: string

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

string

objectReplicationRules

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

objectReplicationRules?: [key: string]: string

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

[key: string]: string

requestId

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

requestId?: string

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

string

tagCount

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

tagCount?: number

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

number

version

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

version?: string

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

string

versionId

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

versionId?: string

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

string