Usar as bibliotecas do Azure (SDK) para Python

Artigo
10/23/2023

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

Os detalhes que você realmente quer 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 próprio serviço atualmente suporta Python.)
As bibliotecas suportam Python 3.8 ou posterior. Para obter mais informações sobre versões suportadas 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 para Python é composto exclusivamente 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 nos serviços do Azure usando o SDK do Azure para Python.
Para instalar pacotes de biblioteca com pip, use pip install <library_name> usando nomes de biblioteca do índice de pacotes. Para instalar pacotes de biblioteca em ambientes conda, use conda install <package_name> usando nomes do canal da Microsoft no anaconda.org. Para obter mais informações, consulte Instalar pacotes de biblioteca do Azure.
Existem bibliotecas de cliente e de gerenciamento distintas (às vezes chamadas de bibliotecas de "plano de gerenciamento" e "plano de dados"). Cada conjunto serve propósitos diferentes 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 para as bibliotecas é encontrada na Referência do Azure para Python, que é organizada pelo Serviço do Azure, ou no navegador da API do 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 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).

Detalhes não essenciais, mas ainda assim 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 executar várias tarefas juntas, lidar automaticamente com operações assíncronas, formatar saídas 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 muito mais exigente de controle sobre o processo.
As bibliotecas do Azure para Python são construídas com base na API REST do Azure subjacente, permitindo que você use essas APIs por meio de paradigmas Python familiares. No entanto, você sempre pode usar a API REST diretamente do código Python, se desejar.
Você pode encontrar o código-fonte das bibliotecas do Azure em https://github.com/Azure/azure-sdk-for-python. Como um projeto de código aberto, as contribuições são bem-vindas!
Embora você possa usar as bibliotecas com intérpretes como IronPython e Jython que não testamos contra, você pode encontrar problemas isolados e incompatibilidades.
O repositório de origem para a documentação de referência da API da biblioteca reside no https://github.com/MicrosoftDocs/azure-docs-sdk-python/.
A partir de 2019, atualizamos as bibliotecas Python do Azure para compartilhar padrões de nuvem comuns, como protocolos de autenticação, registro, rastreamento, protocolos de transporte, respostas em buffer e tentativas. As bibliotecas atualizadas aderem às 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 após 31 de março de 2023, elas não receberão mais suporte e atualizações oficiais 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 do SDK (ou "plano de gerenciamento"), 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 Plano 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. (Como 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árias:

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 trechos de código na documentação de referência e nos Exemplos do Azure.

Migrando 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ê usar a ServicePrincipalCredentials classe, consulte 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-se e usar recursos do Azure com bibliotecas de cliente

As bibliotecas de cliente do SDK (ou "plano de dados") ajudam você a escrever código de aplicativo Python para interagir com serviços já provisionados. As bibliotecas de cliente existem apenas para os serviços que suportam uma 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 obter outros links:

Para obter detalhes sobre como trabalhar com cada biblioteca cliente, 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 trechos de código na documentação de referência e nos Exemplos do Azure.

Obtenha ajuda e conecte-se com a equipe do SDK

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

Próximo passo

É 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 >>>