使用 ARM 模板和 Azure PowerShell 部署资源

Artículo
09/04/2024

本文介绍如何配合使用 Azure PowerShell 与 Azure 资源管理器模板（ARM 模板），以将资源部署到 Azure。如果不熟悉部署和管理 Azure 解决方案的概念，请参阅模版部署概述。

提示

我们建议使用 Bicep，因为它提供与 ARM 模板相同的功能，并且该语法更易于使用。要了解详细信息，请参阅使用 Bicep 和 Azure PowerShell 部署资源。

先决条件

你需要使用模板进行部署。如果还没有模板，请从 Azure 快速入门模板存储库下载并保存一个示例模板。本文中使用的本地文件名为 C:\MyTemplates\azuredeploy.json。

需安装 Azure PowerShell 并连接到 Azure：

在本地计算机上安装 Azure PowerShell cmdlet。 有关详细信息，请参阅 Azure PowerShell 入门。
使用 Connect-AZAccount 连接到 Azure。如果有多个 Azure 订阅，则可能还需要运行 Set-AzContext。有关详细信息，请参阅使用多个 Azure 订阅。

部署范围

可将部署目标设定为资源组、订阅、管理组或租户。根据部署范围使用不同的命令。

若要部署到资源组，请使用 New-AzResourceGroupDeployment：

New-AzResourceGroupDeployment -ResourceGroupName <resource-group-name> -TemplateFile <path-to-template>

若要部署到订阅，请使用 New-AzSubscriptionDeployment（ cmdlet 的别名）：
```
New-AzSubscriptionDeployment -Location <location> -TemplateFile <path-to-template>
```
有关订阅级部署的详细信息，请参阅在订阅级别创建资源组和资源。
若要部署到管理组，请使用 New-AzManagementGroupDeployment。
```
New-AzManagementGroupDeployment -Location <location> -TemplateFile <path-to-template>
```
有关管理组级部署的详细信息，请参阅在管理组级别创建资源。
若要部署到租户，请使用 New-AzTenantDeployment。
```
New-AzTenantDeployment -Location <location> -TemplateFile <path-to-template>
```
有关租户级别部署的详细信息，请参阅在租户级别创建资源。

对于每一个范围，部署模板的用户必须具有创建资源所必需的权限。

部署名称

部署 ARM 模板时，可以为部署指定名称。此名称可以帮助你从部署历史记录中检索该部署。如果没有为部署提供名称，将使用模板文件的名称。例如，如果部署一个名为 azuredeploy.json 的模板，但未指定部署名称，则该部署将命名为 azuredeploy。

每次运行部署时，一个包含部署名称的条目会添加到资源组的部署历史记录中。如果运行另一个部署并为其指定了相同的名称，则会将先前的条目替换为当前部署。如果要在部署历史记录中保持唯一条目，请为每个部署指定唯一名称。

若要创建唯一名称，你可以分配一个随机数。

$suffix = Get-Random -Maximum 1000
$deploymentName = "ExampleDeployment" + $suffix

或者，添加日期值。

$today=Get-Date -Format "MM-dd-yyyy"
$deploymentName="ExampleDeployment"+"$today"

如果使用相同的部署名称对同一资源组运行并发部署，则仅会完成最后一个部署。尚未完成的具有相同名称的任何部署都将被最后一个部署所替换。例如，如果你运行一个名为 newStorage 的部署，它部署了一个名为 storage1 的存储帐户；与此同时，你运行了另一个名为 newStorage 的部署，它部署了一个名为 storage2 的存储帐户，则你将仅部署一个存储帐户。生成的存储帐户名为 storage2。

但是，如果你运行一个名为 newStorage 的部署，它部署了一个名为 storage1 的存储帐户；在该部署完成时你又立即运行了另一个名为 newStorage 的部署，它部署了一个名为 storage2 的存储帐户，则你将有两个存储帐户。一个名为 storage1，另一个名为 storage2。但是，部署历史记录中只有一个条目。

为每个部署指定唯一的名称时，可以并发运行它们而不会发生冲突。如果你运行一个名为 newStorage1 的部署，它部署了一个名为 storage1 的存储帐户；与此同时，你又运行了另一个名为 newStorage2 的部署，它部署了一个名为 storage2 的存储帐户，则部署历史记录中将有两个存储帐户和两个条目。

为避免与并发部署冲突并确保部署历史记录中的条目是唯一的，请为每个部署指定唯一的名称。

部署本地模板

可以部署本地计算机中的模板，也可以部署存储在外部的模板。本节介绍如何部署本地模板。

如果要部署到不存在的资源组，请创建该资源组。资源组名称只能包含字母数字字符、句点、下划线、连字符和括号。它最多可以包含 90 个字符。名称不能以句点结尾。

Connect-AzAccount -Environment AzureChinaCloud
New-AzResourceGroup -Name ExampleGroup -Location "China North 2"

若要部署本地模板，请在部署命令中使用 -TemplateFile 参数。下面的示例还显示了如何设置来自该模板的参数值。

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleGroup `
  -TemplateFile <path-to-template>

部署可能需要几分钟时间才能完成。

部署远程模板

你可能更愿意将 ARM 模板存储在外部位置，而不是存储在本地计算机上。可以将模板存储在源控件存储库（例如 GitHub）中。另外，还可以将其存储在 Azure 存储帐户中，以便在组织中共享访问。

注意

若要部署模板或引用存储在专用 GitHub 存储库中的链接模板，请参阅创建一个安全的定制 Azure 门户产品/服务中记录的自定义解决方案。可以创建一个 Azure 函数，从 Azure Key Vault 中拉取 GitHub 令牌。

New-AzResourceGroup -Name ExampleGroup -Location "China North 2"

若要部署外部模板，请使用 -TemplateUri 参数。

New-AzResourceGroupDeployment `
  -Name remoteTemplateDeployment `
  -ResourceGroupName ExampleGroup `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json

前面的示例要求模板的 URI 可公开访问，它适用于大多数情况，因为模板应该不会包含敏感数据。如果需要指定敏感数据（如管理员密码），请以安全参数的形式传递该值。但是，如果想要管理对模板的访问权限，请考虑使用模板规格。

若要使用存储在存储帐户中的相对路径部署远程链接模板，请使用 QueryString 指定 SAS 令牌：

New-AzResourceGroupDeployment `
  -Name linkedTemplateWithRelativePath `
  -ResourceGroupName "myResourceGroup" `
  -TemplateUri "https://stage20210126.blob.core.chinacloudapi.cn/template-staging/mainTemplate.json" `
  -QueryString "$sasToken"

有关详细信息，请参阅对链接模板使用相对路径。

部署模板规格

你可以创建模板规格，而不是部署本地或远程模板。模板规格是 Azure 订阅中包含 ARM 模板的资源。这使你可以轻松地与组织中的用户安全地共享模板。可使用 Azure 基于角色的访问控制 (Azure RBAC) 来授予对模板规格的访问权限。此功能目前以预览版提供。

下面的示例演示如何创建和部署模板规格。

首先，通过提供 ARM 模板创建模板规格。

New-AzTemplateSpec `
  -Name storageSpec `
  -Version 1.0 `
  -ResourceGroupName templateSpecsRg `
  -Location chinanorth2 `
  -TemplateJsonFile ./mainTemplate.json

然后，获取模板规格的 ID 并部署它。

$id = (Get-AzTemplateSpec -Name storageSpec -ResourceGroupName templateSpecsRg -Version 1.0).Versions.Id

New-AzResourceGroupDeployment `
  -ResourceGroupName demoRG `
  -TemplateSpecId $id

有关详细信息，请参阅 Azure 资源管理器模板规格。

预览更改

在部署模板之前，可以预览模板将对环境做出的更改。使用假设操作验证模板是否进行了预期的更改。模拟操作还验证模板是否有错误。

粘贴参数值

若要传递参数值，可以使用内联参数或参数文件。参数文件可以是 Bicep 参数文件或 JSON 参数文件。

内联参数。

若要传递内联参数，请使用 New-AzResourceGroupDeployment 命令提供参数的名称。例如，若要将字符串和数组传递给模板，请使用：

$arrayParam = "value1", "value2"
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile <path-to-template> `
  -exampleString "inline string" `
  -exampleArray $arrayParam

可以使用 TemplateParameterObject 参数直通包含模板参数的哈希表。

$params = @{
  exampleString = "inline string"
  exampleArray = "value1", "value2"
}

New-AzResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile <path-to-bicep> `
  -TemplateParameterObject $params

还可以获取文件的内容并将该内容作为内联参数提供。

$arrayParam = "value1", "value2"
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile <path-to-template> `
  -exampleString $(Get-Content -Path c:\MyTemplates\stringcontent.txt -Raw) `
  -exampleArray $arrayParam

当需要提供配置值时，从文件中获取参数值非常有用。例如，可以为 Linux 虚拟机提供 cloud-init 值。

如果需要传入对象数组，请在 PowerShell 中创建哈希表并将其添加到数组中。在部署过程中将该数组作为参数传递。

$hash1 = @{ Name = "firstSubnet"; AddressPrefix = "10.0.0.0/24"}
$hash2 = @{ Name = "secondSubnet"; AddressPrefix = "10.0.1.0/24"}
$subnetArray = $hash1, $hash2
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile <path-to-template> `
  -exampleArray $subnetArray

JSON 参数文件

你可能会发现，与在脚本中以内联值的形式传递参数相比，使用包含参数值的 JSON 文件更为容易。参数文件可以是本地文件，也可以是具有可访问 URI 的外部文件。

有关参数文件的详细信息，请参阅创建资源管理器参数文件。

若要传递本地参数文件，请使用 TemplateParameterFile 参数：

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateFile <path-to-template> `
  -TemplateParameterFile c:\MyTemplates\storage.parameters.json

若要传递外部参数文件，请使用 TemplateParameterUri 参数：

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json `
  -TemplateParameterUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.parameters.json

有关参数文件的详细信息，请参阅创建资源管理器参数文件。

Bicep 参数文件

对于 Azure PowerShell 10.4.0 或更高版本和 Bicep CLI 0.22.6 或更高版本，可以使用 Bicep 参数文件来部署 ARM 模板文件。使用 Bicep 参数文件中的 using 语句，在为 -TemplateParameterFile 开关指定 Bicep 参数文件时无需提供 -TemplateFile 开关。

以下示例演示名为 storage.bicepparam 的参数文件。该文件位于运行此命令的同一目录中。

New-AzResourceGroupDeployment `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateParameterFile storage.bicepparam

有关 Bicep 参数文件的详细信息，请参阅 Bicep 参数文件。

后续步骤

若要在出错时回退到成功的部署，请参阅出错时回退到成功的部署。
若要指定如何处理存在于资源组中但未在模板中定义的资源，请参阅 Azure 资源管理器部署模式。
若要了解如何在模板中定义参数，请参阅了解 ARM 模板的结构和语法。
有关部署需要 SAS 令牌的模板的信息，请参阅使用 SAS 令牌部署专用 ARM 模板。

Compartir a través de