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

BlobBatchClient class

  • Ссылка
Пакет:
@azure/storage-blob

BlobBatchClient позволяет выполнять пакетные запросы к службе BLOB-объектов службы хранилища Azure.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch

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

BlobBatchClient(string, PipelineLike)

Создает экземпляр BlobBatchClient.
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

Методы

createBatch()

Создает BLOBBatch. BlobBatch представляет агрегированный набор операций в больших двоичных объектах.
deleteBlobs(BlobClient[], BlobDeleteOptions)

Создайте несколько операций удаления, чтобы пометить указанные большие двоичные объекты или моментальные снимки для удаления. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете одновременно удалить оба варианта. См. сведения об операции удаления . Операция (subrequest) будет проходить проверку подлинности и авторизована с указанными учетными данными. Дополнительные сведения пакетной авторизации BLOB-объектов.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Создайте несколько операций удаления, чтобы пометить указанные большие двоичные объекты или моментальные снимки для удаления. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете одновременно удалить оба варианта. См. сведения об операции удаления . Операции будут проходить проверку подлинности и авторизованы с указанными учетными данными. Дополнительные сведения пакетной авторизации BLOB-объектов.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Создайте несколько операций уровня набора, чтобы задать уровень в большом двоичном объекте. Операция разрешена на странице большого двоичного объекта в учетной записи хранения класса Premium и в блочных BLOB-объектах в учетной записи хранения BLOB-объектов (только локально избыточное хранилище). Уровень большого двоичного объекта страницы уровня "Премиум" определяет допустимый размер, операции ввода-вывода в секунду и пропускную способность большого двоичного объекта. Уровень блочного большого двоичного объекта определяет тип хранилища Hot/Cool/Archive. Эта операция не обновляет ETag большого двоичного объекта. Дополнительные сведения уровня BLOB-объектов см. в. Операция (subrequest) будет проходить проверку подлинности и авторизована с указанными учетными данными. Дополнительные сведения пакетной авторизации BLOB-объектов.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

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

Отправьте пакетный запрос, состоящий из нескольких вложенных запросов.

Получите blobBatchClient и другие сведения перед запуском фрагментов. blobServiceClient.getBlobBatchClient() предоставляет blobBatchClient

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

let batchRequest = new BlobBatch();
await batchRequest.deleteBlob(urlInString0, credential0);
await batchRequest.deleteBlob(urlInString1, credential1, {
 deleteSnapshots: "include"
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

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

let batchRequest = new BlobBatch();
await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
 conditions: { leaseId: leaseId }
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

См. https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch

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

BlobBatchClient(string, PipelineLike)

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

new BlobBatchClient(url: string, pipeline: PipelineLike)

Параметры

url

string

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

pipeline
PipelineLike

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

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

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

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

Параметры

url

string

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

Параметры настройки конвейера HTTP.

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

createBatch()

Создает BLOBBatch. BlobBatch представляет агрегированный набор операций в больших двоичных объектах.

function createBatch(): BlobBatch

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

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

Создайте несколько операций удаления, чтобы пометить указанные большие двоичные объекты или моментальные снимки для удаления. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете одновременно удалить оба варианта. См. сведения об операции удаления . Операция (subrequest) будет проходить проверку подлинности и авторизована с указанными учетными данными. Дополнительные сведения пакетной авторизации BLOB-объектов.

function deleteBlobs(blobClients: BlobClient[], options?: BlobDeleteOptions): Promise<BlobBatchSubmitBatchResponse>

Параметры

blobClients

BlobClient[]

BlobClients для удаленных BLOB-объектов.

options
BlobDeleteOptions

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

Promise<BlobBatchSubmitBatchResponse>

deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

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

function deleteBlobs(urls: string[], credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobDeleteOptions): Promise<BlobBatchSubmitBatchResponse>

Параметры

urls

string[]

URL-адреса удаленных ресурсов BLOB-объектов.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
BlobDeleteOptions

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

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

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

function setBlobsAccessTier(blobClients: BlobClient[], tier: AccessTier, options?: BlobSetTierOptions): Promise<BlobBatchSubmitBatchResponse>

Параметры

blobClients

BlobClient[]

BlobClients для больших двоичных объектов, которые должны иметь новый набор уровней.

tier
AccessTier
options
BlobSetTierOptions

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

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

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

function setBlobsAccessTier(urls: string[], credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, tier: AccessTier, options?: BlobSetTierOptions): Promise<BlobBatchSubmitBatchResponse>

Параметры

urls

string[]

URL-адреса ресурса большого двоичного объекта для удаления.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

tier
AccessTier
options
BlobSetTierOptions

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

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Отправьте пакетный запрос, состоящий из нескольких вложенных запросов.

Получите blobBatchClient и другие сведения перед запуском фрагментов. blobServiceClient.getBlobBatchClient() предоставляет blobBatchClient

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

let batchRequest = new BlobBatch();
await batchRequest.deleteBlob(urlInString0, credential0);
await batchRequest.deleteBlob(urlInString1, credential1, {
 deleteSnapshots: "include"
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

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

let batchRequest = new BlobBatch();
await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
 conditions: { leaseId: leaseId }
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

См. https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch

function submitBatch(batchRequest: BlobBatch, options?: BlobBatchSubmitBatchOptionalParams): Promise<BlobBatchSubmitBatchResponse>

Параметры

batchRequest
BlobBatch

Набор операций Delete или SetTier.

options
BlobBatchSubmitBatchOptionalParams

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

Promise<BlobBatchSubmitBatchResponse>