Visão geral das ferramentas do Azure MCP Server para Azure Terraform

As ferramentas do servidor MCP Azure ajudam você a trabalhar com o Terraform para Azure usando prompts de linguagem natural. Você pode obter a documentação dos provedores AzureRM e AzAPI, descobrir os Módulos Verificados do Azure, exportar recursos existentes do Azure para a configuração do Terraform e validar espaços de trabalho e planos do Terraform em relação à biblioteca de políticas do Azure (policy-library-avm) por meio do Conftest.

As ferramentas do Terraform para Azure abrangem todo o ciclo de vida completo da infraestrutura como código com o Terraform no Azure, desde a consulta à documentação do provedor até a exportação de recursos e a validação de políticas. Para obter mais informações, consulte Terraform na documentação Azure.

Note

Anotações de ferramenta descrevem apenas o comportamento no lado do Azure. Algumas ferramentas dessa família geram arquivos locais ou comandos para o agente executar, o que não é refletido nas dicas de anotação.

Note

Parâmetros de ferramenta: as ferramentas do Servidor MCP do Azure definem parâmetros para os dados necessários para concluir tarefas. Alguns desses parâmetros são específicos para cada ferramenta e estão documentados abaixo. Outros parâmetros são globais e compartilhados por todas as ferramentas. Para obter mais informações, consulte parâmetros de ferramenta.

Obter a documentação do provedor do AzureRM

Obtém a documentação completa do provedor Terraform AzureRM para um tipo de recurso especificado. Retorna o resumo do recurso, argumentos com descrições e requisitos, atributos, exemplos de uso e notas importantes.

Os prompts de exemplo incluem:

  • Obtenha a documentação do recurso: "Mostre-me a documentação do Terraform para azurerm_resource_group"
  • Pesquisar uma fonte de dados: "Obter a documentação da fonte de dados para azurerm_storage_account"
  • Filtrar por argumento: "Mostre-me a documentação do address_space argumento em azurerm_virtual_network."
  • Verificar atributos: "Mostre-me os atributos para azurerm_key_vault"
Parâmetro Obrigatório ou opcional Descrição
Tipo de recurso Obrigatório O nome do tipo de recurso do AzureRM no Terraform (por exemplo, azurerm_resource_group, azurerm_storage_account). O azurerm_ prefixo é opcional.
Tipo de documento Opcional O tipo de documentação a ser recuperado. Opções: resource (padrão), data-source.
Argumento Opcional Filtrar os resultados para um nome de argumento específico.
Atributo Opcional Filtre os resultados para um nome de atributo específico.

Especifique Argument ou Attribute — a ferramenta procura na documentação desse tipo específico de elemento.

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ❌

Obter a documentação do provedor de AzAPI

Recupera a documentação e o esquema do provedor terraform do AzAPI para um tipo de recurso Azure especificado. Retorna o esquema do recurso no formato HCL adequado para blocos azapi_resource, incluindo definições de propriedades com tipos e requisitos, informações sobre o recurso pai e exemplos de uso do Terraform. Essa ferramenta reutiliza as definições de tipo do Azure Bicep para gerar esquemas AzAPI precisos.

Os prompts de exemplo incluem:

  • Obter esquema do recurso: "Mostre o esquema AzAPI para Microsoft.Compute/virtualMachines"
  • Specific API version: "Obtenha a documentação da AzAPI para Microsoft. Storage/storageAccounts na API versão 2023-05-01"
  • Explorar um tipo de recurso: "Quais propriedades o Microsoft.Network/virtualNetworks tem na AzAPI?"
Parâmetro Obrigatório ou opcional Descrição
Tipo de recurso Obrigatório O tipo de recurso Azure no formato ARM (por exemplo, Microsoft.Compute/virtualMachines, Microsoft.Storage/storageAccounts).
Versão da API Opcional A versão da API a ser usada para o esquema de recursos. Se omitida, a versão estável mais recente será usada.

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ❌

Listar módulos verificados Azure

Recupera todos os módulos Azure verificados disponíveis (AVM) para Terraform. Retorna uma lista de módulos com seu nome, descrição, referência de origem e URL do repositório. O campo de origem pode ser usado diretamente em blocos de módulo do Terraform.

Os prompts de exemplo incluem:

  • Listar todos os módulos: "Listar todos os módulos Azure verificados disponíveis para o Terraform"
  • Encontrar módulos: "Quais são os Módulos Verificados do Azure disponíveis para armazenamento?"
  • Procurar módulos: "Mostrar-me o catálogo de módulos da AVM"

Essa ferramenta não tem parâmetros necessários.

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ❌

Obter versões do Módulo Verificado do Azure

Recupera todas as versões disponíveis de um Módulo Verificado do Azure (AVM) especificado. Retorna marcas de versão com datas de criação, classificadas das mais recentes para as mais antigas. A primeira versão da lista é a mais recente.

Os prompts de exemplo incluem:

  • Verificar versões: "Quais versões estão disponíveis para avm-res-storage-storageaccount?"
  • Versão mais recente: "Qual é a versão mais recente do módulo AVM para redes virtuais?"
Parâmetro Obrigatório ou opcional Descrição
Nome do módulo Obrigatório O nome do módulo verificado Azure (por exemplo, avm-res-storage-storageaccount).

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ❌

Obtenha a documentação do Módulo Verificado do Azure

Recupera a documentação (README.md) de uma versão específica de um módulo verificado Azure (AVM). Retorna a documentação completa do módulo, incluindo exemplos de uso, variáveis de entrada, valores de saída e descrições de recursos.

Os prompts de exemplo incluem:

  • Obter documentação do módulo: "Mostre-me a documentação do avm-res-storage-storageaccount na versão 0.4.0"
  • Exemplos de uso: "Obter exemplos de uso para o módulo do cofre de chaves da AVM versão 0.3.0"
Parâmetro Obrigatório ou opcional Descrição
Nome do módulo Obrigatório O nome do módulo verificado Azure (por exemplo, avm-res-storage-storageaccount).
Versão do módulo Obrigatório A versão do módulo Azure Verified (por exemplo, 0.4.0).

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ❌

Exportar um único recurso para o Terraform

Gera um comando aztfexport para exportar um único recurso de Azure para a configuração do Terraform. Retorna o comando e os argumentos para o agente executar localmente. Se aztfexport não estiver instalado localmente, retornará instruções de instalação.

Os prompts de exemplo incluem:

  • Exportar um recurso: "Exportar minha conta de armazenamento para a configuração do Terraform"
  • Usar provedor AzAPI: "Exportar o recurso /subscriptions/.../storageAccounts/myaccount usando o provedor AzAPI"
  • Nome personalizado: "Exportar esta VM para o Terraform com o nome do recurso 'primary_vm'"

Defina isso como false para exportações autoritativas — quando true, a exportação pode ser concluída com recursos ignorados ou infraestrutura como código incompleta.

Parâmetro Obrigatório ou opcional Descrição
ID do recurso Obrigatório A ID de recurso de Azure completa a ser exportada (por exemplo, /subscriptions/.../resourceGroups/.../providers/Microsoft.Storage/storageAccounts/mystorageaccount).
Pasta de saída Opcional Nome da pasta de saída para os arquivos Terraform gerados. Não há padrão — a ferramenta solicita um caminho quando ele é omitido.
Provedor Opcional Provedor do Terraform a ser usado: azurerm (padrão) ou azapi.
Nome do recurso Terraform Opcional Nome do recurso personalizado a ser usado na configuração do Terraform gerada.
Incluir atribuição de função Opcional Inclua atribuições de função na exportação.
Parallelism Opcional Número de operações paralelas (padrão: 10, máximo: 50).
Continuar em caso de erro Opcional Continue a exportar mesmo se alguns recursos falharem (padrão: true).

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ✅

Exportar um grupo de recursos para o Terraform

Gera um comando aztfexport para exportar um grupo de recursos Azure e todos os seus recursos para a configuração do Terraform. Retorna o comando e os argumentos para o agente executar localmente. Se aztfexport não estiver instalado localmente, retornará instruções de instalação.

Os prompts de exemplo incluem:

  • Exportar um grupo de recursos: "Exportar o grupo de recursos my-app-rg para o Terraform"
  • Nomenclatura personalizada: "Exportar o grupo de recursos production-rg com o padrão de nomenclatura 'prod_{type}'"
  • Usar o AzAPI: "Exportar meu grupo de recursos para Terraform usando o provedor AzAPI"

Defina isso como false para exportações autoritativas — quando true, a exportação pode ser concluída com recursos ignorados ou uma infraestrutura como código incompleta.

Parâmetro Obrigatório ou opcional Descrição
Grupo de recursos Obrigatório O nome do grupo de recursos Azure a ser exportado.
Pasta de saída Opcional Nome da pasta de saída para os arquivos Terraform gerados. Sem padrão predefinido — a ferramenta solicita um caminho quando ele é omitido.
Provedor Opcional Provedor terraform a ser usado: azurerm (padrão) ou azapi.
Padrão de nome Opcional Padrão de nomenclatura dos recursos na configuração gerada do Terraform.
Incluir atribuição de função Opcional Inclua atribuições de função na exportação.
Parallelism Opcional Número de operações paralelas (padrão: 10, máximo: 50).
Continuar em caso de erro Opcional Continue a exportar mesmo se alguns recursos falharem (padrão: true).

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ✅

Exportar recursos por consulta para o Terraform

Gera um comando aztfexport para exportar recursos Azure correspondentes a uma consulta Azure Resource Graph à configuração do Terraform. Retorna o comando e os argumentos para o agente executar localmente. Se aztfexport não estiver instalado localmente, retornará instruções de instalação.

Os prompts de exemplo incluem:

  • Exportar por tipo: "Exportar todas as contas de armazenamento para o Terraform"
  • Exportar por consulta: "Exportar recursos correspondentes ao tipo =~ 'Microsoft.Web/sites' para Terraform"
  • Saída personalizada: "Exportar todas as VMs para o Terraform na pasta 'infra-output'"

Defina isso como false para exportações autoritativas — quando true, a exportação pode ser concluída com recursos ignorados ou uma infraestrutura como código incompleta.

Parâmetro Obrigatório ou opcional Descrição
Query Obrigatório cláusula WHERE de KQL do Azure Resource Graph para selecionar recursos a serem exportados (por exemplo, type =~ 'Microsoft.Storage/storageAccounts').
Pasta de saída Opcional Nome da pasta de saída para os arquivos Terraform gerados. Sem padrão predefinido — a ferramenta solicita um caminho quando ele é omitido.
Provedor Opcional Provedor terraform a ser usado: azurerm (padrão) ou azapi.
Padrão de nome Opcional Padrão de nomenclatura dos recursos na configuração gerada do Terraform.
Incluir atribuição de função Opcional Inclua atribuições de função na exportação.
Parallelism Opcional Número de operações paralelas (padrão: 10, máximo: 50).
Continuar em caso de erro Opcional Continue a exportar mesmo se alguns recursos falharem (padrão: true).

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ✅

Validar o workspace do Terraform em relação às políticas

Gera um comando conftest para validar arquivos .tf do Terraform em um espaço de trabalho em relação às políticas do Azure. Retorna o comando e os argumentos para o agente executar localmente. Usa a biblioteca de políticas Azure (policy-library-avm) para validação com conjuntos de políticas configuráveis. Se conftest não estiver instalado localmente, retornará instruções de instalação.

Os prompts de exemplo incluem:

  • Validar workspace: "Validar meu workspace do Terraform em conformidade com as políticas do Azure"
  • Conjunto de políticas específico: "Verificar meus arquivos Terraform na Biblioteca de Resiliência Proativa do Azure"
  • Políticas de segurança: "Executar políticas avmsec com filtro de alta severidade no meu workspace do Terraform"
Parâmetro Obrigatório ou opcional Descrição
Pasta do espaço de trabalho Obrigatório Caminho para a pasta do workspace do Terraform contendo arquivos .tf a serem validados.
Conjunto de políticas Opcional Política definida para uso para validação: all (padrão), Azure-Proactive-Resiliency-Library-v2 ou avmsec.
Filtro de severidade Opcional Filtro de severidade para políticas avmsec: high, , medium, lowou info. Aplicável somente quando o conjunto de políticas é avmsec. Nenhum padrão – todas as severidades incluídas.
Políticas personalizadas Opcional Lista separada por vírgulas de caminhos de política personalizados a serem incluídos na validação.

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ✅

Validar o plano do Terraform em relação às políticas

Gera um comando conftest para validar um arquivo JSON de plano do Terraform em relação a políticas de Azure. Retorna o comando e os argumentos para o agente executar localmente. Usa a biblioteca de políticas Azure (policy-library-avm) para validação com conjuntos de políticas configuráveis. Se conftest não estiver instalado localmente, retornará instruções de instalação.

Os prompts de exemplo incluem:

  • Validar plano: "Validar meu plano Terraform em conformidade com as políticas do Azure"
  • Verificação de resiliência: "Verifique meu tfplan.json em relação à Biblioteca de Resiliência Proativa do Azure"
  • Filtrar por gravidade: "Executar as políticas avmsec de severidade média no meu plano do Terraform"
Parâmetro Obrigatório ou opcional Descrição
Pasta do plano Obrigatório Caminho para a pasta que contém o arquivo JSON do plano Terraform (tfplan.json) a ser validado.
Conjunto de políticas Opcional Política definida para uso para validação: all (padrão), Azure-Proactive-Resiliency-Library-v2 ou avmsec.
Filtro de severidade Opcional Filtro de severidade para políticas avmsec: high, , medium, lowou info. Aplicável somente quando o conjunto de políticas é avmsec. Nenhum padrão – todas as severidades incluídas.
Políticas personalizadas Opcional Lista separada por vírgulas de caminhos de política personalizados a serem incluídos na validação.

Dicas para anotação de ferramentas:

Destrutivo: ❌ | Idempotente: ✅ | Mundo Aberto: ❌ | Somente leitura: ✅ | Segredo: ❌ | Local Necessário: ✅