ARM 模板的部署函数

项目
10/04/2023

资源管理器提供了以下函数，用于获取与 Azure 资源管理器模板（ARM 模板）的当前部署相关的值：

部署
环境
parameters
variables

若要从资源、资源组或订阅获取值，请参阅 Resource functions（资源函数）。

提示

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

部署

deployment()

返回有关当前部署操作的信息。

在 Bicep 中，使用 deployment 函数。

返回值

此函数返回部署期间传递的对象。返回的对象中的属性因以下情况而异：

部署模板或模板规格。
你部署的模板是本地文件，还是通过 URI 访问的远程文件。
部署到资源组还是其他范围之一（Azure 订阅、管理组或租户）。

将本地模板部署到资源组时，该函数返回以下格式：

{
  "name": "",
  "properties": {
    "template": {
      "$schema": "",
      "contentVersion": "",
      "parameters": {},
      "variables": {},
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

将远程模板部署到资源组时，该函数返回以下格式：

{
  "name": "",
  "properties": {
    "templateLink": {
      "uri": ""
    },
    "template": {
      "$schema": "",
      "contentVersion": "",
      "parameters": {},
      "variables": {},
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

将模板规格部署到资源组时：该函数返回以下格式：

{
  "name": "",
  "properties": {
    "templateLink": {
      "id": ""
    },
    "template": {
      "$schema": "",
      "contentVersion": "",
      "parameters": {},
      "variables": {},
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

当部署到 Azure 订阅、管理组或租户时，返回对象包含 location 属性。部署本地模板或外部模板时包含 location 属性。格式为：

{
  "name": "",
  "location": "",
  "properties": {
    "template": {
      "$schema": "",
      "contentVersion": "",
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

部署 languageVersion 2.0 模板时，deployment 函数会返回有限的属性子集：

{
  "name": "",
  "location": "",
  "properties": {
    "template": {
      "contentVersion": ""
    },
    "templateLink": {
      "id": "",
      "uri": ""
    }
  }
}

备注

可以根据父模板的 URI，使用 deployment() 链接到另一个模板。

"variables": {
  "sharedTemplateUrl": "[uri(deployment().properties.templateLink.uri, 'shared-resources.json')]"
}

如果从门户中的部署历史记录重新部署模板，则该模板将部署为本地文件。部署函数不返回 templateLink 属性。如果模板依赖于 templateLink 来构建指向另一个模板的链接，请不要使用门户进行重新部署，而是使用最初部署模板时使用的命令。

示例

下面的示例返回部署对象。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [],
  "outputs": {
    "deploymentOutput": {
      "type": "object",
      "value": "[deployment()]"
    }
  }
}

前面的示例返回以下对象：

{
  "name": "deployment",
  "properties": {
    "template": {
      "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
      "contentVersion": "1.0.0.0",
      "resources": [],
      "outputs": {
        "deploymentOutput": {
          "type": "Object",
          "value": "[deployment()]"
        }
      }
    },
    "templateHash": "13135986259522608210",
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted"
  }
}

对于订阅部署，以下示例返回一个部署对象。

{
  "$schema": "https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {},
  "variables": {},
  "resources": [],
  "outputs": {
    "exampleOutput": {
      "type": "object",
      "value": "[deployment()]"
    }
  }
}

环境

environment()

返回有关用于部署的 Azure 环境的信息。

在 Bicep 中，使用 environment 函数。

注解

若要查看帐户的已注册环境的列表，请使用 az cloud list 或 Get-AzEnvironment。

返回值

此函数返回当前 Azure 环境的属性。以下示例显示了全局 Azure 的属性。主权云可能会返回略有不同的属性。

{
  "name": "",
  "gallery": "",
  "graph": "",
  "portal": "",
  "graphAudience": "",
  "activeDirectoryDataLake": "",
  "batch": "",
  "media": "",
  "sqlManagement": "",
  "vmImageAliasDoc": "",
  "resourceManager": "",
  "authentication": {
    "loginEndpoint": "",
    "audiences": [
      "",
      ""
    ],
    "tenant": "",
    "identityProvider": ""
  },
  "suffixes": {
    "acrLoginServer": "",
    "azureDatalakeAnalyticsCatalogAndJob": "",
    "azureDatalakeStoreFileSystem": "",
    "azureFrontDoorEndpointSuffix": "",
    "keyvaultDns": "",
    "sqlServerHostname": "",
    "storage": ""
  }
}

示例

以下示例模板返回环境对象。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [],
  "outputs": {
    "environmentOutput": {
      "type": "object",
      "value": "[environment()]"
    }
  }
}

前面的示例在部署到 Azure 中国云时返回以下对象：

{
    "name": "AzureChinaCloud",
    "gallery": "https://gallery.chinacloudapi.cn",
    "graph": "https://graph.chinacloudapi.cn",
    "portal": "https://portal.azure.cn",
    "graphAudience": "https://graph.chinacloudapi.cn",
    "activeDirectoryDataLake": null,
    "batch": "https://batch.chinacloudapi.cn",
    "media": "https://rest.media.chinacloudapi.cn",
    "sqlManagement": "https://management.core.chinacloudapi.cn:8443",
    "vmImageAliasDoc": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/arm-compute/quickstart-templates/aliases.json",
    "resourceManager": "https://management.chinacloudapi.cn",
    "authentication": {
        "loginEndpoint": "https://login.chinacloudapi.cn",
        "audiences": [
            "https://management.core.chinacloudapi.cn",
            "https://management.chinacloudapi.cn"
        ],
        "tenant": "common",
        "identityProvider": "AAD"
    },
    "suffixes": {
        "acrLoginServer": ".azurecr.cn",
        "azureDatalakeAnalyticsCatalogAndJob": null,
        "azureDatalakeStoreFileSystem": null,
        "azureFrontDoorEndpointSuffix": "",
        "keyvaultDns": ".vault.azure.cn",
        "sqlServerHostname": ".database.chinacloudapi.cn",
        "storage": "core.chinacloudapi.cn"
    }
}

参数

parameters(parameterName)

返回一个参数值。指定的参数名称必须已在模板的 parameters 节中定义。

在 Bicep 中，通过使用参数的符号名称来直接引用这些参数。

参数

参数	必选	Type	说明
parameterName	是	字符串	要返回的参数名称。

返回值

指定的参数的值。

备注

通常，使用参数设置资源值。以下示例将 Web 站点的名称设置为在部署过程中传递的参数值。

"parameters": {
  "siteName": {
    "type": "string"
  }
}, "resources": [
  {
    "type": "Microsoft.Web/Sites",
    "apiVersion": "2016-08-01",
    "name": "[parameters('siteName')]",
    ...
  }
]

示例

以下示例演示了 parameters 函数的简化用法。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "stringParameter": {
      "type": "string",
      "defaultValue": "option 1"
    },
    "intParameter": {
      "type": "int",
      "defaultValue": 1
    },
    "objectParameter": {
      "type": "object",
      "defaultValue": {
        "one": "a",
        "two": "b"
      }
    },
    "arrayParameter": {
      "type": "array",
      "defaultValue": [ 1, 2, 3 ]
    },
    "crossParameter": {
      "type": "string",
      "defaultValue": "[parameters('stringParameter')]"
    }
  },
  "variables": {},
  "resources": [],
  "outputs": {
    "stringOutput": {
      "type": "string",
      "value": "[parameters('stringParameter')]"
    },
    "intOutput": {
      "type": "int",
      "value": "[parameters('intParameter')]"
    },
    "objectOutput": {
      "type": "object",
      "value": "[parameters('objectParameter')]"
    },
    "arrayOutput": {
      "type": "array",
      "value": "[parameters('arrayParameter')]"
    },
    "crossOutput": {
      "type": "string",
      "value": "[parameters('crossParameter')]"
    }
  }
}

上述示例中使用默认值的输出为：

名称	类型	值
stringOutput	String	选项 1
intOutput	int	1
objectOutput	Object	{"one": "a", "two": "b"}
arrayOutput	Array	[1, 2, 3]
crossOutput	String	选项 1

如需详细了解如何使用参数，请参阅 ARM 模板中的参数。

variables

variables(variableName)

返回变量的值。指定的变量名称必须已在模板的 variables 节中定义。

在 Bicep 中，通过使用变量的符号名称来直接引用这些变量。

参数

参数	必选	Type	说明
variableName	是	String	要返回的变量名称。

返回值

指定的变量的值。

备注

通常，使用变量通过只构造一次复杂值来简化模板。以下示例构造存储帐户的唯一名称。

"variables": {
  "storageName": "[concat('storage', uniqueString(resourceGroup().id))]"
},
"resources": [
  {
    "type": "Microsoft.Storage/storageAccounts",
    "name": "[variables('storageName')]",
    ...
  },
  {
    "type": "Microsoft.Compute/virtualMachines",
    "dependsOn": [
      "[variables('storageName')]"
    ],
    ...
  }
],

示例

以下示例返回不同的变量值。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {},
  "variables": {
    "var1": "myVariable",
    "var2": [ 1, 2, 3, 4 ],
    "var3": "[ variables('var1') ]",
    "var4": {
      "property1": "value1",
      "property2": "value2"
    }
  },
  "resources": [],
  "outputs": {
    "exampleOutput1": {
      "type": "string",
      "value": "[variables('var1')]"
    },
    "exampleOutput2": {
      "type": "array",
      "value": "[variables('var2')]"
    },
    "exampleOutput3": {
      "type": "string",
      "value": "[variables('var3')]"
    },
    "exampleOutput4": {
      "type": "object",
      "value": "[variables('var4')]"
    }
  }
}

上述示例中使用默认值的输出为：

名称	类型	Value
exampleOutput1	String	myVariable
exampleOutput2	Array	[1, 2, 3, 4]
exampleOutput3	String	myVariable
exampleOutput4	Object	{"property1": "value1", "property2": "value2"}

如需详细了解如何使用变量，请参阅 ARM 模板中的变量。

后续步骤

有关 ARM 模板中各部分的说明，请参阅了解 ARM 模板的结构和语法。

ARM 模板的部署函数

部署

返回值

备注

示例

环境

注解

返回值

示例

参数

参数

返回值

备注

示例

variables

参数

返回值

备注

示例

后续步骤

其他资源