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

As ferramentas do Azure MCP Server ajudam-no a trabalhar com o Terraform for Azure usando prompts em linguagem natural. Pode consultar a documentação dos fornecedores AzureRM e AzAPI, descobrir os Módulos Verificados do Azure, exportar recursos existentes do Azure para a configuração do Terraform e validar áreas de trabalho e planos do Terraform com base na biblioteca de políticas do Azure (policy-library-avm) através do conftest.

As ferramentas do Azure Terraform cobrem todo o ciclo de vida do Infrastructure as Code com o Terraform no Azure, desde a consulta de documentação do fornecedor até à exportação de recursos e validação de políticas. Para mais informações, consulte Terraform na documentação Azure.

Observação

As anotações de ferramentas descrevem apenas o comportamento do lado do Azure. Algumas ferramentas desta família geram ficheiros ou comandos locais para o agente executar, o que não se reflete nas dicas de anotação.

Observação

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

Obtenha documentação do fornecedor AzureRM

Recupera documentação abrangente do fornecedor AzureRM Terraform para um tipo de recurso especificado. Devolve o resumo do recurso, argumentos com descrições e requisitos, atributos, exemplos de utilização e notas importantes.

Exemplos de prompts incluem:

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

Especifica qualquer um Argument ou Attribute — a ferramenta procura documentação para esse tipo específico de elemento.

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ❌

Obtenha documentação do fornecedor AzAPI

Recupera documentação e esquema do fornecedor AzAPI Terraform para um tipo de recurso Azure especificado. Devolve o esquema do recurso em formato HCL adequado para blocos azapi_resource, incluindo definições de propriedades com tipos e requisitos, informação sobre o recurso principal e exemplos de utilização no Terraform. Esta ferramenta reutiliza definições de tipos do Azure Bicep para gerar esquemas AzAPI precisos.

Exemplos de prompts incluem:

  • Obter o esquema do recurso: "Mostra-me o esquema da AzAPI para Microsoft.Compute/virtualMachines"
  • Versão específica da API: "Obtenha a documentação do AzAPI para Microsoft.Storage/storageAccounts para a versão da API 2023-05-01"
  • Explore um tipo de recurso: "Que propriedades Microsoft. Network/virtualNetworks têm no AzAPI?"
Parâmetro Obrigatório ou opcional Description
Tipo de recurso Obrigatório O tipo de recurso do Azure em formato ARM (por exemplo, Microsoft.Compute/virtualMachines, Microsoft.Storage/storageAccounts).
Versão da API Opcional A versão da API para usar no esquema de recursos. Se for omitida, é usada a versão estável mais recente.

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ❌

Listar Azure Verified Modules

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

Exemplos de prompts incluem:

  • Listar todos os módulos: "Listar todos os módulos disponíveis Azure Verificados para Terraform"
  • Encontrar módulos: "Quais Azure Módulos Verificados estão disponíveis para armazenamento?"
  • Navegar pelos módulos: "Mostre-me o catálogo de módulos AVM"

Esta ferramenta não tem parâmetros obrigatórios.

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ❌

Obtenha versões do módulo Azure Verified

Recupera todas as versões disponíveis de um Azure Verified Module (AVM) especificado. Devolve etiquetas de versão com datas de criação, ordenadas da mais recente para a mais antiga. A primeira versão da lista é a mais recente.

Exemplos de prompts incluem:

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

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ❌

Obtenha documentação do módulo Azure Verified

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

Exemplos de prompts incluem:

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

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ❌

Exportar um único recurso para o Terraform

Gera um comando aztfexport para exportar um único recurso Azure para a configuração Terraform. Devolve o comando e os argumentos para o agente executar localmente. Se aztfexport não for instalado localmente, devolve as instruções de instalação em vez disso.

Exemplos de prompts incluem:

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

Defina esta opção 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 Description
ID do recurso Obrigatório O ID completo do recurso do Azure para exportar (por exemplo, /subscriptions/.../resourceGroups/.../providers/Microsoft.Storage/storageAccounts/mystorageaccount).
pasta de saída Opcional Nome da pasta de saída para os ficheiros Terraform gerados. Não existe valor predefinido — a ferramenta pede um caminho quando este é omitido.
Fornecedor Opcional Provedor Terraform a utilizar: azurerm (predefinido) ou azapi.
Nome do recurso Terraform Opcional Nome de recurso personalizado para usar na configuração gerada do Terraform.
Incluir atribuição de funções Opcional Incluir atribuições de funções na exportação.
Paralelismo Opcional Número de operações paralelas (padrão: 10, máximo: 50).
Continuar em caso de erro Opcional Continue a exportar mesmo que alguns recursos falhem (padrão: verdadeiro).

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ✅

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 Terraform. Devolve o comando e os argumentos para o agente executar localmente. Se aztfexport não for instalado localmente, devolve as instruções de instalação em vez disso.

Exemplos de prompts incluem:

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

Defina esta opção 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 Description
Grupo de recursos Obrigatório O nome do grupo de recursos Azure para exportar.
pasta de saída Opcional Nome da pasta de saída para os ficheiros Terraform gerados. Não existe valor predefinido — a ferramenta pede um caminho quando este é omitido.
Fornecedor Opcional Provedor Terraform a utilizar: azurerm (predefinido) ou azapi.
Padrão do nome Opcional Padrão para nomear recursos na configuração Terraform gerada.
Incluir atribuição de funções Opcional Incluir atribuições de funções na exportação.
Paralelismo Opcional Número de operações paralelas (padrão: 10, máximo: 50).
Continuar em caso de erro Opcional Continue a exportar mesmo que alguns recursos falhem (padrão: verdadeiro).

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ✅

Exportar recursos por consulta para o Terraform

Gera um comando aztfexport para exportar recursos do Azure que correspondam a uma consulta do Azure Resource Graph para configuração do Terraform. Devolve o comando e os argumentos para o agente executar localmente. Se aztfexport não for instalado localmente, devolve as instruções de instalação em vez disso.

Exemplos de prompts incluem:

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

Defina esta opção 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 Description
Query Obrigatório cláusula WHERE de KQL do Azure Resource Graph para selecionar recursos para exportar (por exemplo, type =~ 'Microsoft.Storage/storageAccounts').
pasta de saída Opcional Nome da pasta de saída para os ficheiros Terraform gerados. Não existe valor predefinido — a ferramenta pede um caminho quando este é omitido.
Fornecedor Opcional Provedor Terraform a utilizar: azurerm (predefinido) ou azapi.
Padrão do nome Opcional Padrão para nomear recursos na configuração Terraform gerada.
Incluir atribuição de funções Opcional Incluir atribuições de funções na exportação.
Paralelismo Opcional Número de operações paralelas (padrão: 10, máximo: 50).
Continuar em caso de erro Opcional Continue a exportar mesmo que alguns recursos falhem (padrão: verdadeiro).

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ✅

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

Gera um comando conftest para validar ficheiros Terraform .tf num espaço de trabalho em relação às políticas do Azure. Devolve o comando e os argumentos para o agente executar localmente. Utiliza a biblioteca de políticas Azure (policy-library-avm) para validação com conjuntos de políticas configuráveis. Se conftest não for instalado localmente, devolve as instruções de instalação em vez disso.

Exemplos de prompts incluem:

  • Validar o espaço de trabalho: "Validar o meu espaço de trabalho do Terraform em relação às políticas do Azure"
  • Conjunto específico de políticas: "Verifique os meus ficheiros Terraform com a Azure Proactive Resiliency Library"
  • Políticas de segurança: "Executar políticas avmsec com filtro de alta severidade no meu espaço de trabalho Terraform"
Parâmetro Obrigatório ou opcional Description
Pasta do espaço de trabalho Obrigatório Caminho para a pasta da workspace do Terraform que contém os ficheiros .tf a validar.
Conjunto de políticas Opcional Política definida para validação: all (padrão), Azure-Proactive-Resiliency-Library-v2 ou avmsec.
Filtro de gravidade Opcional Filtro de gravidade para políticas avmsec: high, medium, low, ou info. Aplicável apenas quando o conjunto de políticas é avmsec. Sem predefinição — todas as gravidades incluídas.
Políticas personalizadas Opcional Lista separada por vírgulas de caminhos de políticas personalizadas a incluir na validação.

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ✅

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

Gera um comando conftest para validar um ficheiro JSON de plano do Terraform face às políticas do Azure. Devolve o comando e os argumentos para o agente executar localmente. Utiliza a biblioteca de políticas Azure (policy-library-avm) para validação com conjuntos de políticas configuráveis. Se conftest não for instalado localmente, devolve as instruções de instalação em vez disso.

Exemplos de prompts incluem:

  • Validar plano: "Validar o meu Terraform plan em relação às políticas do Azure"
  • Verificação da resiliência: "Verifique o meu tfplan.json em relação à biblioteca Azure Proactive Resiliency Library"
  • Filtrar por gravidade: "Executar políticas avmsec com gravidade média no meu plano Terraform"
Parâmetro Obrigatório ou opcional Description
Pasta de planos Obrigatório Caminho para a pasta que contém o ficheiro JSON do plano Terraform (tfplan.json) para validar.
Conjunto de políticas Opcional Política definida para validação: all (padrão), Azure-Proactive-Resiliency-Library-v2 ou avmsec.
Filtro de gravidade Opcional Filtro de gravidade para políticas avmsec: high, medium, low, ou info. Aplicável apenas quando o conjunto de políticas é avmsec. Sem predefinição — todas as gravidades incluídas.
Políticas personalizadas Opcional Lista separada por vírgulas de caminhos de políticas personalizadas a incluir na validação.

Dicas para anotação de ferramentas:

Destrutivo Idempotente Mundo Aberto Somente leitura Secret Localidade obrigatória
❌ ✅ ✅ ✅ ❌ ✅

Conteúdo relacionado

  • Last updated on