Usar as bibliotecas do Azure (SDK) para Python

2025-06-18

As bibliotecas do Azure de software livre para Python simplificam o provisionamento, o gerenciamento e o uso de recursos do Azure do código do aplicativo Python.

Os detalhes que você realmente deseja saber

As bibliotecas do Azure são como você se comunica com os serviços do Azure a partir do código Python que você executa localmente ou na nuvem. (Se você pode executar código Python dentro do escopo de um determinado serviço depende se esse serviço em si atualmente dá suporte ao Python.)
As bibliotecas dão suporte ao Python 3.8 ou posterior. Para obter mais informações sobre versões com suporte do Python, consulte a política de suporte à versão do Python do SDKs do Azure. Se você estiver usando o PyPy, verifique se a versão usada pelo menos dá suporte à versão do Python mencionada anteriormente.
O SDK do Azure para Python é composto exclusivamente por mais de 180 bibliotecas individuais do Python relacionadas a serviços específicos do Azure. Não há outras ferramentas no SDK.
Quando você executa o código localmente, a autenticação com o Azure depende de variáveis de ambiente, conforme descrito em Como autenticar aplicativos Python nos serviços do Azure usando o SDK do Azure para Python.
Para instalar pacotes de biblioteca com o pip, use pip install <library_name> com os nomes de bibliotecas do índice de pacotes. Para instalar pacotes de biblioteca em ambientes conda, utilize conda install <package_name> com nomes do canal da Microsoft no anaconda.org. Para mais informações, veja Instalar pacotes de biblioteca do Azure.
Há bibliotecas de gerenciamento e cliente distintas (às vezes conhecidas como bibliotecas de "plano de gerenciamento" e "plano de dados"). Cada conjunto serve a diferentes finalidades e é usado por diferentes tipos de código. Para obter mais informações, consulte as seguintes seções mais adiante neste artigo:
- Criar e gerenciar recursos do Azure com bibliotecas de gerenciamento
- Conectar-se e usar recursos do Azure com bibliotecas de cliente
A documentação das bibliotecas é encontrada na Referência do Azure para Python, que é organizada pelo Serviço do Azure ou pelo navegador de API python, que é organizado pelo nome do pacote.
Para experimentar as bibliotecas por conta própria, primeiro recomendamos configurar seu ambiente de desenvolvimento local. Em seguida, você pode experimentar qualquer um dos seguintes exemplos autônomos (em qualquer ordem): Exemplo: Criar um grupo de recursos, exemplo: Criar e usar o Armazenamento do Azure, Exemplo: Criar e implantar um aplicativo Web, Exemplo: Criar e consultar um banco de dados MySQL e Exemplo: Criar uma máquina virtual.
Para obter vídeos de demonstração, consulte Introdução ao SDK do Azure para Python (PyCon 2021) e ao uso de SDKs do Azure para interagir com os recursos do Azure (PyCon 2020).

Detalhes não essenciais, mas ainda interessantes

Como a CLI do Azure é escrita em Python usando as bibliotecas de gerenciamento, tudo o que você pode fazer com os comandos da CLI do Azure, você também pode fazer a partir de um script Python. Dito isto, os comandos da CLI fornecem muitos recursos úteis, como executar várias tarefas em conjunto, lidar automaticamente com operações assíncronas, formatar a saída como cadeias de conexão e assim por diante. Portanto, usar a CLI (ou seu equivalente, Azure PowerShell) para scripts de criação e gerenciamento automatizados pode ser mais conveniente do que escrever o código Python equivalente, a menos que você queira ter um grau de controle muito mais exigente sobre o processo.
As bibliotecas do Azure para Python se baseiam na API REST subjacente do Azure, permitindo que você use essas APIs por meio de paradigmas familiares do Python. No entanto, você sempre pode usar a API REST diretamente do código Python, se desejado.
Você pode encontrar o código-fonte para as bibliotecas do Azure.https://github.com/Azure/azure-sdk-for-python Como um projeto de software livre, as contribuições são bem-vindas!
Embora você possa usar as bibliotecas com interpretadores como IronPython e Jython que não testamos, você pode encontrar problemas isolados e incompatibilidades.
O repositório de origem da documentação de referência da API de biblioteca reside em https://github.com/MicrosoftDocs/azure-docs-sdk-python/.
A partir de 2019, atualizamos as bibliotecas do Python do Azure para compartilhar padrões comuns de nuvem, como protocolos de autenticação, registro em log, rastreamento, protocolos de transporte, respostas em buffer e novas tentativas. As bibliotecas atualizadas seguem as diretrizes atuais do SDK do Azure.
- Em 31 de março de 2023, desativamos o suporte para bibliotecas do SDK do Azure que não estão em conformidade com as diretrizes atuais do SDK do Azure. Embora as bibliotecas mais antigas ainda possam ser usadas além de 31 de março de 2023, elas não receberão mais suporte oficial e atualizações da Microsoft. Para obter mais informações, consulte o aviso Atualizar suas bibliotecas do SDK do Azure.
- Para evitar atualizações de segurança e desempenho ausentes para os SDKs do Azure, atualize para as bibliotecas mais recentes do SDK do Azure até 31 de março de 2023.
- Para verificar quais bibliotecas do Python foram afetadas, consulte as versões preteridas do SDK do Azure para Python.
Para obter detalhes sobre as diretrizes que aplicamos às bibliotecas, consulte as Diretrizes do Python: Introdução.

Criar e gerenciar recursos do Azure com bibliotecas de gerenciamento

As bibliotecas de gerenciamento (ou "plano de gerenciamento") do SDK, cujos nomes todos começam com , ajudam você a criar, configurar e gerenciar recursos do Azure a partir de scripts em Python. Todos os serviços do Azure têm bibliotecas de gerenciamento correspondentes. Para obter mais informações, consulte Painel de controle e plano de dados do Azure.

Com as bibliotecas de gerenciamento, você pode escrever scripts de configuração e implantação para executar as mesmas tarefas que você pode por meio do portal do Azure ou da CLI do Azure. (Conforme observado anteriormente, a CLI do Azure é escrita em Python e usa as bibliotecas de gerenciamento para implementar seus vários comandos.)

Os exemplos a seguir ilustram como usar algumas das bibliotecas de gerenciamento primário:

Para obter detalhes sobre como trabalhar com cada biblioteca de gerenciamento, consulte o arquivo README.md ou README.rst localizado na pasta de projeto da biblioteca no repositório GitHub do SDK. Você também pode encontrar mais snippets de código na documentação de referência e nos Exemplos do Azure.

Migração de bibliotecas de gerenciamento mais antigas

Se você estiver migrando código de versões mais antigas das bibliotecas de gerenciamento, confira os seguintes detalhes:

Se você usar a ServicePrincipalCredentials classe, consulte Autenticar com credenciais de token.
Os nomes das APIs assíncronas foram alterados conforme descrito nos padrões de uso da Biblioteca – operações assíncronas. Os nomes de APIs assíncronas em bibliotecas mais recentes começam com begin_. Na maioria dos casos, a assinatura da API permanece a mesma.

Conectar-se e usar recursos do Azure com bibliotecas de cliente

As bibliotecas de cliente (ou "plano de dados") do SDK ajudam você a escrever o código do aplicativo Python para interagir com serviços já provisionados. As bibliotecas de cliente existem apenas para os serviços que dão suporte a uma API de cliente.

O artigo, exemplo: Usar o Armazenamento do Azure, fornece uma ilustração básica do uso da biblioteca de clientes.

Diferentes serviços do Azure também fornecem exemplos usando essas bibliotecas. Consulte as seguintes páginas de índice para outros links:

Para obter detalhes sobre como trabalhar com cada biblioteca de clientes, consulte o arquivo README.md ou README.rst localizado na pasta de projeto da biblioteca no repositório GitHub do SDK. Você também pode encontrar mais snippets de código na documentação de referência e nos Exemplos do Azure.

Obter ajuda e conectar-se com a equipe do SDK

Visite as bibliotecas do Azure para documentação do Python
Postar perguntas para a comunidade no Stack Overflow
Questões abertas contra o SDK em GitHub
Mencionar @AzureSDK no Twitter
Conclua uma breve pesquisa sobre o SDK do Azure para Python

Próxima etapa

É altamente recomendável fazer uma configuração única do seu ambiente de desenvolvimento local para que você possa usar facilmente qualquer uma das bibliotecas do Azure para Python.

Configurar seu ambiente de desenvolvimento local >>>

Compartilhar via