Uso de las bibliotecas de Azure (SDK) para Python

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 son compatibles con Python 2.7 y Python 3.6 o posterior, y también se han probado con PyPy 5.4+.

• 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 el código localmente, la autenticación con Azure se basa en las variables de entorno, tal y como se describe en Configuración del entorno de desarrollo local.

• Para instalar paquetes de biblioteca con pip, use pip install <library_name> el uso de nombres de biblioteca del índice de pip install <library_name>. Para instalar paquetes de biblioteca en entornos de Conda, use el uso de nombres del canal conda install <package_name> de Microsoft en conda install <package_name>. Para más información, consulte Instalación de bibliotecas 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:

  • Aprovisionamiento 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. Actualmente, a menudo es necesario hacer clic en varias capas para llegar a las clases y los métodos que le interesan. Somos conscientes de que esta experiencia no resulta del todo satisfactoria. Por ello, estamos trabajando para mejorarla.

• 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: Aprovisionamiento de un grupo de recursos, Ejemplo: Aprovisionamiento y uso de Azure Storage, Ejemplo: Aprovisionamiento de una aplicación web e implementación de código, Ejemplo: Aprovisionamiento y uso de una base de datos MySQL, y Ejemplo: Aprovisionamiento de una máquina virtual.

• Para ver vídeos de demostración, consulte Introducción a Azure SDK para Python (PyCon 2021) y Uso de Azure SDK 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 con las bibliotecas de administración, todo lo que puede hacer con los comandos de la CLI de Azure también se puede realizar 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 scripts de aprovisionamiento y administración automatizados puede resultar mucho más cómodos que escribir el código de Python equivalente, a menos que desee tener un grado de control mucho más preciso sobre el proceso.

• Las bibliotecas de Azure para Python son una capa que se sitúa encima de la API REST de Azure subyacente, lo que permite usar esas API con los 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/.

• Estamos actualizando las bibliotecas de Azure para Python para compartir patrones comunes en la nube, por ejemplo, protocolos de autenticación, registros, seguimientos, protocolos de transporte, respuestas almacenadas en búfer y reintentos.

  • Esta funcionalidad compartida está contenida en la biblioteca azure-core.

  • Las bibliotecas que actualmente funcionan con la biblioteca principal se enumeran en el artículo sobre las versiones más recientes de Azure SDK para Python. Estas bibliotecas, principalmente las bibliotecas cliente, a veces se llaman "pista 2".

  • Las bibliotecas de administración, y otras que aún no se han actualizado, a veces se llaman "pista 1".

• Para más información sobre las directrices aplicables a las bibliotecas, consulte Guía de Python: Introducción.

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

Las bibliotecas de administración (o "plano de administración") del SDK, cuyos nombres comienzan por , le ayudan a crear, aprovisionar y administrar recursos de Azure desde scripts de Python. Todos los servicios de Azure tienen bibliotecas de administración correspondientes.

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:

• Aprovisionamiento de un grupo de recursos
• Enumeración de los grupos de recursos de una suscripción
• Aprovisionamiento de Azure Storage con las bibliotecas de Azure para Python
• Uso de las bibliotecas de Azure para aprovisionar e implementar una aplicación web
• Uso de las bibliotecas de Azure para aprovisionar una base de datos
• Aprovisionamiento de una máquina virtual

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á fragmentos de código adicionales 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 ServicePrincipalCredentials
• 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. En pocas palabras, 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.

El artículo Ejemplo: Acceso a Azure Storage con las bibliotecas de Azure para Python proporciona una descripció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 siguientes páginas de índice para obtener vínculos adicionales:

• Hospedaje de aplicaciones
• Cognitive Services
• Soluciones de datos
• Identidad y seguridad
• Aprendizaje automático
• Mensajería e IoT
• Otros servicios

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á fragmentos de código adicionales 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.
• Menciones @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.