你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

快速入门：使用 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 通知中心设置推送通知