快速入門：使用 Terraform 在 Azure DevTest Labs 中建立實驗室

本文說明如何使用 Terraform，在 Azure DevTest Labs 內的實驗室中使用 Terraform 建立 Windows Server 2019 Datacenter 虛擬機。

在本文中，您將學會如何：

• 使用 random_pet (英文)，為 Azure 資源群組名稱建立隨機寵物名稱
• 使用 azurerm_resource_group 建立 Azure 資源群組
• 使用 random_password 建立隨機密碼
• 使用 azurerm_dev_test_lab 在 Azure DevTest Labs 內建立實驗室
• 使用 azurerm_dev_test_virtual_network 在 Azure DevTest Labs 中建立虛擬網路
• 使用 azurerm_dev_test_windows_virtual_machine 在 Azure DevTest Labs 中建立 Windows 虛擬機

必要條件

• 安裝及設定 Terraform

實作 Terraform 程式碼

注意

本文中的範例程式碼位於 Azure Terraform GitHub 存放庫 (英文)。 您可以檢視記錄檔，內含目前和舊版 Terraform 的測試結果 (英文)。

請參閱更多文章和範例程式碼，其中顯示如何使用 Terraform 來管理 Azure 資源

1. 建立目錄，然後在目錄中測試並執行範例 Terraform 程式碼，且設為目前的目錄。

2. 建立名為 main.tf 的檔案，並插入下列程式碼：

   resource "random_pet" "rg_name" {
     prefix = var.resource_group_name_prefix
   }
   
   resource "random_string" "vm_suffix" {
     length  = 5
     upper   = false
     special = false
     numeric = false
   }
   
   resource "azurerm_resource_group" "rg" {
     name     = random_pet.rg_name.id
     location = var.resource_group_location
   }
   
   resource "random_password" "password" {
     count       = var.password == null ? 1 : 0
     length      = 20
     special     = true
     min_numeric = 1
     min_upper   = 1
     min_lower   = 1
     min_special = 1
   }
   
   locals {
     password = try(random_password.password[0].result, var.password)
   }
   
   resource "azurerm_dev_test_lab" "lab" {
     name                = var.lab_name
     location            = azurerm_resource_group.rg.location
     resource_group_name = azurerm_resource_group.rg.name
   }
   
   resource "azurerm_dev_test_virtual_network" "vnet" {
     name                = "Dtl${var.lab_name}"
     lab_name            = azurerm_dev_test_lab.lab.name
     resource_group_name = azurerm_resource_group.rg.name
   }
   
   resource "azurerm_dev_test_windows_virtual_machine" "vm" {
     name                   = "ExampleVM-${random_string.vm_suffix.result}"
     lab_name               = azurerm_dev_test_lab.lab.name
     lab_subnet_name        = "Dtl${var.lab_name}Subnet"
     resource_group_name    = azurerm_resource_group.rg.name
     location               = azurerm_resource_group.rg.location
     storage_type           = "Standard"
     size                   = var.vm_size
     username               = var.user_name
     password               = local.password
     allow_claim            = false
     lab_virtual_network_id = azurerm_dev_test_virtual_network.vnet.id
   
     gallery_image_reference {
       offer     = "WindowsServer"
       publisher = "MicrosoftWindowsServer"
       sku       = "2019-Datacenter"
       version   = "latest"
     }
   }
   

3. 建立名為 outputs.tf 的檔案，並插入下列程式碼：

   output "resource_group_name" {
     value = azurerm_resource_group.rg.name
   }
   
   output "lab_name" {
     value = azurerm_dev_test_lab.lab.name
   }
   
   output "vm_name" {
     value = azurerm_dev_test_windows_virtual_machine.vm.name
   }
   
   output "password" {
     sensitive = true
     value     = local.password
   }
   

4. 建立名為 providers.tf 的檔案，並插入下列程式碼：

   terraform {
     required_version = ">=0.12"
     required_providers {
       azurerm = {
         source  = "hashicorp/azurerm"
         version = "~>3.0"
       }
       random = {
         source  = "hashicorp/random"
         version = "~>3.0"
       }
     }
   }
   provider "azurerm" {
     features {}
   }
   

5. 建立名為 variables.tf 的檔案，並插入下列程式碼：

   variable "resource_group_location" {
     type        = string
     default     = "eastus"
     description = "Location for all resources."
   }
   
   variable "resource_group_name_prefix" {
     type        = string
     default     = "rg"
     description = "Prefix of the resource group name that's combined with a random ID so name is unique in your Azure subscription."
   }
   
   variable "lab_name" {
     type        = string
     description = "The name of the new lab instance to be created"
     default     = "ExampleLab"
   }
   
   variable "vm_size" {
     type        = string
     description = "The size of the vm to be created."
     default     = "Standard_D4_v3"
   }
   
   variable "user_name" {
     type        = string
     description = "The username for the local account that will be created on the new vm."
     default     = "exampleuser"
   }
   
   variable "password" {
     type        = string
     description = "The password for the local account that will be created on the new vm."
     sensitive   = true
     default     = null
   }
   

初始化 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，不需要使用參數。

驗證結果

1. 取得建立實驗室的 Azure 資源名稱。

   resource_group_name=$(terraform output -raw resource_group_name)
   

2. 取得實驗室名稱。

   lab_name=$(terraform output -raw lab_name)
   

3. 執行 az lab vm list 來列出您在本文中建立之實驗室的虛擬機。

   az lab vm list --resource-group $resource_group_name \
                  --lab-name $lab_name
   

清除資源

當您不再需要透過 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 時的常見問題進行疑難排解

下一步

教學課程：使用實驗室 VM