快速入門：使用 Terraform 建立 Azure 通知中樞

本文使用 Terraform 來建立 Azure 通知中樞命名空間和通知中樞。 系統會隨機產生每個資源的名稱，以避免命名衝突。

Azure 通知中樞提供易於使用且相應放大的推播引擎，可讓您從任何後端 (雲端或內部部署) 傳送通知到任何平台 (iOS、Android、Windows、Kindle 等)。 如需該服務的詳細資訊，請參閱什麼是 Azure 通知中樞。

Terraform 可讓您定義、預覽和部署雲端基礎結構。 使用 Terraform 時，您可以使用 HCL 語法來建立設定檔。 HCL 語法可讓您指定雲端提供者 (例如 Azure) 和構成雲端基礎結構的元素。 建立設定檔之後，您可以建立執行計畫，讓您先預覽基礎結構變更，之後再部署。 驗證變更之後，您可以套用執行計畫來部署基礎結構。

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

• 使用 random_pet 為 Azure 資源群組名稱建立隨機值。
• 使用 azurerm_resource_group 建立 Azure 資源群組。
• 使用 random_string 建立 Azure 通知中樞命名空間名稱的隨機值。
• 使用 azurerm_notification_hub_namespace 建立 Azure 通知中樞命名空間。
• 使用 random_string 建立 Azure 通知中樞名稱的隨機值。
• 使用 azurerm_notification_hub 建立 Azure 通知中樞。

必要條件

• 安裝及設定 Terraform

實作 Terraform 程式碼

注意

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

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

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

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

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

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

   resource "random_pet" "rg_name" {
     prefix = var.resource_group_name_prefix
   }
   
   resource "azurerm_resource_group" "rg" {
     name     = random_pet.rg_name.id
     location = var.resource_group_location
   }
   
   resource "random_string" "azurerm_notification_hub_namespace_name" {
     length  = 25
     upper   = false
     numeric = false
     special = false
   }
   
   resource "azurerm_notification_hub_namespace" "namespace" {
     name                = "hubns-${random_string.azurerm_notification_hub_namespace_name.result}"
     resource_group_name = azurerm_resource_group.rg.name
     location            = azurerm_resource_group.rg.location
     namespace_type      = "NotificationHub"
     sku_name            = "Free"
   }
   
   resource "random_string" "azurerm_notification_hub_name" {
     length  = 25
     upper   = false
     numeric = false
     special = false
   }
   
   resource "azurerm_notification_hub" "hub" {
     name                = "hub-${random_string.azurerm_notification_hub_name.result}"
     resource_group_name = azurerm_resource_group.rg.name
     namespace_name      = azurerm_notification_hub_namespace.namespace.name
     location            = azurerm_resource_group.rg.location
   }
   

4. 建立名為 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 value so name is unique in your Azure subscription."
   }
   

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

   output "resource_group_name" {
     value = azurerm_resource_group.rg.name
   }
   
   output "notification_hub_namespace_name" {
     value = azurerm_notification_hub_namespace.namespace.name
   }
   
   output "notification_hub__name" {
     value = azurerm_notification_hub.hub.name
   }
   

初始化 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

1. 取得 Azure 資源群組名稱。

   resource_group_name=$(terraform output -raw resource_group_name)
   

2. 取得命名空間名稱。

   notification_hub_namespace_name=$(terraform output -raw notification_hub_namespace_name)
   

3. 執行 az notification-hub list 以顯示指定命名空間的中樞。

   az notification-hub list \
       --resource-group $resource_group_name \
       --namespace-name $notification_hub_namespace_name
   

Azure PowerShell

1. 取得 Azure 資源群組名稱。

   $resource_group_name=$(terraform output -raw resource_group_name)
   

2. 取得命名空間名稱。

   $notification_hub_namespace_name=$(terraform output -raw notification_hub_namespace_name)
   

3. 執行 Get-AzNotificationHub 以顯示指定命名空間的中樞。

   Get-AzNotificationHub -ResourceGroup $resource_group_name `
                         -Namespace $notification_hub_namespace_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 時的常見問題進行疑難排解

下一步

在 Azure 通知中樞中設定推播通知