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

与 Azure 蓝图一起使用的函数

项目
09/07/2023

重要

2026 年 7 月 11 日，蓝图（预览版）将弃用。将现有蓝图定义和分配迁移到模板规格和部署堆栈。蓝图项目将转换为 ARM JSON 模板或用于定义部署堆栈的 Bicep 文件。若要了解如何将项目创作为 ARM 资源，请参阅：

Azure 蓝图提供了使蓝图定义更加动态的函数。这些函数用于蓝图定义和蓝图项目。除了通过蓝图参数获取动态值之外，Azure 资源管理器模板（ARM 模板）项目还支持充分利用资源管理器函数。

支持以下函数：

项目
concat
参数
resourceGroup
resourceGroups
subscription

项目

artifacts(artifactName)

返回由蓝图项目输出填充的属性对象。

注意

artifacts() 函数不能在 ARM 模板内部使用。当使用 Azure PowerShell 或 REST API 作为 Blueprints-as-code 的一部分来管理蓝图时，此函数只能在蓝图定义 JSON 或项目 JSON 中使用。

参数

参数	必需	类型	说明
artifactName	是	字符串	蓝图项目的名称。

返回值

输出属性的对象。 “输出”属性依赖于所引用的蓝图项目的类型。所有类型都遵循以下格式：

{
  "outputs": {collectionOfOutputProperties}
}

策略分配项目

{
    "outputs": {
        "policyAssignmentId": "{resourceId-of-policy-assignment}",
        "policyAssignmentName": "{name-of-policy-assignment}",
        "policyDefinitionId": "{resourceId-of-policy-definition}",
    }
}

ARM 模板项目

返回对象的“输出”属性在 ARM 模板中定义，并由部署返回。

角色分配项目

{
    "outputs": {
        "roleAssignmentId": "{resourceId-of-role-assignment}",
        "roleDefinitionId": "{resourceId-of-role-definition}",
        "principalId": "{principalId-role-is-being-assigned-to}",
    }
}

示例

ID 为“myTemplateArtifact”的 ARM 模板项目，包含以下示例输出属性：

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    ...
    "outputs": {
        "myArray": {
            "type": "array",
            "value": ["first", "second"]
        },
        "myString": {
            "type": "string",
            "value": "my string value"
        },
        "myObject": {
            "type": "object",
            "value": {
                "myProperty": "my value",
                "anotherProperty": true
            }
        }
    }
}

从“myTemplateArtifact”示例检索数据的一些示例如下：

表达式	类型	值
`[artifacts("myTemplateArtifact").outputs.myArray]`	Array	["first", "second"]
`[artifacts("myTemplateArtifact").outputs.myArray[0]]`	字符串	"first"
`[artifacts("myTemplateArtifact").outputs.myString]`	字符串	"my string value"
`[artifacts("myTemplateArtifact").outputs.myObject]`	对象	{ "myproperty": "my value", "anotherProperty": true }
`[artifacts("myTemplateArtifact").outputs.myObject.myProperty]`	字符串	"my value"
`[artifacts("myTemplateArtifact").outputs.myObject.anotherProperty]`	Bool	True

concat

concat(string1, string2, string3, ...)

组合多个字符串值并返回串联的字符串。

参数

参数	必需	类型	说明
string1	是	字符串	串联的第一个值。
其他参数	否	字符串	按顺序排列的串联的其他值

返回值

串联值的字符串。

备注

Azure 蓝图函数与 ARM 模板函数的不同之处在于，它只处理字符串。

示例

concat(parameters('organizationName'), '-vm')

parameters

parameters(parameterName)

返回蓝图参数值。指定的参数名称必须在蓝图定义或蓝图项目中定义。

参数

参数	必需	类型	说明
parameterName	是	string	要返回的参数名称。

返回值

指定的蓝图或蓝图项目参数的值。

备注

Azure 蓝图函数与 ARM 模板函数的不同之处在于，它只处理蓝图参数。

示例

在蓝图定义中定义参数“principalIds”：

{
    "type": "Microsoft.Blueprint/blueprints",
    "properties": {
        ...
        "parameters": {
            "principalIds": {
                "type": "array",
                "metadata": {
                    "displayName": "Principal IDs",
                    "description": "This is a blueprint parameter that any artifact can reference. We'll display these descriptions for you in the info bubble. Supply principal IDs for the users,groups, or service principals for the Azure role assignment.",
                    "strongType": "PrincipalId"
                }
            }
        },
        ...
    }
}

然后使用“principalIds”作为蓝图项目中 parameters() 的参数：

{
    "type": "Microsoft.Blueprint/blueprints/artifacts",
    "kind": "roleAssignment",
    ...
    "properties": {
        "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/8e3af657-a8ff-443c-a75c-2fe8c4bcb635",
        "principalIds": "[parameters('principalIds')]",
        ...
    }
}

resourceGroup

resourceGroup()

返回表示当前资源组的对象。

返回值

返回的对象采用以下格式：

{
  "name": "{resourceGroupName}",
  "location": "{resourceGroupLocation}",
}

备注

Azure 蓝图函数与 ARM 模板函数不同。 resourceGroup() 函数不能在订阅级项目或蓝图定义中使用。它只能在作为资源组项目一部分的蓝图项目中使用。

resourceGroup() 函数的一个常见用途是在与资源组项目相同的位置中创建资源。

示例

若要使用在蓝图定义中或分配期间设置的资源组位置作为另一个项目的位置，请在蓝图定义中声明一个资源组占位符对象。在本例中，“NetworkingPlaceholder”是资源组占位符的名称。

{
    "type": "Microsoft.Blueprint/blueprints",
    "properties": {
        ...
        "resourceGroups": {
            "NetworkingPlaceholder": {
                "location": "eastus"
            }
        }
    }
}

然后，在面向资源组占位符对象的蓝图项目的上下文中使用 resourceGroup() 函数。在本例中，模板项目部署到“NetworkingPlaceholder”资源组中，并提供参数“resourceLocation”，动态填充到模板的“NetworkingPlaceholder”资源组位置。 “NetworkingPlaceholder”资源组的位置可以在蓝图定义上静态定义，也可以在分配期间动态定义。在这两种情况下，模板项目都会将该信息作为参数提供，并使用它将资源部署到正确的位置。

{
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "kind": "template",
  "properties": {
      "template": {
        ...
      },
      "resourceGroup": "NetworkingPlaceholder",
      ...
      "parameters": {
        "resourceLocation": {
          "value": "[resourceGroup().location]"
        }
      }
  }
}

resourceGroups

resourceGroups(placeholderName)

返回表示指定资源组项目的对象。与需要项目上下文的 resourceGroup() 不同，此函数用于在不在资源组上下文中时获取特定资源组占位符的属性。

参数

参数	必需	类型	说明
placeholderName	是	字符串	要返回的资源组项目的占位符名称。

返回值