创建要用于 Azure 逻辑应用工作流输入的跨环境参数

项目
10/24/2024

适用范围：Azure 逻辑应用（消耗型 + 标准型）

在 Azure 逻辑应用中，可以通过定义“参数”来提取可能在整个开发、测试和生产环境的工作流中发生变化的值。使用参数而不是特定于环境的变量时，起初可以更专注于设计工作流，之后再插入特定于环境的变量。

本文介绍如何为多租户消耗型逻辑应用工作流和单租户标准型逻辑应用工作流创建、使用及编辑参数。你还将了解如何管理环境变量。

有关多租户和单租户 Azure 逻辑应用的详细信息，请查看 Azure 逻辑应用中的单租户与多租户。

先决条件

Azure 帐户和订阅。如果没有订阅，可以注册 Azure 帐户。
消耗型或标准型逻辑应用工作流

如果还没有逻辑应用工作流，请参阅使用 Azure 门户创建示例消耗逻辑应用工作流或使用 Azure 门户创建标准逻辑应用工作流。

注意

目前，只能使用 Azure 门户为消耗逻辑应用工作流创建参数。只能使用 Azure 门户或 Visual Studio Code 为标准型逻辑应用工作流创建参数。

消耗型与标准型逻辑应用工作流的参数

可以使用设计器为消耗型和标准型逻辑应用工作流定义参数。定义参数后，可以从同一逻辑应用资源内的任意工作流或连接中引用该参数。

在多租户消耗型逻辑应用工作流中使用设计器创建并使用参数后，需要在 Azure 资源管理器模板（ARM 模板）和模板参数文件中定义和设置环境变量。在此方案中，你必须在部署阶段定义和设置参数。这意味着，即使只需更改一个变量，也必须重新部署逻辑应用的 ARM 模板。

在单租户标准型逻辑应用工作流中，可以通过参数和应用设置在运行时和部署时使用环境变量。应用设置包含同一逻辑应用资源中所有工作流的全局配置选项。有关详细信息，请查阅基于逻辑应用编辑单租户的主机和应用设置。

重要

当你有敏感信息（例如包含用户名和密码的连接字符串）时，请确保使用可用的最安全身份验证流。例如，在标准逻辑应用工作流中，不支持 securestring 和 secureobject 等安全数据类型。 Microsoft 建议尽量使用托管标识对 Azure 资源访问进行身份验证，并分配具有最低所需特权的角色。

如果此功能不可用，请务必通过其他措施（例如可与应用设置一起使用的 Azure 密钥保管库）保护连接字符串。然后，可以直接引用安全字符串，例如连接字符串和密钥。与 ARM 模板类似，在部署时可以定义环境变量，可以在逻辑应用工作流定义中定义应用设置。然后，可以捕获动态生成的基础结构值，例如连接终结点、存储字符串等。有关详细信息，请参阅Microsoft 标识平台的应用程序类型。

但是，应用设置受大小限制，系统无法在 Azure 逻辑应用中的某些区域将其引用。参数可提供比应用设置范围更广的用例，例如支持较大值和复杂对象。

例如，如果使用 Visual Studio Code 作为在本地运行工作流的本地开发工具，则可以在逻辑应用项目中使用“parameters.json”文件定义参数。然后，可以从项目“workflow.json”文件内的任意工作流或者项目“connections.json”文件的任意连接对象中引用此参数文件内的任何参数。下表介绍了几个常见用例：

创建包含所有值，且会在测试时使用这些值的测试参数文件。部署时，可以将测试参数文件替换为生产参数文件。
将“connections.json”文件的不同部分参数化。然后，可以检查源代码管理中的 connections.json 文件，之后通过 parameters.json 文件管理连接。
还可以将复杂对象参数化，如 authentication JSON 对象。例如，将 authentication 对象值替换为包含单个参数表达式的字符串，例如 @parameters('api-auth')。
查看和编辑项目“local.settings.json”文件的应用设置。然后，可以在参数中引用这些应用设置。

注意

一般建议考虑使用参数作为将值参数化的默认方法，而非应用设置。这样，在需要存储安全密钥或字符串时，可以根据建议从参数中引用应用设置。如有需要，可以通过使用参数引用应用设置的方式，在解决方案中同时使用这两个选项。

Azure 门户

在 Azure 门户中，打开逻辑应用工作流。在“工作流”下，选择并打开设计器中的工作流。
在设计器工具栏上，选择“参数”。
在“参数”窗格中，选择“添加参数”。

提供以下与待创建参数相关的信息：

属性	必选	说明
客户	是	要创建参数的名称。
类型	是	参数的数据类型，例如“数组”、“布尔型”、“浮点”、“整数”、“对象”、“安全对象”、“安全字符串”和“字符串”。
默认值	是	参数的默认值。由于一个位置中不会同时存在工作流逻辑、连接信息和参数值，因此必须指定默认参数值。设计器必须能够在加载前即能解析参数值。重要提示：对于“安全对象”和“安全字符串”数据类型，请避免设置默认值，因为该值将存储为纯文本。
实际值	否	实际参数值。

以下示例介绍了字符串参数的定义：

显示 Azure 门户、消耗型工作流的设计器，以及带有示例参数定义的“参数”窗格的屏幕截图。

若要添加更多参数，请选择“添加参数”。否则请关闭“参数”窗格，但切记保存工作流，以保存新的参数定义。
若要在同一工作流中引用触发器或操作中的参数，请执行以下步骤：
1. 在设计器中打开目标工作流，然后展开触发器或操作。
2. 在要使用参数的属性中，单击该属性编辑框的内部。
3. 在已打开的动态内容列表的“参数”下，选择之前创建的参数，如下所示：
若要查看或编辑逻辑应用工作流中的参数，请执行以下步骤：
1. 在设计器中打开逻辑应用工作流。在设计器工具栏中选择“参数”。
  
  “参数”窗格会打开,并显示已在工作流内定义的所有参数。
2. 编辑相关内容，关闭“参数”窗格，然后保存逻辑应用工作流。

Azure 门户

在 Azure 门户中，打开你的逻辑应用资源。在“工作流”下，打开设计器中的工作流。
在设计器工具栏上，选择“参数”。
在“参数”窗格中选择“创建参数”。

提供以下与待创建参数相关的信息：

属性	必选	说明
客户	是	要创建参数的名称。
类型	是	参数的数据类型，例如“数组”、“布尔型”、“浮点”、“整形”、“对象”和“字符串”。注意：标准型逻辑应用工作流不支持安全数据类型，例如 `securestring` 和 `secureobject`。
值	是	参数的值。在标准型逻辑应用工作流中，由于工作流逻辑、连接信息和参数值不位于单个位置，因此在单租户 Azure 逻辑应用中，必须指定参数值。设计器必须能够在加载前即能解析参数值。

以下示例介绍了字符串参数的定义：

显示 Azure 门户、标准型工作流的设计器，以及带有示例参数定义的“参数”窗格的屏幕截图。

完成后，关闭“参数”窗格，但切记保存工作流，以保存新的参数定义。
若要在触发器或操作中引用参数，且该触发器位于同一逻辑应用内的任意工作流中，请执行以下步骤：
1. 在设计器中打开目标工作流，然后展开触发器或操作。
2. 在要使用参数的属性中，单击该属性编辑框的内部。
3. 在已打开的动态内容列表的“参数”下，选择之前创建的参数，如下所示：
若要在同一逻辑应用内查看或编辑参数，请执行以下任一步骤：
- 打开逻辑应用中的任意工作流。在工作流菜单中选择“设计器”。在设计器工具栏中选择“参数”。
  
  “参数”窗格会打开并显示在逻辑应用的工作流内定义的所有参数。
- 若要批量查看或编辑 JSON，请在逻辑应用的主菜单中选择“参数”。
  
  “参数”JSON 视图会打开并显示在逻辑应用的工作流内定义的所有参数。

Visual Studio Code

在名为“parameters.json”的项目根级别 JSON 文件中，定义“全部”参数及其值。此文件内含包含“键值”对的对象。每个“键”即每个参数的名称，而每个“值”则为每个参数的结构。每个结构都需要同时包含 type 和 value 声明。

重要

parameters.json 文件必须定义并包含所有参数及其值。可在项目的其他位置引用或使用的这些参数，例如，在工作流定义或连接中。

基本参数文件如以下示例所示：
```
{
    "responseString": { 
        "type": "string", 
        "value": "hello" 
    },
    "functionAuth": { 
        "type": "object", 
        "value": { 
            "type": "QueryString", 
            "name": "Code", 
            "value": "@appsetting('<AzureFunctionsOperation-FunctionAppKey>')" 
        }
    }
 }
```
注意

parameters.json 文件中唯一有效的表达式类型是 @appsetting。
若要引用触发器或操作输入中的参数，请使用表达式 @parameters('<parameter-name>')。

参数化连接文件

若要对 connections.json 文件进行参数化处理，请将文本值（如 ConnectionRuntimeUrl）替换为单个 parameters() 表达式，例如 @parameters('api-runtimeUrl')。 connections.json 中唯一有效的表达式类型是 @parameters 和 @appsetting。

重要

如果在开发过程中将 connections.json 文件参数化，则本地和 Azure 门户中的设计器体验将受到限制。如果需要使用设计器进行开发，请改用未经参数化处理的 connections.json 文件。然后，在部署管道中，替换为参数化文件。运行时仍适用于参数化。设计器改进正在开发中。

以下示例展示了同时采用“应用设置”和“参数”，且经参数化处理的 connections.json 文件。尽管都希望尽可能使用“参数”，但该示例是异常情况或边角案例。由于“应用部署”在部署阶段即会生成，且更易于在开发管道中动态填充。因此，通常而言，对“应用设置”的使用情况多于“参数”。此示例文件将参数用于复杂的 blob_auth 身份验证对象，并将应用设置用于其他值。在这种情况下，可以将参数用于身份验证对象，因为已不太可能在工作流中引用该参数：

{
   "serviceProviderConnections": {
      "serviceBus": {
         "parameterValues": {
            "connectionString": "@appsetting('serviceBus_connectionString')"
        },
        "serviceProvider": {
           "id": "/serviceProviders/serviceBus"
        },
        "displayName": "servicebus"
     }
   },
   "managedApiConnections": {
      "azureblob": {
         "api": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/providers/Microsoft.Web/locations/@{appsetting('WORKFLOWS_LOCATION_NAME')}/managedApis/azureblob"
         },
         "connection": {
            "id": "/subscriptions/@{appsetting('WORKFLOWS_SUBSCRIPTION_ID')}/resourceGroups/@{appsetting('WORKFLOWS_RESOURCE_GROUP_NAME')}/providers/Microsoft.Web/connections/azureblob"
         },
         "connectionRuntimeUrl": "@appsetting('BLOB_CONNECTION_RUNTIMEURL')",
         "authentication": "@parameters('blob_auth')"
      }
   }
}

注意

如果有以纯文本内联显示的表达式，请确保对该表达式使用内插格式，方法是将该表达式括在大括号中 ({})。此格式有助于避免分析问题。

例如，如果有"<text>/@<function-name>('<parameter-name>')/<text>"，请使用以下版本："<text>/@{<function-name>('<parameter-name>')}/<text>"。

有关详细信息，请查看使用函数时的注意事项。

管理参数文件

通常，需要管理参数文件的多个版本。不同的部署环境（例如开发、测试和生产）下可能会存在不同的目标值。这些参数文件的管理方式与管理 ARM 模板参数文件类似。部署到特定环境时，通常可通过 DevOps 的管道来升级相应的参数文件。

若要使用 Azure CLI 动态替换参数文件，请运行以下命令：

az functionapp deploy --resource-group MyResourceGroup --name MyLogicApp --src-path C:\parameters.json --type static --target-path parameters.json

如果存在一个基于 NuGet 的逻辑应用项目，则必须更新项目文件 (<logic-app-name>.csproj) 以在生成输出中包含参数文件，如下所示：

<ItemGroup>
  <None Update="parameters.json">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
  </None>
</ItemGroup>

注意

目前，在 Azure 门户或工作流设计器中，动态替换参数文件的功能尚不可用。

有关设置用于 DevOps 部署的逻辑应用的详细信息，请参阅以下文档：

管理应用设置

在单租户 Azure 逻辑应用中，应用设置包含同一逻辑应用中所有工作流的全局配置选项。在 Visual Studio Code 本地运行工作流时，可以将这些应用设置作为 local.settings.json 文件中的本地环境变量并加以访问。然后，可以在参数中引用这些应用设置。

若要添加、更新或删除应用设置，请选择并查看 Visual Studio Code、Azure 门户、Azure CLI 或 ARM (Bicep) 模板的下列部分。

Azure 门户

若要在 Azure 门户中查看逻辑应用资源的应用设置，请执行以下步骤：

在 Azure 门户中，打开你的逻辑应用资源。
在逻辑应用菜单上的“设置”下，选择“配置”。
在“配置”页上的“应用程序设置”选项卡上，查看逻辑应用的应用设置。
若要查看所有值，请选择“显示值”。或者，若要查看单个值，请选择该值。

若要新增设置，请执行以下步骤：

在“应用程序设置”选项卡上的“应用程序设置”下，选择“新建应用程序设置”。
对于“名称”，输入新设置的键或名称。
对于“值”，输入新设置的值。
准备好创建新的键值对时，请选择“确定”。
完成后，在“配置”工具栏上选择“保存”。

Azure CLI

若要使用 Azure CLI 查看当前应用设置，请运行 az logicapp config appsettings list 命令。请确保命令包含 --name -n 和 --resource-group -g 参数，例如：

az logicapp config appsettings list --name MyLogicApp --resource-group MyResourceGroup

若要使用 Azure CLI 添加或更新应用设置，请运行命令 az logicapp config appsettings set。请确保命令包含 --name n 和 --resource-group -g 参数。例如，以下命令可用于创建一个设置，该设置具有名为 CUSTOM_LOGIC_APP_SETTING 的键，其值为 12345：

az logicapp config appsettings set --name MyLogicApp --resource-group MyResourceGroup --settings CUSTOM_LOGIC_APP_SETTING=12345

资源管理器或 Bicep 模板

若要查看和定义 ARM 模板或 Bicep 模板中的应用设置，请查找逻辑应用的资源定义，并更新 appSettings JSON 对象。有关完整资源定义，请参阅 ARM 模板参考。

ARM 模板或 Bicep 模板的文件设置如以下示例所示：

"appSettings": [
    {
        "name": "string",
        "value": "string"
    },
    {
        "name": "string",
        "value": "string"
    },
    <...>
],

Azure 逻辑应用中的单租户与多租户

通过

创建要用于 Azure 逻辑应用工作流输入的跨环境参数

先决条件

消耗型与标准型逻辑应用工作流的参数

定义、使用和编辑参数

Azure 门户

相关内容

其他资源