Copie um blob com agendamento assíncrono usando JavaScript ou TypeScript

• .NET
• Java
• JavaScript
• Python
• Go

Este artigo mostra como copiar um blob com agendamento assíncrono usando a biblioteca de clientes do Armazenamento do Microsoft Azure para JavaScript. Você pode copiar um blob de uma origem dentro da mesma conta de armazenamento, de uma origem em uma conta de armazenamento diferente ou de qualquer objeto acessível recuperado por meio de uma solicitação HTTP GET em um URL específico. Você também pode anular uma operação de cópia pendente.

Os métodos de biblioteca de clientes abordados neste artigo usam a operação da API REST Copiar Blob e pode ser usado quando você deseja executar uma cópia com agendamento assíncrono. Para a maioria dos cenários de cópia em que você deseja mover os dados para uma conta de armazenamento e ter uma URL para o objeto de origem, confira Copiar um blob de uma URL de objeto de origem com JavaScript.

Pré-requisitos

• Os exemplos neste artigo pressupõem que você já tenha um projeto configurado para trabalhar com a biblioteca de clientes do Armazenamento de Blobs do Azure para JavaScript. Para saber mais sobre a configuração do seu projeto, incluindo a instalação de pacotes, a importação de módulos e a criação de um objeto cliente autorizado para trabalhar com recursos de dados, confira Introdução ao Armazenamento de Blobs do Azure e o JavaScript.
• O mecanismo de autorização deve ter permissões para executar uma operação de cópia ou anular uma cópia pendente. Para saber mais, consulte as diretrizes de autorização para as seguintes operações de API REST:
  • Copiar blob
  • Anular copiar Blob

Sobre como copiar blobs com agendamento assíncrono

A operação Copy Blob pode ser concluída de forma assíncrona e é executada da melhor maneira possível, o que significa que não há garantia de que a operação começará imediatamente ou será concluída dentro de um prazo especificado. A operação de cópia é agendada em segundo plano e executada conforme o servidor tem recursos disponíveis. A operação poderá ser concluída de forma síncrona se a cópia ocorrer na mesma conta de armazenamento.

Uma operação Copy Blob pode executar qualquer uma das ações a seguir:

• Copie um blob de origem em um blob de destino com outro nome. O blob de destino pode ser um blob existente do mesmo tipo de blob (blocos, acréscimo ou páginas), ou pode ser um novo blob criado pela operação de cópia.
• Copie um blob de origem para um blob de destino com o mesmo nome, isso substitui o blob de destino. Esse tipo de operação de cópia remove todos os blocos não confirmados e substitui os metadados do blob de destino.
• Copie um arquivo de origem no serviço de Arquivo do Azure para um blob de destino. O blob de destino pode ser um blob de blocos existente ou pode ser um novo blob de blocos criado pela operação de cópia. Não há suporte para a cópia de arquivos para blobs de páginas ou blobs de acréscimo.
• Copiar um instantâneo sobre seu blob de base. Promovendo um instantâneo para a posição do blob de base, você pode restaurar uma versão anterior de um blob.
• Copiar um instantâneo para um blob de destino com um nome diferente. O blob de destino resultante é um blob gravável e não um instantâneo.

Para saber mais sobre a operação Copy Blob, incluindo informações sobre propriedades, marcas de índice, metadados e cobrança, confira Copiar comentários do Blob.

Copiar um blob com agendamento assíncrono

Esta seção fornece uma visão geral dos métodos fornecidos pela biblioteca de clientes do Armazenamento do Microsoft Azure para JavaScript para executar uma operação de cópia com agendamento assíncrono.

Os seguintes métodos encapsulam a operação da API REST Copiar Blob e iniciam uma cópia assíncrona de dados do blob de origem:

• BlobClient.beginCopyFromURL

O método beginCopyFromURL retorna um instrumento de sondagem de operação de execução prolongada que permite aguardar indefinidamente até que a cópia seja concluída.

Copiar um blob de uma fonte no Azure

Se você estiver copiando um blob dentro da mesma conta de armazenamento, a operação poderá ser concluída de forma síncrona. O acesso ao blob de origem pode ser autorizado por meio do Microsoft Entra ID, uma assinatura de acesso compartilhado (SAS) ou uma chave de conta. Para uma operação de cópia síncrona alterativa, confira Copiar um blob de uma URL de objeto de origem com JavaScript.

Se a fonte da cópia for um blob em uma conta de armazenamento diferente, a operação poderá ser concluída de forma assíncrona. O blob de origem deve ser público ou autorizado por meio do token SAS. O token SAS precisa incluir a permissão de Leitura ("r"). Para saber mais sobre tokens SAS, confira Delegar acesso com assinaturas de acesso compartilhado.

O exemplo a seguir mostra um cenário para copiar um blob de origem de uma conta de armazenamento diferente com agendamento assíncrono. Neste exemplo, criamos uma URL de blob de origem com um token SAS de delegação de usuário acrescentado. O exemplo mostra como gerar o token SAS usando a biblioteca de clientes, mas você também pode fornecer o seu próprio. O exemplo também mostra como alugar o blob de origem durante a operação de cópia para impedir alterações no blob de um cliente diferente. A operação Copy Blob salva o valor ETag do blob de origem quando a operação de cópia é iniciada. Se o valor ETag for alterado antes da conclusão da operação de cópia, a operação falhará.

JavaScript

async function copyAcrossStorageAccountsAsync(sourceBlob, destinationBlob, blobServiceClient) {
  
  // Lease the source blob to prevent changes during the copy operation
  const sourceBlobLease = new BlobLeaseClient(sourceBlob);

  // Create a SAS token that's valid for 1 hour
  const sasToken = await generateUserDelegationSAS(sourceBlob, blobServiceClient);
  const sourceBlobSASURL = sourceBlob.url + "?" + sasToken;

  try {
    await sourceBlobLease.acquireLease(-1);

    // Start the copy operation and wait for it to complete
    const copyPoller = await destinationBlob.beginCopyFromURL(sourceBlobSASURL);
    await copyPoller.pollUntilDone();
  } catch (error) {
    // Handle the exception
  } finally {
    // Release the lease once the copy operation completes
    await sourceBlobLease.releaseLease();
  }
}

async function generateUserDelegationSAS(sourceBlob, blobServiceClient) {
  
  // Get a user delegation key for the Blob service that's valid for 1 hour, as an example
  const delegationKeyStart = new Date();
  const delegationKeyExpiry = new Date(Date.now() + 3600000);
  const userDelegationKey = await blobServiceClient.getUserDelegationKey(
    delegationKeyStart,
    delegationKeyExpiry
  );

  // Create a SAS token that's valid for 1 hour, as an example
  const sasTokenStart = new Date();
  const sasTokenExpiry = new Date(Date.now() + 3600000);
  const blobName = sourceBlob.name;
  const containerName = sourceBlob.containerName;
  const sasOptions = {
    blobName,
    containerName,
    permissions: BlobSASPermissions.parse("r"),
    startsOn: sasTokenStart,
    expiresOn: sasTokenExpiry,
    protocol: SASProtocol.HttpsAndHttp
  };

  const sasToken = generateBlobSASQueryParameters(
    sasOptions,
    userDelegationKey,
    blobServiceClient.accountName
  ).toString();

  return sasToken.toString();
}

TypeScript

async function copyAcrossStorageAccountsAsync(
  sourceBlob: BlockBlobClient,
  destinationBlob: BlockBlobClient,
  blobServiceClient: BlobServiceClient
): Promise<void> {
  const sourceBlobLease = new BlobLeaseClient(sourceBlob);

  // Create a SAS token that's valid for 1 hour
  const sasToken = await generateUserDelegationSAS(sourceBlob, blobServiceClient);
  const sourceBlobSASURL: string = sourceBlob.url + '?' + sasToken;

  try {
    await sourceBlobLease.acquireLease(-1);

    const copyPoller = await destinationBlob.beginCopyFromURL(sourceBlobSASURL);
    await copyPoller.pollUntilDone();
  } catch (error) {
    console.log(error);
  } finally {
    await sourceBlobLease.releaseLease();
  }
}

async function generateUserDelegationSAS(
  sourceBlob: BlockBlobClient,
  blobServiceClient: BlobServiceClient
): Promise<string> {
  // Get a user delegation key for the Blob service that's valid for 1 hour, as an example
  const delegationKeyStart = new Date();
  const delegationKeyExpiry = new Date(Date.now() + 3600000);
  const userDelegationKey = await blobServiceClient.getUserDelegationKey(
    delegationKeyStart,
    delegationKeyExpiry
  );

  // Create a SAS token that's valid for 1 hour, as an example
  const sasTokenStart = new Date();
  const sasTokenExpiry = new Date(Date.now() + 3600000);
  const blobName = sourceBlob.name;
  const containerName = sourceBlob.containerName;
  const sasOptions = {
    blobName,
    containerName,
    permissions: BlobSASPermissions.parse("r"),
    startsOn: sasTokenStart,
    expiresOn: sasTokenExpiry,
    protocol: SASProtocol.HttpsAndHttp
  };

  const sasToken = generateBlobSASQueryParameters(
    sasOptions,
    userDelegationKey,
    blobServiceClient.accountName
  ).toString();

  return sasToken.toString();
}

Observação

Os tokens SAS de delegação de usuário oferecem maior segurança, pois são assinados com as credenciais do Microsoft Entra em vez de uma chave de conta. Para criar um token SAS de delegação de usuário, a entidade de segurança do Microsoft Entra precisa de permissões apropriadas. Para obter os requisitos de autorização, consulte Obter a Chave de Delegação de Usuário.

Copiar um blob de uma origem fora do Azure

Você pode executar uma operação de cópia em qualquer objeto de origem que possa ser recuperado por meio da solicitação HTTP GET em um URL específico, incluindo objetos acessíveis fora do Azure. O exemplo a seguir mostra um cenário para copiar um blob de um URL de objeto de origem acessível.

JavaScript

async function copyFromExternalSource(sourceURL, destinationBlob) {
  
  const copyPoller = await destinationBlob.beginCopyFromURL(sourceURL);
  await copyPoller.pollUntilDone();
}

TypeScript

async function copyFromExternalSource(sourceURL: string,
  destinationBlob: BlockBlobClient
): Promise<void> {
  try {
    const copyPoller = await destinationBlob.beginCopyFromURL(sourceURL);
    await copyPoller.pollUntilDone();
  } catch (error) {
    console.log(error);
  }
}

Verificar o status de uma operação de cópia

Para verificar o status de uma operação assíncrona Copy Blob, você pode pesquisar o método getProperties e verificar o status da cópia.

O exemplo de código a seguir mostra como verificar o status de uma operação de cópia pendente:

JavaScript

async function checkCopyStatus(destinationBlob) {
  
  const properties = await destinationBlob.getProperties();
  console.log(properties.copyStatus);
}

TypeScript

async function checkCopyStatus(destinationBlob: BlockBlobClient): Promise<void> {
  const properties = await destinationBlob.getProperties();
  console.log(properties.copyStatus);
}

Anular uma operação de cópia

Anular uma operação Copy Blob resulta em um blob de destino de comprimento zero. No entanto, os metadados para o blob de destino têm os novos valores copiados do blob de origem ou definidos explicitamente durante a operação de cópia. Para manter os metadados originais de antes da cópia, obtenha um instantâneo do blob de destino antes de chamar um dos métodos de cópia.

Para anular uma operação de cópia pendente, chame a operação a seguir:

• BlobClient.abortCopyFromURL

Esse métodos encapsula a operação Anular Copiar Blob da API REST, que cancela uma operação Copy Blob pendente. O exemplo de código a seguir mostra como anular uma operação Copy Blob pendente:

JavaScript

async function abortCopy(destinationBlob) {
  
  const properties = await destinationBlob.getProperties();

  // Check the copy status and abort if pending
  if (properties.copyStatus === "pending") {
    await destinationBlob.abortCopyFromURL(properties.copyId);
  }
}

TypeScript

async function abortCopy(destinationBlob: BlockBlobClient): Promise<void> {
  const properties = await destinationBlob.getProperties();

  // Check the copy status and abort if pending
  if (properties.copyStatus === "pending") {
    await destinationBlob.abortCopyFromURL(properties.copyId?.toString()!);
  }
}

Recursos

Para saber mais sobre como copiar blobs com agendamento assíncrono usando a biblioteca de clientes do Armazenamento de Blobs do Azure para JavaScript, consulte os seguintes recursos.

Exemplos de código

• Exibir exemplos de código JavaScript e TypeScript deste artigo (GitHub)

Operações da API REST

O SDK do Azure para JavaScript contém bibliotecas que se baseiam na API REST do Azure, permitindo a interação com as operações de API REST por meio de paradigmas conhecidos do JavaScript. Os métodos de biblioteca de clientes abordados neste artigo usam as seguintes operações de API REST:

• Copiar Blob (API REST)
• Anular Cópia de Blob (API REST)

Recursos da biblioteca de clientes

• Documentação de referência da biblioteca de clientes
• Código-fonte da biblioteca de clientes
• Pacote (npm)

Conteúdo relacionado

• Este artigo faz parte do guia do desenvolvedor do Armazenamento de Blobs para JavaScript/TypeScript. Para saber mais, confira a lista completa de artigos do guia do desenvolvedor em Criar seu aplicativo JavaScript/TypeScript.