快速入门：使用 AzAPI Terraform 提供程序部署第一个 Azure 更新资源

文章使用以下 Terraform 和 Terraform 提供程序版本进行测试：

• Terraform v1.1.8
• AzureRM 提供程序 v.3.0.2
• AzAPI 提供程序 v.0.1.0

使用 Terraform 可以定义、预览和部署云基础结构。 使用 Terraform 时，请使用 HCL 语法来创建配置文件。 利用 HCL 语法，可指定 Azure 这样的云提供程序和构成云基础结构的元素。 创建配置文件后，请创建一个执行计划，利用该计划，可在部署基础结构更改之前先预览这些更改。 验证了更改后，请应用该执行计划以部署基础结构。

本文介绍如何使用 AzAPI Terraform 提供程序管理 Azure 服务当前不支持的新功能。 该 azapi_update_resource 规则将用于管理 Azure EventHub 网络规则集。

• 定义和配置 AzureRM 和 AzAPI 提供程序
• 为事件中心命名空间生成随机名称
• 使用 AzureRM 提供程序创建 Azure 资源组和所需的网络和事件中心资源
• 使用 AzAPI 提供程序将网络规则集添加到 azurerm_eventhub_namespace 资源

注意

本文中的示例代码位于 Azure Terraform GitHub 存储库中。

先决条件

• Azure 订阅：如果没有 Azure 订阅，请在开始之前创建一个免费帐户。

• 配置 Terraform：如果尚未执行此操作，请使用以下选项之一配置 Terraform：

  • 使用 Bash 在 Azure Cloud Shell 中配置 Terraform
  • 使用 PowerShell 在 Azure Cloud Shell 中配置 Terraform
  • 使用 Bash 在 Windows 中配置 Terraform
  • 使用 PowerShell 在 Windows 中配置 Terraform

实现 Terraform 代码

1. 创建用于测试和运行示例 Terraform 代码的目录，并将其设为当前目录。

2. 创建名为 providers.tf 的文件并插入下列代码：

   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. 创建名为 main.tf 的文件并插入下列代码：

   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. 创建名为 main-generic.tf 的文件并插入下列代码：

   # 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"
           }
         ]
       }
     })
   }
   

初始化 Terraform

运行 terraform init，将 Terraform 部署进行初始化。 此命令将下载管理 Azure 资源所需的 Azure 提供程序。

terraform init -upgrade

要点：

• 参数 -upgrade 可将必要的提供程序插件升级到符合配置版本约束的最新版本。

创建 Terraform 执行计划

运行 terraform plan 以创建执行计划。

terraform plan -out main.tfplan

要点：

• terraform plan 命令将创建一个执行计划，但不会执行它。 它会确定创建配置文件中指定的配置需要执行哪些操作。 此模式允许你在对实际资源进行任何更改之前验证执行计划是否符合预期。
• 使用可选 -out 参数可以为计划指定输出文件。 使用 -out 参数可以确保所查看的计划与所应用的计划完全一致。

应用 Terraform 执行计划

运行 terraform apply，将执行计划应用到云基础结构。

terraform apply main.tfplan

要点：

• 示例 terraform apply 命令假设你先前运行了 terraform plan -out main.tfplan。
• 如果为 -out 参数指定了不同的文件名，请在对 terraform apply 的调用中使用该相同文件名。
• 如果未使用 -out 参数，请调用不带任何参数的 terraform apply。

验证结果

Azure CLI

运行 az eventhubs namespace network-rule list 以显示事件中心命名空间网络规则。

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

要点：

• 资源组名称和事件中心命名空间名称显示在输出中 terraform apply 。

Azure PowerShell

运行 Get-AzEventHubNetworkRuleSet 以显示事件中心命名空间网络规则。

Get-AzEventHubNetworkRuleSet -ResourceGroupName <resource_group_name> -Namespace <namespace_name>

要点：

• 资源组名称和事件中心命名空间名称显示在输出中 terraform apply 。

清理资源

不再需要通过 Terraform 创建的资源时，请执行以下步骤：

1. 运行 terraform plan 并指定 destroy 标志。

   terraform plan -destroy -out main.destroy.tfplan
   

   要点：

   • terraform plan 命令将创建一个执行计划，但不会执行它。 它会确定创建配置文件中指定的配置需要执行哪些操作。 此模式允许你在对实际资源进行任何更改之前验证执行计划是否符合预期。
   • 使用可选 -out 参数可以为计划指定输出文件。 使用 -out 参数可以确保所查看的计划与所应用的计划完全一致。

2. 运行 terraform apply 以应用执行计划。

   terraform apply main.destroy.tfplan
   

Azure 上的 Terraform 故障排除

排查在 Azure 上使用 Terraform 时遇到的常见问题

后续步骤

详细了解如何在 Azure 中使用 Terraform