BlockBlobClient class

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

new BlockBlobClient(url: string, pipeline: PipelineLike)

Параметры

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

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

Параметры

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

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

Параметры

accountName: string

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

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

string containerName

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

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

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

string name

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

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

url: string

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

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

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

Параметры

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

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

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

Параметры

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

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

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions)

Параметры

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

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

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

Параметры

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

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

function delete(options?: BlobDeleteOptions)

Параметры

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

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

function deleteIfExists(options?: BlobDeleteOptions)

Параметры

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

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Параметры

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

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

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

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

Параметры

// 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);
  });
}

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Загружает весь большой двоичный объект, если они не указаны.

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

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

Параметры

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Загружает весь большой двоичный объект, если они не указаны.

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

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Параметры

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Загружает BLOB-объект Azure в локальный файл. Сбой, если указанный путь к файлу уже завершается. Смещение и счетчик являются необязательными, передаются 0 и undefined соответственно, чтобы скачать весь большой двоичный объект.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

Параметры

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

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

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

function exists(options?: BlobExistsOptions)

Параметры

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

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Параметры

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

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

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

function getAppendBlobClient()

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

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

function getBlobLeaseClient(proposeLeaseId?: string)

Параметры

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

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

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

function getBlockBlobClient()

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

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

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions)

Параметры

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

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

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

function getPageBlobClient()

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

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

function getProperties(options?: BlobGetPropertiesOptions)

Параметры

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

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

function getTags(options?: BlobGetTagsOptions)

Параметры

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ 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)

Параметры

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

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

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

Параметры

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

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

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

Параметры

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

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

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)

Параметры

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

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

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)

Параметры

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

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

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

Параметры

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

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

function setTags(tags: Tags, options?: BlobSetTagsOptions)

Параметры

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

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

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)

Параметры

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

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

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

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions)

Параметры

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

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

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

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

Параметры

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

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

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions)

Параметры

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

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

function undelete(options?: BlobUndeleteOptions)

Параметры

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

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

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Параметры

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

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

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

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

ДОСТУПНО ТОЛЬКО В БРАУЗЕРАХ. Отправляет объект blob/File/ArrayBuffer/ArrayBufferView браузера в блочный BLOB-объект.

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

Распространенным <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> параметром является blobContentType, позволяющий браузеру предоставлять функциональные возможности в зависимости от типа файла.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Параметры

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

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

Отправляет объект Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView в BlockBlob. Если длина данных не превышает указанную <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (по умолчанию — <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), этот метод будет использовать 1 <xref:upload> вызов для завершения отправки. В противном случае этот метод вызовет <xref:stageBlock> для отправки блоков и, наконец, вызовет <xref:commitBlockList> для фиксации списка блокировок.

Распространенным <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> параметром является blobContentType, позволяющий браузеру предоставлять функциональные возможности в зависимости от типа файла.

function uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Параметры

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет локальный файл блоками в блочный BLOB-объект.

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

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions)

Параметры

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

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет Node.js читаемый поток в блочный BLOB-объект.

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

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

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions)

Параметры

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

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

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

function withSnapshot(snapshot: string)

Параметры

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

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

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

function withVersion(versionId: string)

Параметры

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

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