Partilhar via

Copiar um blob com agendamento assíncrono usando Python

  • Artigo

Este artigo mostra como copiar um blob com agendamento assíncrono usando a biblioteca de cliente do Armazenamento do Azure para Python. Você pode copiar um blob de uma fonte dentro da mesma conta de armazenamento, de uma fonte em uma conta de armazenamento diferente ou de qualquer objeto acessível recuperado via solicitação HTTP GET em uma determinada URL. Você também pode abortar uma operação de cópia pendente.

Os métodos de biblioteca de cliente abordados neste artigo usam a operação Copy Blob REST API e podem ser usados 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, consulte Copiar um blob de uma URL de objeto de origem com Python.

Pré-requisitos

Configurar o ambiente

Se você não tiver um projeto existente, esta seção mostra como configurar um projeto para trabalhar com a biblioteca de cliente do Armazenamento de Blobs do Azure para Python. Para obter mais detalhes, consulte Introdução ao Armazenamento de Blobs do Azure e Python.

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

Instalar pacotes

Instale os seguintes pacotes usando pip install:

pip install azure-storage-blob azure-identity

Adicionar instruções de importação

Adicione as seguintes instruções 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 para anular uma cópia pendente. Para autorização com o Microsoft Entra ID (recomendado), a função interna menos privilegiada do RBAC do Azure varia com base em vários fatores. Para saber mais, consulte as diretrizes de autorização para Copiar Blob (API REST) ou Abortar Blob de Cópia (API REST).

Criar um objeto cliente

Para conectar um aplicativo ao Armazenamento de Blob, crie uma instância de 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 de cliente para contêineres ou blobs específicos, diretamente ou a partir do BlobServiceClient objeto. Para saber mais sobre como criar e gerenciar objetos de cliente, consulte Criar e gerenciar objetos de cliente que interagem com recursos de dados.

Sobre a cópia de blobs com agendamento assíncrono

A Copy Blob operação pode ser concluída de forma assíncrona e é executada com base no melhor esforço, o que significa que não é garantido que a operação comece imediatamente ou seja concluída dentro de um período de tempo especificado. A operação de cópia é agendada em segundo plano e executada à medida que o servidor tem recursos disponíveis. A operação pode ser concluída de forma síncrona se a cópia ocorrer na mesma conta de armazenamento.

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

  • Copie um blob de origem para um blob de destino com um nome diferente. O blob de destino pode ser um blob existente do mesmo tipo de blob (bloco, acréscimo ou página), 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, que substitui o blob de destino. Esse tipo de operação de cópia remove quaisquer 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 bloco existente ou pode ser um novo blob de bloco criado pela operação de cópia. Não há suporte para copiar de arquivos para blobs de página ou acrescentar blobs.
  • Copie um instantâneo sobre seu blob base. Ao promover um instantâneo para a posição do blob base, você pode restaurar uma versão anterior de um blob.
  • Copie 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 um dos seguintes tipos: blob de bloco, blob de acréscimo, blob de página, instantâneo de blob ou versão de blob. A operação de cópia sempre copia todo o blob ou arquivo de origem. Não há suporte para copiar um intervalo de bytes ou um conjunto de blocos.

Se o blob de destino já existir, ele deverá 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 Copy Blob operação, incluindo informações sobre propriedades, marcas de índice, metadados e cobrança, consulte Copiar comentários de Blob.

Copiar um blob com agendamento assíncrono

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

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

O start_copy_from_url retorna um dicionário contendo copy_status e copy_id. A propriedade copy_status será bem-sucedida 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 através do Microsoft Entra ID, de uma assinatura de acesso partilhado (SAS) ou de uma chave de conta. Para uma operação de cópia síncrona alterativa, consulte Copiar um blob de uma URL de objeto de origem com Python.

Se a origem 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 via token SAS. O token SAS precisa incluir a permissão Read ('r'). Para saber mais sobre tokens SAS, consulte 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 anexado. O exemplo mostra como gerar o token SAS usando a biblioteca do cliente, mas você também pode fornecer o seu próprio. O exemplo também mostra como conceder o blob de origem durante a operação de cópia para evitar alterações no blob de um cliente diferente. A Copy Blob operação salva o ETag valor do blob de origem quando a operação de cópia é iniciada. Se o ETag valor 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

Nota

Os tokens SAS de delegação de usuários oferecem maior segurança, pois são assinados com 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 chave de delegação de usuário.

Copiar um blob de uma fonte 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 uma determinada URL, 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íncrona Copy Blob , você pode sondar o método get_blob_properties 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:

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

Abortar uma operação pendente 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, faça 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 seguinte operação:

Esse método encapsula a operação Abort Copy Blob REST API, que cancela uma operação pendente Copy Blob . O exemplo de código a seguir mostra como abortar uma operação pendente Copy Blob :

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 cliente do Armazenamento de Blobs do Azure para Python, consulte os recursos a seguir.

Amostras de código

Operações da API REST

O SDK do Azure para Python contém bibliotecas que se baseiam na API REST do Azure, permitindo que você interaja com operações da API REST por meio de paradigmas Python familiares. Os métodos de biblioteca de cliente abordados neste artigo usam as seguintes operações de API REST:

Recursos da biblioteca do cliente

Conteúdos relacionados

  • Este artigo faz parte do guia do desenvolvedor do Blob Storage para Python. Para saber mais, consulte a lista completa de artigos do guia do desenvolvedor em Build your Python app.