Utiliser les bibliothèques Azure (SDK) pour Python

Article
10/23/2023

Les bibliothèques Azure open source pour Python simplifient le provisionnement, la gestion et l’utilisation des ressources Azure à partir du code d’application Python.

Détails à connaître absolument

Les bibliothèques Azure sont le moyen par lequel vous communiquez avec des services Azure à partir de code Python que vous exécutez localement ou dans le cloud. (Le fait de pouvoir exécuter du code Python dans l’étendue d’un service particulier dépend du fait que ce service lui-même prend actuellement en charge Python ou non.)
Les bibliothèques prennent en charge Python 3.8 ou version ultérieure. Pour plus d’informations sur les versions prises en charge de Python, consultez la stratégie de prise en charge des kits sdk Azure Python. Si vous utilisez PyPy, vérifiez que la version que vous utilisez prend au moins en charge la version de Python mentionnée précédemment.
Le kit SDK Azure pour Python se compose seulement de plus de 180 bibliothèques Python individuelles, associées à des services Azure spécifiques. Il n’existe aucun autre outil dans le « kit SDK ».
Lorsque vous exécutez du code localement, l’authentification auprès d’Azure s’appuie sur des variables d’environnement, comme décrit dans Comment authentifier des applications Python auprès des services Azure à l’aide du Kit de développement logiciel (SDK) Azure 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> des noms à partir 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 remplit 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
- Se connecter à des ressources Azure et les utiliser avec des bibliothèques clientes
La documentation des bibliothèques se trouve dans la documentation de référence d’Azure pour Python, qui est organisée par service Azure, ou dans le navigateur de l’API Python, qui est organisé par nom de package.
Pour essayer les bibliothèques par vous-même, nous vous recommandons d’abord de configurer votre environnement de développement local. Vous pouvez ensuite essayer l’un des exemples autonomes suivants (dans n’importe quel ordre) : Exemple : Créer un groupe de ressources, Exemple : Créer et utiliser Stockage Azure, Exemple : Créer et déployer une application web, Exemple : Créer et interroger une base de données MySQL, et Exemple : Créer une machine virtuelle.
Pour obtenir des vidéos de démonstration, consultez Présentation du Kit de développement logiciel (SDK) Azure pour Python (PyCon 2021) et utilisation des kits SDK Azure pour interagir avec les ressources Azure (PyCon 2020).

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

Étant donné que l’interface Azure CLI est écrite en Python à l’aide des bibliothèques de gestion, tout ce que vous pouvez faire avec les commandes Azure CLI que vous pouvez également effectuer à partir d’un script Python. Cela dit, les commandes CLI fournissent de nombreuses fonctionnalités utiles, telles que l’exécution simultanée de plusieurs tâches, la gestion automatique des opérations asynchrones, la mise en forme de la sortie comme les chaînes de connexion, etc. Par conséquent, l’utilisation de l’interface CLI (ou de son équivalent, Azure PowerShell) pour les scripts de création et de gestion automatisés peut être plus pratique 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, ce qui vous permet d’utiliser ces API par le biais de paradigmes Python familiers. Toutefois, vous pouvez toujours utiliser l’API REST directement à partir du code Python, si vous le souhaitez.
Vous trouverez le code source des bibliothèques Azure dans https://github.com/Azure/azure-sdk-for-python. Comme il s’agit d’un projet open source, les contributions sont les bienvenues.
Bien que vous puissiez utiliser les bibliothèques avec des interpréteurs tels qu’IronPython et Jython que nous ne testons pas, vous pouvez rencontrer des incompatibilités et des problèmes isolés.
Le référentiel source de la documentation de référence de l’API des bibliothèques se trouve sur https://github.com/MicrosoftDocs/azure-docs-sdk-python/.
À compter de 2019, nous avons mis à jour les bibliothèques Azure Python 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 respectent les instructions actuelles du Kit de développement logiciel (SDK) Azure.
- Le 31 mars 2023, nous avons mis hors service la prise en charge des bibliothèques du Kit de développement logiciel (SDK) Azure qui ne sont pas conformes aux instructions actuelles du Kit de développement logiciel (SDK) Azure. Bien que les bibliothèques plus anciennes puissent toujours être utilisées au-delà du 31 mars 2023, elles ne recevront plus de support officiel et de mises à jour de Microsoft. Pour plus d’informations, consultez l’avis de mise à jour de vos bibliothèques du Kit de développement logiciel (SDK) Azure.
- Pour éviter les mises à jour de sécurité et de performances manquantes pour les kits sdk Azure, effectuez une mise à niveau vers les dernières bibliothèques du KIT de développement logiciel (SDK) Azure d’ici le 31 mars 2023.
- Pour case activée quelles bibliothèques Python sont affectées, consultez les versions dépréciées du Kit de développement logiciel (SDK) Azure pour Python.
Pour plus d’informations sur les instructions que nous appliquons aux bibliothèques, consultez les instructions Python : Introduction.

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

Les bibliothèques de gestion (ou « plan de gestion ») du Kit de développement logiciel (SDK), dont tous commencent azure-mgmt-par , 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 Plan de contrôle et plan de données Azure.

Grâce aux 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 effectuer à l’aide du Portail Azure ou d’Azure CLI. (Comme indiqué précédemment, Azure CLI est écrit en Python et utilise les bibliothèques de gestion pour implémenter ses différentes commandes.)

Les exemples suivants montrent comment utiliser certaines bibliothèques de gestion principales :

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 dépôt GitHub du kit SDK. Vous trouverez également d’autres extraits de code dans la documentation de référence et la page 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 classe ServicePrincipalCredentials, consultez Authentifier avec des informations d’identification de jeton.
Les noms des API asynchrones ont changé, comme décrit dans Modèles d’utilisation des bibliothèques - 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 de l’API reste la même.

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

Les bibliothèques cliente (ou « plan de données ») du Kit de développement logiciel (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 les services qui prennent en charge une API cliente.

L’article, Exemple : Utiliser Stockage Azure, fournit une illustration de base de l’utilisation de la bibliothèque cliente.

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

Pour plus d’informations sur l’utilisation de chaque bibliothèque cliente, consultez le fichier README.md ou README.rst situé dans le dossier de projet de la bibliothèque, dans le dépôt GitHub du kit SDK. Vous trouverez également d’autres extraits de code dans la documentation de référence et la page Exemples Azure.

Obtenez de l’aide et communiquez avec l’équipe du Kit de développement logiciel (SDK)

Reportez-vous à la documentation des bibliothèques Azure pour Python
Posez des questions à la communauté sur Stack Overflow
Soumettez des problèmes relatifs au kit SDK sur GitHub
Mention @AzureSDK sur Twitter
Répondre à une courte enquête sur le SDK Azure pour Python

Étape suivante

Nous vous recommandons vivement de procéder à une installation unique de votre environnement de développement local pour pouvoir utiliser facilement l’une des bibliothèques Azure pour Python.

Configurer votre environnement de développement local >>>