Rychlý start: Vytvoření centra oznámení Azure pomocí Terraformu

Tento článek využívá Terraform k vytvoření oboru názvů Azure Notification Hubs a oznamovacího centra. Název každého prostředku se náhodně vygeneruje, aby nedocházelo ke konfliktům názvů.

Azure Notification Hubs poskytuje snadno použitelný a škálovaný modul nabízených oznámení, který umožňuje odesílat oznámení na libovolnou platformu (iOS, Android, Windows, Kindle atd.) z jakéhokoli back-endu (cloudu nebo místního prostředí). Další informace o službě najdete v tématu Co je Azure Notification Hubs.

Terraform umožňuje definovat, prohlížet a nasazovat cloudovou infrastrukturu. Pomocí Terraformu vytvoříte konfigurační soubory pomocí syntaxe HCL. Syntaxe seznamu HCL umožňuje zadat poskytovatele cloudu , například Azure, a prvky, které tvoří vaši cloudovou infrastrukturu. Po vytvoření konfiguračních souborů vytvoříte plán provádění, který vám umožní zobrazit náhled změn infrastruktury před jejich nasazením. Jakmile ověříte změny, použijete plán provádění k nasazení infrastruktury.

V tomto článku se naučíte:

• Vytvořte náhodnou hodnotu pro název skupiny prostředků Azure pomocí random_pet.
• Vytvořte skupinu prostředků Azure pomocí azurerm_resource_group.
• Vytvořte náhodnou hodnotu pro název oboru názvů služby Azure Notification Hub pomocí random_string.
• Pomocí azurerm_notification_hub_namespace vytvořte obor názvů služby Azure Notification Hub.
• Vytvořte náhodnou hodnotu pro název centra oznámení Azure pomocí random_string.
• Vytvořte centrum oznámení Azure pomocí azurerm_notification_hub.

Požadavky

• Nainstalujte a nakonfigurujte Terraform

Implementace kódu Terraformu

Poznámka:

Vzorový kód pro tento článek se nachází v úložišti GitHubu Azure Terraformu. Můžete zobrazit soubor protokolu obsahující výsledky testu z aktuálních a předchozích verzí Terraformu.

Další články a ukázkový kód ukazující použití Terraformu ke správě prostředků Azure

1. Vytvořte adresář, ve kterém chcete otestovat a spustit ukázkový kód Terraformu a nastavit ho jako aktuální adresář.

2. Vytvořte soubor s názvem providers.tf a vložte následující kód:

   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. Vytvořte soubor s názvem main.tf a vložte následující kód:

   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. Vytvořte soubor s názvem variables.tf a vložte následující kód:

   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. Vytvořte soubor s názvem outputs.tf a vložte následující kód:

   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
   }
   

Inicializujte Terraform

Spusťte terraform init a inicializujte nasazení Terraformu. Tento příkaz stáhne poskytovatele Azure potřebného ke správě prostředků Azure.

terraform init -upgrade

klíčové body:

• Parametr -upgrade aktualizuje potřebné pluginy poskytovatele na nejnovější verzi, která odpovídá verzním omezením konfigurace.

Vytvoření plánu provádění Terraformu

Spusťte terraform plan pro vytvoření plánu provedení.

terraform plan -out main.tfplan

klíčové body:

• Příkaz terraform plan vytvoří plán provádění, ale nespustí ho. Místo toho určuje, jaké akce jsou nezbytné k vytvoření konfigurace zadané v konfiguračních souborech. Tento model umožňuje ověřit, jestli plán provádění odpovídá vašim očekáváním, než provede jakékoli změny skutečných prostředků.
• Volitelný -out parametr umožňuje zadat výstupní soubor pro plán. Použití parametru -out zajišťuje, že vámi zkontrolovaný plán je přesně tím, co bude aplikován.

Implementujte plán Terraformu

Spusťte terraform apply, abyste aplikovali plán provádění na vaši cloudovou infrastrukturu.

terraform apply main.tfplan

klíčové body:

• terraform apply Ukázkový příkaz předpokládá, že jste dříve spustili terraform plan -out main.tfplan.
• Pokud jste pro -out parametr zadali jiný název souboru, použijte stejný název souboru při volání terraform apply.
• Pokud jste parametr nepoužíli -out , zavolejte terraform apply bez parametrů.

Ověření výsledků

Azure CLI

1. Získejte název skupiny prostředků Azure.

   resource_group_name=$(terraform output -raw resource_group_name)
   

2. Získejte název jmenného prostoru.

   notification_hub_namespace_name=$(terraform output -raw notification_hub_namespace_name)
   

3. Spuštěním příkazu az notification-hub list zobrazte centra pro zadaný obor názvů.

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

Azure PowerShell

1. Získejte název skupiny prostředků Azure.

   $resource_group_name=$(terraform output -raw resource_group_name)
   

2. Získejte název jmenného prostoru.

   $notification_hub_namespace_name=$(terraform output -raw notification_hub_namespace_name)
   

3. Spuštěním rutiny Get-AzNotificationHub zobrazte centra pro zadaný obor názvů.

   Get-AzNotificationHub -ResourceGroup $resource_group_name `
                         -Namespace $notification_hub_namespace_name
   

Vyčistěte zdroje

Pokud už prostředky vytvořené přes Terraform nepotřebujete, proveďte následující kroky:

1. Spusťte terraform plan a zadejte parametr destroy.

   terraform plan -destroy -out main.destroy.tfplan
   

   klíčové body:

   • Příkaz terraform plan vytvoří plán provádění, ale nespustí ho. Místo toho určuje, jaké akce jsou nezbytné k vytvoření konfigurace zadané v konfiguračních souborech. Tento model umožňuje ověřit, jestli plán provádění odpovídá vašim očekáváním, než provede jakékoli změny skutečných prostředků.
   • Volitelný -out parametr umožňuje zadat výstupní soubor pro plán. Použití parametru -out zajišťuje, že vámi zkontrolovaný plán je přesně tím, co bude aplikován.

2. Spusťte terraform apply pro aplikaci prováděcího plánu.

   terraform apply main.destroy.tfplan
   

Řešení potíží s Terraformem v Azure

Řešení běžných problémů při používání Terraformu v Azure

Další kroky

Nastavení nabízených oznámení ve službě Azure Notification Hubs