Obtenha as bibliotecas do Azure (SDK) para Python

Artigo
10/23/2023

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

Os detalhes que você realmente quer saber

As bibliotecas do Azure são como você se comunica com os serviços do Azure do código Python executado localmente ou na nuvem. (A possibilidade de executar o código Python dentro do escopo de um serviço específico depende se esse serviço atualmente dá suporte a Python.)
As bibliotecas suportam Python 3.8 ou posterior. Para obter mais informações sobre versões com suporte do Python, consulte Política de suporte de versão Python dos SDKs do Azure. Se você estiver usando o PyPy, certifique-se de que a versão que você usa pelo menos suporta a versão do Python mencionada anteriormente.
O SDK do Azure é composto por mais de 180 bibliotecas Python individuais relacionadas a serviços específicos do Azure. Não há outras ferramentas no "SDK".
Quando você executa código localmente, a autenticação com o Azure depende de variáveis de ambiente, conforme descrito em Como autenticar aplicativos Python em 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, use conda install <package_name> usando nomes do canal da Microsoft em anaconda.org. Para obter mais informações, consulte Instalar pacotes de biblioteca do Azure.
Há bibliotecas de gerenciamento e de cliente distintas (às vezes chamadas de bibliotecas de "plano de gerenciamento" e de "plano de dados"). Cada conjunto atende a diferentes finalidades e é usado por diferentes tipos de código. Para obter mais informações, confira as seções posteriores deste artigo:
- Criar e gerenciar recursos do Azure com bibliotecas de gerenciamento
- Conectar e usar os recursos do Azure com bibliotecas de clientes
A documentação das bibliotecas é encontrada na Referência do Azure para Python, que é organizada por Serviço do Azure ou no navegador de API do Python, que é organizado por nome de pacote.
Para experimentar as bibliotecas por conta própria, recomendamos primeiro configurar seu ambiente de desenvolvimento local. Em seguida, você pode tentar 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 vídeos de demonstração, consulte Apresentando o SDK do Azure para Python (PyCon 2021) e Usando SDKs do Azure para interagir com recursos do Azure (PyCon 2020).

Informações 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 também pode fazer a partir de um script Python. Dito isso, os comandos da CLI fornecem muitos recursos úteis, como a execução de várias tarefas ao mesmo tempo, o tratamento automático de operações assíncronas, a formatação de saída como cadeias de conexão e assim por diante. Portanto, usar a CLI (ou seu equivalente, o Azure PowerShell) para criação automatizada e scripts de gerenciamento pode ser mais conveniente do que escrever o código Python equivalente, a menos que você queira ter um grau muito mais exato de controle sobre o processo.
As bibliotecas do Azure para Python são criadas sobre a API REST do Azure subjacente, 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 desejar.
Você pode encontrar o código-fonte para as bibliotecas do Azure em https://github.com/Azure/azure-sdk-for-python. Como um projeto de software livre, contribuições são bem-vindas!
Embora você possa usar as bibliotecas com interpretadores, como IronPython e Jython, com os quais não comparamos, é possível encontrar problemas isolados e incompatibilidades.
O repositório de fonte para a 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 Python do Azure para compartilhar padrões comuns de nuvem, como protocolos de autenticação, log, rastreamento, protocolos de transporte, respostas em buffer e tentativas. As bibliotecas atualizadas seguem as diretrizes atuais do SDK do Azure.
- Em 31 de março de 2023, retiramos 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 após 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 a falta de atualizações de segurança e desempenho 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 Python são afetadas, consulte 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 começam com azure-mgmt-, ajudam você a criar, configurar e gerenciar recursos do Azure a partir de scripts 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, é possível gravar scripts de configuração e de implantação para executar as mesmas tarefas que você pode realizar pelo portal do Azure ou pela CLI do Azure. (Como observamos anteriormente, a CLI do Azure é escrita em Python e usa as bibliotecas de gerenciamento para implementar seus vários comandos.)

Os seguintes exemplos ilustram como usar algumas das principais bibliotecas de gerenciamento:

Para obter detalhes sobre como trabalhar com cada biblioteca de gerenciamento, veja o arquivo README.md ou README.rst localizado na pasta de projeto da biblioteca no repositório GitHub do SDK. Também é possível encontrar mais trechos de código na documentação de referência e nas Amostras 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, consulte os seguintes detalhes:

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

Conectar e usar os recursos do Azure com bibliotecas de clientes

As bibliotecas de cliente do SDK (ou “plano de dados”) ajudam a escrever código de aplicativos Python para interagir com serviços já provisionados. As bibliotecas de clientes existem somente para os serviços que dão suporte a um API de cliente.

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

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, veja o arquivo README.md ou README.rst localizado na pasta de projeto da biblioteca no repositório GitHub do SDK. Também é possível encontrar mais trechos de código na documentação de referência e nas Amostras do Azure.

Obtenha ajuda e conecte-se com a equipe do SDK

Visite a documentação do Python para bibliotecas do Azure
Poste perguntas para a comunidade no Stack Overflow
Problemas em aberto no SDK no GitHub
Mencione @AzureSDK no Twitter
Conclua uma breve pesquisa sobre o SDK do Azure para Python

Próxima etapa

Nós recomendamos fortemente fazer uma configuração única de seu ambiente de desenvolvimento local para que você possa facilmente usar qualquer uma das bibliotecas do Azure para Python.

Configurar seu ambiente de desenvolvimento local >>>