Azure 逻辑应用中工作流定义语言的架构引用指南

在 Azure 逻辑应用中创建逻辑应用时，该逻辑应用会采用一个基础工作流定义，其中描述了在逻辑应用中运行的实际逻辑。 That workflow definition uses JSON and follows a structure that's validated by the Workflow Definition Language schema. 本参考文档将会概述此结构，并介绍该架构如何定义工作流定义中的特征。

工作流定义结构

工作流定义始终包含一个用于实例化逻辑应用的触发器，以及该触发器激发后要运行的一个或多个操作。

下面是工作流定义的高级结构：

"definition": {
  "$schema": "<workflow-definition-language-schema-version>",
  "actions": { "<workflow-action-definitions>" },
  "contentVersion": "<workflow-definition-version-number>",
  "outputs": { "<workflow-output-definitions>" },
  "parameters": { "<workflow-parameter-definitions>" },
  "staticResults": { "<static-results-definitions>" },
  "triggers": { "<workflow-trigger-definitions>" }
}

触发器和操作

在工作流定义中，triggers 和 actions 节定义工作流执行期间发生的调用。 有关这些节的语法和详细信息，请参阅工作流触发器和操作。

Parameters

部署生命周期通常有用于开发、测试、过渡和生产的不同环境。 将逻辑应用部署到各种环境时，可能需要根据部署需求使用不同的值，例如连接字符串。 或者，你可能希望在整个逻辑应用中重用某些值而无需进行硬编码，或者你的某些值经常更改。 在工作流定义的 parameters 节中，可以为逻辑应用在运行时使用的值定义或编辑参数。 你必须先定义这些参数，然后才能在工作流定义中的其他位置引用这些参数。

下面是参数定义的一般结构：

"parameters": {
   "<parameter-name>": {
      "type": "<parameter-type>",
      "defaultValue": <default-parameter-value>,
      "allowedValues": [ <array-with-permitted-parameter-values> ],
      "metadata": {
         "description": "<parameter-description>"
      }
   }
},

接下来，请为工作流定义创建一个 Azure 资源管理器模板，定义模板参数来接收部署时需要的值，视情况将硬编码值替换为对模板或工作流定义参数的引用，并将需要在部署时使用的值存储在单独的参数文件中。 这样，无需更新和重新部署逻辑应用即可通过参数文件更轻松地更改这些值。 对于敏感的或者必须进行保护的信息（例如用户名、密码和机密），可将这些值存储在 Azure Key Vault 中，让参数文件从密钥保管库中检索这些值。 有关在模板和工作流定义级别定义参数的详细信息和示例，请参阅概述：使用 Azure 资源管理器模板自动部署逻辑应用。

Static results

在 staticResults 特性中，定义操作的模拟 outputs 和 status，启用操作的静态结果设置时，操作将返回这些信息。 在操作的定义中，runtimeConfiguration.staticResult.name 特性引用 staticResults 中的静态结果定义的名称。 了解如何通过设置静态结果使用模拟数据测试逻辑应用工作流。

"definition": {
   "$schema": "<...>",
   "actions": { "<...>" },
   "contentVersion": "<...>",
   "outputs": { "<...>" },
   "parameters": { "<...>" },
   "staticResults": {
      "<static-result-definition-name>": {
         "outputs": {
            <output-attributes-and-values-returned>,
            "headers": { <header-values> },
            "statusCode": "<status-code-returned>"
         },
         "status": "<action-status>"
      }
   },
   "triggers": { "<...>" }
}

例如，在此 HTTP 操作定义中，runtimeConfiguration.staticResult.name 特性引用 HTTP0 中的定义了操作模拟输出的 staticResults 特性。 runtimeConfiguration.staticResult.staticResultOptions 特性指定 HTTP 操作的静态结果设置为 Enabled。

"actions": {
   "HTTP": {
      "inputs": {
         "method": "GET",
         "uri": "https://www.microsoft.com"
      },
      "runAfter": {},
      "runtimeConfiguration": {
         "staticResult": {
            "name": "HTTP0",
            "staticResultOptions": "Enabled"
         }
      },
      "type": "Http"
   }
},

HTTP 操作在 HTTP0 内的 staticResults 定义中返回输出。 在此示例中，状态代码的模拟输出为 OK。 标头值的模拟输出为 "Content-Type": "application/JSON"。 操作状态的模拟输出为 Succeeded。

"definition": {
   "$schema": "<...>",
   "actions": { "<...>" },
   "contentVersion": "<...>",
   "outputs": { "<...>" },
   "parameters": { "<...>" },
   "staticResults": {
      "HTTP0": {
         "outputs": {
            "headers": {
               "Content-Type": "application/JSON"
            },
            "statusCode": "OK"
         },
         "status": "Succeeded"
      }
   },
   "triggers": { "<...>" }
},

Expressions

使用 JSON 可以获取设计时存在的文本值，例如：

"customerName": "Sophia Owen",
"rainbowColors": ["red", "orange", "yellow", "green", "blue", "indigo", "violet"],
"rainbowColorsCount": 7

还可以获取在运行时之前不存在的值。 To represent these values, you can use expressions, which are evaluated at run time. An expression is a sequence that can contain one or more functions, operators, variables, explicit values, or constants. 在工作流定义中，可以在 JSON 字符串值中的任何位置使用表达式，并在表达式的前面加上 @ 符号前缀。 计算表示 JSON 值的表达式时，会通过删除 @ 字符来提取表达式主体，并且始终生成另一个 JSON 值。

For example, for the previously defined customerName property, you can get the property value by using the parameters() function in an expression and assign that value to the accountName property:

"customerName": "Sophia Owen",
"accountName": "@parameters('customerName')"

String interpolation also lets you use multiple expressions inside strings that are wrapped by the @ character and curly braces ({}). 语法如下：

@{ "<expression1>", "<expression2>" }

结果始终是一个字符串。因此，此功能类似于 concat() 函数，例如：

"customerName": "First name: @{parameters('firstName')} Last name: @{parameters('lastName')}"

如果某个文本字符串以 @ 字符开头，请加上 @ 字符作为前缀，并加上另一个 @ 字符作为转义符：@@

这些示例演示如何计算表达式：

这些示例假设定义了 "myBirthMonth" 等于 "January"，"myAge" 等于数字 42：

"myBirthMonth": "January",
"myAge": 42

这些示例演示如何计算以下表达式：

在工作流设计器中以可视方式工作时，可以使用表达式编辑器创建表达式，例如：

完成后，将为工作流定义中的相应属性显示表达式，例如，下面的 searchQuery 属性：

"Search_tweets": {
  "inputs": {
    "host": {
      "connection": {
        "name": "@parameters('$connections')['x']['connectionId']"
      }
    }
  },
  "method": "get",
  "path": "/searchtweets",
  "queries": {
    "maxResults": 20,
    "searchQuery": "Azure @{concat('firstName','', 'LastName')}"
  }
},

Outputs

在 outputs 节中，定义工作流在完成运行时可以返回的数据。 例如，若要跟踪每次运行的特定状态或值，请指定工作流输出应返回该数据。

下面是输出定义的一般结构：

"outputs": {
  "<key-name>": {
    "type": "<key-type>",
    "value": "<key-value>"
  }
}

若要从工作流运行中获取输出，请在 Azure 门户中查看逻辑应用的运行历史记录和详细信息，或使用工作流 REST API。 也可将输出传递给 Power BI 等外部系统，以便可创建仪表板。

Operators

In expressions and functions, operators perform specific tasks, such as reference a property or a value in an array.

Functions

某些表达式从运行时操作获取其值，而这些操作在工作流定义开始运行时可能不存在。 To reference or work with these values in expressions, you can use functions that the Workflow Definition Language provides.

Related content

• 工作流定义语言动作和触发器
• 工作流 REST API