Partilhar via

BlobBatchClient class

  • Referência
Pacote:
@azure/storage-blob

Um BlobBatchClient permite-lhe fazer pedidos em lotes para o serviço Blob de Armazenamento do Azure.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

Construtores

BlobBatchClient(string, PipelineLike)

Cria uma instância de BlobBatchClient.
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância de BlobBatchClient.

Métodos

createBatch()

Cria um BlobBatch. Um BlobBatch representa um conjunto agregado de operações em blobs.
deleteBlobs(BlobClient[], BlobDeleteOptions)

Crie várias operações de eliminação para marcar os blobs ou instantâneos especificados para eliminação. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo. Veja eliminar detalhes da operação. A operação (subrequesto) será autenticada e autorizada com a credencial especificada. Veja os detalhes de autorização do lote de blobs.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Crie várias operações de eliminação para marcar os blobs ou instantâneos especificados para eliminação. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo. Veja eliminar detalhes da operação. As operações serão autenticadas e autorizadas com credenciais especificadas. Veja os detalhes de autorização do lote de blobs.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Crie várias operações de escalão definido para definir a camada num blob. A operação é permitida num blob de páginas numa conta de armazenamento premium e num blob de blocos numa conta de armazenamento de blobs (apenas armazenamento localmente redundante). O escalão de um blob de páginas premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Frequente/Esporádico/Arquivo. Esta operação não atualiza a ETag do blob. Veja Definir detalhes da camada de blobs. A operação (subrequesto) será autenticada e autorizada com a credencial especificada. Veja os detalhes de autorização do lote de blobs.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Crie várias operações de escalão definido para definir a camada num blob. A operação é permitida num blob de páginas numa conta de armazenamento premium e num blob de blocos numa conta de armazenamento de blobs (apenas armazenamento localmente redundante). O escalão de um blob de páginas premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Frequente/Esporádico/Arquivo. Esta operação não atualiza a ETag do blob. Veja Definir detalhes da camada de blobs. A operação (subrequesto) será autenticada e autorizada com a credencial especificada. Veja os detalhes de autorização do lote de blobs.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Submeta um pedido em lote que consiste em vários sub-requisitos.

Obtenha blobBatchClient e outros detalhes antes de executar os fragmentos. blobServiceClient.getBlobBatchClient() dá o blobBatchClient

Utilização de exemplo: 

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);

Exemplo com uma concessão:

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);

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

Detalhes do Construtor

BlobBatchClient(string, PipelineLike)

Cria uma instância de BlobBatchClient.

new BlobBatchClient(url: string, pipeline: PipelineLike)

Parâmetros

url

string

Um URL a apontar para o serviço de blobs do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Chame newPipeline() para criar um pipeline predefinido ou forneça um pipeline personalizado.

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

Cria uma instância de BlobBatchClient.

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

Parâmetros

url

string

Um URL a apontar para o serviço de blobs do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos para o serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

options
StoragePipelineOptions

Opções para configurar o pipeline HTTP.

Detalhes de Método

createBatch()

Cria um BlobBatch. Um BlobBatch representa um conjunto agregado de operações em blobs.

function createBatch(): BlobBatch

Devoluções

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

Crie várias operações de eliminação para marcar os blobs ou instantâneos especificados para eliminação. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo. Veja eliminar detalhes da operação. A operação (subrequesto) será autenticada e autorizada com a credencial especificada. Veja os detalhes de autorização do lote de blobs.

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

Parâmetros

blobClients

BlobClient[]

Os BlobClients para os blobs eliminarem.

options
BlobDeleteOptions

Devoluções

Promise<BlobBatchSubmitBatchResponse>

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

Crie várias operações de eliminação para marcar os blobs ou instantâneos especificados para eliminação. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo. Veja eliminar detalhes da operação. As operações serão autenticadas e autorizadas com credenciais especificadas. Veja os detalhes de autorização do lote de blobs.

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

Parâmetros

urls

string[]

Os URLs dos recursos de blob a eliminar.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos para o serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

options
BlobDeleteOptions

Devoluções

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Crie várias operações de escalão definido para definir a camada num blob. A operação é permitida num blob de páginas numa conta de armazenamento premium e num blob de blocos numa conta de armazenamento de blobs (apenas armazenamento localmente redundante). O escalão de um blob de páginas premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Frequente/Esporádico/Arquivo. Esta operação não atualiza a ETag do blob. Veja Definir detalhes da camada de blobs. A operação (subrequesto) será autenticada e autorizada com a credencial especificada. Veja os detalhes de autorização do lote de blobs.

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

Parâmetros

blobClients

BlobClient[]

Os BlobClients para os blobs que devem ter uma nova camada definida.

tier
AccessTier
options
BlobSetTierOptions

Devoluções

Promise<BlobBatchSubmitBatchResponse>

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

Crie várias operações de escalão definido para definir a camada num blob. A operação é permitida num blob de páginas numa conta de armazenamento premium e num blob de blocos numa conta de armazenamento de blobs (apenas armazenamento localmente redundante). O escalão de um blob de páginas premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Frequente/Esporádico/Arquivo. Esta operação não atualiza a ETag do blob. Veja Definir detalhes da camada de blobs. A operação (subrequesto) será autenticada e autorizada com a credencial especificada. Veja os detalhes de autorização do lote de blobs.

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

Parâmetros

urls

string[]

Os URLs do recurso de blob a eliminar.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos para o serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

tier
AccessTier
options
BlobSetTierOptions

Devoluções

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Submeta um pedido em lote que consiste em vários sub-requisitos.

Obtenha blobBatchClient e outros detalhes antes de executar os fragmentos. blobServiceClient.getBlobBatchClient() dá o blobBatchClient

Utilização de exemplo: 

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);

Exemplo com uma concessão:

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);

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

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

Parâmetros

batchRequest
BlobBatch

Um conjunto de operações Delete ou SetTier.

options
BlobBatchSubmitBatchOptionalParams

Devoluções

Promise<BlobBatchSubmitBatchResponse>