Uso de las bibliotecas de Azure (SDK) para Python

Artículo
10/19/2023

Las bibliotecas de Azure para Python son de código abierto y simplifican el aprovisionamiento, la administración y el uso de los recursos de Azure desde el código de aplicación de Python.

Detalles que debe conocer

Las bibliotecas de Azure son la manera de comunicarse con los servicios de Azure desde el código de Python que se ejecuta localmente o en la nube. (Poder ejecutar el código de Python dentro del ámbito de un servicio determinado depende de si ese servicio admite actualmente Python).
Las bibliotecas admiten Python 3.8 o posterior. Para más información sobre las versiones compatibles de Python, consulte Directiva de compatibilidad con versiones de Python de SDK de Azure. Si usa PyPy, asegúrese de que la versión que usa al menos admite la versión de Python mencionada anteriormente.
Azure SDK para Python se compone exclusivamente de más de 180 bibliotecas de Python individuales relacionadas con servicios específicos de Azure. No hay otras herramientas en el "SDK".
Al ejecutar código localmente, la autenticación con Azure se basa en variables de entorno, como se describe en Autenticación de aplicaciones de Python en servicios de Azure mediante el SDK de Azure para Python.
Para instalar paquetes de biblioteca con pip, use pip install <library_name> con los nombres de biblioteca del índice de paquetes. Para instalar paquetes de biblioteca en entornos de Conda, use el uso conda install <package_name> de nombres del canal de Microsoft en anaconda.org. Para más información, consulte Instalación de paquetes de biblioteca de Azure.
Hay distintas bibliotecas de administración y cliente (a veces llamadas bibliotecas del "plano de administración" y del "plano de datos"). Cada conjunto tiene distintos objetivos y se usa en diferentes tipos de código. Para más información, consulte las siguientes secciones de este artículo:
- Creación y administración de recursos de Azure con bibliotecas de administración
- Conexión y uso de los recursos de Azure con bibliotecas cliente
La documentación de las bibliotecas se encuentra en la referencia de Azure para Python, que se organiza por servicios de Azure, o en el explorador de API de Python, que se organiza por nombres de paquete.
Para probar las bibliotecas por sí mismo, le recomendamos que primero configure su entorno de desarrollo local. A continuación, puede probar cualquiera de los siguientes ejemplos independientes (en cualquier orden): Ejemplo: Crear un grupo de recursos, Ejemplo: Crear y usar Azure Storage, Ejemplo: Crear e implementar una aplicación web, Ejemplo: Crear y consultar una base de datos MySQL y Ejemplo: Crear una máquina virtual.
Para ver vídeos de demostración, consulte Introducción al SDK de Azure para Python (PyCon 2021) y Uso de SDK de Azure para interactuar con los recursos de Azure (PyCon 2020).

Detalles no esenciales de interés

Dado que la CLI de Azure está escrita en Python mediante las bibliotecas de administración, cualquier cosa que pueda hacer con los comandos de la CLI de Azure también puede hacerlo desde un script de Python. No obstante, los comandos de la CLI proporcionan muchas características útiles, como la realización simultánea de varias tareas, el control automático de operaciones asincrónicas, el formato de salida como cadenas de conexión, etc. Por lo tanto, el uso de la CLI (o su equivalente, Azure PowerShell) para la creación y administración automatizadas de scripts puede ser más conveniente que escribir el código de Python equivalente, a menos que desee tener un grado de control mucho más exacto sobre el proceso.
Las bibliotecas de Azure para Python se basan en la API REST de Azure subyacente, lo que le permite usar esas API a través de paradigmas conocidos de Python. Sin embargo, siempre puede usar la API REST directamente desde el código de Python, si lo desea.
Puede encontrar el código fuente de las bibliotecas de Azure en https://github.com/Azure/azure-sdk-for-python. Como proyecto de código abierto, todas las contribuciones son bienvenidas.
Aunque las bibliotecas pueden usarse con intérpretes como IronPython y Jython, que no probamos, podría experimentar problemas aislados e incompatibilidades.
El repositorio de origen de la documentación de referencia de API de las bibliotecas se encuentra en https://github.com/MicrosoftDocs/azure-docs-sdk-python/.
A partir de 2019, actualizamos las bibliotecas de Python de Azure para compartir patrones comunes en la nube, como protocolos de autenticación, registro, seguimiento, protocolos de transporte, respuestas almacenadas en búfer y reintentos. Las bibliotecas actualizadas cumplen las directrices actuales del SDK de Azure.
- El 31 de marzo de 2023, se retiró la compatibilidad con las bibliotecas de Azure SDK que no se ajustan a las directrices actuales del SDK de Azure. Aunque las bibliotecas anteriores todavía se pueden usar más allá del 31 de marzo de 2023, ya no recibirán soporte técnico oficial ni actualizaciones de Microsoft. Para más información, consulte el aviso Actualización de las bibliotecas del SDK de Azure.
- Para evitar que falten actualizaciones de seguridad y rendimiento en los SDK de Azure, actualice a las bibliotecas más recientes del SDK de Azure el 31 de marzo de 2023.
- Para comprobar qué bibliotecas de Python se ven afectadas, consulte Versiones en desuso del SDK de Azure para Python.
Para obtener más información sobre las directrices que aplicamos a las bibliotecas, consulte las Directrices de Python: Introducción.

Creación y administración de recursos de Azure con bibliotecas de administración

Las bibliotecas de administración (o "plano de administración") del SDK, los nombres de los cuales comienzan azure-mgmt-por , le ayudan a crear, configurar y administrar recursos de Azure desde scripts de Python. Todos los servicios de Azure tienen bibliotecas de administración correspondientes. Para más información, consulte Plano de control y plano de datos de Azure.

Con las bibliotecas de administración, puede escribir scripts de configuración e implementación para llevar a cabo las mismas tareas que puede realizar mediante Azure Portal o la CLI de Azure. (Como se ha indicado anteriormente, la CLI de Azure está escrita en Python y usa las bibliotecas de administración para implementar sus diversos comandos).

En los siguientes ejemplos se muestra cómo usar algunas de las bibliotecas de administración principales:

Para más información sobre cómo trabajar con cada biblioteca de administración, consulte el archivo README.md o README.rst que se encuentra en la carpeta de proyecto de la biblioteca, en el repositorio de GitHub del SDK. También encontrará otros fragmentos de código en la documentación de referencia y en los ejemplos de Azure.

Migración desde bibliotecas de administración anteriores

Si va a migrar código de versiones anteriores de las bibliotecas de administración, consulte los detalles siguientes:

Si usa la clase ServicePrincipalCredentials, consulte Autenticación con credenciales de token.
Los nombres de las API asincrónicas han cambiado, tal como se describe en Patrones de uso de las bibliotecas de Azure para Python: operaciones asincrónicas. Los nombres de las API asincrónicas de las bibliotecas más recientes comienzan por begin_. En la mayoría de los casos, la firma de la API sigue siendo la misma.

Conexión y uso de los recursos de Azure con bibliotecas cliente

Las bibliotecas cliente (o del "plano de datos") del SDK le ayudan a escribir código de aplicación de Python para interactuar con servicios ya aprovisionados. Las bibliotecas cliente solo existen para los servicios que admiten una API de cliente.

En el artículo Ejemplo : Uso de Azure Storage se proporciona una ilustración básica del uso de la biblioteca cliente.

Los diferentes servicios de Azure también proporcionan ejemplos del uso de estas bibliotecas. Consulte las páginas de índice siguientes para ver otros vínculos:

Para más información sobre cómo trabajar con cada biblioteca cliente, consulte el archivo README.md o README.rst que se encuentra en la carpeta de proyecto de la biblioteca, en el repositorio de GitHub del SDK. También encontrará otros fragmentos de código en la documentación de referencia y en los ejemplos de Azure.

Ayuda y contacto con el equipo de SDK

Consulte la documentación de las bibliotecas de Azure para Python.
Plantee preguntas a la comunidad en Stack Overflow.
Abra incidencias relativas al SDK en GitHub.
Mencione @AzureSDK en Twitter
Realización de una breve encuesta sobre el SDK de Azure para Python

Paso siguiente

Es muy recomendable realizar una instalación única del entorno de desarrollo local para que pueda usar fácilmente cualquiera de las bibliotecas de Azure para Python.

Configuración del entorno de desarrollo local >>>