Utilisez les bibliothèques Azure (SDK) pour Python

Les bibliothèques Azure open source pour Python simplifier l’approvisionnement, la gestion et l’utilisation de ressources Azure à partir de Python code d’application.

Les détails que vous voulez vraiment savoir

• Utilisez les bibliothèques Azure pour communiquer avec les services Azure depuis du code Python que vous exécutez localement ou dans le cloud. Si vous pouvez exécuter du code Python dans l’étendue d’un service particulier, cela dépend de si ce service supporte actuellement Python.

• Les bibliothèques prennent en charge Python 3.9 ou version ultérieure. Pour plus d’informations sur les versions prises en charge de Python, consultez Azure SDKs Python stratégie de prise en charge des versions. Si vous utilisez PyPy, vérifiez que la version que vous utilisez au moins prend en charge la version Python mentionnée précédemment.

• Le Azure SDK de Python est composé uniquement de plus de 180 bibliothèques de Python individuelles liées à des services de Azure spécifiques. Il n’existe aucun autre outil dans le Kit de développement logiciel (SDK).

• Lorsque vous exécutez du code localement, l’authentification avec Azure s’appuie sur des variables d’environnement, comme décrit dans How pour authentifier les applications Python pour Azure services à l’aide des Azure SDK pour Python.

• Pour installer des packages de bibliothèque avec pip, utilisez pip install <library_name> avec des noms de bibliothèque issus de l’index des packages. Pour installer des packages de bibliothèque dans des environnements conda, utilisez conda install <package_name> en utilisant les noms du canal Microsoft sur anaconda.org. Pour plus d’informations, consultez Installer des packages de bibliothèque Azure.

• Il existe des bibliothèques de gestion et de client distinctes (parfois appelées bibliothèques « plan de gestion » et « plan de données »). Chaque ensemble a des objectifs différents et est utilisé par différents types de code. Pour plus d’informations, consultez les sections suivantes plus loin dans cet article :

  • Créer et gérer des ressources Azure avec des bibliothèques de gestion
  • Connecter et utiliser des ressources Azure avec des bibliothèques clientes

• Vous trouverez de la documentation sur les bibliothèques sur le Azure pour Python Reference, qui est organisée par Azure Service ou le navigateur d’API Python, qui est organisé par nom de package.

• Pour essayer les bibliothèques vous-même, commencez par configurer votre environnement de développement local. Vous pouvez ensuite essayer l’un des exemples autonomes suivants (dans n’importe quel ordre) : Example : Créer un groupe de ressources, Example : Créer et utiliser Azure Storage, Example : Créer et déployer une application web, Example : Créer et interroger une base de données MySQL, et Example : Créer une machine virtuelle.

• Pour des vidéos de démonstration, consultez Présentation des Azure SDK pour Python (PyCon 2021) et Utilisant Azure SDKs pour interagir avec les ressources Azure (PyCon 2020).

Détails non essentiels mais néanmoins intéressants

• Étant donné que le Azure CLI est écrit dans Python et utilise les bibliothèques de gestion, vous pouvez effectuer n’importe quoi avec les commandes Azure CLI que vous pouvez également effectuer à partir d’un script Python. Les commandes CLI fournissent de nombreuses fonctionnalités utiles, telles que l’exécution de plusieurs tâches ensemble, la gestion automatique des opérations asynchrones, la mise en forme de sortie comme les chaînes de connexion, etc. Par conséquent, l’utilisation de l’interface CLI (ou son équivalent, Azure PowerShell) pour la création et la gestion automatisées de scripts peuvent être plus pratiques que l’écriture du code Python équivalent, sauf si vous souhaitez avoir un degré de contrôle beaucoup plus précis sur le processus.

• Les bibliothèques Azure pour Python s’appuient sur l’API REST Azure sous-jacente, afin de pouvoir utiliser ces API par le biais de paradigmes de Python familiers. Toutefois, vous pouvez toujours utiliser l’API REST directement à partir de Python code, si vous le souhaitez.

• Vous trouverez le code source des bibliothèques Azure sur https://github.com/Azure/azure-sdk-for-python. En tant que projet open source, les contributions sont bienvenues !

• Bien que vous puissiez utiliser les bibliothèques avec des interpréteurs tels que IronPython et Jython que Microsoft ne teste pas, vous pouvez rencontrer des problèmes isolés et des incompatibilités.

• Le référentiel source de la documentation de référence de l’API de bibliothèque réside sur https://github.com/MicrosoftDocs/azure-docs-sdk-python/.

• À compter de 2019, Microsoft a mis à jour Azure Python bibliothèques pour partager des modèles cloud courants tels que les protocoles d’authentification, la journalisation, le suivi, les protocoles de transport, les réponses mises en mémoire tampon et les nouvelles tentatives. Les bibliothèques mises à jour adhèrent aux instructions current Azure SDK.

  • Le 31 mars 2023, Microsoft a retiré le support des bibliothèques Azure SDK qui ne sont pas conformes aux directives actuelles de l'Azure SDK. Bien que les bibliothèques plus anciennes puissent toujours être utilisées au-delà du 31 mars 2023, elles ne reçoivent plus de support officiel et de mises à jour de Microsoft. Pour plus d’informations, consultez l’avis Update your Azure SDK libraries.

  • Pour éviter les mises à jour de sécurité et de performances manquantes dans le Azure SDKs, effectuez une mise à niveau vers les bibliothèques de Azure SDK les plus récentes le 31 mars 2023.

  • Pour vérifier les Python bibliothèques affectées, consultez Azure SDK Versions déconseillées pour Python.

• Pour plus d’informations sur les instructions que Microsoft applique aux bibliothèques, consultez les Python Guidelines : Introduction.

Créer et gérer des ressources Azure avec des bibliothèques de gestion

Les bibliothèques management (ou « plan de gestion ») du SDK, dont tous commencent par azure-mgmt-, vous aident à créer, configurer et gérer les ressources Azure à partir de scripts Python. Tous les services Azure ont des bibliothèques de gestion correspondantes. Pour plus d’informations, consultez Azure plan de contrôle et plan de données.

En utilisant les bibliothèques de gestion, vous pouvez écrire des scripts de configuration et de déploiement pour effectuer les mêmes tâches que celles que vous pouvez via le portail Azure ou le Azure CLI. (Comme indiqué précédemment, le Azure CLI est écrit dans Python et utilise les bibliothèques de gestion pour implémenter ses différentes commandes.)

Les exemples suivants illustrent comment utiliser certaines des bibliothèques de gestion primaires :

• Créer un groupe de ressources
• Répertorier les groupes de ressources dans un abonnement
• Créer un compte Azure Storage et un conteneur de stockage Blob
• Créer et déployer une application web sur App Service
• Créer et interroger une base de données MySQL Azure
• Créer une machine virtuelle

Pour plus d'informations sur l'utilisation de chaque bibliothèque de gestion, consultez le fichier README.md ou README.rst situé dans le dossier de projet de la bibliothèque dans le référentiel SDK GitHub. Vous trouverez également d’autres extraits de code dans la documentation reference et les exemples Azure.

Migration à partir d’anciennes bibliothèques de gestion

Si vous migrez du code à partir de versions antérieures des bibliothèques de gestion, consultez les détails suivants :

• Si vous utilisez la ServicePrincipalCredentials classe, consultez Authentifier avec des informations d’identification de jeton.
• Les noms des API asynchrones ont changé comme décrit dans les modèles d’utilisation de la bibliothèque : opérations asynchrones. Les noms des API asynchrones dans les bibliothèques plus récentes commencent par begin_. Dans la plupart des cas, la signature d’API reste la même.

Se connecter et utiliser des ressources Azure avec des bibliothèques clientes

Les bibliothèques client (ou « plan de données ») du SDK vous aident à écrire du code d'application Python pour interagir avec les services déjà approvisionnés. Les bibliothèques clientes existent uniquement pour ces services qui prennent en charge une API cliente.

L’article Example : Utiliser Azure Storage fournit une illustration de base de l’utilisation d’une bibliothèque cliente.

Différents services Azure fournissent également des exemples qui utilisent ces bibliothèques. Consultez les pages d’index suivantes pour d’autres liens :

• Hébergement d’applications
• Cognitive Services
• Solutions de données
• Identité et sécurité
• Apprentissage automatique
• Messagerie et IoT
• Autres services

Pour plus d'informations sur l'utilisation de chaque bibliothèque cliente, consultez le fichier README.md ou README.rst situé dans le dossier du projet de la bibliothèque dans le référentiel SDK GitHub. Vous trouverez également d’autres extraits de code dans la documentation reference et les exemples Azure.

Obtenir de l’aide et se connecter à l’équipe du Kit de développement logiciel (SDK)

• Visitez la documentation des bibliothèques Azure pour Python
• Publier des questions sur la communauté sur Stack Overflow
• Ouvrez des problèmes sur le Kit de développement logiciel (SDK) sur GitHub
• Mention @AzureSDK sur Twitter
• Complétez un court sondage concernant le SDK Azure pour Python

Étape suivante

Configurez votre environnement de développement local afin de pouvoir facilement utiliser l’une des bibliothèques Azure pour Python.