BlockBlobClient class

Ссылка

Пакет:: @azure/storage-blob

BlockBlobClient определяет набор операций, применимых к блочному двоичному объекту.

Extends: BlobClient

Конструкторы

BlockBlobClient(string, PipelineLike)	Создает экземпляр BlockBlobClient. Этот метод принимает закодированный URL-адрес или некодированный URL-адрес, указывающий на блочный BLOB-объект. Закодированная строка URL-адреса не будет экранирована дважды, экранировать будут только специальные символы в URL-пути. Если имя большого двоичного объекта включает ? или %, имя BLOB-объекта должно быть закодировано в URL-адресе.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Создает экземпляр BlockBlobClient. Этот метод принимает закодированный URL-адрес или некодированный URL-адрес, указывающий на блочный BLOB-объект. Закодированная строка URL-адреса не будет экранирована дважды, экранировать будут только специальные символы в URL-пути. Если имя большого двоичного объекта включает ? или %, имя BLOB-объекта должно быть закодировано в URL-адресе.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Создает экземпляр BlockBlobClient.

Свойства

containerName	Имя контейнера хранилища, с которым связан большой двоичный объект.
name	Имя большого двоичного объекта.

Унаследованные свойства

accountName
credential	Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные `@azure/identity` данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект , реализующий интерфейс TokenCredential. Если значение не указано, используется AnonymousCredential.
url	Значение строки закодированного URL-адреса.

Методы

commitBlockList(string[], BlockBlobCommitBlockListOptions)	Записывает большой двоичный объект, указывая список идентификаторов составляющих его блокировок. Для записи в составе большого двоичного объекта блок должен быть успешно записан на сервер в предыдущей операции stageBlock . Вы можете вызвать commitBlockList для обновления большого двоичного объекта, отправив только те блоки, которые изменились, а затем зафиксировав новые и существующие блоки вместе. Все блоки, не указанные в списке блокировок и окончательно удаленные. См. раздел https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Возвращает список блоков, которые были отправлены в составе блочного BLOB-объекта с помощью указанного фильтра списка блокировок. См. раздел https://docs.microsoft.com/rest/api/storageservices/get-block-list
query(string, BlockBlobQueryOptions)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Быстрый запрос большого двоичного объекта в формате JSON или CSV. Пример использования (Node.js): // Query and convert a blob to a string const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString(); console.log("Query blob content:", downloaded); async function streamToBuffer(readableStream) { return new Promise((resolve, reject) => { const chunks = []; readableStream.on("data", (data) => { chunks.push(data instanceof Buffer ? data : Buffer.from(data)); }); readableStream.on("end", () => { resolve(Buffer.concat(chunks)); }); readableStream.on("error", reject); }); }
stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)	Отправляет указанный блок в "промежуточную область" блочного BLOB-объекта для последующего фиксации путем вызова commitBlockList. См. раздел https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	Операция Stage Block From URL создает новый блок, который будет зафиксирован как часть большого двоичного объекта, в котором содержимое считывается из URL-адреса. Этот API доступен начиная с версии 2018-03-28. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Создает блочный BLOB-объект, в котором содержимое большого двоичного объекта считывает по заданному URL-адресу. Этот API поддерживается начиная с версии 2020-04-08. Частичные обновления не поддерживаются при добавлении большого двоичного объекта из URL-адреса; содержимое существующего большого двоичного объекта перезаписывается содержимым нового большого двоичного объекта. Чтобы выполнить частичное обновление содержимого блочного BLOB-объекта с помощью исходного URL-адреса, используйте stageBlockFromURL и commitBlockList.
upload(HttpRequestBody, number, BlockBlobUploadOptions)	Создает новый блочный BLOB-объект или обновляет содержимое существующего блочного BLOB-объекта. Обновление существующего блочного большого двоичного объекта блокировки перезаписывает все существующие метаданные в большом двоичном объекте. Частичные обновления не поддерживаются; содержимое существующего большого двоичного объекта перезаписывается новым содержимым. Чтобы выполнить частичное обновление блочного BLOB-объекта, используйте stageBlock и commitBlockList. Это непараллеленный метод отправки. Для повышения производительности при отправке с параллелизмом используйте uploadFile, uploadStream или uploadBrowserData . См. раздел https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	ДОСТУПНО ТОЛЬКО В БРАУЗЕРАХ. Отправляет объект blob/File/ArrayBuffer/ArrayBufferView браузера в блочный BLOB-объект. Если длина буфера меньше или равна 256 МБ, этот метод будет использовать 1 вызов отправки для завершения отправки. В противном случае этот метод вызовет stageBlock для отправки блоков и, наконец, вызовет commitBlockList для фиксации списка блокировок. Стандартным параметром blobHTTPHeaders является `blobContentType`, что позволяет браузеру предоставлять функциональные возможности в зависимости от типа файла.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Отправляет объект Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView в BlockBlob. Если длина данных не превышает указанное значение maxSingleShotSize (по умолчанию — <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), этот метод будет использовать 1 вызов отправки для завершения отправки. В противном случае этот метод вызовет stageBlock для отправки блоков и, наконец, вызовет commitBlockList для фиксации списка блокировок. Стандартным параметром blobHTTPHeaders является `blobContentType`, что позволяет браузеру предоставлять функциональные возможности в зависимости от типа файла.
uploadFile(string, BlockBlobParallelUploadOptions)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет локальный файл блоками в блочный BLOB-объект. Если размер файла меньше или равен 256 МБ, этот метод будет использовать 1 вызов отправки для завершения отправки. В противном случае этот метод вызовет stageBlock для отправки блоков и, наконец, вызовет commitBlockList для фиксации списка блокировок.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет Node.js читаемый поток в блочный BLOB-объект. СОВЕТЫ ПО ПОВЫШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ. Входной поток highWaterMark лучше задать то же значение с параметром bufferSize, что позволит избежать операций Buffer.concat().
withSnapshot(string)	Создает объект BlockBlobClient, идентичный источнику, но с указанной меткой времени моментального снимка. При указании "" будет удален моментальный снимок и возвращен URL-адрес базового BLOB-объекта.

Наследуемые методы

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Прерывает ожидающие асинхронные операции копирования BLOB-объектов и оставляет целевой BLOB-объект нулевой длины и полные метаданные. Версия 12.02.2012 и более поздние. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Асинхронно копирует BLOB-объект в место назначения в учетной записи хранения. Этот метод возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока копирование не будет завершено. Вы также можете отменить копию до ее завершения, вызвав `cancelOperation` в опроснике. Обратите внимание, что обратный вызов onProgress не будет вызываться, если операция завершится в первом запросе, а попытка отменить завершенную копию приведет к возникновению ошибки. В версии 2012-02-12 и более поздних версиях источником операции копирования BLOB-объектов может быть зафиксированный BLOB-объект в любой учетной записи хранения Azure. Начиная с версии 2015-02-21 источником операции копирования BLOB-объектов может быть файл Azure в любой учетной записи хранения Azure. Только учетные записи хранилища, созданные 7 июня 2012 года или позже, позволяют использовать операцию Copy Blob для копирования из другой учетной записи хранилища. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Пример использования автоматического опроса: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` Пример использования опроса вручную: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` Пример использования обновлений хода выполнения: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); Пример изменения интервала опроса (по умолчанию 15 секунд): `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` Пример отмены копирования: `const copyPoller = await blobClient.beginCopyFromURL('url'); // cancel operation after starting it. try { await copyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError await copyPoller.getResult(); } catch (err) { if (err.name === 'PollerCancelledError') { console.log('The copy was cancelled.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	Создает доступный только для чтения моментальный снимок BLOB-объекта. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)	Помечает указанный большой двоичный объект или моментальный снимок для удаления. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)	Помечает указанный большой двоичный объект или моментальный снимок для удаления, если он существует. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Удалите политику immutablility в большом двоичном объекте.
download(number, number, BlobDownloadOptions)	Считывает или скачивает большой двоичный объект из системы, включая его метаданные и свойства. Для чтения моментального снимка можно также вызвать метод Get BLOB-объекта. В Node.js данные возвращаются в потоке readableStreamBody. В браузерах данные возвращаются в объекте promise blobBody См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Загружает весь большой двоичный объект, если они не указаны. Предупреждение. Буферы могут поддерживать только файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для больших двоичных объектов, превышающих этот размер, рассмотрите возможность downloadToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Загружает весь большой двоичный объект, если они не указаны. Предупреждение. Буферы могут поддерживать только файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для больших двоичных объектов, превышающих этот размер, рассмотрите возможность downloadToFile.
downloadToFile(string, number, number, BlobDownloadOptions)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Загружает BLOB-объект Azure в локальный файл. Сбой, если указанный путь к файлу уже завершается. Смещение и счетчик являются необязательными, передаются 0 и undefined соответственно, чтобы скачать весь большой двоичный объект.
exists(BlobExistsOptions)	Возвращает значение true, если ресурс BLOB-объектов Azure, представленный этим клиентом, существует; Значение false в противном случае. ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий BLOB-объект может быть удален другими клиентами или приложениями. Наоборот, новые большие двоичные объекты могут добавляться другими клиентами или приложениями после завершения этой функции.
generateSasUrl(BlobGenerateSasUrlOptions)	Доступно только для BlobClient, созданного с учетными данными общего ключа. Создает URI подписанного URL-адреса службы BLOB-объектов (SAS) на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAppendBlobClient()	Создает объект AppendBlobClient.
getBlobLeaseClient(string)	Получите BlobLeaseClient , который управляет арендой большого двоичного объекта.
getBlockBlobClient()	Создает объект BlockBlobClient.
getPageBlobClient()	Создает объект PageBlobClient.
getProperties(BlobGetPropertiesOptions)	Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства большого двоичного объекта. Операция не возвращает содержимое большого двоичного объекта. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties ПРЕДУПРЕЖДЕНИЕ. Ключи `metadata` , возвращаемые в ответе, будут содержаться в нижнем регистре, даже если они изначально содержали символы верхнего регистра. Это отличается от ключей метаданных, возвращаемых методами ContainerClient , которые перечисляют большие двоичные объекты с помощью `includeMetadata` параметра , который сохранит их исходный регистр.
getTags(BlobGetTagsOptions)	Возвращает теги, связанные с базовым BLOB-объектом.
setAccessTier(string, BlobSetTierOptions)	Задает уровень для большого двоичного объекта. Операция разрешена для страничного BLOB-объекта в учетной записи хранения класса Premium и блочного BLOB-объекта в учетной записи хранения BLOB-объектов (только локально избыточное хранилище). Уровень страничного BLOB-объекта уровня "Премиум" определяет допустимый размер, операции ввода-вывода в секунду и пропускную способность большого двоичного объекта. Уровень блочного BLOB-объекта определяет тип горячего, холодного или архивного хранилища. Эта операция не обновляет ETag большого двоичного объекта. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Задает системные свойства для большого двоичного объекта. Если значение не указано или не указано для указанных HTTP-заголовков BLOB-объектов, эти HTTP-заголовки больших двоичных объектов без значения будут удалены. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Задайте политику immutablility для большого двоичного объекта.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Установите удержание большого двоичного объекта по юридическим причинам.
setMetadata(Metadata, BlobSetMetadataOptions)	Задает определяемые пользователем метаданные для определенного большого двоичного объекта в виде одной или нескольких пар "имя — значение". Если параметр не указан или метаданные не определены в параметре, метаданные большого двоичного объекта будут удалены. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)	Задает теги для базового большого двоичного объекта. Большой двоичный объект может содержать до 10 тегов. Клавиши тегов должны содержать от 1 до 128 символов. Значения тегов должны быть от 0 до 256 символов. Допустимые символы ключа тега и значения включают строчные и прописные буквы, цифры (0–9), пробел (' '), плюс ('+'), минус ('-'), точка ('.'), косая черта ('/'), двоеточие (':'), равно ('=') и подчеркивание ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Синхронная операция копирования из URL-адреса копирует большой двоичный объект или интернет-ресурс в новый BLOB-объект. Он не вернет ответ до завершения копирования. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	Восстанавливает содержимое и метаданные обратимо удаленного BLOB-объекта и всех связанных обратимо удаленных моментальных снимков. Отмена удаления BLOB-объекта поддерживается только в версии 2017-07-29 или более поздней. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withVersion(string)	Создает новый объект BlobClient, указывающий на версию этого BLOB-объекта. При указании "" будет удален идентификатор versionId и возвращен клиент в базовый BLOB-объект.

Сведения о конструкторе

BlockBlobClient(string, PipelineLike)

Создает экземпляр BlockBlobClient. Этот метод принимает закодированный URL-адрес или некодированный URL-адрес, указывающий на блочный BLOB-объект. Закодированная строка URL-адреса не будет экранирована дважды, экранировать будут только специальные символы в URL-пути. Если имя большого двоичного объекта включает ? или %, имя BLOB-объекта должно быть закодировано в URL-адресе.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Параметры

url: string

Строка URL-адреса, указывающая на блочный BLOB-объект службы хранилища Azure, например "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Вы можете добавить SAS с помощью AnonymousCredential, например "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString"". Этот метод принимает закодированный URL-адрес или некодированный URL-адрес, указывающий на большой двоичный объект. Закодированная строка URL-адреса не будет экранирована дважды, экранировать будут только специальные символы в URL-пути. Однако, если имя большого двоичного объекта содержит ? или %, имя BLOB-объекта должно быть закодировано в URL-адресе. Например, большой двоичный объект с именем my?blob%, URL-адрес должен иметь значение "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline: PipelineLike

Вызовите newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.

BlockBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

new BlockBlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Параметры

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.

options: StoragePipelineOptions

Необязательный элемент. Параметры для настройки конвейера HTTP.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Создает экземпляр BlockBlobClient.

new BlockBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

Параметры

connectionString: string

Строка подключения учетной записи или строка подключения SAS учетной записи хранения Azure. [ Примечание. Строка подключения учетной записи может использоваться только в NODE.JS среде выполнения. ] Пример строки подключения учетной записи —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Пример строки подключения SAS: BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName: string

Имя контейнера.

blobName: string

Имя BLOB-объекта.

options: StoragePipelineOptions

Необязательный элемент. Параметры для настройки конвейера HTTP.

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

containerName

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

string containerName

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

string

name

Имя большого двоичного объекта.

string name

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

string

Сведения об унаследованном свойстве

accountName

accountName: string

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

string

Наследуется отblobClient.accountName

credential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект , реализующий интерфейс TokenCredential. Если значение не указано, используется AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Наследуется отblobClient.credential

url

Значение строки закодированного URL-адреса.

url: string

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

string

Наследуется отblobClient.url

Сведения о методе

commitBlockList(string[], BlockBlobCommitBlockListOptions)

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

См. раздел https://docs.microsoft.com/rest/api/storageservices/put-block-list

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

Параметры

blocks: string[]

Массив 64-байтового значения в кодировке base64

options: BlockBlobCommitBlockListOptions

Параметры операции "Зафиксировать список блокировок BLOB-объектов".

Возвращаемое значение

Promise<BlockBlobCommitBlockListResponse>

Данные ответа для операции "Зафиксировать список блокировок блочных BLOB-объектов".

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

См. раздел https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

Параметры

listType: BlockListType

Указывает, следует вернуть список зафиксированных блокировок, список незафиксированных блокировок или оба списка одновременно.

options: BlockBlobGetBlockListOptions

Параметры операции получения блочного BLOB-объекта.

Возвращаемое значение

Promise<BlockBlobGetBlockListResponse>

Данные ответа для операции получения списка блок-объектов.

query(string, BlockBlobQueryOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Быстрый запрос большого двоичного объекта в формате JSON или CSV.

Пример использования (Node.js):

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>

Параметры

query: string

options: BlockBlobQueryOptions

Возвращаемое значение

Promise<BlobDownloadResponseModel>

stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

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

См. раздел https://docs.microsoft.com/rest/api/storageservices/put-block

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

Параметры

blockId: string

64-байтовое значение в кодировке base64.

body: HttpRequestBody

Данные для отправки в промежуточную область.

contentLength: number

Количество байтов для отправки.

options: BlockBlobStageBlockOptions

Параметры операции блокировки этапа блочного BLOB-объекта.

Возвращаемое значение

Promise<BlockBlobStageBlockResponse>

Данные ответа для операции блока этапа блочного BLOB-объекта.

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Операция Stage Block From URL создает новый блок, который будет зафиксирован как часть большого двоичного объекта, в котором содержимое считывается из URL-адреса. Этот API доступен начиная с версии 2018-03-28.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

Параметры

blockId: string

64-байтовое значение в кодировке base64.

sourceURL: string

Указывает URL-адрес большого двоичного объекта. Значением может быть URL-адрес длиной до 2 КБ, указывающий большой двоичный объект. Значение должно быть закодировано в URL-адресе в том виде, в каком оно указано в запросе URI. Исходный BLOB-объект должен быть общедоступным или пройти проверку подлинности с помощью подписанного URL-адреса. Если исходный BLOB-объект является общедоступным, для выполнения операции проверка подлинности не требуется. Ниже приведены некоторые примеры URL-адресов исходного объекта: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

offset: number

Расположение большого двоичного объекта для скачивания, больше или равное 0

count: number

Объем загружаемых данных, превышающий 0. Скачивание до конца, если значение не определено

options: BlockBlobStageBlockFromURLOptions

Параметры операции "Блок из URL-адреса этапа блочного BLOB-объекта".

Возвращаемое значение

Promise<BlockBlobStageBlockFromURLResponse>

Данные ответа для операции "Блок из URL-адреса этапа блочного BLOB-объекта".

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Создает блочный BLOB-объект, в котором содержимое большого двоичного объекта считывает по заданному URL-адресу. Этот API поддерживается начиная с версии 2020-04-08. Частичные обновления не поддерживаются при добавлении большого двоичного объекта из URL-адреса; содержимое существующего большого двоичного объекта перезаписывается содержимым нового большого двоичного объекта. Чтобы выполнить частичное обновление содержимого блочного BLOB-объекта с помощью исходного URL-адреса, используйте stageBlockFromURL и commitBlockList.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

Параметры

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Дополнительные параметры.

Возвращаемое значение

Promise<BlockBlobPutBlobFromUrlResponse>

upload(HttpRequestBody, number, BlockBlobUploadOptions)

Создает новый блочный BLOB-объект или обновляет содержимое существующего блочного BLOB-объекта. Обновление существующего блочного большого двоичного объекта блокировки перезаписывает все существующие метаданные в большом двоичном объекте. Частичные обновления не поддерживаются; содержимое существующего большого двоичного объекта перезаписывается новым содержимым. Чтобы выполнить частичное обновление блочного BLOB-объекта, используйте stageBlock и commitBlockList.

Это непараллеленный метод отправки. Для повышения производительности при отправке с параллелизмом используйте uploadFile, uploadStream или uploadBrowserData .

См. раздел https://docs.microsoft.com/rest/api/storageservices/put-blob

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

Параметры

body: HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView или функция, которая возвращает новый доступный для чтения поток, смещение которого от начала источника данных.

contentLength: number

Длина основного текста в байтах. Используйте Buffer.byteLength(), чтобы вычислить длину текста для строки, включающей символы, отличные от Base64/Hex.

options: BlockBlobUploadOptions

Параметры операции отправки блочного BLOB-объекта.

Возвращаемое значение

Promise<BlockBlobUploadResponse>

Данные ответа для операции отправки блочного BLOB-объекта.

Пример использования:

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Предупреждение

Теперь этот API является нерекомендуемым.

Use uploadData instead.

ДОСТУПНО ТОЛЬКО В БРАУЗЕРАХ.

Отправляет объект blob/File/ArrayBuffer/ArrayBufferView браузера в блочный BLOB-объект.

Если длина буфера меньше или равна 256 МБ, этот метод будет использовать 1 вызов отправки для завершения отправки. В противном случае этот метод вызовет stageBlock для отправки блоков и, наконец, вызовет commitBlockList для фиксации списка блокировок.

Стандартным параметром blobHTTPHeaders является blobContentType, что позволяет браузеру предоставлять функциональные возможности в зависимости от типа файла.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Параметры

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer или ArrayBufferView

options: BlockBlobParallelUploadOptions

Параметры для отправки данных браузера.

Возвращаемое значение

Promise<BlobUploadCommonResponse>

Данные ответа для операции отправки BLOB-объекта.

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Отправляет объект Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView в BlockBlob.

Если длина данных не превышает указанное значение maxSingleShotSize (по умолчанию — <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), этот метод будет использовать 1 вызов отправки для завершения отправки. В противном случае этот метод вызовет stageBlock для отправки блоков и, наконец, вызовет commitBlockList для фиксации списка блокировок.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Параметры

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node.js), BLOB-объект, ArrayBuffer или ArrayBufferView

options: BlockBlobParallelUploadOptions

Возвращаемое значение

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Отправляет локальный файл блоками в блочный BLOB-объект.

Если размер файла меньше или равен 256 МБ, этот метод будет использовать 1 вызов отправки для завершения отправки. В противном случае этот метод вызовет stageBlock для отправки блоков и, наконец, вызовет commitBlockList для фиксации списка блокировок.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Параметры

filePath: string

Полный путь к локальному файлу

options: BlockBlobParallelUploadOptions

Параметры для операции отправки в блочный BLOB-объект.

Возвращаемое значение

Promise<BlobUploadCommonResponse>

Данные ответа для операции отправки BLOB-объектов.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

Отправляет Node.js читаемый поток в блочный BLOB-объект.

СОВЕТЫ ПО ПОВЫШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ.

Входной поток highWaterMark лучше задать то же значение с параметром bufferSize, что позволит избежать операций Buffer.concat().

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

Параметры

stream: Readable

Node.js читаемый поток

bufferSize: number

Размер каждого выделенного буфера, а также размер блока в отправленном блочном BLOB-объекте. Значение по умолчанию — 8 МБ.

maxConcurrency: number

Максимальный параллелизм указывает максимальное число буферов, которые можно выделить, положительная корреляция с максимальным параллелизмом отправки. Значение по умолчанию — 5.

options: BlockBlobUploadStreamOptions

Параметры отправки потока в блочный BLOB-объект.

Возвращаемое значение

Promise<BlobUploadCommonResponse>

Данные ответа для операции отправки BLOB-объектов.

withSnapshot(string)

Создает объект BlockBlobClient, идентичный источнику, но с указанной меткой времени моментального снимка. При указании "" будет удален моментальный снимок и возвращен URL-адрес базового BLOB-объекта.

function withSnapshot(snapshot: string): BlockBlobClient

Параметры

snapshot: string

Метка времени моментального снимка.

Возвращаемое значение

BlockBlobClient

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

Сведения о наследуемом методе

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Прерывает ожидающие асинхронные операции копирования BLOB-объектов и оставляет целевой BLOB-объект нулевой длины и полные метаданные. Версия 12.02.2012 и более поздние.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Параметры

copyId: string

Идентификатор операции копирования с URL-адреса.

options: BlobAbortCopyFromURLOptions

Необязательные параметры для операции прерывания копирования BLOB-объекта с URL-адреса.

Возвращаемое значение

Promise<BlobAbortCopyFromURLResponse>

Наследуется отblobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

В версии 2012-02-12 и более поздних версиях источником операции копирования BLOB-объектов может быть зафиксированный BLOB-объект в любой учетной записи хранения Azure. Начиная с версии 2015-02-21 источником операции копирования BLOB-объектов может быть файл Azure в любой учетной записи хранения Azure. Только учетные записи хранилища, созданные 7 июня 2012 года или позже, позволяют использовать операцию Copy Blob для копирования из другой учетной записи хранилища.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Пример использования автоматического опроса:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Пример использования опроса вручную:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Пример использования обновлений хода выполнения:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Пример изменения интервала опроса (по умолчанию 15 секунд):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Пример отмены копирования:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Параметры

copySource: string

URL-адрес исходного blob-объекта Или файла Azure.

options: BlobBeginCopyFromURLOptions

Необязательные параметры для операции Запуска копирования с URL-адреса большого двоичного объекта.

Возвращаемое значение

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Наследуется отblobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

Создает доступный только для чтения моментальный снимок BLOB-объекта.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Параметры

options: BlobCreateSnapshotOptions

Необязательные параметры операции создания моментального снимка BLOB-объекта.

Возвращаемое значение

Promise<BlobCreateSnapshotResponse>

Наследуется отblobClient.createSnapshot

delete(BlobDeleteOptions)

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

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Параметры

options: BlobDeleteOptions

Необязательные параметры операции удаления BLOB-объектов.

Возвращаемое значение

Promise<BlobDeleteResponse>

Наследуется отblobClient.delete

deleteIfExists(BlobDeleteOptions)

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

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Параметры

options: BlobDeleteOptions

Необязательные параметры операции удаления BLOB-объектов.

Возвращаемое значение

Promise<BlobDeleteIfExistsResponse>

Наследуется отblobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Удалите политику immutablility в большом двоичном объекте.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

Параметры

options: BlobDeleteImmutabilityPolicyOptions

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

Возвращаемое значение

Promise<BlobDeleteImmutabilityPolicyResponse>

Наследуется отblobClient.deleteImmutabilityPolicy

download(number, number, BlobDownloadOptions)

Считывает или скачивает большой двоичный объект из системы, включая его метаданные и свойства. Для чтения моментального снимка можно также вызвать метод Get BLOB-объекта.

В Node.js данные возвращаются в потоке readableStreamBody.
В браузерах данные возвращаются в объекте promise blobBody

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Параметры

offset: number

Расположение большого двоичного объекта для скачивания, больше или равное 0

count: number

Объем загружаемых данных, превышающий 0. Скачивание до конца при неопределенном

options: BlobDownloadOptions

Необязательные параметры для операции скачивания BLOB-объектов.

Пример использования (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

Пример использования (браузер):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Возвращаемое значение

Promise<BlobDownloadResponseParsed>

Наследуется отBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

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

Предупреждение. Буферы могут поддерживать только файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для больших двоичных объектов, превышающих этот размер, рассмотрите возможность downloadToFile.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Параметры

buffer: Buffer

Буфер для заполнения должен иметь длину больше счетчика

offset: number

Расположение блочного BLOB-объекта для скачивания (в байтах)

count: number

Сколько данных (в байтах) требуется скачать. Скачивание до конца при передаче неопределенного

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Возвращаемое значение

Promise<Buffer>

Наследуется отblobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Параметры

offset: number

Расположение блочного BLOB-объекта для скачивания (в байтах)

count: number

Сколько данных (в байтах) требуется скачать. Скачивание до конца при передаче неопределенного

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Возвращаемое значение

Promise<Buffer>

Наследуется отblobClient.downloadToBuffer

downloadToFile(string, number, number, BlobDownloadOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.

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

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Параметры

filePath: string

offset: number

Расположение блочного BLOB-объекта для скачивания.

count: number

Сколько данных нужно скачать. Скачивание до конца при передаче неопределенного значения.

options: BlobDownloadOptions

Параметры для параметров скачивания BLOB-объектов.

Возвращаемое значение

Promise<BlobDownloadResponseParsed>

Данные ответа для операции скачивания BLOB-объектов, но с параметром readableStreamBody задано значение undefined, так как его содержимое уже считывается и записывается в локальный файл по указанному пути.

Наследуется отBlobClient.downloadToFile

exists(BlobExistsOptions)

Возвращает значение true, если ресурс BLOB-объектов Azure, представленный этим клиентом, существует; Значение false в противном случае.

ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий BLOB-объект может быть удален другими клиентами или приложениями. Наоборот, новые большие двоичные объекты могут добавляться другими клиентами или приложениями после завершения этой функции.

function exists(options?: BlobExistsOptions): Promise<boolean>

Параметры

options: BlobExistsOptions

параметры операции Существует.

Возвращаемое значение

Promise<boolean>

Наследуется отblobClient.exists

generateSasUrl(BlobGenerateSasUrlOptions)

Доступно только для BlobClient, созданного с учетными данными общего ключа.

Создает URI подписанного URL-адреса службы BLOB-объектов (SAS) на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

Параметры

options: BlobGenerateSasUrlOptions

Дополнительные параметры.

Возвращаемое значение

Promise<string>

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Наследуется отblobClient.generateSasUrl

getAppendBlobClient()

Создает объект AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Возвращаемое значение

AppendBlobClient

Наследуется отblobClient.getAppendBlobClient

getBlobLeaseClient(string)

Получите BlobLeaseClient , который управляет арендой большого двоичного объекта.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Параметры

proposeLeaseId: string

Первоначальный предлагаемый идентификатор аренды.

Возвращаемое значение

BlobLeaseClient

Новый объект BlobLeaseClient для управления арендой большого двоичного объекта.

Наследуется отBlobClient.getBlobLeaseClient

getBlockBlobClient()

Создает объект BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Возвращаемое значение

BlockBlobClient

Наследуется отblobClient.getBlockBlobClient

getPageBlobClient()

Создает объект PageBlobClient.

function getPageBlobClient(): PageBlobClient

Возвращаемое значение

PageBlobClient

Наследуется отblobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

ПРЕДУПРЕЖДЕНИЕ. Ключи metadata , возвращаемые в ответе, будут содержаться в нижнем регистре, даже если они изначально содержали символы верхнего регистра. Это отличается от ключей метаданных, возвращаемых методами ContainerClient , которые перечисляют большие двоичные объекты с помощью includeMetadata параметра , который сохранит их исходный регистр.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Параметры

options: BlobGetPropertiesOptions

Необязательные параметры для операции Получения свойств.

Возвращаемое значение

Promise<BlobGetPropertiesResponse>

Наследуется отBlobClient.getProperties

getTags(BlobGetTagsOptions)

Возвращает теги, связанные с базовым BLOB-объектом.

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

Параметры

options: BlobGetTagsOptions

Возвращаемое значение

Promise<BlobGetTagsResponse>

Наследуется отblobClient.getTags

setAccessTier(string, BlobSetTierOptions)

Задает уровень для большого двоичного объекта. Операция разрешена для страничного BLOB-объекта в учетной записи хранения класса Premium и блочного BLOB-объекта в учетной записи хранения BLOB-объектов (только локально избыточное хранилище). Уровень страничного BLOB-объекта уровня "Премиум" определяет допустимый размер, операции ввода-вывода в секунду и пропускную способность большого двоичного объекта. Уровень блочного BLOB-объекта определяет тип горячего, холодного или архивного хранилища. Эта операция не обновляет ETag большого двоичного объекта.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Параметры

tier: string

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

options: BlobSetTierOptions

Необязательные параметры для операции установки уровня BLOB-объектов.

Возвращаемое значение

Promise<BlobSetTierResponse>

Наследуется отblobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

Если значение не указано или не указано для указанных HTTP-заголовков BLOB-объектов, эти HTTP-заголовки больших двоичных объектов без значения будут удалены.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

Параметры

blobHTTPHeaders: BlobHTTPHeaders

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

options: BlobSetHTTPHeadersOptions

Необязательные параметры для операции установки заголовков HTTP для BLOB-объектов.

Возвращаемое значение

Promise<BlobSetHTTPHeadersResponse>

Наследуется отblobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Задайте политику immutablility для большого двоичного объекта.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

Параметры

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Возвращаемое значение

Promise<BlobSetImmutabilityPolicyResponse>

Наследуется отblobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

Параметры

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Возвращаемое значение

Promise<BlobSetLegalHoldResponse>

Наследуется отBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

Задает определяемые пользователем метаданные для определенного большого двоичного объекта в виде одной или нескольких пар "имя — значение".

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

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

Параметры

metadata: Metadata

Замените существующие метаданные этим значением. Если значение не указано, существующие метаданные будут удалены.

options: BlobSetMetadataOptions

Необязательные параметры для операции задания метаданных.

Возвращаемое значение

Promise<BlobSetMetadataResponse>

Наследуется отBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

Задает теги для базового большого двоичного объекта. Большой двоичный объект может содержать до 10 тегов. Клавиши тегов должны содержать от 1 до 128 символов. Значения тегов должны быть от 0 до 256 символов. Допустимые символы ключа тега и значения включают строчные и прописные буквы, цифры (0–9), пробел (' '), плюс ('+'), минус ('-'), точка ('.'), косая черта ('/'), двоеточие (':'), равно ('=') и подчеркивание ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Параметры

tags: Tags

options: BlobSetTagsOptions

Возвращаемое значение

Promise<BlobSetTagsResponse>

Наследуется отBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

Синхронная операция копирования из URL-адреса копирует большой двоичный объект или интернет-ресурс в новый BLOB-объект. Он не вернет ответ до завершения копирования.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

Параметры

copySource: string

Исходный URL-адрес для копирования, подписанный URL-адрес (SAS), возможно, необходим для проверки подлинности.

options: BlobSyncCopyFromURLOptions

Возвращаемое значение

Promise<BlobCopyFromURLResponse>

Наследуется отblobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

Восстанавливает содержимое и метаданные обратимо удаленного BLOB-объекта и всех связанных обратимо удаленных моментальных снимков. Отмена удаления BLOB-объекта поддерживается только в версии 2017-07-29 или более поздней.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Параметры

options: BlobUndeleteOptions

Необязательные параметры операции отмены удаления BLOB-объектов.

Возвращаемое значение

Promise<BlobUndeleteResponse>

Наследуется отblobClient.undelete

withVersion(string)

Создает новый объект BlobClient, указывающий на версию этого BLOB-объекта. При указании "" будет удален идентификатор versionId и возвращен клиент в базовый BLOB-объект.

function withVersion(versionId: string): BlobClient

Параметры

versionId: string

VersionId.

Возвращаемое значение

BlobClient

Новый объект BlobClient, указывающий на версию этого большого двоичного объекта.

Наследуется отblobClient.withVersion