AppendBlobClient class

Ссылка

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

AppendBlobClient определяет набор операций, применимых к добавлению BLOB-объектов.

Extends: BlobClient

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

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

Свойства

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

Методы

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Прерывает ожидающий асинхронную операцию копирования BLOB-объекта и оставляет целевой BLOB-объект с нулевой длиной и полными метаданными. Версия 12.02.2012 и более поздние.
appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)	Фиксирует новый блок данных в конце существующего добавочного BLOB-объекта.
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)	Операция добавления блока фиксирует новый блок данных в конце существующего добавочного BLOB-объекта, где содержимое считывается из исходного URL-адреса.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Асинхронно копирует большой двоичный объект в место назначения в учетной записи хранения. Этот метод возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения копирования. Вы также можете отменить копию до ее завершения, вызвав `cancelOperation` в опрашиватель. Обратите внимание, что обратный вызов onProgress не будет вызываться, если операция завершится в первом запросе, а попытка отменить завершенную копию приведет к ошибке. В версии 2012-02-12 и более поздних версиях источником операции копирования BLOB-объекта может быть зафиксированный BLOB-объект в любой учетной записи хранения Azure. Начиная с версии 2015-02-21, источником операции копирования BLOB-объектов может быть файл Azure в любой учетной записи хранения Azure. Только учетные записи хранилища, созданные 7 июня 2012 года или позже, позволяют использовать операцию Copy Blob для копирования из другой учетной записи хранилища.
create(AppendBlobCreateOptions)	Создает добавочный BLOB-объект длиной 0. Вызовите AppendBlock, чтобы добавить данные в добавочный BLOB-объект.
createIfNotExists(AppendBlobCreateIfNotExistsOptions)	Создает добавочный BLOB-объект длиной 0. Вызовите AppendBlock, чтобы добавить данные в добавочный BLOB-объект. Если большой двоичный объект с тем же именем уже существует, содержимое существующего большого двоичного объекта останется неизменным.
createSnapshot(BlobCreateSnapshotOptions)	Создает доступный только для чтения моментальный снимок BLOB-объекта.
delete(BlobDeleteOptions)	Помечает указанный большой двоичный объект или моментальный снимок для удаления. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект.
deleteIfExists(BlobDeleteOptions)	Помечает указанный большой двоичный объект или моментальный снимок для удаления, если он существует. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Удалите политику immutablility в большом двоичном объекте.
download(number, number, BlobDownloadOptions)	Считывает или скачивает большой двоичный объект из системы, включая его метаданные и свойства. Вы также можете вызвать метод Get Blob для чтения моментального снимка. В Node.js данные возвращаются в потоке readableStreamBody. В браузерах данные возвращаются в обещанном blobBody
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Скачивает весь большой двоичный объект, если они не указаны. Предупреждение. Буферы могут поддерживать файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для больших двоичных объектов, превышающих этот размер, рассмотрите.<xref:downloadToFile>
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Скачивает весь большой двоичный объект, если они не указаны. Предупреждение. Буферы могут поддерживать файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для больших двоичных объектов, превышающих этот размер, рассмотрите.<xref: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 подписывается учетными данными общего ключа клиента.
getAppendBlobClient()	Создает объект AppendBlobClient.
getBlobLeaseClient(string)	Получите объект , <xref:BlobLeaseClient> который управляет арендой большого двоичного объекта.
getBlockBlobClient()	Создает объект BlockBlobClient.
getPageBlobClient()	Создает объект PageBlobClient.
getProperties(BlobGetPropertiesOptions)	Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства большого двоичного объекта. Операция не возвращает содержимое большого двоичного объекта.
getTags(BlobGetTagsOptions)	Возвращает теги, связанные с базовым BLOB-объектом.
seal(AppendBlobSealOptions)	Запечатывает добавочный BLOB-объект, делая его только для чтения.
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Задает уровень для BLOB-объекта. Операция разрешена для страничного BLOB-объекта в учетной записи хранения класса Premium и блочного BLOB-объекта в учетной записи хранения BLOB-объектов (только локально избыточное хранилище). Уровень страничного BLOB-объекта ценовой категории "Премиум" определяет допустимый размер, количество операций ввода-вывода в секунду и пропускную способность большого двоичного объекта. Уровень блочного BLOB-объекта определяет тип горячего, холодного и архивного хранилища. Эта операция не обновляет ETag BLOB-объекта.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Задает системные свойства для большого двоичного объекта. Если значение не указано или не указано значение для указанных HTTP-заголовков BLOB-объектов, эти http-заголовки больших двоичных объектов без значения будут очищены.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Задайте политику immutablility для большого двоичного объекта.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Установите удержание по юридическим причинам для большого двоичного объекта.
setMetadata(Metadata, BlobSetMetadataOptions)	Задает определяемые пользователем метаданные для определенного большого двоичного объекта в виде одной или нескольких пар "имя — значение". Если параметр не указан или метаданные не определены в параметре, метаданные BLOB-объекта будут удалены.
setTags(Tags, BlobSetTagsOptions)	Задает теги для базового BLOB-объекта. Большой двоичный объект может содержать до 10 тегов. Ключи тегов должны содержать от 1 до 128 символов. Значения тегов должны быть от 0 до 256 символов. Допустимые символы ключа и значения тега включают строчные и прописные буквы, цифры (0–9), пробел (' '), плюс ('+'), минус ('-'), точку ('.'), косую черту ('/'), двоеточие (':'), равно ('=') и подчеркивание ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Синхронная операция копирования из URL-адреса копирует большой двоичный объект или интернет-ресурс в новый BLOB-объект. Он не вернет ответ до завершения копирования.
undelete(BlobUndeleteOptions)	Восстанавливает содержимое и метаданные обратимо удаленного BLOB-объекта и всех связанных обратимо удаленных моментальных снимков. Отмена удаления BLOB-объекта поддерживается только в версии 2017-07-29 или более поздней.
withSnapshot(string)	Создает объект AppendBlobClient, идентичный источнику, но с указанной меткой времени моментального снимка. Укажите "", чтобы удалить моментальный снимок и вернуть клиент в базовый BLOB-объект.
withVersion(string)	Создает новый объект BlobClient, указывающий на версию этого BLOB-объекта. При указании "" будет удален идентификатор versionId и возвращен клиент в базовый BLOB-объект.

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

AppendBlobClient(string, PipelineLike)

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

new AppendBlobClient(url: string, pipeline: PipelineLike)

Параметры

url: string

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

pipeline: PipelineLike

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

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

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

Параметры

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

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

AppendBlobClient(string, string, string, StoragePipelineOptions)

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

new AppendBlobClient(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.

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

accountName

accountName: string

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

string

containerName

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

string containerName

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

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

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

string name

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

string

url

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

url: string

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

string

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

Параметры

copyId: string

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

options: BlobAbortCopyFromURLOptions

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

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

Promise<BlobAbortCopyFromURLResponse>

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)

Фиксирует новый блок данных в конце существующего добавочного BLOB-объекта.

function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions)

Параметры

body: HttpRequestBody

Добавляемые данные.

contentLength: number

Длина тела в байтах.

options: AppendBlobAppendBlockOptions

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

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

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

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

Promise<AppendBlobAppendBlockResponse>

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

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

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions)

Параметры

sourceURL: string

          The url to the blob that will be the source of the copy. A source blob in the same storage account can
          be authenticated via Shared Key. However, if the source is a blob in another account, the source blob
          must either be public or must be authenticated via a shared access signature. If the source blob is
          public, no authentication is required to perform the operation.

sourceOffset: number

Смещение в добавляемом источнике

count: number

Число байтов, добавляемых в виде блока

options: AppendBlobAppendBlockFromURLOptions

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

Promise<AppendBlobAppendBlockFromUrlResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

Параметры

copySource: string

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

options: BlobBeginCopyFromURLOptions

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

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

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

create(AppendBlobCreateOptions)

Создает добавочный BLOB-объект длиной 0. Вызовите AppendBlock, чтобы добавить данные в добавочный BLOB-объект.

function create(options?: AppendBlobCreateOptions)

Параметры

options: AppendBlobCreateOptions

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

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

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

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

Promise<AppendBlobCreateResponse>

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

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

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions)

Параметры

options: AppendBlobCreateIfNotExistsOptions

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

Promise<AppendBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

Параметры

options: BlobCreateSnapshotOptions

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

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

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

function delete(options?: BlobDeleteOptions)

Параметры

options: BlobDeleteOptions

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

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

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

function deleteIfExists(options?: BlobDeleteOptions)

Параметры

options: BlobDeleteOptions

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

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

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Параметры

options: BlobDeleteImmutabilityPolicyOptions

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

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

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

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

Параметры

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>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

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

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

Параметры

buffer: Buffer

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

offset: number

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

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

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

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

Параметры

offset: number

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

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

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

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

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

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

Параметры

filePath: string

offset: number

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

count: number

Объем загружаемых данных. Скачивание до конца при передаче undefined.

options: BlobDownloadOptions

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

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

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

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

function exists(options?: BlobExistsOptions)

Параметры

options: BlobExistsOptions

параметров для операции Exists.

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

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Параметры

options: BlobGenerateSasUrlOptions

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

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

Promise<string>

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

getAppendBlobClient()

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

function getAppendBlobClient()

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

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string)

Параметры

proposeLeaseId: string

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

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

BlobLeaseClient

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

getBlockBlobClient()

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

function getBlockBlobClient()

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

BlockBlobClient

getPageBlobClient()

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

function getPageBlobClient()

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

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

Параметры

options: BlobGetPropertiesOptions

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

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

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

Параметры

options: BlobGetTagsOptions

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

Promise<BlobGetTagsResponse>

seal(AppendBlobSealOptions)

Запечатывает добавочный BLOB-объект, делая его только для чтения.

function seal(options?: AppendBlobSealOptions)

Параметры

options: AppendBlobSealOptions

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

Promise<AppendBlobAppendBlockResponse>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

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

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

Параметры

tier: BlockBlobTier | PremiumPageBlobTier | string

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

options: BlobSetTierOptions

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

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

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

Параметры

blobHTTPHeaders: BlobHTTPHeaders

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

options: BlobSetHTTPHeadersOptions

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

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

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

Параметры

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

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

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

Параметры

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

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

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

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

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

Параметры

metadata: Metadata

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

options: BlobSetMetadataOptions

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

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

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

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

Параметры

tags: Tags

options: BlobSetTagsOptions

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

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

Параметры

copySource: string

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

options: BlobSyncCopyFromURLOptions

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

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

function undelete(options?: BlobUndeleteOptions)

Параметры

options: BlobUndeleteOptions

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

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

Promise<BlobUndeleteResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string)

Параметры

snapshot: string

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

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

AppendBlobClient

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

withVersion(string)

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

function withVersion(versionId: string)

Параметры

versionId: string

VersionId.

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

BlobClient

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