Uso de las bibliotecas de Azure (SDK) para Python

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

Los detalles que realmente quiere saber

• Utilice las bibliotecas de Azure para comunicarse con los servicios de Azure en código Python que ejecute localmente o en la nube. Si puede ejecutar Python código dentro del ámbito de un servicio determinado depende de si ese propio servicio admite actualmente Python.

• Las bibliotecas admiten Python 3.9 o posterior. Para obtener más información sobre las versiones admitidas de Python, consulte SDK de Azure Python directiva de compatibilidad de versiones. Si usa PyPy, asegúrese de que la versión que usa al menos admite la versión de Python mencionada anteriormente.

• El SDK de Azure para Python se compone únicamente de más de 180 bibliotecas de Python individuales relacionadas con servicios Azure específicos. No hay otras herramientas en el SDK.

• Al ejecutar código localmente, la autenticación con Azure se basa en variables de entorno, tal y como se describe en Cómo autenticar Python aplicaciones en Azure servicios mediante el SDK de Azure para Python.

• Para instalar paquetes de biblioteca con pip, use mediante nombres de biblioteca del índice de paquete de . Para instalar paquetes de biblioteca en entornos de conda, use conda install <package_name> mediante nombres del canal Microsoft en anaconda.org. Para obtener más información, consulte Instalar paquetes de bibliotecas de Azure.

• Hay bibliotecas de administración distintas y bibliotecas de cliente (a veces denominadas bibliotecas de "plano de administración" y "plano de datos"). Cada conjunto sirve para distintos propósitos y se usa en diferentes tipos de código. Para obtener más información, consulte las secciones siguientes más adelante en este artículo:

  • Crear y administrar recursos de Azure con bibliotecas de administración
  • Conectar y usar recursos de Azure con bibliotecas de cliente

• Puede encontrar documentación sobre las bibliotecas en el Azure para Python Reference, que está organizada por Azure Service o el explorador de API Python, que está organizado por nombre de paquete.

• Para probar las bibliotecas por su cuenta, configure primero el entorno de desarrollo local. A continuación, puede probar cualquiera de los siguientes ejemplos independientes (en cualquier orden): Example: Crear un grupo de recursos, Example: Crear y usar Azure Storage, Example: Crear e implementar una aplicación web, Example: Crear y consultar una base de datos MySQL, y Example: cree una máquina virtual.

• Para ver vídeos de demostración, consulte Introducing the SDK de Azure for Python (PyCon 2021) and Using SDK de Azure to interact with Azure resources (PyCon 2020).

Detalles no esenciales, pero aún interesantes

• Dado que el CLI de Azure se escribe en Python y usa las bibliotecas de administración, puede hacer cualquier cosa con comandos de CLI de Azure que también puede hacer desde un script de Python. Los comandos de la CLI proporcionan muchas características útiles, como realizar varias tareas juntas, controlar automáticamente las operaciones asincrónicas, dar formato a la salida, como las cadenas de conexión, etc. Por lo tanto, el uso de la CLI (o su equivalente, Azure PowerShell) para scripts de administración y creación automatizados 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 DE REST subyacente Azure, por lo que puede usar esas API a través de paradigmas de Python conocidos. Sin embargo, siempre puede usar la API REST directamente desde Python código, 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, las contribuciones son bienvenidas.

• Aunque puede usar las bibliotecas con intérpretes como IronPython y Jython con los que Microsoft no prueba, es posible que encuentre problemas aislados y incompatibilidades.

• El repositorio de origen de la documentación de referencia de la API de biblioteca reside en .

• A partir de 2019, Microsoft actualizó las bibliotecas de Azure Python para compartir patrones comunes de la nube, como protocolos de autenticación, registro de actividades, seguimiento, protocolos de transporte, respuestas en búfer y reintentos. Las bibliotecas actualizadas se adhieren a las directrices de current SDK de Azure.

  • El 31 de marzo de 2023, Microsoft retiró el soporte técnico para las bibliotecas de SDK de Azure que no cumplen las directrices actuales de SDK de Azure. Aunque las bibliotecas anteriores todavía se pueden usar más allá del 31 de marzo de 2023, ya no reciben soporte técnico oficial ni actualizaciones de Microsoft. Para obtener más información, consulte el aviso Actualizar las bibliotecas de SDK de Azure.

  • Para no perderse actualizaciones de seguridad y rendimiento de los SDK de Azure, actualice a las últimas bibliotecas de SDK de Azure antes de que llegue el 31 de marzo de 2023.

  • Para comprobar qué bibliotecas de Python se ven afectadas, consulte SDK de Azure Versiones en desuso para Python.

• Para obtener más información sobre las directrices que Microsoft aplica a las bibliotecas, consulte las Python Guidelines: Introduction.

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

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

Mediante las bibliotecas de administración, puede escribir scripts de configuración e implementación para realizar las mismas tareas que puede realizar a través del portal de Azure o el CLI de Azure. (Como se indicó anteriormente, el CLI de Azure se escribe en Python y usa las bibliotecas de administración para implementar sus distintos comandos).

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

• Crear un grupo de recursos
• Enumerar grupos de recursos en una suscripción
• Crear una cuenta de Azure Storage y un contenedor de Blob Storage
• Creación e implementación de una aplicación web en App Service
• Crear y consultar una base de datos mySQL de Azure
• Crear una máquina virtual

Para obtener más información sobre cómo trabajar con cada biblioteca de administración, consulte el archivo README.md o README.rst ubicado en la carpeta del proyecto de la biblioteca en el SDK GitHub repositorio. También puede encontrar más fragmentos de código en la documentación de reference y el Azure Samples.

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 , consulte Autenticar con credenciales de token.
• Los nombres de las API asincrónicas han cambiado como se describe en los patrones de uso de Library: operaciones asincrónicas. Los nombres de las API asincrónicas de las bibliotecas más recientes comienzan por . En la mayoría de los casos, la firma de api sigue siendo la misma.

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

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

El artículo Example: Use Azure Storage proporciona una ilustración básica del uso de una biblioteca cliente.

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

• Hospedaje de aplicaciones
• Servicios Cognitivos
• soluciones de datos
• Identidad y seguridad
• Aprendizaje Automático
• Mensajería e IoT
• Otros servicios

Para obtener más información sobre cómo trabajar con cada biblioteca cliente, consulte el archivo README.md o README.rst ubicado en la carpeta del proyecto de la biblioteca en el repositorio de SDK GitHub. También puede encontrar más fragmentos de código en la documentación de reference y el Azure Samples.

Obtención de ayuda y conexión con el equipo del SDK

• Visite las bibliotecas Azure para obtener Python documentación
• Publique preguntas a la comunidad en Stack Overflow
• Problemas abiertos con el SDK en GitHub
• Mencionar @AzureSDK en Twitter
• Complete una breve encuesta sobre el SDK de Azure de Python

Paso siguiente

Configure el entorno de desarrollo local para que pueda usar fácilmente cualquiera de las bibliotecas de Azure para Python.