Use as bibliotecas da Azure (SDK) voltadas para Python

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

Os detalhes que você realmente deseja saber

• Use as bibliotecas do Azure para se comunicar com os serviços do Azure a partir de 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 de se esse serviço em si suporta Python atualmente.

• As bibliotecas dão suporte a Python 3.9 ou posterior. Para obter mais informações sobre versões com suporte do Python, consulte Azure SDKs Python política de suporte à versão. Se você estiver usando PyPy, verifique se a versão usada pelo menos dá suporte à versão Python mencionada anteriormente.

• O Azure SDK para Python é composto exclusivamente por mais de 180 bibliotecas Python individuais relacionadas a serviços Azure específicos. Não há outras ferramentas no SDK.

• Quando você executa o código localmente, a autenticação com Azure depende de variáveis de ambiente, conforme descrito em Como autenticar aplicativos Python para Azure serviços usando o Azure SDK 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 Microsoft no anaconda.org. Para obter mais informações, consulte Instalar pacotes de biblioteca de 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 Azure com bibliotecas de gerenciamento
  • Conectar e usar recursos Azure com bibliotecas de cliente

• Você pode encontrar a documentação das bibliotecas no Azure for Python Reference, que é organizado pelo Serviço Azure ou pelo navegador Python API, que é organizado pelo nome do pacote.

• Para experimentar as bibliotecas por conta própria, primeiro configure seu ambiente de desenvolvimento local. Em seguida, você pode experimentar qualquer um dos seguintes exemplos autônomos (em qualquer ordem): Example: Criar um grupo de recursos, Example: criar e usar Azure Storage, Example: criar e implantar um aplicativo Web, Example: criar e consultar um banco de dados MySQL, e Example: criar uma máquina virtual.

• Para ver vídeos de demonstração, consulte Introducing the Azure SDK for Python (PyCon 2021) and Using Azure SDKs to interact with Azure resources (PyCon 2020).

Detalhes não essenciais, mas ainda interessantes

• Como o Azure CLI é escrito em Python e usa as bibliotecas de gerenciamento, você pode fazer qualquer coisa com comandos Azure CLI que você também pode fazer de um script Python. Os comandos da CLI fornecem muitos recursos úteis, como executar várias tarefas em conjunto, lidar automaticamente com operações assíncronas, formatar saída como cadeias de conexão e muito mais. 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 de Python equivalente, a menos que você queira ter um grau de controle muito mais exato sobre o processo.

• As bibliotecas de Azure para Python se baseiam na API REST Azure subjacente, para que você possa usar essas APIs por meio de paradigmas Python familiares. No entanto, você pode sempre usar a API REST diretamente do código Python, se desejar.

• Você pode encontrar o código-fonte das bibliotecas de Azure em 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 a Microsoft não testa, 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, a Microsoft atualizou bibliotecas de Azure Python 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 aderem às diretrizes atuais do Azure SDK.

  • Em 31 de março de 2023, a Microsoft retirou o suporte para bibliotecas de Azure SDK que não estão em conformidade com as diretrizes de Azure SDK atuais. Embora as bibliotecas mais antigas ainda possam ser usadas além de 31 de março de 2023, elas não recebem mais suporte oficial e atualizações da Microsoft. Para obter mais informações, consulte o aviso Update suas bibliotecas de Azure SDK.

  • Para evitar perder atualizações de segurança e desempenho nos SDKs do Azure, atualize para as bibliotecas mais recentes do Azure SDK até 31 de março de 2023.

  • Para verificar quais bibliotecas Python são afetadas, consulte Azure SDK Versões preteridas para Python.

• Para obter detalhes sobre as diretrizes que a Microsoft aplica às bibliotecas, consulte as diretrizes Python: Introdução.

Criar e gerenciar recursos Azure com bibliotecas de gerenciamento

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

Usando 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 Azure ou do Azure CLI. (Conforme observado anteriormente, o Azure CLI é escrito 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:

• Criar um Grupo de Recursos.
• Listar grupos de recursos em uma assinatura
• Criar uma conta Azure Storage e um contêiner de Armazenamento de Blobs
• Criar e implantar um aplicativo Web no Serviço de Aplicativo
• Criar e consultar um banco de dados MySQL Azure
• Criar uma máquina virtual

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 SDK GitHub repositório. Você também pode encontrar mais snippets de código na documentação reference e no Azure Samples.

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 Azure com bibliotecas de cliente

As bibliotecas client (ou "plano de dados") do SDK ajudam-no a escrever código de aplicação em 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 Example: Use Azure Storage fornece uma ilustração básica do uso de uma biblioteca de clientes.

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

• Hospedagem de aplicativos
• Serviços Cognitivos
• Soluções de dados
• Identidade e segurança
• Aprendizado de máquina
• Mensagens e IoT
• Outros serviços

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 reference e no Azure Samples.

Obter ajuda e conectar-se com a equipe do SDK

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

Próxima etapa

Configure seu ambiente de desenvolvimento local para que você possa usar facilmente qualquer uma das bibliotecas de Azure para Python.