PageBlobClient class
PageBlobClient определяет набор операций, применимых к страничным BLOB-объектам.
- Extends
Конструкторы
Page |
Создает экземпляр PageBlobClient. |
Page |
Создает экземпляр PageBlobClient. Этот метод принимает закодированный URL-адрес или некодированный URL-адрес, указывающий на большой двоичный объект. Закодированная строка URL-адреса НЕ будет экранирована дважды, экранируются только специальные символы в url-пути. Если имя большого двоичного объекта содержит ? Или % имя большого двоичного объекта должно быть закодировано в URL-адресе. |
Page |
Создает экземпляр PageBlobClient. |
Свойства
container |
Имя контейнера хранилища, с которым связан большой двоичный объект. |
name | Имя большого двоичного объекта. |
Унаследованные свойства
account |
|
credential | Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные |
url | Закодированное значение строки URL-адреса. |
Методы
clear |
Освобождает указанные страницы из страничного BLOB-объекта. См. раздел https://docs.microsoft.com/rest/api/storageservices/put-page |
create(number, Page |
Создает страничный BLOB-объект указанной длины. Вызов uploadPages для отправки данных в страничный BLOB-объект. См. раздел https://docs.microsoft.com/rest/api/storageservices/put-blob |
create |
Создает страничный BLOB-объект указанной длины. Вызов uploadPages для отправки данных в страничный BLOB-объект. Если большой двоичный объект с таким же именем уже существует, содержимое существующего большого двоичного объекта останется неизменным. См. раздел https://docs.microsoft.com/rest/api/storageservices/put-blob |
get |
Возвращает список допустимых диапазонов страниц для страничного BLOB-объекта или моментального снимка страничного BLOB-объекта. См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges |
get |
Возвращает коллекцию диапазонов страниц, которые отличаются между указанным моментальным снимком и данным страничного BLOB-объекта. См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges |
get |
Возвращает коллекцию диапазонов страниц, которые отличаются между указанным моментальным снимком и данным страничного BLOB-объекта для управляемых дисков. См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges |
list |
Возвращает асинхронный итератор для списка диапазонов страниц для страничного BLOB-объекта. См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges .byPage() возвращает асинхронный итератор для списка диапазонов страниц для страничного BLOB-объекта. Пример использования синтаксиса
Пример, использующий среду
Пример, использующий среду
Пример использования разбиения по страницам с маркером:
|
list |
Возвращает асинхронный итератор для списка диапазонов страниц, которые отличаются между указанным моментальным снимком и этим страничного BLOB-объекта. См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges .byPage() возвращает асинхронный итератор для списка диапазонов страниц, которые отличаются между указанным моментальным снимком и этим страничного BLOB-объекта. Пример использования синтаксиса
Пример, использующий среду
Пример, использующий среду
Пример использования разбиения по страницам с маркером:
|
resize(number, Page |
Изменяет размер страничного BLOB-объекта до указанного размера (который должен быть кратным 512). См. раздел https://docs.microsoft.com/rest/api/storageservices/set-blob-properties |
start |
Начинает операцию запуска добавочного копирования моментального снимка одного страничного BLOB-объекта в этот страничный BLOB-объект. Моментальный снимок копируется таким образом, что в назначение передаются только разностные изменения между ранее скопированным моментальным снимком. Скопированные моментальные снимки являются полными копиями исходного моментального снимка и могут быть прочитаны или скопированы из них, как обычно. См. раздел https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob См. https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots |
update |
Задает порядковый номер страничного BLOB-объекта. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
upload |
Записывает 1 или более страниц в страничный BLOB-объект. Начальные и конечные смещения должны быть кратными 512. См. раздел https://docs.microsoft.com/rest/api/storageservices/put-page |
upload |
Операция Отправки страниц записывает диапазон страниц в страничный BLOB-объект, где содержимое считывается из URL-адреса. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url |
with |
Создает объект PageBlobClient, идентичный источнику, но с указанной меткой времени моментального снимка. Укажите "", чтобы удалить моментальный снимок и вернуть клиент в базовый BLOB-объект. |
Наследуемые методы
abort |
Прерывает ожидающие асинхронные операции копирования BLOB-объекта и оставляет целевой BLOB-объект с нулевой длиной и полными метаданными. Версия 12.02.2012 и более поздние. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob |
begin |
Асинхронно копирует большой двоичный объект в место назначения в учетной записи хранения.
Этот метод возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения копирования.
Вы также можете отменить копию до ее завершения, вызвав В версии 2012-02-12 и более поздних версиях источником операции копирования BLOB-объекта может быть зафиксированный BLOB-объект в любой учетной записи хранения Azure. Начиная с версии 2015-02-21, источником операции копирования BLOB-объектов может быть файл Azure в любой учетной записи хранения Azure. Только учетные записи хранилища, созданные 7 июня 2012 года или позже, позволяют использовать операцию Copy Blob для копирования из другой учетной записи хранилища. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Пример использования автоматического опроса:
Пример использования опроса вручную:
Пример использования обновлений хода выполнения:
Пример использования изменяющегося интервала опроса (по умолчанию 15 секунд):
Пример использования отмены копирования:
|
create |
Создает доступный только для чтения моментальный снимок BLOB-объекта. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob |
delete(Blob |
Помечает указанный большой двоичный объект или моментальный снимок для удаления. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
Помечает указанный большой двоичный объект или моментальный снимок для удаления, если он существует. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
Удалите политику immutablility в большом двоичном объекте. |
download(number, number, Blob |
Считывает или скачивает большой двоичный объект из системы, включая его метаданные и свойства. Вы также можете вызвать метод Get Blob для чтения моментального снимка.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
download |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Скачивает весь большой двоичный объект, если они не указаны. Предупреждение. Буферы могут поддерживать файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для больших двоичных объектов, превышающих этот размер, рассмотрите возможность downloadToFile. |
download |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Скачивает весь большой двоичный объект, если они не указаны. Предупреждение. Буферы могут поддерживать файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для больших двоичных объектов, превышающих этот размер, рассмотрите возможность downloadToFile. |
download |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Скачивает BLOB-объект Azure в локальный файл. Сбой, если указанный путь к файлу уже завершается. Смещение и счетчик являются необязательными. Для скачивания всего большого двоичного объекта необходимо передать значение 0 и значение undefined соответственно. |
exists(Blob |
Возвращает значение true, если ресурс BLOB-объекта Azure, представленный этим клиентом, существует; В противном случае значение false. ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий BLOB-объект может быть удален другими клиентами или приложениями. И наоборот, после выполнения этой функции новые большие двоичные объекты могут добавляться другими клиентами или приложениями. |
generate |
Доступно только для BlobClient, созданного с учетными данными общего ключа. Создает URI подписанного URL-адреса службы BLOB-объектов (SAS) на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Создает объект AppendBlobClient. |
get |
Получите BlobLeaseClient , который управляет арендой большого двоичного объекта. |
get |
Создает объект BlockBlobClient. |
get |
Создает объект PageBlobClient. |
get |
Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства большого двоичного объекта. Операция не возвращает содержимое большого двоичного объекта. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties ВНИМАНИЕ! Ключи |
get |
Возвращает теги, связанные с базовым BLOB-объектом. |
set |
Задает уровень для BLOB-объекта. Операция разрешена для страничного BLOB-объекта в учетной записи хранения класса Premium и блочного BLOB-объекта в учетной записи хранения BLOB-объектов (только локально избыточное хранилище). Уровень страничного BLOB-объекта ценовой категории "Премиум" определяет допустимый размер, количество операций ввода-вывода в секунду и пропускную способность большого двоичного объекта. Уровень блочного BLOB-объекта определяет тип горячего, холодного и архивного хранилища. Эта операция не обновляет ETag BLOB-объекта. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier |
set |
Задает системные свойства для большого двоичного объекта. Если значение не указано или не указано значение для указанных HTTP-заголовков BLOB-объектов, эти http-заголовки больших двоичных объектов без значения будут очищены. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Задайте политику неизменяемости для большого двоичного объекта. |
set |
Установите удержание по юридическим причинам для большого двоичного объекта. |
set |
Задает определяемые пользователем метаданные для определенного большого двоичного объекта в виде одной или нескольких пар "имя — значение". Если параметр не указан или метаданные не определены в параметре, метаданные BLOB-объекта будут удалены. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
set |
Задает теги для базового BLOB-объекта. Большой двоичный объект может содержать до 10 тегов. Ключи тегов должны содержать от 1 до 128 символов. Значения тегов должны быть от 0 до 256 символов. Допустимые символы ключа и значения тега включают строчные и прописные буквы, цифры (0–9), пробел (' '), плюс ('+'), минус ('-'), точку ('.'), косую черту ('/'), двоеточие (':'), равно ('=') и подчеркивание ('_') . |
sync |
Синхронная операция копирования из URL-адреса копирует большой двоичный объект или интернет-ресурс в новый BLOB-объект. Он не вернет ответ до завершения копирования. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url |
undelete(Blob |
Восстанавливает содержимое и метаданные обратимо удаленного BLOB-объекта и всех связанных обратимо удаленных моментальных снимков. Отмена удаления BLOB-объекта поддерживается только в версии 2017-07-29 или более поздней. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
with |
Создает новый объект BlobClient, указывающий на версию этого BLOB-объекта. При указании "" будет удален идентификатор versionId и возвращен клиент в базовый BLOB-объект. |
Сведения о конструкторе
PageBlobClient(string, PipelineLike)
Создает экземпляр PageBlobClient.
new PageBlobClient(url: string, pipeline: PipelineLike)
Параметры
- url
-
string
Строка URL-адреса, указывающая на страничный BLOB-объект службы хранилища Azure, например "https://myaccount.blob.core.windows.net/mycontainer/pageblob". Вы можете добавить SAS при использовании AnonymousCredential, например "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString"". Этот метод принимает закодированный URL-адрес или некодированный URL-адрес, указывающий на большой двоичный объект. Закодированная строка URL-адреса НЕ будет экранирована дважды, экранируются только специальные символы в url-пути. Однако, если имя большого двоичного объекта содержит ? Или % имя большого двоичного объекта должно быть закодировано в URL-адресе. Например, большой двоичный объект с именем "my?blob%", URL-адрес должен быть "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- pipeline
- PipelineLike
Вызовите newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Создает экземпляр PageBlobClient. Этот метод принимает закодированный URL-адрес или некодированный URL-адрес, указывающий на большой двоичный объект. Закодированная строка URL-адреса НЕ будет экранирована дважды, экранируются только специальные символы в url-пути. Если имя большого двоичного объекта содержит ? Или % имя большого двоичного объекта должно быть закодировано в URL-адресе.
new PageBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Параметры
- url
-
string
Строка клиента, указывающая на страничный BLOB-объект службы хранилища Azure, например "https://myaccount.blob.core.windows.net/mycontainer/pageblob"". Вы можете добавить SAS при использовании AnonymousCredential, например "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString"".
- 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.
Сведения о свойстве
containerName
Имя контейнера хранилища, с которым связан большой двоичный объект.
string containerName
Значение свойства
string
name
Имя большого двоичного объекта.
string name
Значение свойства
string
Сведения об унаследованном свойстве
accountName
credential
Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity
данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Значение свойства
Наследуется отblobClient.credential
url
Закодированное значение строки URL-адреса.
url: string
Значение свойства
string
Наследуется отBlobClient.url
Сведения о методе
clearPages(number, number, PageBlobClearPagesOptions)
Освобождает указанные страницы из страничного BLOB-объекта.
См. раздел https://docs.microsoft.com/rest/api/storageservices/put-page
function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>
Параметры
- offset
-
number
Начальная позиция байтов страниц для очистки.
- count
-
number
Число байтов для очистки.
- options
- PageBlobClearPagesOptions
Параметры для операции очистки страниц большого двоичного объекта.
Возвращаемое значение
Promise<PageBlobClearPagesResponse>
Данные ответа для операции очистки страниц страничного BLOB-объекта.
create(number, PageBlobCreateOptions)
Создает страничный BLOB-объект указанной длины. Вызов uploadPages для отправки данных в страничный BLOB-объект.
См. раздел https://docs.microsoft.com/rest/api/storageservices/put-blob
function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>
Параметры
- size
-
number
размер страничного BLOB-объекта.
- options
- PageBlobCreateOptions
Параметры операции создания страничного BLOB-объекта.
Возвращаемое значение
Promise<PageBlobCreateResponse>
Данные ответа для операции создания страничного BLOB-объекта.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)
Создает страничный BLOB-объект указанной длины. Вызов uploadPages для отправки данных в страничный BLOB-объект. Если большой двоичный объект с таким же именем уже существует, содержимое существующего большого двоичного объекта останется неизменным.
См. раздел https://docs.microsoft.com/rest/api/storageservices/put-blob
function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>
Параметры
- size
-
number
размер страничного BLOB-объекта.
- options
- PageBlobCreateIfNotExistsOptions
Возвращаемое значение
Promise<PageBlobCreateIfNotExistsResponse>
getPageRanges(number, number, PageBlobGetPageRangesOptions)
Возвращает список допустимых диапазонов страниц для страничного BLOB-объекта или моментального снимка страничного BLOB-объекта.
См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>
Параметры
- offset
-
number
Начальная позиция в байтах диапазонов страниц.
- count
-
number
Число байтов для получения.
- options
- PageBlobGetPageRangesOptions
Параметры операции получения диапазонов страничного BLOB-объекта.
Возвращаемое значение
Promise<PageBlobGetPageRangesResponse>
Данные ответа для операции получения диапазонов страничного BLOB-объекта.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)
Возвращает коллекцию диапазонов страниц, которые отличаются между указанным моментальным снимком и данным страничного BLOB-объекта.
См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>
Параметры
- offset
-
number
Начальная позиция байтов страничного BLOB-объекта
- count
-
number
Число байтов для получения различий в диапазонах.
- prevSnapshot
-
string
Метка времени моментального снимка для получения разницы.
- options
- PageBlobGetPageRangesDiffOptions
Параметры операции "Размеять диапазоны страниц" для страничного BLOB-объекта.
Возвращаемое значение
Promise<PageBlobGetPageRangesDiffResponse>
Ответные данные для операции "Получение различия диапазона страниц" в большом двоичном объекте.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)
Возвращает коллекцию диапазонов страниц, которые отличаются между указанным моментальным снимком и данным страничного BLOB-объекта для управляемых дисков.
См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>
Параметры
- offset
-
number
Начальная позиция байтов страничного BLOB-объекта
- count
-
number
Число байтов для получения различий в диапазонах.
- prevSnapshotUrl
-
string
URL-адрес моментального снимка для получения разницы.
- options
- PageBlobGetPageRangesDiffOptions
Параметры операции "Размеять диапазоны страниц" для страничного BLOB-объекта.
Возвращаемое значение
Promise<PageBlobGetPageRangesDiffResponse>
Ответные данные для операции "Получение различия диапазона страниц" в большом двоичном объекте.
listPageRanges(number, number, PageBlobListPageRangesOptions)
Возвращает асинхронный итератор для списка диапазонов страниц для страничного BLOB-объекта.
См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
.byPage() возвращает асинхронный итератор для списка диапазонов страниц для страничного BLOB-объекта.
Пример использования синтаксиса for await
:
// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
Пример, использующий среду iter.next()
:
let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
pageRangeItem = await iter.next();
}
Пример, использующий среду byPage()
:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
for (const pageRange of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
}
Пример использования разбиения по страницам с маркером:
let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
for (const pageRange of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
for (const blob of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>
Параметры
- offset
-
number
Начальная позиция в байтах диапазонов страниц.
- count
-
number
Число байтов для получения.
- options
- PageBlobListPageRangesOptions
Параметры операции получения диапазонов страничного BLOB-объекта.
Возвращаемое значение
AsyncIterableIterator, поддерживающий разбиение по страницам.
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)
Возвращает асинхронный итератор для списка диапазонов страниц, которые отличаются между указанным моментальным снимком и этим страничного BLOB-объекта.
См. раздел https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
.byPage() возвращает асинхронный итератор для списка диапазонов страниц, которые отличаются между указанным моментальным снимком и этим страничного BLOB-объекта.
Пример использования синтаксиса for await
:
// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
Пример, использующий среду iter.next()
:
let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
pageRangeItem = await iter.next();
}
Пример, использующий среду byPage()
:
// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
for (const pageRange of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
}
Пример использования разбиения по страницам с маркером:
let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 page ranges
for (const pageRange of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 page ranges
for (const blob of response) {
console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>
Параметры
- offset
-
number
Начальная позиция в байтах диапазонов страниц.
- count
-
number
Число байтов для получения.
- prevSnapshot
-
string
Метка времени моментального снимка для получения разницы.
Параметры операции получения диапазонов страничного BLOB-объекта.
Возвращаемое значение
AsyncIterableIterator, поддерживающий разбиение по страницам.
resize(number, PageBlobResizeOptions)
Изменяет размер страничного BLOB-объекта до указанного размера (который должен быть кратным 512).
См. раздел https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>
Параметры
- size
-
number
целевой размер;
- options
- PageBlobResizeOptions
Параметры операции изменения размера страничного BLOB-объекта.
Возвращаемое значение
Promise<PageBlobResizeResponse>
Данные ответа для операции изменения размера страничного BLOB-объекта.
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)
Начинает операцию запуска добавочного копирования моментального снимка одного страничного BLOB-объекта в этот страничный BLOB-объект. Моментальный снимок копируется таким образом, что в назначение передаются только разностные изменения между ранее скопированным моментальным снимком. Скопированные моментальные снимки являются полными копиями исходного моментального снимка и могут быть прочитаны или скопированы из них, как обычно.
См. раздел https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob См. https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>
Параметры
- copySource
-
string
Указывает имя моментального снимка BLOB-объекта исходной страницы. Например https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=.
Параметры добавочной операции копирования страничного BLOB-объекта.
Возвращаемое значение
Promise<PageBlobCopyIncrementalResponse>
Данные ответа для добавочной операции копирования страничного BLOB-объекта.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)
Задает порядковый номер страничного BLOB-объекта.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>
Параметры
- sequenceNumberAction
- SequenceNumberActionType
Указывает, как служба должна изменять порядковый номер большого двоичного объекта.
- sequenceNumber
-
number
Требуется, если sequenceNumberAction имеет значение max или update
Параметры операции номер последовательного номера обновления страничного BLOB-объекта.
Возвращаемое значение
Promise<PageBlobUpdateSequenceNumberResponse>
Данные ответа для операции "Номер последовательного номера обновления страничного BLOB-объекта".
uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)
Записывает 1 или более страниц в страничный BLOB-объект. Начальные и конечные смещения должны быть кратными 512.
См. раздел https://docs.microsoft.com/rest/api/storageservices/put-page
function uploadPages(body: RequestBodyType, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>
Параметры
- body
- HttpRequestBody
Данные для отправки
- offset
-
number
Смещение целевого страничного BLOB-объекта
- count
-
number
Длина содержимого текста, а также количество байтов для отправки
- options
- PageBlobUploadPagesOptions
Параметры для операции "Отправка страниц BLOB-объектов".
Возвращаемое значение
Promise<PageBlobUploadPagesResponse>
Данные ответа для операции "Отправка страниц BLOB-объектов".
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)
Операция Отправки страниц записывает диапазон страниц в страничный BLOB-объект, где содержимое считывается из URL-адреса.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>
Параметры
- sourceURL
-
string
Укажите URL-адрес источника копирования. Возможно, для проверки подлинности требуется подписанный URL-адрес (SAS)
- sourceOffset
-
number
Исходное смещение для копирования. Передайте 0 для копирования из начала исходной страницы BLOB-объекта
- destOffset
-
number
Смещение целевого страничного BLOB-объекта
- count
-
number
Число байтов для отправки из исходного страничного BLOB-объекта
Возвращаемое значение
Promise<PageBlobUploadPagesFromURLResponse>
withSnapshot(string)
Создает объект PageBlobClient, идентичный источнику, но с указанной меткой времени моментального снимка. Укажите "", чтобы удалить моментальный снимок и вернуть клиент в базовый BLOB-объект.
function withSnapshot(snapshot: string): PageBlobClient
Параметры
- snapshot
-
string
Метка времени моментального снимка.
Возвращаемое значение
Новый объект PageBlobClient, идентичный источнику, но с указанной меткой времени моментального снимка.
Сведения о наследуемом методе
abortCopyFromURL(string, BlobAbortCopyFromURLOptions)
Прерывает ожидающие асинхронные операции копирования BLOB-объекта и оставляет целевой BLOB-объект с нулевой длиной и полными метаданными. Версия 12.02.2012 и более поздние.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>
Параметры
- copyId
-
string
Идентификатор операции копирования из URL-адреса.
- options
- BlobAbortCopyFromURLOptions
Необязательные параметры для операции прерывания копирования BLOB-объекта из URL-адреса.
Возвращаемое значение
Promise<BlobAbortCopyFromURLResponse>
Наследуется отblobClient.abortCopyFromURL
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)
Асинхронно копирует большой двоичный объект в место назначения в учетной записи хранения.
Этот метод возвращает средство опроса длительных операций, которое позволяет бесконечно ждать завершения копирования.
Вы также можете отменить копию до ее завершения, вызвав cancelOperation
в опрашиватель.
Обратите внимание, что обратный вызов onProgress не будет вызываться, если операция завершится в первом запросе, а попытка отменить завершенную копию приведет к ошибке.
В версии 2012-02-12 и более поздних версиях источником операции копирования BLOB-объекта может быть зафиксированный BLOB-объект в любой учетной записи хранения Azure. Начиная с версии 2015-02-21, источником операции копирования BLOB-объектов может быть файл Azure в любой учетной записи хранения Azure. Только учетные записи хранилища, созданные 7 июня 2012 года или позже, позволяют использовать операцию Copy Blob для копирования из другой учетной записи хранилища.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
Пример использования автоматического опроса:
const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();
Пример использования опроса вручную:
const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
await poller.poll();
}
const result = copyPoller.getResult();
Пример использования обновлений хода выполнения:
const copyPoller = await blobClient.beginCopyFromURL('url', {
onProgress(state) {
console.log(`Progress: ${state.copyProgress}`);
}
});
const result = await copyPoller.pollUntilDone();
Пример использования изменяющегося интервала опроса (по умолчанию 15 секунд):
const copyPoller = await blobClient.beginCopyFromURL('url', {
intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
Пример использования отмены копирования:
const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
await copyPoller.cancelOperation();
// calls to get the result now throw PollerCancelledError
await copyPoller.getResult();
} catch (err) {
if (err.name === 'PollerCancelledError') {
console.log('The copy was cancelled.');
}
}
function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Параметры
- copySource
-
string
URL-адрес исходного BLOB-объекта Или файла Azure.
- options
- BlobBeginCopyFromURLOptions
Необязательные параметры для операции Начать копирование BLOB-объекта с URL-адреса.
Возвращаемое значение
Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Наследуется отblobClient.beginCopyFromURL
createSnapshot(BlobCreateSnapshotOptions)
Создает доступный только для чтения моментальный снимок BLOB-объекта.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>
Параметры
- options
- BlobCreateSnapshotOptions
Необязательные параметры операции создания моментального снимка BLOB-объекта.
Возвращаемое значение
Promise<BlobCreateSnapshotResponse>
Наследуется отblobClient.createSnapshot
delete(BlobDeleteOptions)
Помечает указанный большой двоичный объект или моментальный снимок для удаления. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>
Параметры
- options
- BlobDeleteOptions
Необязательные параметры для операции удаления BLOB-объектов.
Возвращаемое значение
Promise<BlobDeleteResponse>
Наследуется отblobClient.delete
deleteIfExists(BlobDeleteOptions)
Помечает указанный большой двоичный объект или моментальный снимок для удаления, если он существует. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>
Параметры
- options
- BlobDeleteOptions
Необязательные параметры для операции удаления BLOB-объектов.
Возвращаемое значение
Promise<BlobDeleteIfExistsResponse>
Наследуется отblobClient.deleteIfExists
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Удалите политику immutablility в большом двоичном объекте.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Параметры
Необязательные параметры для удаления политики неизменяемости большого двоичного объекта.
Возвращаемое значение
Promise<BlobDeleteImmutabilityPolicyResponse>
Наследуется отblobClient.deleteImmutabilityPolicy
download(number, number, BlobDownloadOptions)
Считывает или скачивает большой двоичный объект из системы, включая его метаданные и свойства. Вы также можете вызвать метод Get Blob для чтения моментального снимка.
- В Node.js данные возвращаются в потоке readableStreamBody.
- В браузерах данные возвращаются в обещанном blobBody
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Параметры
- offset
-
number
Расположение большого двоичного объекта для скачивания, больше или равное 0
- count
-
number
Объем загружаемых данных, превышающий 0. Скачивание до конца, если значение не определено
- options
- BlobDownloadOptions
Необязательные параметры для операции скачивания BLOB-объектов.
Пример использования (Node.js):
// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());
async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
Пример использования (браузер):
// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
"Downloaded blob content",
downloaded
);
async function blobToString(blob: Blob): Promise<string> {
const fileReader = new FileReader();
return new Promise<string>((resolve, reject) => {
fileReader.onloadend = (ev: any) => {
resolve(ev.target!.result);
};
fileReader.onerror = reject;
fileReader.readAsText(blob);
});
}
Возвращаемое значение
Promise<BlobDownloadResponseParsed>
Наследуется отblobClient.download
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Скачивает весь большой двоичный объект, если они не указаны.
Предупреждение. Буферы могут поддерживать файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для больших двоичных объектов, превышающих этот размер, рассмотрите возможность downloadToFile.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Параметры
- buffer
-
Buffer
Буфер для заполнения должен иметь длину больше, чем число
- offset
-
number
Расположение блочного BLOB-объекта для скачивания (в байтах)
- count
-
number
Объем скачиваемых данных (в байтах). Скачивание до конца при передаче неопределенного значения
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Возвращаемое значение
Promise<Buffer>
Наследуется отblobClient.downloadToBuffer
downloadToBuffer(number, number, BlobDownloadToBufferOptions)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Скачивает BLOB-объект Azure параллельно в буфер. Смещение и счетчик являются необязательными. Скачивает весь большой двоичный объект, если они не указаны.
Предупреждение. Буферы могут поддерживать файлы размером до одного гигабайта в 32-разрядных системах или около двух гигабайт в 64-разрядных системах из-за ограничений Node.js/V8. Для больших двоичных объектов, превышающих этот размер, рассмотрите возможность downloadToFile.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Параметры
- offset
-
number
Расположение блочного BLOB-объекта для скачивания (в байтах)
- count
-
number
Объем скачиваемых данных (в байтах). Скачивание до конца при передаче неопределенного значения
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Возвращаемое значение
Promise<Buffer>
Наследуется отblobClient.downloadToBuffer
downloadToFile(string, number, number, BlobDownloadOptions)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Скачивает BLOB-объект Azure в локальный файл. Сбой, если указанный путь к файлу уже завершается. Смещение и счетчик являются необязательными. Для скачивания всего большого двоичного объекта необходимо передать значение 0 и значение undefined соответственно.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Параметры
- filePath
-
string
- offset
-
number
Расположение блочного BLOB-объекта для скачивания.
- count
-
number
Объем загружаемых данных. Скачивание до конца при передаче undefined.
- options
- BlobDownloadOptions
Параметры для параметров скачивания BLOB-объектов.
Возвращаемое значение
Promise<BlobDownloadResponseParsed>
Данные ответа для операции скачивания BLOB-объектов, но с параметром readableStreamBody, для параметра undefined, так как его содержимое уже считывается и записывается в локальный файл по указанному пути.
Наследуется отblobClient.downloadToFile
exists(BlobExistsOptions)
Возвращает значение true, если ресурс BLOB-объекта Azure, представленный этим клиентом, существует; В противном случае значение false.
ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий BLOB-объект может быть удален другими клиентами или приложениями. И наоборот, после выполнения этой функции новые большие двоичные объекты могут добавляться другими клиентами или приложениями.
function exists(options?: BlobExistsOptions): Promise<boolean>
Параметры
- options
- BlobExistsOptions
параметров для операции Exists.
Возвращаемое значение
Promise<boolean>
Наследуется отblobClient.exists
generateSasUrl(BlobGenerateSasUrlOptions)
Доступно только для BlobClient, созданного с учетными данными общего ключа.
Создает URI подписанного URL-адреса службы BLOB-объектов (SAS) на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>
Параметры
- options
- BlobGenerateSasUrlOptions
Дополнительные параметры.
Возвращаемое значение
Promise<string>
URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.
Наследуется отblobClient.generateSasUrl
getAppendBlobClient()
Создает объект AppendBlobClient.
function getAppendBlobClient(): AppendBlobClient
Возвращаемое значение
Наследуется отblobClient.getAppendBlobClient
getBlobLeaseClient(string)
Получите BlobLeaseClient , который управляет арендой большого двоичного объекта.
function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient
Параметры
- proposeLeaseId
-
string
Первоначальный предлагаемый идентификатор аренды.
Возвращаемое значение
Новый объект BlobLeaseClient для управления арендой большого двоичного объекта.
Наследуется отblobClient.getBlobLeaseClient
getBlockBlobClient()
Создает объект BlockBlobClient.
function getBlockBlobClient(): BlockBlobClient
Возвращаемое значение
Наследуется отblobClient.getBlockBlobClient
getPageBlobClient()
Создает объект PageBlobClient.
function getPageBlobClient(): PageBlobClient
Возвращаемое значение
Наследуется отblobClient.getPageBlobClient
getProperties(BlobGetPropertiesOptions)
Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства большого двоичного объекта. Операция не возвращает содержимое большого двоичного объекта.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
ВНИМАНИЕ! Ключи metadata
объекта, возвращенного в ответе, будут содержаться в нижнем регистре, даже если они изначально содержали символы верхнего регистра. Это отличается от ключей метаданных, возвращаемых методами ContainerClient , которые перечисляют большие двоичные объекты с помощью includeMetadata
параметра , который сохранит их исходный регистр.
function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>
Параметры
- options
- BlobGetPropertiesOptions
Необязательные параметры для операции получения свойств.
Возвращаемое значение
Promise<BlobGetPropertiesResponse>
Наследуется отblobClient.getProperties
getTags(BlobGetTagsOptions)
Возвращает теги, связанные с базовым BLOB-объектом.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Параметры
- options
- BlobGetTagsOptions
Возвращаемое значение
Promise<BlobGetTagsResponse>
Наследуется отblobClient.getTags
setAccessTier(string, BlobSetTierOptions)
Задает уровень для BLOB-объекта. Операция разрешена для страничного BLOB-объекта в учетной записи хранения класса Premium и блочного BLOB-объекта в учетной записи хранения BLOB-объектов (только локально избыточное хранилище). Уровень страничного BLOB-объекта ценовой категории "Премиум" определяет допустимый размер, количество операций ввода-вывода в секунду и пропускную способность большого двоичного объекта. Уровень блочного BLOB-объекта определяет тип горячего, холодного и архивного хранилища. Эта операция не обновляет ETag BLOB-объекта.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>
Параметры
- tier
-
string
Уровень, который необходимо задать для большого двоичного объекта. Допустимые значения: Hot, Cool или Archive.
- options
- BlobSetTierOptions
Необязательные параметры для операции установки уровня BLOB-объектов.
Возвращаемое значение
Promise<BlobSetTierResponse>
Наследуется отblobClient.setAccessTier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Задает системные свойства для большого двоичного объекта.
Если значение не указано или не указано значение для указанных HTTP-заголовков BLOB-объектов, эти http-заголовки больших двоичных объектов без значения будут очищены.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
Параметры
- blobHTTPHeaders
- BlobHTTPHeaders
Если значение не указано или не указано значение для указанных HTTP-заголовков BLOB-объектов, эти http-заголовки больших двоичных объектов без значения будут очищены.
Общий заголовок, который необходимо задать, позволяет blobContentType
браузеру предоставлять функциональные возможности в зависимости от типа файла.
- options
- BlobSetHTTPHeadersOptions
Необязательные параметры для операции установки заголовков HTTP для BLOB-объектов.
Возвращаемое значение
Promise<BlobSetHTTPHeadersResponse>
Наследуется отblobClient.setHTTPHeaders
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Задайте политику неизменяемости для большого двоичного объекта.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>
Параметры
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Необязательные параметры для установки политики неизменяемости для большого двоичного объекта.
Возвращаемое значение
Promise<BlobSetImmutabilityPolicyResponse>
Наследуется отblobClient.setImmutabilityPolicy
setLegalHold(boolean, BlobSetLegalHoldOptions)
Установите удержание по юридическим причинам для большого двоичного объекта.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>
Параметры
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Необязательные параметры для установки удержания большого двоичного объекта по юридическим причинам.
Возвращаемое значение
Promise<BlobSetLegalHoldResponse>
Наследуется отblobClient.setLegalHold
setMetadata(Metadata, BlobSetMetadataOptions)
Задает определяемые пользователем метаданные для определенного большого двоичного объекта в виде одной или нескольких пар "имя — значение".
Если параметр не указан или метаданные не определены в параметре, метаданные BLOB-объекта будут удалены.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>
Параметры
- metadata
- Metadata
Замените существующие метаданные этим значением. Если значение не указано, существующие метаданные будут удалены.
- options
- BlobSetMetadataOptions
Необязательные параметры для операции задания метаданных.
Возвращаемое значение
Promise<BlobSetMetadataResponse>
Наследуется отblobClient.setMetadata
setTags(Tags, BlobSetTagsOptions)
Задает теги для базового BLOB-объекта. Большой двоичный объект может содержать до 10 тегов. Ключи тегов должны содержать от 1 до 128 символов. Значения тегов должны быть от 0 до 256 символов. Допустимые символы ключа и значения тега включают строчные и прописные буквы, цифры (0–9), пробел (' '), плюс ('+'), минус ('-'), точку ('.'), косую черту ('/'), двоеточие (':'), равно ('=') и подчеркивание ('_') .
function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>
Параметры
- tags
- Tags
- options
- BlobSetTagsOptions
Возвращаемое значение
Promise<BlobSetTagsResponse>
Наследуется отblobClient.setTags
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
Синхронная операция копирования из URL-адреса копирует большой двоичный объект или интернет-ресурс в новый BLOB-объект. Он не вернет ответ до завершения копирования.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>
Параметры
- copySource
-
string
Исходный URL-адрес для копирования, подписанный URL-адрес (SAS), возможно, необходим для проверки подлинности.
- options
- BlobSyncCopyFromURLOptions
Возвращаемое значение
Promise<BlobCopyFromURLResponse>
Наследуется отblobClient.syncCopyFromURL
undelete(BlobUndeleteOptions)
Восстанавливает содержимое и метаданные обратимо удаленного BLOB-объекта и всех связанных обратимо удаленных моментальных снимков. Отмена удаления BLOB-объекта поддерживается только в версии 2017-07-29 или более поздней.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>
Параметры
- options
- BlobUndeleteOptions
Необязательные параметры операции отмены удаления BLOB-объектов.
Возвращаемое значение
Promise<BlobUndeleteResponse>
Наследуется отblobClient.undelete
withVersion(string)
Создает новый объект BlobClient, указывающий на версию этого BLOB-объекта. При указании "" будет удален идентификатор versionId и возвращен клиент в базовый BLOB-объект.
function withVersion(versionId: string): BlobClient
Параметры
- versionId
-
string
VersionId.
Возвращаемое значение
Новый объект BlobClient, указывающий на версию этого большого двоичного объекта.
Наследуется отblobClient.withVersion