BlockBlobClient class

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

new BlockBlobClient(url: string, pipeline: PipelineLike)

Параметры

Создает экземпляр BlockBlobClient. Этот метод принимает закодированный URL-адрес или некодированный URL-адрес, указывающий на блочный большой двоичный объект. Строка ЗАкодированного 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-объектов и оставляет целевой большой двоичный объект нулевой длиной и полными метаданными. Версия 2012-02-12 и более позднюю.

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

Параметры

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

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

function delete(options?: BlobDeleteOptions)

Параметры

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

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

function deleteIfExists(options?: BlobDeleteOptions)

Параметры

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

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Параметры

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

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

• В Node.jsданные возвращаются в потоке, доступном для чтения, доступном для чтенияStreamBody
• В браузерах данные возвращаются в объекте 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. Загружает большой двоичный объект Azure параллельно с буфером. Смещение и количество необязательными, загружает весь большой двоичный объект, если они не предоставлены.

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

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

Параметры

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

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

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

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

Параметры

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

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

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

Параметры

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

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

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

function exists(options?: BlobExistsOptions)

Параметры

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

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Параметры

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

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

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

function getAppendBlobClient()

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

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

function getBlobLeaseClient(proposeLeaseId?: string)

Параметры

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

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

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

function getBlockBlobClient()

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

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

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

Параметры

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

Ответные данные для операции "Блочный blob-объект Get Block List".

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

function getPageBlobClient()

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

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

function getProperties(options?: BlobGetPropertiesOptions)

Параметры

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

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

function getTags(options?: BlobGetTagsOptions)

Параметры

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

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Быстрый запрос к форматируемой BLOB-объекту 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)

Параметры

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

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

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

Параметры

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

Задает системные свойства большого двоичного объекта. Если для указанных заголовков HTTP большого двоичного объекта не задано никакого значения, эти заголовки HTTP БОЛЬШИХ двоичных объектов без значения будут удалены.

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

Задает теги в базовом большом двоичном объекте. Большой двоичный объект может содержать до 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-объектов.

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

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

Параметры

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

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

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

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

Параметры

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

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

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

Параметры

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

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

function undelete(options?: BlobUndeleteOptions)

Параметры

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

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

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 в блок больших двоичных объектов.

Если длина буфера меньше или равна 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. Отправляет локальный файл в блоки в блочный большой двоичный объект.

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

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

Параметры

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

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

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

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

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

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

Параметры

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

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

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

function withSnapshot(snapshot: string)

Параметры

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

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

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

function withVersion(versionId: string)

Параметры

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

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