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

创建和发布 Azure 逻辑应用工作流模板

适用于:Azure 逻辑应用(消耗型 + 标准型)

Azure 逻辑应用提供预生成、可重用的自动化和集成工作流模板,可用于加快生成集成应用程序的过程。 这些模板遵循常用的模式,通过提供具有预定义业务逻辑和配置的起点或基线来帮助简化开发。

模板可以包含一个或多个工作流及其连接、参数和文档。 Azure 逻辑应用提供以下模板类型:

模板类型 说明
Workflow 创建单个工作流的可重用模板。
加速器 包含多个相关工作流的捆绑解决方案。

可以在模板库中找到这些模板,在选择从模板开始创建工作流时打开。 该画廊已包含由Microsoft创作的用于常见设计和集成模式的模板。

不仅可以使用工作流模板启动开发,还可以在 Azure 订阅中单独为组织的使用创建和发布工作流模板,或与他人共享它们。 模板可以包括架构、映射和自定义程序集等项目。

借助组织模板,可以标准化集成模式、共享最佳做法,并在企业内部重复使用解决方案,而无需公开解决方案。 此功能对于想要促进一致性的企业尤其有用,同时保持选项开放以保持灵活性。 无论你的方案是嵌入内部 API、处理特定于域的逻辑还是强制实施体系结构模式,组织模板都可以帮助你在保持控制的同时缩放和增长。

Azure 逻辑应用模板还提供以下功能:

  • 在测试或生产模式下发布模板,使你能够安全地试验和控制发布。

  • 在模板中直接使用 API 和内部系统,而无需将其外部化。

  • 下载模板包,并可以选择将其添加到 GitHub 中 Azure 逻辑应用的公共工作流模板存储库

  • 使用 Azure DevOps 中的内置生命周期管理功能,将模板从测试环境转移到生产环境,该功能为团队提供结构的同时保持敏捷性。

  • 作为 Azure 中的一流资源,模板支持 Azure 基于角色的访问控制(RBAC)。

    • 可以像管理任何其他 Azure 资源一样管理模板权限。

      这些权限尊重订阅和角色范围,这意味着开发人员只能查看和访问开发人员有权访问的订阅中的模板。

      此功能提供企业级控制谁可以创作、查看和部署模板。 你可以完全控制想要组织模板的方式,以便确保正确的团队能够访问所需的自动化模式。

以下屏幕截图显示了限定为组织和 Azure 订阅的工作流模板库,其中包含显示状态标签(如测试和生产)的示例模板:

屏幕截图显示了 Azure 门户和工作流模板库,其中包含 Azure 订阅范围内的自定义模板,用于测试和生产。

本指南演示如何通过以下方式创建和发布工作流模板:

先决条件

  • 一个 Azure 帐户和订阅。 如果没有订阅,可以注册免费的 Azure 帐户

  • 已部署的消耗或标准逻辑应用资源和工作流,用作模板的源工作流定义。

    创建模板之前,必须先部署逻辑应用资源和工作流。 请确保正确参数化工作流的最终用户必须提供的任何值,而不是硬编码这些值。

    如果没有此资源和工作流,请参阅以下文章:

  • 显示模板创建的工作流的只读预览图像的屏幕截图。 对于这些屏幕截图,请使用 .png 文件扩展名。 模板的这些预览图像显示在模板库中的模板概述窗格中。

    若要存储这些映像,以便模板可以使用它们,需要 一个 Azure 存储帐户一个 Blob 容器

    若要创建这些映像,请执行以下步骤:

    1. Azure 门户中,在设计器中打开源逻辑应用资源和工作流。

    2. 设置工作流以创建两个屏幕截图:一个版本适用于 Web 浏览器的浅色主题,另一个版本适用于 Web 浏览器的深色主题。

    3. 使用首选的屏幕捕获工具创建屏幕截图。 不要在工作流周围包含太多空白。

    4. 使用 .png 文件扩展名和遵循 名称和样式约定的名称保存每个图像,例如 <图像名称>-light.png<图像名称>-dark.png

    5. 将映像添加到 Azure 存储帐户中的 Blob 容器。 复制并保存每个映像的 Blob URL,以便以后可以从模板引用映像。

      重要

      URL 包括一个共享访问签名(SAS)密钥或令牌,用于向存储服务授予权限,例如。 请确保保护 SAS 密钥,就像保护帐户密钥免受未经授权的使用一样。

最佳做法

此列表提供了创建工作流模板时要遵循的最佳做法:

  • 请勿在触发器和操作定义中使用硬编码属性及其值。

  • 通过添加描述性和有用的注释,提供有关触发器和操作定义的更多上下文。

  • 标准逻辑应用资源和工作流

    • 尽可能多使用内置操作。 例如,Azure Blob 存储连接器的以下版本可用于标准工作流:

      • 内置服务提供商操作显示在连接器库中的“内置”筛选器下。 这些版本通过单租户 Azure 逻辑应用运行时进行托管和运行,可提供更好的性能、吞吐量和其他优势。

      • Azure 托管的托管 API 连接器操作显示在连接器库中的“共享”筛选器下。 这些版本使用共享全局资源在多租户 Azure 中托管和运行。

创建工作流模板

根据你希望使工作流模板仅适用于组织或 Azure 中的每个人,请执行相应的步骤:

这些步骤介绍如何创建和发布仅适用于特定 Azure 订阅中的成员的工作流模板。

  1. Azure 门户 搜索框中,找到并选择 逻辑应用模板

  2. “逻辑应用模板” 页工具栏上,选择“ 创建”。

  3. 在“ 创建 Azure 逻辑应用模板 ”页上的“ 基本信息 ”选项卡上,提供以下信息:

    参数 必选 说明
    订阅 < Azure-subscription-name> 要用于工作流模板的 Azure 订阅。
    资源组 < resource-group-name> 要用于模板的 Azure 资源组的名称。
    名称 < template-name> 工作流模板资源的名称。
    区域 < Azure-region> 用于创建工作流模板资源的 Azure 区域。
  4. 完成操作后,选择“查看 + 创建”。 查看提供的信息,然后选择“ 创建”。

    Azure 创建模板资源。

接下来,选择要用于模板的源工作流定义。

选择源工作流定义

  1. 在模板资源菜单上的 “模板”下,选择“ 模板”。

  2. “模板 ”页上的“ 工作流 ”选项卡上,选择“ 添加”。

  3. 在此模板窗格中的“ 管理工作流 ”窗格中的“ 选择工作流 ”选项卡上,提供以下信息:

    参数 必选 说明
    订阅 < Azure-subscription-name> 具有源逻辑应用的 Azure 订阅的名称。
    资源组 < resource-group-name> 具有源逻辑应用的 Azure 资源组的名称。
    逻辑应用实例 < source-logic-app> 您要使用的工作流所属的源逻辑应用的名称。
    工作流 < source-workflows> 对于消耗逻辑应用,请选择模板中使用的唯一现有工作流。

    对于标准逻辑应用,请选择模板中使用的至少一个工作流。
  4. 完成后,选择“下一步”

  5. “设置工作流 ”选项卡上,为每个选定的源工作流提供以下信息:

    参数 必选 说明
    工作流名称 < JSON-workflow-name> 工作流的 JSON 名称,只能使用小写字母、数字和连字符,并且只能重命名一次。
    有状态无状态 默认情况下,是否要保存和存储工作流运行历史、操作输入和操作输出。
    总结 < short-description> 有关模板用途的简短概要摘要。
    说明 < detailed-description> 包含有关模板的更多详细信息的说明。
    先决条件 < 先决条件> 使用模板之前所需的任何要求。
  6. “工作流映像 ”部分中,提供用于模板库中模板概述窗格的工作流预览图像。 此窗格包含其他模板信息。

    工作流图像 说明
    浅色模式 SAS URL 存储在 Azure 存储帐户的 Blob 容器中的浅色主题工作流预览图像的 SAS URL。
    深色模式 SAS URL 您的 Azure 存储帐户中 Blob 容器内存储的深色主题工作流预览图像的 SAS URL。
  7. 完成后,选择“保存”。

    可以在创建过程中随时保存模板。 每次保存进度时,验证都会自动运行,以确定是否存在任何错误,例如,不支持的操作或未参数化的参数。 在找到错误时,无需立即修复错误,但在发布之前必须对其进行修复。

  8. 在“ 连接 ”选项卡上,查看并确认 Azure 自动从源工作流中提取的连接。

    无需采取任何其他操作。

  9. 准备就绪后,选择“下一步”

自定义参数

在“ 参数 ”选项卡上,为工作流所需的任何参数添加自定义项。

  1. 在“ 参数 ”选项卡上,选择参数的编辑图标。

  2. 提供参数的以下信息:

    资产 必选 说明
    显示名称 显示在 Azure 门户中的参数名称。
    默认值 参数的默认值。
    说明 参数用途的说明。
    必需字段 工作流是否需要参数。
  3. 完成后,选择“保存”。

提供模板信息

配置文件 ”选项卡指定模板在模板库中显示的信息,例如模板的显示名称、发布者名称、连接器和其他元数据。

  1. “配置文件 ”选项卡上,提供有关模板的以下信息:

    资产 必选 说明
    显示名称 显示在模板库中的工作流模板显示名称。
    发布者 工作流模板发布者名称。
    总结 模板创建的工作流的说明。
    精选连接器 在工作流模板中选择主要连接器类型。
    类别 模板所属的类别。
    标签 用于标记工作流的任何标签。
  2. 准备就绪后,选择“下一步”

  3. “摘要 ”选项卡上,查看并确认所有提供的信息。

发布以供测试

准备好测试模板后,可以发布用于测试的模板。

  1. “摘要 ”选项卡或上一个选项卡的底部的“ 保存 ”列表中,选择“ 保存 + 发布”进行测试

    屏幕截图显示了 Azure 门户、配置文件选项卡,以及为“保存 + 发布”选择进行测试的选项。

    Azure 将显示 测试 标签的模板发布到模板库。

  2. 若要测试新模板,请按照 从预生成模板创建工作流 中的步骤作,但执行以下步骤:

    1. “状态 ”列表中,选择“ 已发布以进行测试”。 在筛选器行下,选择 “我的模板”。

      模板将显示为 “测试 ”标签,例如:

      屏幕截图显示了“我的模板”的 Azure 门户、模板库和所选选项卡。

    2. 完成工作流创建、测试模板以及进行任何必要的调整。

发布以供生产

若要在模板库中将模板标签从 “测试 ”更改为 “生产 ”,请执行以下步骤:

  1. Azure 门户中,找到并打开模板资源。

  2. 在模板边栏的 “模板”下,选择“ 模板”。

  3. “模板 ”页上,选择“ 下一步 ”并重复,直到打开 “配置文件 ”选项卡。

  4. 保存 列表中,选择 保存 + 发布以投产

    屏幕截图显示了 Azure 门户、配置文件选项卡和为生产环境选择的“保存 + 发布”选项。

如果要从模板库中暂时或永久删除自定义工作流模板,可以取消发布模板。

  1. Azure 门户中,找到并打开模板资源。

  2. 在模板边栏的 “模板”下,选择“ 模板”。

  3. “模板 ”页上,选择“ 下一步 ”并重复,直到打开 “配置文件 ”选项卡。

  4. “保存 ”列表中,选择“ 保存 + 取消发布”模板

    屏幕截图显示了为“保存 + 取消发布”模板选择的“Azure 门户”、“配置文件”选项卡和选项。

名称和样式约定

区域 约定
敏感数据 不要在模板文件、屏幕截图、说明或测试数据中添加或上传个人数据和敏感数据。 例如,此数据包括订阅 ID、用户名、密码等。
文件夹名称 为便于阅读,请尽可能使用小写和连字符。 请参阅大写 - Microsoft 风格指南
图像文件名 使用 .png 作为文件扩展名,并使用小写和连字符,例如 workflow-light.png
产品、服务、技术和品牌名称 遵循官方拼写和大写。 例如:

- 引用服务名称或平台时,请使用“Azure 逻辑应用”,而不是“逻辑应用”。

- 引用资源或实例时,请使用“逻辑应用”。

- 引用触发器和操作序列时,请使用“逻辑应用工作流”或“工作流”。
缩写和首字母缩略词 对产品、服务、技术、品牌名称和不常见的技术术语使用全称,而非缩写或首字母缩略词。 常见的首字母缩略词(如“HTTP”和“URL”)是可接受的。 例如,使用“Visual Studio Code”,而不是“VS Code”。 请参阅首字母缩略词 - Microsoft 风格指南
其他文本 - 对标题和正文内容使用句子大小写,这意味着仅大写首字母,除非其中有产品、服务、技术或品牌名称。

- 不要将普通名词和冠词等大写,如“a”、“an”、“and”、“or”、“the”等。
Voice - 使用第二人称(你和你的),而不是第三人(用户、开发人员、客户),除非需要提到特定岗位。 请参阅人员 - Microsoft 风格指南

- 尽可能使用主动、直接但友好的语气。 主动语态侧重于文本中的主语和谓词,而被动语态侧重于文本中的对象。
词汇 - 使用简单、常见、日常的单词,例如“使用”,而不是“行使”或“施用”。

- 不要使用难以跨语言翻译的单词、短语、行话、口语、习语或俚语。

- 仅针对特定情况使用“请”。 请参阅请 - Microsoft 风格指南

- 使用“例如”或“比如”,而不是“例”或“譬如”。

- 不要使用方向术语,如“这里”、“上方”、“下方”、“右”和“左”,这不利于无障碍服务。
标点 - 对于一系列项,请在连词前包括最后一个逗号,例如“以及”。 例如,“苹果、橙子,以及香蕉”。 请参阅逗号 - Microsoft 风格指南

- 使用适当的标点结束完整句子。 不要使用感叹号。 请参阅标点符号 - Microsoft 风格指南
格式设置 - 对于代码,请遵循该代码语言的风格约定。

- 不要使用硬编码链接,如果 URL 发生更改,这种链接会中断。 在 PR 请求中,要求改用重定向链接。

- 对于链接,请使用以下格式:

For more information, see [descriptive-link-text](URL)]。”

- 使用描述性链接文本,而不是宽泛或模糊的链接文本,如“See [here](URL).”

- 对过程中的步骤仅使用数字,不对没有特定顺序的列表使用数字。 请参阅列表 - Microsoft 风格指南

- 在标点符号后仅使用一个空格,除非要缩进代码。

有关更多指导,请参阅 Microsoft 风格指南通用写作提示

从预生成模板创建逻辑应用工作流