Compartilhar via

Copiar um blob com agendamento assíncrono usando o Python

  • Artigo

Este artigo mostra como copiar um blob com agendamento assíncrono usando a biblioteca de clientes do Armazenamento do Microsoft Azure para Python. 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 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 o Python.

Pré-requisitos

Configure seu ambiente

Se você não tiver um projeto existente, esta seção mostrará como configurar um projeto para funcionar com a biblioteca de clientes do Armazenamento de Blobs do Azure para Python. Para obter mais detalhes, confira Introdução ao Armazenamento de Blobs do Azure e ao Python.

Para trabalhar com os exemplos de código neste artigo, siga estas etapas para configurar seu projeto.

Instalar Pacotes

Instale os seguintes pacotes por meio de pip install:

pip install azure-storage-blob azure-identity

Adicionar instruções de importação

Adicione as seguintes declarações de import :

import datetime
from azure.identity import DefaultAzureCredential
from azure.storage.blob import (
    BlobServiceClient,
    BlobClient,
    BlobLeaseClient,
    BlobSasPermissions,
    generate_blob_sas
)

Autorização

O mecanismo de autorização deve ter as permissões necessárias para executar uma operação de cópia ou anular uma cópia pendente. Para autorização com o Microsoft Entra ID (recomendado), a função interna do RBAC do Azure com menos privilégios varia de acordo com vários fatores. Para saber mais, consulte as diretrizes de autorização para Copiar blob (API REST) e Anular cópia do blob (API REST).

Criar um objeto cliente

Para conectar um aplicativo ao Armazenamento de Blobs, crie uma instância do BlobServiceClient. O exemplo a seguir mostra como criar um objeto cliente usando DefaultAzureCredential para autorização:

# TODO: Replace <storage-account-name> with your actual storage account name
account_url = "https://<storage-account-name>.blob.core.windows.net"
credential = DefaultAzureCredential()

# Create the BlobServiceClient object
blob_service_client = BlobServiceClient(account_url, credential=credential)

Você também pode criar objetos cliente para contêineres ou blobs específicos, diretamente ou do objeto BlobServiceClient. Para saber mais sobre como criar e gerenciar objetos clientes, confira Criar e gerenciar objetos clientes que interagem com recursos de dados.

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.

O blob de origem para uma operação de cópia pode ser de um dos seguintes tipos: blob de blocos, blob de acréscimo, blob de páginas, instantâneo de blob ou versão de blob. A operação de cópia sempre copia o blob de origem inteiro. Não há suporte para a cópia de um intervalo de bytes ou um conjunto de blocos.

Se o blob de destino já existir, ele deve ser do mesmo tipo de blob que o blob de origem e o blob de destino existente será substituído. O blob de destino não pode ser modificado enquanto uma operação de cópia estiver em andamento e um blob de destino só pode ter uma operação de cópia pendente.

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 Python 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:

O start_copy_from_url retorna um dicionário que contém copy_status e copy_id. A propriedade copy_status terá sucesso se a cópia for concluída de forma síncrona ou pendente se a cópia tiver sido iniciada de forma assíncrona.

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 Python.

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á.

def copy_from_source_in_azure_async(self, source_blob: BlobClient, destination_blob: BlobClient, blob_service_client: BlobServiceClient):
    # Lease the source blob during copy to prevent other clients from modifying it
    lease = BlobLeaseClient(client=source_blob)

    sas_token = self.generate_user_delegation_sas(blob_service_client=blob_service_client, source_blob=source_blob)
    source_blob_sas_url = source_blob.url + "?" + sas_token

    # Create an infinite lease by passing -1 as the lease duration
    lease.acquire(lease_duration=-1)

    # Start the copy operation - specify False for the requires_sync parameter
    copy_operation = dict()
    copy_operation = destination_blob.start_copy_from_url(source_url=source_blob_sas_url, requires_sync=False)
    
    # If start_copy_from_url returns copy_status of 'pending', the operation has been started asynchronously
    # You can optionally add logic here to wait for the copy operation to complete

    # Release the lease on the source blob
    lease.break_lease()

def generate_user_delegation_sas(self, blob_service_client: BlobServiceClient, source_blob: BlobClient):
    # Get a user delegation key
    delegation_key_start_time = datetime.datetime.now(datetime.timezone.utc)
    delegation_key_expiry_time = delegation_key_start_time + datetime.timedelta(hours=1)
    key = blob_service_client.get_user_delegation_key(
        key_start_time=delegation_key_start_time,
        key_expiry_time=delegation_key_expiry_time
    )

    # Create a SAS token that's valid for one hour, as an example
    sas_token = generate_blob_sas(
        account_name=blob_service_client.account_name,
        container_name=source_blob.container_name,
        blob_name=source_blob.blob_name,
        account_key=None,
        user_delegation_key=key,
        permission=BlobSasPermissions(read=True),
        expiry=datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(hours=1),
        start=datetime.datetime.now(datetime.timezone.utc)
    )

    return sas_token

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 uma URL de objeto de origem acessível.

def copy_from_external_source_async(self, source_url: str, destination_blob: BlobClient):
    # Start the copy operation - specify False for the requires_sync parameter
    copy_operation = dict()
    copy_operation = destination_blob.start_copy_from_url(source_url=source_url, requires_sync=False)
    
    # If start_copy_from_url returns copy_status of 'pending', the operation has been started asynchronously
    # You can optionally add logic here to wait for the copy operation to complete

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

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

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

def check_copy_status(self, destination_blob: BlobClient):
    # Get the copy status from the destination blob properties
    copy_status = destination_blob.get_blob_properties().copy.status

    return copy_status

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:

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:

def abort_copy(self, destination_blob: BlobClient):
    # Get the copy operation details from the destination blob properties
    copy_status = destination_blob.get_blob_properties().copy.status
    copy_id = destination_blob.get_blob_properties().copy.id

    # Check the copy status and abort if pending
    if copy_status == 'pending':
        destination_blob.abort_copy(copy_id)
        print(f"Copy operation {copy_id} has been aborted")

Recursos

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

Exemplos de código

Operações da API REST

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

Recursos da biblioteca de clientes

Conteúdo relacionado

  • Este artigo faz parte do guia para desenvolvedores do Armazenamento de Blobs para Python. Para saber mais, veja a lista completa de artigos do guia do desenvolvedor em Criar seu aplicativo Python.