Desenvolver para Arquivos do Azure com Python

Saiba como desenvolver aplicativos Python que usam Arquivos do Azure para armazenar dados. Arquivos do Azure é um serviço de compartilhamento de arquivos gerenciado na nuvem. Ele fornece compartilhamentos de arquivos totalmente gerenciados que são acessíveis por meio dos protocolos SMB (Bloco de Mensagens do Servidor) padrão do setor e NFS (Sistema de Arquivos de Rede). Arquivos do Azure também fornece uma API REST para acesso programático a compartilhamentos de arquivos.

Neste artigo, você aprenderá sobre as diferentes abordagens para desenvolver com Arquivos do Azure em Python e como escolher a abordagem que melhor atende às necessidades do seu aplicativo. Você também aprenderá a criar um aplicativo de console básico que interage com Arquivos do Azure recursos.

Sobre o desenvolvimento de aplicativos em Python com Arquivos do Azure

Arquivos do Azure oferece várias maneiras para desenvolvedores de Python acessar dados e gerenciar recursos no Arquivos do Azure. A tabela a seguir lista as abordagens, resume como elas funcionam e fornece diretrizes sobre quando usar cada abordagem:

Para obter informações gerais sobre essas abordagens, consulte Overview do desenvolvimento de aplicativos com Arquivos do Azure.

Este artigo se concentra em trabalhar com recursos Arquivos do Azure usando as seguintes abordagens:

• Trabalho com Arquivos do Azure usando bibliotecas de E/S de arquivo Python: monte um compartilhamento de arquivos usando SMB ou NFS e use as bibliotecas de E/S de arquivo Python para trabalhar com arquivos e diretórios no compartilhamento.
• Work with Arquivos do Azure using the File Shares client library for Python: Use a biblioteca de cliente de Armazenamento do Azure File Shares para Python para trabalhar com arquivos e diretórios em um compartilhamento de arquivos. Essa biblioteca de clientes se baseia na API FileREST.
• Gerencie os recursos de Arquivos do Azure usando as bibliotecas de gerenciamento do Armazenamento do Azure: use as bibliotecas de gerenciamento do Armazenamento do Azure para gerenciar compartilhamentos de arquivos e outros recursos em sua conta de armazenamento. As bibliotecas de gerenciamento se baseiam na API REST do provedor de recursos Armazenamento do Azure.

Pré-requisitos

• Azure assinatura – criar uma gratuitamente
• Azure conta de armazenamento – criar uma conta de armazenamento
• Python 3.8+

Configurar o seu projeto

Esta seção orienta você na preparação de um projeto para trabalhar com o Arquivos do Azure.

No diretório do projeto, instale pacotes com base nas necessidades do aplicativo usando o pip install comando. O exemplo a seguir mostra como instalar a biblioteca de clientes Azure Compartilhamentos de Arquivos, a biblioteca de clientes de gerenciamento de armazenamento e a biblioteca de identidades do Azure. O pacote azure-identity é necessário para conexões sem senha com serviços Azure.

pip install azure-identity
pip install azure-storage-file-share
pip install azure-mgmt-resource
pip install azure-mgmt-storage

Abra o arquivo de código e adicione as instruções de importação necessárias.

Se você planeja usar as bibliotecas Python os e io, adicione o seguinte ao arquivo .py:

import os
import io

Se você planeja usar a biblioteca cliente para Compartilhamentos de Arquivos do Armazenamento do Azure, adicione o seguinte ao arquivo .py:

from azure.identity import DefaultAzureCredential
from azure.storage.fileshare import ShareClient, ShareDirectoryClient, ShareFileClient

Se você planeja usar as bibliotecas de gerenciamento de Armazenamento do Azure, adicione o seguinte ao arquivo .py:

from azure.identity import DefaultAzureCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.storage import StorageManagementClient

Trabalhar com Arquivos do Azure usando bibliotecas de E/S de arquivo Python

As bibliotecas de E/S de arquivo padrão são a maneira mais comum de acessar e trabalhar com recursos de Arquivos do Azure. Quando você monta um compartilhamento de arquivos usando SMB ou NFS, seu sistema operacional redireciona solicitações de API para o sistema de arquivos local. Essa abordagem permite que você use bibliotecas de E/S de arquivo padrão, como os ou io, para interagir com arquivos e diretórios no compartilhamento.

Considere usar as bibliotecas de E/S de arquivo do Python quando seu aplicativo exigir:

• Compatibilidade do aplicativo: Ideal para aplicativos de linha de negócios com código já existente que utiliza bibliotecas de E/S de arquivo em Python. Você não precisa reescrever o código para que o aplicativo funcione com um compartilhamento de arquivos Azure.
• Facilidade de uso: As bibliotecas de E/S de arquivo Python são bem conhecidas pelos desenvolvedores e fáceis de usar. Uma proposta de valor chave do Arquivos do Azure é que ele expõe APIs do sistema de arquivos nativo por meio de SMB e NFS.

Nesta seção, você aprenderá a usar Python bibliotecas de E/S de arquivo para trabalhar com recursos de Arquivos do Azure.

Para obter mais informações e exemplos, consulte os seguintes recursos:

• Bibliotecas Python para E/S de arquivo: os e io

Montar um compartilhamento de arquivos

Para usar bibliotecas de E/S de arquivos do Python, primeiro você deve montar um compartilhamento de arquivos. Consulte os seguintes recursos para obter diretrizes sobre como montar um compartilhamento de arquivos usando SMB ou NFS:

• Montar um compartilhamento de arquivos SMB no Windows
• Montar um compartilhamento de arquivo SMB no Linux
• Montar um compartilhamento de arquivo NFS no Linux

Neste artigo, usamos o seguinte caminho para fazer referência a um compartilhamento de arquivo SMB montado no Windows:

file_share_path = "Z:\\file-share"

Exemplo: conectar-se a um compartilhamento de arquivos e enumerar diretórios usando bibliotecas de E/S de arquivo Python

O exemplo de código a seguir mostra como se conectar a um compartilhamento de arquivos e listar os diretórios no compartilhamento:

import os

def enumerate_directories(path):
    try:
        # Get all directories in the specified path
        dirs = [d for d in os.listdir(path) if os.path.isdir(os.path.join(path, d))]
        
        # Print each directory name
        for dir_name in dirs:
            print(f"{dir_name}")
            
        print(f"{len(dirs)} directories found.")
    except (PermissionError, FileNotFoundError, OSError) as ex:
        print(f"Error: {ex}")

#Example usage
file_share_path = "Z:\\file-share"
enumerate_directories(file_share_path)

Exemplo: escrever em um arquivo em um compartilhamento de arquivos usando bibliotecas de E/S de arquivo do Python

O exemplo de código a seguir mostra como gravar e acrescentar texto a um arquivo:

import os

def write_to_file(file_share_path, file_name):
    # First line of text with platform-appropriate line ending
    text_to_write = "First line" + os.linesep
    
    # Combine the file share path and filename
    file_path = os.path.join(file_share_path, file_name)
    
    # Write initial text to file (overwrites if file exists)
    with open(file_path, 'w') as file:
        file.write(text_to_write)
    
    # Text to append
    text_to_append = ["Second line", "Third line"]
    
    # Append lines to the file
    with open(file_path, 'a') as file:
        file.write(os.linesep.join(text_to_append) + os.linesep)

# Example usage
file_share_path = "Z:\\file-share"
write_to_file(file_share_path, "test.txt")

Exemplo: Enumerar ACLs de arquivo usando bibliotecas de E/S de arquivo Python

O exemplo de código a seguir mostra como enumerar ACLs (listas de controle de acesso) básicas para um arquivo:

import os
import stat

def enumerate_file_acls(file_path):
    try:
        # Get file stats
        file_stat = os.stat(file_path)
        
        # Get permissions in octal format
        permissions_octal = oct(stat.S_IMODE(file_stat.st_mode))
        
        print(f"File: {file_path}")
        print(f"Permissions (octal): {permissions_octal}")
        
        # Interpret permissions in a human-readable format
        permissions = ""
        permissions += "r" if file_stat.st_mode & stat.S_IRUSR else "-"
        permissions += "w" if file_stat.st_mode & stat.S_IWUSR else "-"
        permissions += "x" if file_stat.st_mode & stat.S_IXUSR else "-"
        permissions += "r" if file_stat.st_mode & stat.S_IRGRP else "-"
        permissions += "w" if file_stat.st_mode & stat.S_IWGRP else "-" 
        permissions += "x" if file_stat.st_mode & stat.S_IXGRP else "-"
        permissions += "r" if file_stat.st_mode & stat.S_IROTH else "-"
        permissions += "w" if file_stat.st_mode & stat.S_IWOTH else "-"
        permissions += "x" if file_stat.st_mode & stat.S_IXOTH else "-"
        
        print(f"Permissions (symbolic): {permissions}")
        
        print(f"Owner ID: {file_stat.st_uid}")
        print(f"Group ID: {file_stat.st_gid}")
        print("Note: For detailed Windows ACLs, you may need a specialized library.")
        
    except FileNotFoundError:
        print(f"Error: File '{file_path}' not found.")
    except PermissionError:
        print(f"Error: Permission denied for '{file_path}'.")
    except Exception as e:
        print(f"Error: {e}")

# Example usage
file_share_path = "Z:\\file-share"
file_name = "test.txt"
file_path = os.path.join(file_share_path, file_name)

enumerate_file_acls(file_path)

Trabalhar com dados Arquivos do Azure usando a biblioteca de clientes de Compartilhamentos de Arquivos para Python

A API FileREST fornece acesso programático a Arquivos do Azure. Ele permite que você chame os pontos de extremidade HTTPS para realizar operações em compartilhamentos de arquivos, diretórios e arquivos. A API FileREST foi projetada para alta escalabilidade e recursos avançados que podem não estar disponíveis por meio de protocolos nativos. O SDK do Azure fornece bibliotecas de clientes, como a biblioteca de clientes de Compartilhamentos de Arquivos para Python, que se baseiam na API FileREST.

Considere usar a API FileREST e a biblioteca de clientes do Compartilhamento de Arquivos se o aplicativo exigir:

• Recursos avançados: Acessar operações e recursos que não estão disponíveis por meio de protocolos nativos.
• Integrações de nuvem personalizadas: Criar serviços personalizados de valor agregado, como backup, antivírus ou gerenciamento de dados, que interagem diretamente com o Arquivos do Azure.
• Otimização de desempenho: Aproveite as vantagens de desempenho em cenários de alta escala usando operações de plano de dados.

A API FileREST modela os Arquivos do Azure como uma hierarquia de recursos e é recomendada para operações realizadas no nível de directory ou file. Você deve preferir a API REST do provedor de recursos de armazenamento para operações executadas no nível de compartilhamento de arquivos ou serviço de arquivo.

Nesta seção, você aprenderá a usar a biblioteca de clientes Compartilhamentos de Arquivos para trabalhar com recursos de Arquivos do Azure.

Para obter mais informações e exemplos, consulte os seguintes recursos:

• Biblioteca cliente de Compartilhamentos de Arquivos do Armazenamento do Azure para Python
• Biblioteca de cliente de Compartilhamentos de Arquivos do Armazenamento do Azure para exemplos em Python

Autorizar o acesso e criar um cliente

Para conectar um aplicativo ao Arquivos do Azure, crie um objeto ShareClient. Esse objeto é o ponto de partida para trabalhar com recursos Arquivos do Azure. Os exemplos de código a seguir mostram como criar um ShareClient objeto usando diferentes mecanismos de autorização.

from azure.identity import DefaultAzureCredential
from azure.storage.fileshare import ShareClient

account_name = "<account-name>"
share_name = "<share-name>"

# Create the share client using DefaultAzureCredential
share_client = ShareClient(
    account_url=f"https://{account_name}.file.core.windows.net",
    share_name=share_name,
    credential=DefaultAzureCredential(),
    # When using a token credential, you MUST specify a token_intent
    token_intent='backup'
)

# Get a reference to a directory in the share
directory_client = share_client.get_directory_client("sample-directory")

from azure.storage.fileshare import ShareClient

account_name = "<account-name>"
account_key = "<account-key>"
share_name = "<share-name>"
credential = account_key

# Create a share client using the account key
share_client = ShareClient(
    account_url=f"https://{account_name}.file.core.windows.net",
    share_name=share_name,
    credential=credential
)

# Get a reference to a directory in the share
directory_client = share_client.get_directory_client("sample-directory")

from azure.storage.fileshare import ShareClient

connection_string = "<connection-string>"
share_name = "<share-name>"

# Create a share client using the connection string
share_client = ShareClient.from_connection_string(connection_string, share_name)

# Get a reference to a directory in the share
directory_client = share_client.get_directory_client("sample-directory")

Para saber mais sobre cada um desses mecanismos de autorização, consulte Escolher como autorizar o acesso aos dados do arquivo.

Exemplo: Copiar arquivos usando a biblioteca cliente de Compartilhamento de Arquivos

Você pode copiar arquivos em um compartilhamento de arquivos ou entre compartilhamentos de arquivos usando o seguinte método:

• start_copy_from_url

Você pode copiar um arquivo para um blob de destino usando o seguinte método de um BlobClient objeto:

• start_copy_from_url

O exemplo de código a seguir mostra como copiar um arquivo para um arquivo em outro compartilhamento de arquivos:

from azure.identity import DefaultAzureCredential
from azure.storage.fileshare import ShareFileClient

# Define storage account parameters
account_name = "<account-name>"
src_share_name = "src-file-share"
dest_share_name = "dest-file-share"
src_file_path = "src/path/to/file"
dest_file_path = "dest/path/to/file"

# Create token credential
token_credential = DefaultAzureCredential()

# Create source file client
src_file_client = ShareFileClient(
    account_url=f"https://{account_name}.file.core.windows.net",
    share_name=src_share_name,
    file_path=src_file_path,
    credential=token_credential,
    token_intent='backup'
)

# Create destination file client
dest_file_client = ShareFileClient(
    account_url=f"https://{account_name}.file.core.windows.net",
    share_name=dest_share_name,
    file_path=dest_file_path,
    credential=token_credential,
    token_intent='backup'
)

# Copy the file from the source share to the destination share
copy_operation = dest_file_client.start_copy_from_url(src_file_client.url)

Exemplo: alugar um arquivo usando a biblioteca de clientes de Compartilhamentos de Arquivos

Uma concessão cria um bloqueio em um arquivo gerenciado por Azure por meio de uma ID de concessão. A concessão fornece um mecanismo para coordenar o acesso a arquivos em vários clientes em um sistema distribuído. Uma concessão em um arquivo fornece acesso exclusivo de gravação e exclusão. Para saber mais sobre estados e ações de locação, consulte Arquivo de Locação.

O exemplo de código a seguir mostra como criar um cliente de concessão, adquirir uma concessão de duração infinita em um arquivo e liberar a concessão:

from azure.identity import DefaultAzureCredential
from azure.storage.fileshare import ShareFileClient, ShareLeaseClient

# Define storage account parameters
account_name = "<account-name>"
share_name = "sample-file-share"
file_path = "path/to/file"

# Create a DefaultAzureCredential for authentication
token_credential = DefaultAzureCredential()

# Create a ShareFileClient
file_client = ShareFileClient(
    account_url=f"https://{account_name}.file.core.windows.net",
    share_name=share_name,
    file_path=file_path,
    credential=token_credential,
    token_intent='backup'
)

# Get a lease client for the file
lease_client = ShareLeaseClient(file_client)

# Acquire an infinite duration lease on the file
lease_info = lease_client.acquire()

# Do something with the file while it's leased
# ...

# Release the lease
lease_client.release()

Ao usar o SMB e a API FileREST, tenha em mente que a API FileREST usa concessões para gerenciar bloqueios de arquivos, enquanto o SMB usa bloqueios do sistema de arquivos gerenciados pelo sistema operacional. Para saber mais sobre como gerenciar interações de bloqueio de arquivos entre o SMB e a API FileREST, consulte Gerenciar bloqueios de arquivo.

Exemplo: criar e listar instantâneos de compartilhamento usando a biblioteca de clientes Compartilhamentos de Arquivos

Os instantâneos de compartilhamento são cópias somente leitura de um compartilhamento de arquivos em um momento. Você pode criar um instantâneo de um compartilhamento de arquivos e, em seguida, usar o instantâneo para acessar os dados no compartilhamento no momento em que o instantâneo foi criado. Você também pode listar todos os instantâneos em um compartilhamento de arquivos e excluir instantâneos de compartilhamento.

O exemplo de código a seguir mostra como criar um instantâneo de compartilhamento, listar os instantâneos em um compartilhamento de arquivos e percorrer o diretório raiz em um instantâneo de compartilhamento:

from azure.storage.fileshare import ShareServiceClient, ShareDirectoryClient

def list_root_directory_snapshot(root_dir: ShareDirectoryClient):
    for item in root_dir.list_directories_and_files():
        if item["is_directory"]:
            print(f"Directory in snapshot: {item['name']}")
        else:
            print(f"File in snapshot: {item['name']}")

# Connection string with account key (required for share snapshots)
connection_string = "<connection-string>"

# Create service and share clients
share_service_client = ShareServiceClient.from_connection_string(connection_string)
share_name = "sample-file-share"
share_client = share_service_client.get_share_client(share_name)

# Create a snapshot
snapshot_info = share_client.create_snapshot()
print(f"Snapshot created: {snapshot_info['snapshot']}")

# List snapshots in a share
for share_item in share_service_client.list_shares(include_snapshots=True):
    if share_item["snapshot"]:
        print(f"Share: {share_item['name']} (Snapshot: {share_item['snapshot']})")

# List directories and files in a share snapshot
snapshot_timestamp = snapshot_info["snapshot"]
share_snapshot = share_service_client.get_share_client(share_name, snapshot=snapshot_timestamp)
root_dir = share_snapshot.get_directory_client("")

list_root_directory_snapshot(root_dir)

Gerenciar recursos Arquivos do Azure usando as bibliotecas de gerenciamento de Armazenamento do Azure

As bibliotecas de gerenciamento de Armazenamento do Azure são criadas na API REST do provedor de recursos Armazenamento do Azure. O provedor de recursos Armazenamento do Azure é um serviço baseado em Azure Resource Manager e dá suporte a métodos declarativos (modelos) e imperativos (chamada direta à API). A API REST do provedor de recursos Armazenamento do Azure fornece acesso programático a recursos Armazenamento do Azure, incluindo compartilhamentos de arquivos. O SDK do Azure fornece bibliotecas de gerenciamento que se baseiam na API REST do provedor de recursos Armazenamento do Azure.

As bibliotecas de gerenciamento são recomendadas para operações executadas no nível de serviço de arquivo ou compartilhamento de arquivos. Nesta seção, você aprenderá a usar as bibliotecas de gerenciamento de Armazenamento do Azure para gerenciar Arquivos do Azure recursos.

Exemplo: criar um compartilhamento de arquivos usando a biblioteca de gerenciamento de Armazenamento do Azure

O exemplo de código a seguir mostra como criar um objeto ArmClient de nível superior, registrar o provedor de recursos de armazenamento com uma assinatura e criar um compartilhamento de arquivos usando a biblioteca de gerenciamento de Armazenamento do Azure:

from azure.identity import DefaultAzureCredential
from azure.mgmt.resource import ResourceManagementClient, SubscriptionClient
from azure.mgmt.storage import StorageManagementClient
from azure.mgmt.storage.models import FileShare

# Create the credential for authentication
credential = DefaultAzureCredential()

# Define variables
subscription_id = "<subscription-id>"
resource_group_name = "<resource-group-name>"
storage_account_name = "<storage-account-name>"
share_name = "sample-file-share"

# Create clients
resource_client = ResourceManagementClient(credential, subscription_id)
subscription_client = SubscriptionClient(credential)
storage_client = StorageManagementClient(credential, subscription_id)

# Register Microsoft.Storage resource provider, if not already registered
provider = resource_client.providers.get('Microsoft.Storage')
if provider.registration_state == "NotRegistered":
    resource_client.providers.register('Microsoft.Storage')

# Create a file share
file_share = storage_client.file_shares.create(
    resource_group_name=resource_group_name,
    account_name=storage_account_name,
    share_name=share_name,
    file_share=FileShare(
        share_quota=1  # Share size in GiB
        # Add other file share properties here
    )
)

Você pode configurar as propriedades de compartilhamento de arquivos usando a FileShare classe. O exemplo anterior mostra como definir a share_quota propriedade. Para saber mais, consulte a referência da classe StorageManagementClient .

Exemplo: listar compartilhamentos de arquivos e instantâneos usando a biblioteca de gerenciamento de Armazenamento do Azure

O exemplo de código a seguir mostra como listar compartilhamentos de arquivos e instantâneos em uma conta de armazenamento:

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

# Create the credential for authentication
credential = DefaultAzureCredential()

# Define variables
subscription_id = "<subscription-id>"
resource_group_name = "<resource-group-name>"
storage_account_name = "<storage-account-name>"
expand = "snapshots"  # Include snapshots in the response

# Create storage management client
storage_client = StorageManagementClient(credential, subscription_id)

# List all file shares with their snapshots
file_shares = storage_client.file_shares.list(
    resource_group_name=resource_group_name,
    account_name=storage_account_name,
    expand=expand
)

# Iterate over the file shares and print them along with any snapshots
for share in file_shares:
    print(f"Resource name: {share.name}")
    if share.snapshot_time:
        print(f"Snapshot: {share.snapshot_time}")

Conteúdo relacionado

Para obter mais informações sobre como desenvolver com Arquivos do Azure, consulte os seguintes recursos:

• Overview do desenvolvimento de aplicativos com Arquivos do Azure
• Nomeando e referenciando compartilhamentos, diretórios, arquivos e metadados
• Gerenciar bloqueios de arquivo
• Operações em diretórios
• Operações em arquivos