Compartir a través de

Introducción a las plantillas de la CLI para desarrolladores de Azure

  • Artículo

Las plantillas de la CLI para desarrolladores de Azure (azd) son repositorios de código estándar que incluyen código de aplicación de ejemplo, así como azd archivos de configuración e infraestructura. azd Las plantillas le permiten aprovisionar recursos de Azure, implementar la aplicación, configurar canalizaciones de CI/CD, etc. Puede crear sus propias plantillas o empezar a usar una plantilla existente desde un repositorio de plantillas como Awesome AZD. En este artículo, obtendrá información sobre los siguientes conceptos:

  • Cómo azd las plantillas le permiten aprovisionar e implementar recursos de aplicación
  • Cómo azd se estructuran las plantillas
  • Cómo decidir si usar una plantilla existente o crear una
  • Exploración de las plantillas de inicio existentes azd

¿Por qué usar plantillas de la CLI para desarrolladores de Azure?

A menudo, los desarrolladores se enfrentan a muchas tareas difíciles y lentas al compilar aplicaciones de entorno configuradas y diseñadas correctamente para la nube. Teams debe tener en cuenta muchos problemas diferentes en estos entornos, como la creación de recursos, la aplicación de configuraciones, la configuración de la supervisión y el registro, la creación de canalizaciones de CI/CD y otras tareas. azd Las plantillas reducen y simplifican estas responsabilidades para ayudar al desarrollador en su recorrido desde el desarrollo local a una aplicación implementada correctamente en Azure.

Por ejemplo, supongamos que trabaja en una empresa que opera una plataforma de comunicación de clientes y administración de vales, que requiere los siguientes recursos de Azure:

  • Dos instancias de App Service y un plan de App Service para hospedar una aplicación web front-end y una API de back-end
  • Una instancia de Key Vault para almacenar secretos de aplicación seguros
  • Una base de datos de Cosmos DB para almacenar los datos de la aplicación de forma permanente
  • Recursos de Azure Monitor, como los paneles de Application Insights
  • Una instancia de Service Bus para administrar la mensajería escalable
  • Las canalizaciones de integración continua y entrega continua garantizan que los cambios se pueden implementar de forma confiable a través de un proceso automatizado y repetible.

En lugar de empezar desde cero, puede azd aprovechar las plantillas de arquitectura existentes para aprovisionar e implementar la mayoría de los recursos automáticamente. Después, el equipo de desarrollo puede centrarse en compilar la aplicación y realizar ajustes más pequeños en la arquitectura de plantilla.

Funcionamiento de las plantillas de la CLI para desarrolladores de Azure

Las plantillas de la CLI para desarrolladores de Azure están diseñadas para trabajar con azd comandos como azd init y azd up. Las plantillas incluyen archivos de configuración e infraestructura como código (IaC) que usan los comandos para realizar tareas como aprovisionar recursos de Azure e implementar el código de la aplicación en ellos.

Por ejemplo, un flujo de trabajo típico de azd que utiliza una plantilla existente incluye los siguientes pasos:

  1. Ejecute el azd init comando con el --template parámetro para clonar una plantilla existente desde GitHub.

    azd init --template todo-nodejs-mongo

  2. Ejecute el azd auth login comando para autenticarse en la suscripción de Azure.

    azd auth login

  3. Ejecute el comando azd up para aprovisionar e implementar los recursos de plantilla en Azure. El azd up comando aprovecha los archivos de configuración e infraestructura como código (IaC) de la plantilla para aprovisionar recursos de Azure e implementar la aplicación en esos recursos.

    azd up

  4. Una vez configurado el entorno en Azure, puede modificar localmente las características de la aplicación o las plantillas de recursos de Azure y, a continuación, volver a ejecutar azd up para aprovisionar los cambios.

Descripción de la estructura de plantillas de la CLI para desarrolladores de Azure

Todas las azd plantillas comparten una estructura de archivos similar basada en azd convenciones. Los recursos mínimos necesarios suelen incluir lo siguiente:

  • Carpeta infra: contiene toda la infraestructura de Bicep o Terraform como archivos de código para la plantilla azd. azd ejecuta estos archivos para crear los recursos de Azure necesarios para hospedar la aplicación.

  • azure.yaml file : un archivo de configuración que define uno o varios servicios del proyecto y los asigna a los recursos de Azure definidos en la carpeta para la infra implementación. Por ejemplo, puede definir un servicio de API y un servicio front-end web y asignarlos a distintos recursos de Azure para la implementación.

  • Carpeta .azure: contiene configuraciones esenciales de Azure y variables de entorno, como la ubicación para implementar recursos u otra información de suscripción.

  • src folder : contiene todo el código fuente de la aplicación que se puede implementar. Algunas azd plantillas excluyen la src carpeta y solo proporcionan recursos de infraestructura para que pueda agregar su propio código de aplicación.

    Nota:

    Las plantillas que excluyen la src carpeta se suelen diseñar como plantillas de inicio de infraestructura.

azd Las plantillas también incluyen opcionalmente una o varias de las siguientes carpetas:

  • .github carpeta : contiene los archivos de flujo de trabajo de CI/CD para Acciones de GitHub, el proveedor de CI/CD predeterminado para azd.
  • Carpeta .azdo: si decide usar Azure Pipelines para CI/CD, defina los archivos de configuración de flujo de trabajo en esta carpeta.
  • .devcontainer folder : permite configurar un entorno de contenedor de desarrollo para la aplicación.

Por ejemplo, una plantilla común azd podría coincidir con la siguiente estructura de carpetas:

Captura de pantalla que muestra una estructura de plantilla de la CLI para desarrolladores de Azure.

Comience con una plantilla existente o cree su propia

Existen dos enfoques principales para trabajar con plantillas azd:

  • Comience con una plantilla existente azd .
    • Esta es una buena opción si acaba de empezar a trabajar o azd si busca una plantilla para crear una nueva aplicación con una arquitectura y marcos similares.
  • Convertir un proyecto existente en una azd plantilla.
    • Esta es una buena opción cuando ya tiene una aplicación existente, pero quiere que sea compatible con azd las funcionalidades.

En las secciones siguientes se proporciona más información sobre estas dos opciones.

Empezar con una plantilla existente

Hay una amplia selección de azd plantillas disponibles en la galería de plantillas awesome-azd . Estas plantillas proporcionan código de aplicación e infraestructura para varios escenarios de desarrollo, marcos de lenguaje y servicios de Azure. Si encuentra una plantilla que se alinea con la pila de aplicaciones local o la arquitectura deseada, puede ampliar y reemplazar el código de plantilla por el suyo propio.

Por ejemplo, las plantillas siguientes azd proporcionan puntos de partida para las arquitecturas y marcos de aplicaciones comunes:

Plantilla Host de aplicación Pila técnica
React Web App con la API de C# y MongoDB en Azure Azure App Service Azure Cosmos DB para NoSQL, Bicep
React Web App con la API de C# y SQL Database en Azure Azure App Service Azure SQL Database, Bicep
Static React Web App + Functions con la API de C# y SQL Database en Azure Azure Static Web Apps, Azure Functions Azure SQL Database, Bicep

Creación de una plantilla para azd la aplicación

También puede convertir una aplicación existente en una azd plantilla para mejorar el repositorio con funcionalidades de aprovisionamiento e implementación. Este enfoque permite el mayor control y genera una solución reutilizable para el futuro trabajo de desarrollo en la aplicación. Los pasos generales para crear su propia plantilla son los siguientes:

  • Inicialización de la plantilla de proyecto con azd init.
  • Cree la infraestructura de Bicep o Terraform como archivos de código en la infra carpeta .
  • Actualización del archivo azure.yaml para vincular los servicios de aplicaciones junto con los recursos de Azure.
  • Aprovisionamiento e implementación con azd up.

Los siguientes recursos proporcionan más información sobre cómo crear sus propias plantillas:

Directrices para usar azd plantillas

Tenga en cuenta que cada plantilla que use con la CLI para desarrolladores de Azure tiene licencia por su propietario respectivo (que puede o no ser Microsoft) en virtud del contrato que acompaña a la plantilla. Es su responsabilidad determinar qué licencia se aplica a cualquier plantilla que elija usar.

Microsoft no es responsable de ninguna plantilla que no sea de Microsoft y no muestra estas plantillas para problemas de seguridad, privacidad, compatibilidad o rendimiento. Las plantillas que usa con la CLI para desarrolladores de Azure, incluidas las proporcionadas por Microsoft, no son compatibles con ningún servicio o programa de soporte técnico de Microsoft. Las plantillas proporcionadas por Microsoft se proporcionan AS IS sin garantía de ningún tipo.

Pasos siguientes

Selección e implementación de una plantilla