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

快速入门：使用 Terraform 创建 Azure SQL 数据库服务器和数据库

适用于：Azure SQL 数据库

在 Azure SQL 数据库中创建数据库时，创建单一数据库是最快速且最简单的选项。 本快速入门介绍了如何使用 Terraform 创建单一数据库。

使用 Terraform 可以定义、预览和部署云基础结构。 使用 Terraform 时，请使用 HCL 语法来创建配置文件。 利用 HCL 语法，可指定 Azure 这样的云提供程序和构成云基础结构的元素。 创建配置文件后，请创建一个执行计划，利用该计划，可在部署基础结构更改之前先预览这些更改。 验证了更改后，请应用该执行计划以部署基础结构。

在本文中，学习如何：

• 使用 random_pet 为 Azure 资源组名称创建一个随机值。
• 使用 azurerm_resource_group 创建 Azure 资源组。
• 使用 random_pet 为 Azure 中的逻辑服务器创建一个随机值。
• 使用 random_password 为 Azure 中的逻辑服务器创建一个随机密码。
• 使用 azurerm_mssql_server 创建 Azure 中的逻辑服务器。
• 使用 azurerm_mssql_database 在 Azure SQL 数据库中创建一个数据库。

先决条件

• 安装和配置 Terraform

权限

若要通过 Transact-SQL 创建数据库：需要 CREATE DATABASE 权限。 若要创建数据库，登录名必须是服务器管理员登录名（预配 Azure SQL 数据库逻辑服务器时创建）、服务器的 Microsoft Entra 管理员、master 中 dbmanager 数据库角色的成员。 有关详细信息，请参阅 CREATE DATABASE。

若要通过 Azure 门户、PowerShell、Azure CLI 或 REST API 创建数据库：需要 Azure RBAC 权限，特别是参与者、SQL DB 参与者或 SQL Server 参与者 Azure RBAC 角色。 有关详细信息，请参阅 Azure RBAC 内置角色。

实现 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_pet" "azurerm_mssql_server_name" {
     prefix = "sql"
   }
   
   resource "random_password" "admin_password" {
     count       = var.admin_password == null ? 1 : 0
     length      = 20
     special     = true
     min_numeric = 1
     min_upper   = 1
     min_lower   = 1
     min_special = 1
   }
   
   locals {
     admin_password = try(random_password.admin_password[0].result, var.admin_password)
   }
   
   resource "azurerm_mssql_server" "server" {
     name                         = random_pet.azurerm_mssql_server_name.id
     resource_group_name          = azurerm_resource_group.rg.name
     location                     = azurerm_resource_group.rg.location
     administrator_login          = var.admin_username
     administrator_login_password = local.admin_password
     version                      = "12.0"
   }
   
   resource "azurerm_mssql_database" "db" {
     name      = var.sql_db_name
     server_id = azurerm_mssql_server.server.id
   }
   

4. 创建名为 variables.tf 的文件并插入下列代码：

   variable "resource_group_location" {
     type        = string
     description = "Location for all resources."
     default     = "eastus"
   }
   
   variable "resource_group_name_prefix" {
     type        = string
     description = "Prefix of the resource group name that's combined with a random ID so name is unique in your Azure subscription."
     default     = "rg"
   }
   
   variable "sql_db_name" {
     type        = string
     description = "The name of the SQL Database."
     default     = "SampleDB"
   }
   
   variable "admin_username" {
     type        = string
     description = "The administrator username of the SQL logical server."
     default     = "azureadmin"
   }
   
   variable "admin_password" {
     type        = string
     description = "The administrator password of the SQL logical server."
     sensitive   = true
     default     = null
   }
   

5. 创建名为 outputs.tf 的文件并插入下列代码：

   output "resource_group_name" {
     value = azurerm_resource_group.rg.name
   }
   
   output "sql_server_name" {
     value = azurerm_mssql_server.server.name
   }
   
   
   output "admin_password" {
     sensitive = true
     value     = local.admin_password
   }
   

初始化 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. 获取新的逻辑服务器名称。

   sql_server_name=$(terraform output -raw sql_server_name)
   

3. 运行 az sql db list 以显示服务器中所有数据库的名称。

   az sql db list \
   --resource-group $resource_group_name \
   --server $sql_server_name \
   --output table
   

Azure PowerShell

1. 获取 Azure 资源组名称。

   $resource_group_name=$(terraform output -raw resource_group_name)
   

2. 获取新的逻辑服务器名称。

   $sql_server_name=$(terraform output -raw sql_server_name)
   

3. 运行 Get-AzSqlDatabase 以显示服务器中所有数据库的名称。

    Get-AzSqlDatabase -ResourceGroupName $resource_group_name `
                      -ServerName $sql_server_name `
                      | Format-Table
   

清理资源

不再需要通过 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 时遇到的常见问题

下一步

创建服务器级防火墙规则