Compartir a través de

Uso de las bibliotecas de Azure (SDK) para Python

  • Artículo

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

Detalles no esenciales, pero aún interesantes

  • Dado que el de la CLI de Azure se escribe 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. Dicho esto, 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 cadenas de conexión, etc. Por lo tanto, el uso de la CLI (o su equivalente, Azure PowerShell) para scripts de creación y administración automatizados puede ser más cómodo 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 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, las contribuciones son bienvenidas.

  • Aunque puedes usar las bibliotecas con intérpretes, como IronPython y Jython, los cuales no probamos, es posible que encuentres problemas aislados e incompatibilidades.

  • El repositorio de origen de la documentación de referencia de la API de biblioteca reside 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, hemos retirado la compatibilidad con las bibliotecas de Azure SDK que no se ajustan a las actuales directrices de Azure SDK. 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 de Azure SDK.

    • 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 antes del 31 de marzo de 2023.

    • Para comprobar qué bibliotecas de Python se ven afectadas, consulte Azure SDK Deprecated Releases for 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 de del SDK (o "plano de administración"), los nombres de los cuales comienzan por azure-mgmt-, 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 realizar las mismas tareas que puede realizar a través de la Azure Portal o la CLI de Azure . (Como se indicó anteriormente, la 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:

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 repositorio de GitHub del SDK de . También puede encontrar más fragmentos de código en la documentación de referencia de y Azure Ejemplos.

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 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 begin_. 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 de cliente del SDK (o "plano de datos") le ayudan a desarrollar código de aplicaciones en Python para interactuar con servicios ya existentes. Las bibliotecas cliente solo existen para aquellos servicios que admiten una API de cliente.

El artículo titulado Ejemplo: Uso de Azure Storageproporciona una ilustración básica del uso de la biblioteca cliente.

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

Para obtener 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 del proyecto de la biblioteca en el repositorio de GitHub del SDK de . También puede encontrar más fragmentos de código en la documentación de referencia de y los Ejemplos de Azure.

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

Paso siguiente

Se recomienda encarecidamente realizar una configuració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 >>>