Use marcas de índice de blob para gerenciar e localizar dados com o Python
Este artigo mostra como usar marcas de índice de blob para gerenciar e localizar dados usando a biblioteca de clientes do Armazenamento do Microsoft Azure para Python.
Para saber mais sobre como definir marcas de índice de blob usando APIs assíncronas, consulte Definir marcas de índice de blob de maneira assíncrona.
Pré-requisitos
- Este artigo pressupõe que você já tenha um projeto configurado para trabalhar com a biblioteca de clientes do Armazenamento de Blobs do Azure para Python. Para saber mais sobre como configurar seu projeto, incluindo a instalação de pacote, a adição de instruções de
import
e a criação de um objeto de cliente autorizado, consulte Introdução ao Armazenamento de Blobs do Azure e Python. - O mecanismo de autorização deve ter permissões para trabalhar com marcas de índice de blob. Para saber mais, confira as diretrizes de autorização para as seguintes operações de API REST:
Gravar marcas de índice de blob
As marcas de índice de blob categorizam os dados na sua conta de armazenamento usando atributos de marca de chave-valor. Essas marcas são indexadas automaticamente e expostas como um índice multidimensional pesquisável para localizar dados com facilidade. Este artigo mostra como definir, obter e localizar dados usando marcas de índice de blob.
Não há suporte para marcas de índice de blob para contas de armazenamento com namespace hierárquico habilitado. Para saber mais sobre o recurso de marca de índice de blob, juntamente com problemas e limitações conhecidos, confira Gerenciar e localizar dados de Blob do Azure com marcas de índice de blob.
Editar marcas
Você poderá definir marcas de índice se o código tiver acesso autorizado aos dados de blob por meio de um dos seguintes mecanismos:
- Entidade de segurança que recebe uma função RBAC do Azure com a ação Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/write. O Proprietário de Dados de Blob de Armazenamento é uma função interna que inclui essa ação.
- Assinatura de Acesso Compartilhado (SAS) com permissão para acessar as marcas do blob (permissão
t
) - Chave de conta
Para obter mais informações, consulte Configuração de marcas de índice de blob.
Defina marcas usando o seguinte método:
As marcas especificadas nesse método substituirão marcas existentes. Se os valores antigos precisarem ser preservados, eles deverão ser baixados e incluídos na chamada para esse método. O seguinte exemplo mostra como definir marcas:
def set_blob_tags(self, blob_service_client: BlobServiceClient, container_name):
blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt")
# Get any existing tags for the blob if they need to be preserved
tags = blob_client.get_blob_tags()
# Add or modify tags
updated_tags = {'Sealed': 'false', 'Content': 'image', 'Date': '2022-01-01'}
tags.update(updated_tags)
blob_client.set_blob_tags(tags)
Você pode excluir todas as marcas passando um objeto dict
vazio para o método set_blob_tags
:
def clear_blob_tags(self, blob_service_client: BlobServiceClient, container_name):
blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt")
# Pass in empty dict object to clear tags
tags = dict()
blob_client.set_blob_tags(tags)
Obter marcas
Você poderá obter marcas de índice se o código tiver acesso autorizado aos dados de blob por meio de um dos seguintes mecanismos:
- Entidade de segurança que recebe uma função RBAC do Azure com a ação Microsoft.Storage/storageAccounts/blobServices/containers/blobs/tags/read. O Proprietário de Dados de Blob de Armazenamento é uma função interna que inclui essa ação.
- Assinatura de Acesso Compartilhado (SAS) com permissão para acessar as marcas do blob (permissão
t
) - Chave de conta
Para obter mais informações, consulte Obtendo e listando marcas de índice de blob.
Obtenha marcas usando o seguinte método:
O seguinte exemplo mostra como recuperar e iterar as marcas do blob:
def get_blob_tags(self, blob_service_client: BlobServiceClient, container_name):
blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt")
tags = blob_client.get_blob_tags()
print("Blob tags: ")
for k, v in tags.items():
print(k, v)
Filtre e localize dados com marcas de índice de blob
Você poderá usar marcas de índice para localizar e filtrar dados se o código tiver acesso autorizado aos dados de blob por meio de um dos seguintes mecanismos:
- Entidade de segurança que recebe uma função RBAC do Azure com a ação Microsoft.Storage/storageAccounts/blobServices/containers/blobs/filter/action. O Proprietário de Dados de Blob de Armazenamento é uma função interna que inclui essa ação.
- Assinatura de Acesso Compartilhado (SAS) com permissão para filtrar blobs por marcas (permissão
f
) - Chave de conta
Para obter mais informações, consulte Localizando dados usando marcas de índice de blob.
Observação
Não é possível usar marcas de índice para recuperar versões anteriores. As marcas para versões anteriores não são passadas para o mecanismo de índice de blob. Para obter mais informações, consulte Condições e problemas conhecidos.
Localize os dados usando o seguinte método:
O seguinte exemplo localiza e lista todos os blobs marcados como uma imagem:
def find_blobs_by_tags(self, blob_service_client: BlobServiceClient, container_name):
container_client = blob_service_client.get_container_client(container=container_name)
query = "\"Content\"='image'"
blob_list = container_client.find_blobs_by_tags(filter_expression=query)
print("Blobs tagged as images")
for blob in blob_list:
print(blob.name)
Definir marcas de índice de blob de maneira assíncrona
A biblioteca de clientes do Armazenamento de Blobs do Azure para Python é compatível com a listagem de blobs de maneira assíncrona. Para saber mais sobre os requisitos de instalação do projeto, confira Programação assíncrona.
Siga estas etapas para definir marcas de índice de blob usando APIs assíncronas:
Adicione as seguintes instruções de importação:
import asyncio from azure.identity.aio import DefaultAzureCredential from azure.storage.blob.aio import BlobServiceClient
Adicione o código para executar o programa usando
asyncio.run
. Essa função executa a corrotina passada,main()
no nosso exemplo, e gerencia o loop de eventosasyncio
. As corrotinas são declaradas com a sintaxe async/await. Nesse exemplo, a corrotinamain()
primeiro cria oBlobServiceClient
de nível superior usandoasync with
e, em seguida, chama o método que define as marcas de índice de blob. Observe que somente o cliente de nível superior precisa usarasync with
, pois os outros clientes criados a partir dele compartilham o mesmo pool de conexões.async def main(): sample = BlobSamples() # TODO: Replace <storage-account-name> with your actual storage account name account_url = "https://<storage-account-name>.blob.core.windows.net" credential = DefaultAzureCredential() async with BlobServiceClient(account_url, credential=credential) as blob_service_client: await sample.set_blob_tags(blob_service_client, "sample-container") if __name__ == '__main__': asyncio.run(main())
Adicione código para definir as marcas de índice de blob. O código é igual ao exemplo síncrono, exceto que o método é declarado com a palavra-chave
async
e a palavra-chaveawait
é usada ao chamar os métodosget_blob_tags
eset_blob_tags
.async def set_blob_tags(self, blob_service_client: BlobServiceClient, container_name): blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt") # Get any existing tags for the blob if they need to be preserved tags = await blob_client.get_blob_tags() # Add or modify tags updated_tags = {'Sealed': 'false', 'Content': 'image', 'Date': '2022-01-01'} tags.update(updated_tags) await blob_client.set_blob_tags(tags)
Com essa configuração básica em vigor, você pode implementar outros exemplos neste artigo como corrotinas usando sintaxe a async/await.
Recursos
Para saber mais sobre como usar as marcas de índice para gerenciar e localizar dados usando a biblioteca de clientes de Armazenamento de Blobs do Azure para Python, confira os recursos a seguir.
Operações da API REST
O SDK do Azure para Python contém bibliotecas que se baseiam na API REST do Azure, permitindo a interação com as operações da API REST por meio de paradigmas conhecidos do Python. Os métodos da biblioteca de clientes para gerenciar e usar marcas de índice de blob usam as seguintes operações da API REST:
- Obter marcas de blob (API REST)
- Definir marcas de blob (API REST)
- Localizar blobs por marcas (API REST)
Exemplos de código
- Exibir exemplos de código síncrono ou assíncrono deste artigo (GitHub)
Recursos da biblioteca de clientes
- Documentação de referência da biblioteca de clientes
- Código-fonte da biblioteca de clientes
- Pacote (PyPi)
Confira também
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de