共用方式為


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

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

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

Terraform 可啟用雲端基礎結構的定義、預覽和部署。 使用 Terraform,您可以使用 HCL 語法建立組態檔。 HCL 語法可讓您指定雲端提供者,例如 Azure,以及構成雲端基礎結構的專案。 建立組態檔之後,您會建立一個 執行計劃 ,讓您在部署基礎結構變更之前先預覽這些變更。 驗證變更之後,您會套用執行計劃來部署基礎結構。

在本文中,您將學會如何:

先決條件

實作 Terraform 程式碼

  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 計劃 以建立執行計劃。

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. 取得命名空間名稱。

    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
    

清理資源

當您不再需要透過 Terraform 建立的資源時,請執行下列步驟:

  1. 執行 terraform 計劃 並指定 destroy 旗標。

    terraform plan -destroy -out main.destroy.tfplan
    

    要點:

    • terraform plan 命令會建立執行計劃,但不會執行它。 然而,它會決定哪些動作是必要的,以建立您組態檔中所指定的設定。 此模式可讓您在對實際資源進行任何變更之前,先確認執行計劃是否符合您的預期。
    • 選擇性 -out 參數可讓您指定計劃的輸出檔。 使用 -out 參數可確保您查看的計劃確切地被套用。
  2. 執行 terraform apply 以執行該計劃。

    terraform apply main.destroy.tfplan
    

排除 Azure 上 Terraform 的故障

針對在 Azure 上使用 Terraform 時的常見問題進行疑難解答

後續步驟