PageBlobClient class

Ссылка

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

PageBlobClient определяет набор операций, применимых к страничным BLOB-объектам.

Extends: BlobClient

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

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

Свойства

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

Методы

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Прерывает ожидающие асинхронные операции копирования BLOB-объектов и оставляет целевой BLOB-объект нулевой длины и полные метаданные. Версия 12.02.2012 и более поздние.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Асинхронно копирует BLOB-объект в место назначения в учетной записи хранения. Этот метод возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время, пока копирование не будет завершено. Вы также можете отменить копию до ее завершения, вызвав `cancelOperation` в опроснике. Обратите внимание, что обратный вызов onProgress не будет вызываться, если операция завершится в первом запросе, а попытка отменить завершенную копию приведет к возникновению ошибки. В версии 2012-02-12 и более поздних версиях источником операции копирования BLOB-объектов может быть зафиксированный BLOB-объект в любой учетной записи хранения Azure. Начиная с версии 2015-02-21 источником операции копирования BLOB-объектов может быть файл Azure в любой учетной записи хранения Azure. Только учетные записи хранилища, созданные 7 июня 2012 года или позже, позволяют использовать операцию Copy Blob для копирования из другой учетной записи хранилища.
clearPages(number, number, PageBlobClearPagesOptions)	Освобождает указанные страницы из страничного BLOB-объекта.
create(number, PageBlobCreateOptions)	Создает страничный BLOB-объект указанной длины. Вызов uploadPages для отправки данных в страничный BLOB-объект.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Создает страничный BLOB-объект указанной длины. Вызов uploadPages для отправки данных в страничный BLOB-объект. Если большой двоичный объект с таким же именем уже существует, содержимое существующего большого двоичного объекта останется неизменным.
createSnapshot(BlobCreateSnapshotOptions)	Создает доступный только для чтения моментальный снимок BLOB-объекта.
delete(BlobDeleteOptions)	Помечает указанный большой двоичный объект или моментальный снимок для удаления. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект.
deleteIfExists(BlobDeleteOptions)	Помечает указанный большой двоичный объект или моментальный снимок для удаления, если он существует. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Удалите политику immutablility в большом двоичном объекте.
download(number, number, BlobDownloadOptions)	Считывает или скачивает большой двоичный объект из системы, включая его метаданные и свойства. Для чтения моментального снимка можно также вызвать метод Get BLOB-объекта. В Node.js данные возвращаются в потоке readableStreamBody. В браузерах данные возвращаются в объекте promise 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.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Возвращает список допустимых диапазонов страниц для страничного BLOB-объекта или моментального снимка страничного BLOB-объекта.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	Возвращает коллекцию диапазонов страниц, которые отличаются между указанным моментальным снимком и данным страничного BLOB-объекта.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	Возвращает коллекцию диапазонов страниц, которые отличаются между указанным моментальным снимком и данным страничного BLOB-объекта для управляемых дисков.
getProperties(BlobGetPropertiesOptions)	Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства большого двоичного объекта. Операция не возвращает содержимое большого двоичного объекта.
getTags(BlobGetTagsOptions)	Возвращает теги, связанные с базовым BLOB-объектом.
resize(number, PageBlobResizeOptions)	Изменяет размер страничного BLOB-объекта до указанного размера (который должен быть кратным 512).
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Задает уровень для большого двоичного объекта. Операция разрешена для страничного BLOB-объекта в учетной записи хранения класса Premium и блочного BLOB-объекта в учетной записи хранения BLOB-объектов (только локально избыточное хранилище). Уровень страничного BLOB-объекта уровня "Премиум" определяет допустимый размер, операции ввода-вывода в секунду и пропускную способность большого двоичного объекта. Уровень блочного BLOB-объекта определяет тип горячего, холодного или архивного хранилища. Эта операция не обновляет ETag большого двоичного объекта.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Задает системные свойства для большого двоичного объекта. Если значение не указано или не указано для указанных HTTP-заголовков BLOB-объектов, эти HTTP-заголовки больших двоичных объектов без значения будут удалены.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Задайте политику immutablility для большого двоичного объекта.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Установите удержание большого двоичного объекта по юридическим причинам.
setMetadata(Metadata, BlobSetMetadataOptions)	Задает определяемые пользователем метаданные для определенного большого двоичного объекта в виде одной или нескольких пар "имя — значение". Если параметр не указан или метаданные не определены в параметре, метаданные большого двоичного объекта будут удалены.
setTags(Tags, BlobSetTagsOptions)	Задает теги для базового большого двоичного объекта. Большой двоичный объект может содержать до 10 тегов. Клавиши тегов должны содержать от 1 до 128 символов. Значения тегов должны быть от 0 до 256 символов. Допустимые символы ключа тега и значения включают строчные и прописные буквы, цифры (0–9), пробел (' '), плюс ('+'), минус ('-'), точка ('.'), косая черта ('/'), двоеточие (':'), равно ('=') и подчеркивание ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Начинает операцию запуска добавочного копирования моментального снимка одного страничного BLOB-объекта в этот страничный BLOB-объект. Моментальный снимок копируется таким образом, что в назначение передаются только разностные изменения между ранее скопированным моментальным снимком. Скопированные моментальные снимки являются полными копиями исходного моментального снимка и могут быть прочитаны или скопированы из них, как обычно.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	Синхронная операция копирования с URL-адреса копирует большой двоичный объект или интернет-ресурс в новый BLOB-объект. Он не вернет ответ, пока копия не будет завершена.
undelete(BlobUndeleteOptions)	Восстанавливает содержимое и метаданные обратимо удаленных BLOB-объектов и всех связанных обратимо удаленных моментальных снимков. Отмена удаления BLOB-объектов поддерживается только в версии 2017-07-29 или более поздней.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Задает порядковый номер страничного BLOB-объекта.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Записывает 1 или более страниц в страничный BLOB-объект. Начальные и конечные смещения должны быть кратными 512.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	Операция Отправки страниц записывает диапазон страниц в страничный BLOB-объект, где содержимое считывается из URL-адреса.
withSnapshot(string)	Создает объект PageBlobClient, идентичный источнику, но с указанной меткой времени моментального снимка. Укажите "", чтобы удалить моментальный снимок и вернуть клиент в базовый BLOB-объект.
withVersion(string)	Создает новый объект BlobClient, указывающий на версию этого BLOB-объекта. При указании "" удалит versionId и вернет клиент в базовый BLOB-объект.

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

PageBlobClient(string, PipelineLike)

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

new PageBlobClient(url: string, pipeline: PipelineLike)

Параметры

url: string

Строка клиента, указывающая на страничный BLOB-объект службы хранилища Azure, например "https://myaccount.blob.core.windows.net/mycontainer/pageblob"". Вы можете добавить SAS с помощью AnonymousCredential, например "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString"".

pipeline: PipelineLike

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

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

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

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

Параметры

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

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

PageBlobClient(string, string, string, StoragePipelineOptions)

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

new PageBlobClient(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>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Асинхронно копирует 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)

Параметры

copySource: string

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

options: BlobBeginCopyFromURLOptions

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

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

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

clearPages(number, number, PageBlobClearPagesOptions)

Освобождает указанные страницы из страничного BLOB-объекта.

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

Параметры

offset: number

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

count: number

Число байтов для очистки.

options: PageBlobClearPagesOptions

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

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

Promise<PageBlobClearPagesResponse>

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

create(number, PageBlobCreateOptions)

Создает страничный BLOB-объект указанной длины. Вызов uploadPages для отправки данных в страничный BLOB-объект.

function create(size: number, options?: PageBlobCreateOptions)

Параметры

size: number

размер страничного BLOB-объекта.

options: PageBlobCreateOptions

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

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

Promise<PageBlobCreateResponse>

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

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

Параметры

size: number

размер страничного BLOB-объекта.

options: PageBlobCreateIfNotExistsOptions

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

Promise<PageBlobCreateIfNotExistsResponse>

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.
В браузерах данные возвращаются в объекте promise 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

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

options: BlobDownloadOptions

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

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

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

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

function exists(options?: BlobExistsOptions)

Параметры

options: BlobExistsOptions

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

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

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

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

Параметры

offset: number

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

count: number

Число байтов для получения.

options: PageBlobGetPageRangesOptions

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

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

Promise<PageBlobGetPageRangesResponse>

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

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

Параметры

offset: number

Начальная позиция байтов страничного BLOB-объекта

count: number

Число байтов для получения различий в диапазонах.

prevSnapshot: string

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

options: PageBlobGetPageRangesDiffOptions

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

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

Promise<PageBlobGetPageRangesDiffResponse>

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

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

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

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

Параметры

offset: number

Начальная позиция байтов страничного BLOB-объекта

count: number

Число байтов для получения различий в диапазонах.

prevSnapshotUrl: string

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

options: PageBlobGetPageRangesDiffOptions

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

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

Promise<PageBlobGetPageRangesDiffResponse>

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

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

Параметры

options: BlobGetPropertiesOptions

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

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

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

Параметры

options: BlobGetTagsOptions

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

Promise<BlobGetTagsResponse>

resize(number, PageBlobResizeOptions)

Изменяет размер страничного BLOB-объекта до указанного размера (который должен быть кратным 512).

function resize(size: number, options?: PageBlobResizeOptions)

Параметры

size: number

целевой размер;

options: PageBlobResizeOptions

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

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

Promise<PageBlobResizeResponse>

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

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

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

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)

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

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

Параметры

metadata: Metadata

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

options: BlobSetMetadataOptions

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

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

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

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

Параметры

tags: Tags

options: BlobSetTagsOptions

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

Promise<BlobSetTagsResponse>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Начинает операцию запуска добавочного копирования моментального снимка одного страничного BLOB-объекта в этот страничный BLOB-объект. Моментальный снимок копируется таким образом, что в назначение передаются только разностные изменения между ранее скопированным моментальным снимком. Скопированные моментальные снимки являются полными копиями исходного моментального снимка и могут быть прочитаны или скопированы из них, как обычно.

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

Параметры

copySource: string

Указывает имя моментального снимка blob-объекта исходной страницы. Например https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=.

options: PageBlobStartCopyIncrementalOptions

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

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

Promise<PageBlobCopyIncrementalResponse>

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

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>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

Параметры

sequenceNumberAction: SequenceNumberActionType

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

sequenceNumber: number

Требуется, если sequenceNumberAction имеет значение max или update

options: PageBlobUpdateSequenceNumberOptions

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

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

Promise<PageBlobUpdateSequenceNumberResponse>

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

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Записывает 1 или более страниц в страничный BLOB-объект. Начальные и конечные смещения должны быть кратными 512.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

Параметры

body: HttpRequestBody

Данные для отправки

offset: number

Смещение целевого страничного BLOB-объекта

count: number

Длина содержимого текста, а также количество байтов для отправки

options: PageBlobUploadPagesOptions

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

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

Promise<PageBlobUploadPagesResponse>

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

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

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

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

Параметры

sourceURL: string

Укажите URL-адрес источника копирования. Для проверки подлинности может потребоваться подписанный URL-адрес (SAS)

sourceOffset: number

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

destOffset: number

Смещение целевого страничного BLOB-объекта

count: number

Число байтов для отправки из исходного страничного BLOB-объекта

options: PageBlobUploadPagesFromURLOptions

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

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string)

Параметры

snapshot: string

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

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

PageBlobClient

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

withVersion(string)

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

function withVersion(versionId: string)

Параметры

versionId: string

VersionId.

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

BlobClient

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

Поделиться через

PageBlobClient class

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

Свойства

Методы

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

PageBlobClient(string, PipelineLike)

Параметры

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

Параметры

PageBlobClient(string, string, string, StoragePipelineOptions)

Параметры

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

accountName

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

containerName

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

credential

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

name

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

url

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

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Параметры

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

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Параметры

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

clearPages(number, number, PageBlobClearPagesOptions)

Параметры

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

create(number, PageBlobCreateOptions)

Параметры

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

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Параметры

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

createSnapshot(BlobCreateSnapshotOptions)

Параметры

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

delete(BlobDeleteOptions)

Параметры

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

deleteIfExists(BlobDeleteOptions)

Параметры

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

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Параметры

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

download(number, number, BlobDownloadOptions)

Параметры

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

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Параметры

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

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Параметры

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

downloadToFile(string, number, number, BlobDownloadOptions)

Параметры

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

exists(BlobExistsOptions)

Параметры

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

generateSasUrl(BlobGenerateSasUrlOptions)

Параметры

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

getAppendBlobClient()

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

getBlobLeaseClient(string)

Параметры

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

getBlockBlobClient()

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

getPageBlobClient()

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

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Параметры