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

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

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

本文介绍如何使用 AzAPI Terraform 提供程序 来管理 AzureRM 提供程序当前不支持的 Azure 服务。 该 azapi_resource 帐户将用于管理 Azure 实验室服务 帐户和实验室。

  • 定义和配置 AzureRM 和 AzAPI 提供程序。
  • 使用 AzureRM 提供程序创建 Azure 资源组
  • 使用 AzureRM 提供程序在订阅中注册“Microsoft.LabServices”提供程序
  • 使用 AzAPI 提供程序创建 Azure 实验室服务资源

注意

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

先决条件

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

实现 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"
        }
      }
    }
    
    provider "azapi" {
      default_location = "eastus"
      default_tags = {
        team = "Azure deployments"
      }
    }
    
    provider "azurerm" {
      features {}
    }
    
  3. 创建名为 main.tf 的文件并插入下列代码:

    resource "azurerm_resource_group" "qs101" {
      name     = "rg-qs101"
      location = "westus2"
    }
    
  4. 创建名为 main-generic.tf 的文件并插入下列代码:

    # Provision a Lab Service Account and a Lab that are in public preview
    resource "azapi_resource" "qs101-account" {
      type      = "Microsoft.LabServices/labaccounts@2018-10-15"
      name      = "qs101LabAccount"
      parent_id = azurerm_resource_group.qs101.id
    
      body = jsonencode({
        properties = {
          enabledRegionSelection = false
        }
      })
    }
    
    resource "azapi_resource" "qs101-lab" {
      type      = "Microsoft.LabServices/labaccounts/labs@2018-10-15"
      name      = "qs101Lab"
      parent_id = azapi_resource.qs101-account.id
    
      body = jsonencode({
        properties = {
          maxUsersInLab  = 10
          userAccessMode = "Restricted"
        }
      })
    }
    

初始化 Terraform

运行 terraform init,将 Terraform 部署进行初始化。 此命令下载管理 Azure 资源所需的 Azure 模块。

terraform init

创建 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

验证结果

  1. 在 Azure 订阅中,浏览到 rg-qs101 资源组。
  2. 名为 qs101LabAccount “的新实验室服务帐户”显示为资源组的成员。

清理资源

不再需要通过 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 时遇到的常见问题

后续步骤