BlobBatchClient class

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

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

См. раздел https://docs.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)

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

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

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

Создайте несколько операций уровня набора, чтобы задать уровень в большом двоичном объекте. Операция разрешена для страничного BLOB-объекта в учетной записи хранения класса Premium и блочного BLOB-объекта в учетной записи хранения BLOB-объектов (только локально избыточное хранилище). Уровень страничного BLOB-объекта ценовой категории "Премиум" определяет допустимый размер, количество операций ввода-вывода в секунду и пропускную способность большого двоичного объекта. Уровень блочного BLOB-объекта определяет тип горячего, холодного и архивного хранилища. Эта операция не обновляет ETag BLOB-объекта. См . сведения о настройке уровня BLOB-объектов. Операция (вложенный запрос) будет проходить проверку подлинности и авторизоваться с указанными учетными данными. См . сведения об авторизации пакета 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://docs.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". Вы можете добавить SAS с помощью AnonymousCredential, например "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". Вы можете добавить SAS с помощью AnonymousCredential, например "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)

Создайте несколько операций удаления, чтобы пометить указанные большие двоичные объекты или моментальные снимки для удаления. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно. См. сведения об операции удаления. Операция (вложенный запрос) будет проходить проверку подлинности и авторизоваться с помощью указанных учетных данных. См. сведения об авторизации пакетной службы 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)

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

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

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

Параметры

urls

string[]

URL-адреса удаляемого ресурса BLOB-объекта.

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://docs.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>