Partilhar via

BlobBatchClient class

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

Um BlobBatchClient permite que você faça solicitações em lote para o serviço de Blob de Armazenamento do Azure.

Visualizar 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 exclusão para marcar os blobs ou instantâneos especificados para exclusão. Observe que, para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo. Consulte excluir detalhes da operação. A operação (subsolicitação) será autenticada e autorizada com credencial especificada. Consulte detalhes de autorização de lote de blob.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Crie várias operações de exclusão para marcar os blobs ou instantâneos especificados para exclusão. Observe que, para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo. Consulte excluir detalhes da operação. As operações serão autenticadas e autorizadas com credencial especificada. Consulte detalhes de autorização de lote de blob.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Crie várias operações de camada definida para definir a camada em um blob. A operação é permitida em um blob de página em uma conta de armazenamento premium e em um blob de bloco em uma conta de armazenamento de blob (somente armazenamento redundante localmente). A camada de um blob de página premium determina o tamanho, IOPS e largura de banda permitidos do blob. A camada de um blob de bloco determina o tipo de armazenamento Hot/Cool/Archive. Esta operação não atualiza o ETag do blob. Consulte definir detalhes da camada de blob. A operação (subsolicitação) será autenticada e autorizada com credencial especificada. Consulte detalhes de autorização de lote de blob.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Crie várias operações de camada definida para definir a camada em um blob. A operação é permitida em um blob de página em uma conta de armazenamento premium e em um blob de bloco em uma conta de armazenamento de blob (somente armazenamento redundante localmente). A camada de um blob de página premium determina o tamanho, IOPS e largura de banda permitidos do blob. A camada de um blob de bloco determina o tipo de armazenamento Hot/Cool/Archive. Esta operação não atualiza o ETag do blob. Consulte definir detalhes da camada de blob. A operação (subsolicitação) será autenticada e autorizada com credencial especificada. Consulte detalhes de autorização de lote de blob.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Envie uma solicitação em lote que consiste em várias subsolicitações.

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

Exemplo de uso:

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 de utilização de um contrato de arrendamento:

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

Visualizar 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

Uma url apontando para o serviço de blob de Armazenamento do Azure, como "https://myaccount.blob.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Chame newPipeline() para criar um pipeline padrão 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

Uma url apontando para o serviço de blob de Armazenamento do Azure, como "https://myaccount.blob.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

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 exclusão para marcar os blobs ou instantâneos especificados para exclusão. Observe que, para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo. Consulte excluir detalhes da operação. A operação (subsolicitação) será autenticada e autorizada com credencial especificada. Consulte detalhes de autorização de lote de blob.

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

Parâmetros

blobClients

BlobClient[]

Os BlobClients para os blobs a serem excluídos.

options
BlobDeleteOptions

Devoluções

Promise<BlobBatchSubmitBatchResponse>

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

Crie várias operações de exclusão para marcar os blobs ou instantâneos especificados para exclusão. Observe que, para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo. Consulte excluir detalhes da operação. As operações serão autenticadas e autorizadas com credencial especificada. Consulte detalhes de autorização de lote de blob.

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

Parâmetros

urls

string[]

As urls dos recursos de blob a serem excluídos.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

options
BlobDeleteOptions

Devoluções

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Crie várias operações de camada definida para definir a camada em um blob. A operação é permitida em um blob de página em uma conta de armazenamento premium e em um blob de bloco em uma conta de armazenamento de blob (somente armazenamento redundante localmente). A camada de um blob de página premium determina o tamanho, IOPS e largura de banda permitidos do blob. A camada de um blob de bloco determina o tipo de armazenamento Hot/Cool/Archive. Esta operação não atualiza o ETag do blob. Consulte definir detalhes da camada de blob. A operação (subsolicitação) será autenticada e autorizada com credencial especificada. Consulte detalhes de autorização de lote de blob.

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

Parâmetros

blobClients

BlobClient[]

Os BlobClients para os blobs que devem ter um novo conjunto de camadas.

tier
AccessTier
options
BlobSetTierOptions

Devoluções

Promise<BlobBatchSubmitBatchResponse>

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

Crie várias operações de camada definida para definir a camada em um blob. A operação é permitida em um blob de página em uma conta de armazenamento premium e em um blob de bloco em uma conta de armazenamento de blob (somente armazenamento redundante localmente). A camada de um blob de página premium determina o tamanho, IOPS e largura de banda permitidos do blob. A camada de um blob de bloco determina o tipo de armazenamento Hot/Cool/Archive. Esta operação não atualiza o ETag do blob. Consulte definir detalhes da camada de blob. A operação (subsolicitação) será autenticada e autorizada com credencial especificada. Consulte detalhes de autorização de lote de blob.

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

Parâmetros

urls

string[]

As urls do recurso de blob a ser excluído.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

tier
AccessTier
options
BlobSetTierOptions

Devoluções

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Envie uma solicitação em lote que consiste em várias subsolicitações.

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

Exemplo de uso:

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 de utilização de um contrato de arrendamento:

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

Visualizar 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>