Introducción a las herramientas de Azure MCP Server para Azure Terraform

Las herramientas de servidor MCP de Azure le ayudan a trabajar con Terraform para Azure mediante mensajes de lenguaje natural. Puede recuperar la documentación de los proveedores AzureRM y AzAPI, descubrir los módulos verificados de Azure, exportar recursos de Azure existentes a la configuración de Terraform y validar espacios de trabajo y planes de Terraform conforme a la biblioteca de directivas de Azure (policy-library-avm) mediante conftest.

Las herramientas de Terraform para Azure abarcan todo el ciclo de vida de la infraestructura como código con Terraform en Azure, desde la consulta de la documentación del proveedor hasta la exportación de recursos y la validación de directivas. Para obtener más información, consulte la documentación de Terraform en Azure.

Note

Las anotaciones de herramientas solo describen el comportamiento del lado de Azure. Algunas herramientas de esta familia generan archivos locales o comandos para que el agente los ejecute, algo que no se refleja en las indicaciones de anotación.

Note

Parámetros de herramienta: las herramientas del servidor MCP de Azure definen parámetros para los datos que necesitan para completar las tareas. Algunos de estos parámetros son específicos de cada herramienta y se documentan aquí. Otros parámetros son globales y compartidos por todas las herramientas. Para obtener más información, consulte Parámetros de la herramienta.

Obtención de documentación del proveedor de AzureRM

Recupera la documentación completa del proveedor de AzureRM Terraform para un tipo de recurso especificado. Devuelve el resumen de recursos, los argumentos con descripciones y requisitos, atributos, ejemplos de uso y notas importantes.

Algunas indicaciones de ejemplo incluyen:

  • Obtener documentación de recursos: "Mostrar la documentación de Terraform para azurerm_resource_group"
  • Buscar una fuente de datos: Consulta la documentación de la fuente de datos para azurerm_storage_account
  • Filtre por argumento: "Mostrarme la documentación del address_space argumento en azurerm_virtual_network".
  • Comprobar atributos: "Mostrarme los atributos de azurerm_key_vault"
Parámetro Obligatorio u opcional Description
Tipo de recurso Obligatorio Nombre del tipo de recurso de Terraform de AzureRM (por ejemplo, azurerm_resource_group, azurerm_storage_account). El azurerm_ prefijo es opcional.
Tipo de documento Optional Tipo de documentación que se va a recuperar. Opciones: resource (valor predeterminado), data-source.
Argumento Optional Filtre los resultados por un nombre de argumento específico.
Atributo Optional Filtre los resultados por un nombre de atributo específico.

Especifique Argument o bien Attribute — la herramienta busca la documentación para ese tipo de elemento específico.

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ❌

Obtención de la documentación del proveedor de AzAPI

Recupera la documentación y el esquema del proveedor de Terraform de AzAPI para un tipo de recurso de Azure especificado. Devuelve el esquema de recursos en formato HCL adecuado para azapi_resource bloques, incluidas definiciones de propiedades con tipos y requisitos, información de recursos primarios y ejemplos de uso de Terraform. Esta herramienta reutiliza Azure Bicep definiciones de tipos para generar esquemas AzAPI precisos.

Algunas indicaciones de ejemplo incluyen:

  • Obtener esquema del recurso: "Muéstrame el esquema de AzAPI para Microsoft.Compute/virtualMachines"
  • Versión específica de la API: "Obtenga la documentación de AzAPI para Microsoft.Storage/storageAccounts en la versión de la API 2023-05-01"
  • Explorar un tipo de recurso: "¿Qué propiedades tiene Microsoft.Network/virtualNetworks en AzAPI?"
Parámetro Obligatorio u opcional Description
Tipo de recurso Obligatorio Tipo de recurso Azure en formato ARM (por ejemplo, Microsoft.Compute/virtualMachines, Microsoft.Storage/storageAccounts).
Versión de API Optional Versión de LA API que se va a usar para el esquema de recursos. Si se omite, se usa la versión estable más reciente.

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ❌

Enumerar Azure módulos comprobados

Obtiene todos los módulos verificados de Azure (AVM) disponibles para Terraform. Devuelve una lista de módulos con su nombre, descripción, referencia de origen y dirección URL del repositorio. El campo de origen se puede usar directamente en bloques de módulos de Terraform.

Algunas indicaciones de ejemplo incluyen:

  • Enumerar todos los módulos: "Enumerar todos los Módulos validados de Azure para Terraform disponibles"
  • Buscar módulos: "¿Qué módulos validados por Azure están disponibles de almacenamiento?"
  • Examinar módulos: "Mostrarme el catálogo de módulos de AVM"

Esta herramienta no tiene parámetros necesarios.

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ❌

Obtener versiones del módulo verificado de Azure

Obtiene todas las versiones disponibles de un Azure Verified Module (AVM) especificado. Devuelve etiquetas de versión con fechas de creación, ordenadas de la más reciente a la más antigua. La primera versión de la lista es la más reciente.

Algunas indicaciones de ejemplo incluyen:

  • Comprobar versiones: "¿Qué versiones están disponibles para avm-res-storage-storageaccount?"
  • Versión más reciente: "¿Cuál es la versión más reciente del módulo AVM para redes virtuales?"
Parámetro Obligatorio u opcional Description
Nombre del módulo Obligatorio Nombre del módulo comprobado de Azure (por ejemplo, avm-res-storage-storageaccount).

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ❌

Obtener la documentación del módulo verificado de Azure

Recupera la documentación (README.md) de una versión específica de un módulo comprobado (AVM) de Azure. Devuelve la documentación completa del módulo, incluidos ejemplos de uso, variables de entrada, valores de salida y descripciones de recursos.

Algunas indicaciones de ejemplo incluyen:

  • Obtener la documentación del módulo: "Muéstrame la documentación de avm-res-storage-storageaccount de la versión 0.4.0"
  • Ejemplos de uso: "Obtención de ejemplos de uso para la versión 0.3.0 del módulo del almacén de claves de AVM"
Parámetro Obligatorio u opcional Description
Nombre del módulo Obligatorio Nombre del módulo comprobado de Azure (por ejemplo, avm-res-storage-storageaccount).
Versión del módulo Obligatorio Versión del módulo comprobado de Azure (por ejemplo, 0.4.0).

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ❌

Exportación de un único recurso a Terraform

Genera un comando aztfexport para exportar un único recurso de Azure a la configuración de Terraform. Devuelve el comando y los argumentos para que el agente los ejecute localmente. Si aztfexport no está instalado localmente, devuelve instrucciones de instalación en su lugar.

Algunas indicaciones de ejemplo incluyen:

  • Exportar un recurso: "Exportar mi cuenta de almacenamiento a la configuración de Terraform"
  • Utilice el proveedor AzAPI: "Exporte el recurso /subscriptions/.../storageAccounts/myaccount mediante el proveedor AzAPI"
  • Nombre personalizado: "Exportar esta VM a Terraform con el nombre de recurso 'primary_vm'"

Configúralo en false para exportaciones autorizadas; cuando sea true, la exportación puede completarse con recursos omitidos o una infraestructura como código incompleta.

Parámetro Obligatorio u opcional Description
Identificador del recurso Obligatorio Identificador de recurso de Azure completo que se va a exportar (por ejemplo, /subscriptions/.../resourceGroups/.../providers/Microsoft.Storage/storageAccounts/mystorageaccount).
Carpeta de salida Optional Nombre de carpeta de salida para los archivos de Terraform generados. Sin valor predeterminado — la herramienta solicita una ruta cuando se omite.
Proveedor Optional Proveedor de Terraform que se utilizará: azurerm (valor predeterminado) o azapi.
Nombre del recurso de Terraform Optional Nombre de recurso personalizado que se usará en la configuración de Terraform generada.
Incluir asignación de rol Optional Incluir asignaciones de roles en la exportación.
Paralelismo Optional Número de operaciones paralelas (valor predeterminado: 10, máximo: 50).
Continuar en caso de error Optional Continúe la exportación aunque se produzca un error en algunos recursos (valor predeterminado: true).

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ✅

Exportación de un grupo de recursos a Terraform

Genera un comando aztfexport para exportar un grupo de recursos de Azure y todos sus recursos a la configuración de Terraform. Devuelve el comando y los argumentos para que el agente los ejecute localmente. Si aztfexport no está instalado localmente, devuelve instrucciones de instalación en su lugar.

Algunas indicaciones de ejemplo incluyen:

  • Exportar un grupo de recursos: "Exportar el grupo de recursos my-app-rg a Terraform"
  • Nomenclatura personalizada: "Exportar el grupo de recursos production-rg con el patrón de nombre 'prod_{type}'"
  • Uso de AzAPI: "Exportar mi grupo de recursos a Terraform mediante el proveedor azapi"

Configúralo en false para exportaciones autorizadas; cuando sea true, la exportación puede completarse con recursos omitidos o una infraestructura como código incompleta.

Parámetro Obligatorio u opcional Description
Grupo de recursos Obligatorio Nombre del grupo de recursos Azure que se va a exportar.
Carpeta de salida Optional Nombre de carpeta de salida para los archivos de Terraform generados. Sin valor predeterminado — la herramienta solicita una ruta cuando se omite.
Proveedor Optional Proveedor de Terraform que se utilizará: azurerm (valor predeterminado) o azapi.
Patrón de nombres Optional Patrón para asignar nombres a los recursos en la configuración de Terraform generada.
Incluir asignación de rol Optional Incluir asignaciones de roles en la exportación.
Paralelismo Optional Número de operaciones paralelas (valor predeterminado: 10, máximo: 50).
Continuar en caso de error Optional Continúe la exportación aunque se produzca un error en algunos recursos (valor predeterminado: true).

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ✅

Exportación de recursos por consulta a Terraform

Genera un comando aztfexport para exportar Azure recursos que coinciden con una consulta de Azure Resource Graph a la configuración de Terraform. Devuelve el comando y los argumentos para que el agente los ejecute localmente. Si aztfexport no está instalado localmente, devuelve instrucciones de instalación en su lugar.

Algunas indicaciones de ejemplo incluyen:

  • Exportar por tipo: "Exportar todas las cuentas de almacenamiento a Terraform"
  • Exportar por consulta: "Exportar recursos cuyo tipo coincide con =~ 'Microsoft.Web/sites' a Terraform"
  • Salida personalizada: "Exportar todas las máquinas virtuales a Terraform en la carpeta "infra-output"

Configúralo en false para exportaciones autorizadas; cuando sea true, la exportación puede completarse con recursos omitidos o una infraestructura como código incompleta.

Parámetro Obligatorio u opcional Description
Query Obligatorio Cláusula WHERE de KQL de Azure Resource Graph para seleccionar recursos para exportar (por ejemplo, type =~ 'Microsoft.Storage/storageAccounts').
Carpeta de salida Optional Nombre de carpeta de salida para los archivos de Terraform generados. Sin valor predeterminado — la herramienta solicita una ruta cuando se omite.
Proveedor Optional Proveedor de Terraform que se utilizará: azurerm (valor predeterminado) o azapi.
Patrón de nombres Optional Patrón para asignar nombres a los recursos en la configuración de Terraform generada.
Incluir asignación de rol Optional Incluir asignaciones de roles en la exportación.
Paralelismo Optional Número de operaciones paralelas (valor predeterminado: 10, máximo: 50).
Continuar en caso de error Optional Continúe la exportación aunque se produzca un error en algunos recursos (valor predeterminado: true).

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ✅

Validar el espacio de trabajo de Terraform conforme a las directivas

Genera un comando conftest para validar los archivos de Terraform .tf en un espacio de trabajo con las directivas de Azure. Devuelve el comando y los argumentos para que el agente los ejecute localmente. Usa la biblioteca de directivas de Azure (policy-library-avm) para la validación con conjuntos de directivas configurables. Si conftest no está instalado localmente, devuelve instrucciones de instalación en su lugar.

Algunas indicaciones de ejemplo incluyen:

  • Validar área de trabajo: "Validar mi área de trabajo de Terraform con respecto a las políticas de Azure"
  • Conjunto específico de directivas: "Comprobar mis archivos de Terraform con Azure Proactive Resiliency Library"
  • Directivas de seguridad: "Ejecutar directivas avmsec con filtro de gravedad alta en mi área de trabajo de Terraform"
Parámetro Obligatorio u opcional Description
Carpeta del área de trabajo Obligatorio Ruta a la carpeta del espacio de trabajo de Terraform que contiene los archivos .tf que se van a validar.
Conjunto de directivas Optional Directiva establecida para su uso para la validación: all (valor predeterminado), Azure-Proactive-Resiliency-Library-v2 o avmsec.
Filtro de severidad Optional Filtro de gravedad para directivas de avmsec: high, medium, lowo info. Solo es aplicable cuando el conjunto de directivas es avmsec. Sin opción predeterminada — se incluyen todos los niveles de gravedad.
Directivas personalizadas Optional Lista de rutas de directivas personalizadas, separadas por comas, que se incluirán en la validación.

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ✅

Validar el plan de Terraform con las políticas

Genera un comando conftest para validar un archivo JSON del plan de Terraform con directivas de Azure. Devuelve el comando y los argumentos para que el agente los ejecute localmente. Usa la biblioteca de directivas de Azure (policy-library-avm) para la validación con conjuntos de directivas configurables. Si conftest no está instalado localmente, devuelve instrucciones de instalación en su lugar.

Algunas indicaciones de ejemplo incluyen:

  • Validar plan: "Validar mi plan de Terraform conforme a las directivas de Azure"
  • Resiliency check: "Compruebe mi tfplan.json en la biblioteca de resistencia proactiva de Azure"
  • Filtrar por severidad: "Ejecuta las directivas de avmsec con severidad media en mi plan de Terraform"
Parámetro Obligatorio u opcional Description
Carpeta del plan Obligatorio Ruta de acceso a la carpeta que contiene el archivo JSON del plan de Terraform (tfplan.json) que se debe validar.
Conjunto de directivas Optional Directiva establecida para su uso para la validación: all (valor predeterminado), Azure-Proactive-Resiliency-Library-v2 o avmsec.
Filtro de severidad Optional Filtro de gravedad para directivas de avmsec: high, medium, lowo info. Solo es aplicable cuando el conjunto de directivas es avmsec. Sin opción predeterminada — se incluyen todos los niveles de gravedad.
Directivas personalizadas Optional Lista de rutas de directivas personalizadas, separadas por comas, que se incluirán en la validación.

Sugerencias de anotación de herramientas:

Destructivo Idempotente Abrir mundo Solo lectura Secret Requisito local
❌ ✅ ✅ ✅ ❌ ✅

Contenido relacionado

  • Last updated on