Compartilhar via


Guia de início rápido: implantar seu primeiro recurso de atualização do Azure com o provedor AzAPI Terraform

Artigo testado com as seguintes versões do Terraform e do provedor do Terraform:

O Terraform permite a definição, a visualização e a implantação da infraestrutura de nuvem. Usando o Terraform, você cria arquivos de configuração usando sintaxe de HCL. A sintaxe da HCL permite que você especifique o provedor de nuvem, como o Azure, e os elementos que compõem sua infraestrutura de nuvem. Depois de criar os arquivos de configuração, você cria um plano de execução que permite visualizar as alterações de infraestrutura antes de serem implantadas. Depois de verificar as alterações, aplique o plano de execução para implantar a infraestrutura.

Neste artigo, você aprenderá a usar o provedor AzAPI Terraform para gerenciar um novo recurso de um serviço do Azure que não é suportado atualmente pelo provedor AzureRM. O azapi_update_resource será usado para gerenciar um conjunto de regras de rede do Azure EventHub .

  • Definir e configurar os provedores AzureRM e AzAPI
  • Gerar um nome aleatório para o namespace dos Hubs de Eventos
  • Usar o provedor do AzureRM para criar um grupo de recursos do Azure e os recursos de rede e Hubs de Eventos necessários
  • Usar o provedor AzAPI para adicionar um conjunto de regras de rede aos azurerm_eventhub_namespace recursos

Observação

O código de exemplo deste artigo está localizado no repositório do GitHub do Azure Terraform.

Pré-requisitos

  • Assinatura do Azure: caso você não tenha uma assinatura do Azure, crie uma conta gratuita antes de começar.

Implementar o código do Terraform

  1. Crie um diretório em que você vai testar o código de exemplo do Terraform, depois transforme-o no diretório atual.

  2. Crie um arquivo chamado providers.tf e insira o seguinte código:

    terraform {
      required_providers {
        azapi = {
          source  = "azure/azapi"
          version = "=0.1.0"
        }
    
        azurerm = {
          source  = "hashicorp/azurerm"
          version = "=3.0.2"
        }
    
        random = {
          source  = "hashicorp/random"
          version = "=3.1.2"
        }
      }
    }
    
    provider "azapi" {
    }
    
    provider "azurerm" {
      features {}
    }
    
    provider "random" {
    }
    
  3. Crie um arquivo chamado main.tf e insira o seguinte código:

    resource "azurerm_resource_group" "qs101" {
      name     = "rg-qs101-eh-rules"
      location = "westus2"
    }
    
    resource "azurerm_virtual_network" "qs101" {
      name                = "myvnet"
      location            = azurerm_resource_group.qs101.location
      resource_group_name = azurerm_resource_group.qs101.name
      address_space       = ["172.17.0.0/16"]
      dns_servers         = ["10.0.0.4", "10.0.0.5"]
    }
    
    resource "azurerm_subnet" "qs101" {
      name                 = "default"
      resource_group_name  = azurerm_resource_group.qs101.name
      virtual_network_name = azurerm_virtual_network.qs101.name
      address_prefixes     = ["172.17.0.0/24"]
    
      service_endpoints = ["Microsoft.EventHub"]
    }
    
    resource "random_pet" "qs101_namespace" {
      length    = 3
      separator = ""
    }
    
    resource "azurerm_eventhub_namespace" "qs101" {
      name                = random_pet.qs101_namespace.id
      location            = azurerm_resource_group.qs101.location
      resource_group_name = azurerm_resource_group.qs101.name
      sku                 = "Standard"
      capacity            = 2
    }
    
  4. Crie um arquivo chamado main-generic.tf e insira o seguinte código:

    # AzAPI update resource is used to enable Network Rule sets on Event Hub namespace
    resource "azapi_update_resource" "qs101" {
      type      = "Microsoft.EventHub/namespaces/networkRuleSets@2021-11-01"
      name      = "default"
      parent_id = azurerm_eventhub_namespace.qs101.id
    
      body = jsonencode({
        properties = {
          defaultAction       = "Deny"
          publicNetworkAccess = "Enabled"
          virtualNetworkRules = [
            {
              ignoreMissingVnetServiceEndpoint = false
              subnet = {
                # API bug, returned id replaced `resourceGroups` with `resourcegroups`
                id = replace(azurerm_subnet.qs101.id, "resourceGroups", "resourcegroups")
              }
            }
          ]
          ipRules = [
            {
              action = "Allow"
              ipMask = "1.1.1.1"
            }
          ]
        }
      })
    }
    

Inicializar Terraform

Execute terraform init para inicializar a implantação do Terraform. Esse comando baixa o provedor do Azure necessário para gerenciar seus recursos do Azure.

terraform init -upgrade

Pontos principais:

  • O parâmetro -upgrade atualiza os plug-ins do provedor necessários para a versão mais recente que esteja em conformidade com as restrições de versão da configuração.

Criar um plano de execução Terraform

Execute o comando terraform plan para criar um plano de execução.

terraform plan -out main.tfplan

Pontos principais:

  • O comando terraform plan cria um plano de execução, mas não o executa. Em vez disso, ele determina quais ações são necessárias para criar a configuração especificada em seus arquivos de configuração. Esse padrão permite que você verifique se o plano de execução corresponde às suas expectativas antes de fazer qualquer alteração nos recursos reais.
  • O parâmetro opcional -out permite que você especifique um arquivo de saída para o plano. Usar o parâmetro -out garante que o plano que você examinou seja exatamente o que é aplicado.

Aplicar um plano de execução do Terraform

Execute terraform apply para aplicar o plano de execução à sua infraestrutura de nuvem.

terraform apply main.tfplan

Pontos principais:

  • O exemplo de comando do terraform apply pressupõe que você executou o terraform plan -out main.tfplan anteriormente.
  • Se você especificou um nome de arquivo diferente para o parâmetro -out, use esse mesmo nome de arquivo na chamada para terraform apply.
  • Se você não usou o parâmetro -out, chame terraform apply sem nenhum parâmetro.

Verifique os resultados

Execute az eventhubs namespace network-rule list para exibir as regras de rede do namespace Event Hubs.

az eventhubs namespace network-rule list --resource-group <resource_group_name> --namespace-name <namespace_name>

Pontos principais:

  • O nome do grupo de recursos e o terraform apply nome do namespace dos Hubs de Eventos são exibidos na saída.

Limpar os recursos

Quando você não precisar mais dos recursos criados por meio o Terraform, execute as seguintes etapas:

  1. Execute terraform plan e especifique o sinalizador destroy.

    terraform plan -destroy -out main.destroy.tfplan
    

    Pontos principais:

    • O comando terraform plan cria um plano de execução, mas não o executa. Em vez disso, ele determina quais ações são necessárias para criar a configuração especificada em seus arquivos de configuração. Esse padrão permite que você verifique se o plano de execução corresponde às suas expectativas antes de fazer qualquer alteração nos recursos reais.
    • O parâmetro opcional -out permite que você especifique um arquivo de saída para o plano. Usar o parâmetro -out garante que o plano que você examinou seja exatamente o que é aplicado.
  2. Execute a aplicação do Terraform para aplicar o plano de execução.

    terraform apply main.destroy.tfplan
    

Solucionar problemas do Terraform no Azure

Solucionar problemas comuns ao usar o Terraform no Azure

Próximas etapas