自定义连接器

虽然 Azure 逻辑应用、Microsoft Power Automate 和 Microsoft Power Apps 提供 1,000 个连接器以便连接到 Microsoft 服务和经过验证的服务，但您可能需要与未作为预生成连接器提供的服务通信。 自定义连接器可以解决这个问题，因为它可以让您创建（甚至共享）具有自己的触发器和操作的连接器。

生命周期

1. 构建 API

自定义连接器是围绕 REST API（逻辑应用还支持 SOAP API）的包装器，它允许逻辑应用、Power Automate 或 Power Apps 与该 REST 或 SOAP API 通信。 这些 API 可以是：

• 公共（在公共 Internet 上可见），如 Spotify、Slack、Rackspace 或您管理的 API。
• 专用（仅对您的网络可见）。

对于您计划创建和管理的公共 API，请考虑使用以下 Microsoft Azure 产品之一：

• Azure Functions
• Azure Web 应用
• Azure API 应用

对于专用 API，Microsoft 通过本地数据网关提供本地数据连接。

2. 保护 API

请对您的 API 和连接器使用这些标准身份验证方法之一（建议使用 Microsoft Entra ID）：

• 通用 OAuth 2.0
• 适用于特定服务的 OAuth 2.0，包括 Microsoft Entra ID、Dropbox、GitHub 和 SalesForce
• 基本身份验证
• API 键

您可以在 Azure 门户中为您的 API 设置 Microsoft Entra ID 身份验证，因此不必实施身份验证。 或者，您也可以在 API 代码中要求并执行身份验证。 有关对自定义连接器使用 Microsoft Entra ID 的详细信息，请参阅使用 Microsoft Entra ID 保护 API 和连接器。

2.1. OAuth 2.0

使用 OAuth 2.0 自动进行身份验证的新创建的自定义连接器具有每连接器重定向 URI。 现有 OAuth 2.0 连接器必须在 2024 年 2 月 17 日之前更新为使用每连接器重定向 URI。

• 如果您使用 Web 界面创建了自定义连接器，请编辑您的自定义连接器，转到安全性选项卡并选中复选框更新为唯一重定向 URL，然后保存以启用每连接器重定向 URI。
• 如果您使用使用命令行接口 (CLI) 工具的多重身份验证创建了自定义连接器，则需要使用 CLI 工具更新您的连接器才能设置 "redirectMode": "GlobalPerConnector"。
• 在自定义连接器更新为使用每连接器重定向 URI（通过“安全性”选项卡中的设置或使用 CLI 工具）后，您应该从 OAuth 2.0 应用中删除全局重定向 URI，然后向 OAuth 2.0 应用添加新生成的唯一重定向 URL。
• 我们将从 2024 年 2 月 17 日开始对现有 OAuth 2.0 自定义连接器强制执行此更新。 任何尚未更新为使用每连接器重定向 URI 的自定义连接器都将停止用于新连接，并向用户显示一条错误消息。
• 若要找出哪些自定义连接器需要更新才能迁移到每连接器重定向 URL，您可以创建一个简单的流，该流针对管理员连接器使用 Power Apps 的以管理员身份获取自定义连接器操作并分析其结果。 本文后面附加的流使用相同方法获取所有自定义连接器。 然后，它对连接参数的属性应用筛选器条件以筛选出非 Oauth 自定义连接器，然后使用另一个筛选器来仅选择不使用每连接器唯一重定向 URL 的连接器。 最后，它将所选自定义连接器放入在流开始时初始化的数组变量中，并生成一个 HTML 表，显示这些连接器的名称和创建者。 您只需导入此解决方案即可将此流导入到您的环境中。 您可以进一步扩展该流，以电子邮件形式将 HTML 表发送给自己。 或者，您可以扩展它以直接向连接器创建者发送电子邮件，并向他们提供需要更新的连接器的名称。

3. 说明 API 并定义自定义连接器

有了具有通过身份验证的访问权限的 API 之后，接下来要做的是说明您的 API 以便逻辑应用、Power Automate 或 Power Apps 可以与您的 API 进行通信。 以下方法均支持：

• 一个 OpenAPI 定义（以前称为 Swagger 文件）

  • 从 OpenAPI 定义创建自定义连接器
  • OpenAPI 文档

• Postman 集合

  • 创建 Postman 集合
  • 根据 Postman 集合创建自定义连接器
  • Postman 文档

• 使用自定义连接器门户从头开始（仅 Power Automate 和 Power Apps）

  • 从头开始创建自定义连接器

虽然 OpenAPI 定义和 Postman 集合使用的格式不同，但两者都是与语言无关的机器可读文档，其中描述了 API。 根据 API 所用的语言和平台，还可以使用各种工具生成这些文档。 在后台，逻辑应用、Power Automate 和 Power Apps 使用 OpenAPI 来定义连接器。

4. 在逻辑应用、Power Automate 或 Power Apps 应用中使用您的连接器

自定义连接器的使用方式与预生成连接器的使用方式相同。 请先创建与 API 的连接，以使用该连接调用已在自定义连接器中公开的任何操作。

Power Apps 中提供了在 Power Automate 中创建的连接器。 同样，Power Automate 中提供了在 Power Apps 中创建的连接器。 对于在逻辑应用程序中创建的连接器，情况并非如此。 但是，您可以重用 OpenAPI 定义或 Postman 集合在任何这些服务中重新创建连接器。 有关详细信息，请参阅相应教程：

• 通过流使用自定义连接器
• 从应用使用自定义连接器
• 通过逻辑应用使用自定义连接器

5. 共享连接器

您可以使用在逻辑应用、Power Automate 或 Power Apps 中共享资源的方式与组织中的用户共享连接器。 共享是可选的，但有时您可能需要与其他用户共享您的连接器。

有关详细信息，请参阅在组织中共享自定义连接器。

6. 验证连接器

若要与逻辑应用、Power Automate 和 Power Apps 的所有用户共享连接器，可提交连接器进行 Microsoft 认证。 Microsoft 会审查连接器、检查技术和内容符合性，并验证功能。

有关详细信息，请参阅提交连接器进行 Microsoft 认证。

教程

本教程使用认知服务文本分析 API。 Microsoft 已为此 API 提供了一个连接器。 这是一个很好的示例，用于讲授自定义连接器生命周期以及自定义连接器如何支持独特的方案。

方案

要生成的连接器会公开文本分析情绪操作，该操作返回文本输入的情绪分数（0.000 到 1.000）。

先决条件

• 以下订阅之一：

  • Azure 订阅（逻辑应用）
  • Power Automate
  • Power Apps

• 基本了解如何创建逻辑应用、Power Automate 流或 Power Apps。

• 认知服务文本分析 API 的 API 密钥。

获取 API 密钥

文本分析 API 使用 API 密钥对用户进行身份验证。 当用户通过自定义连接器创建与 API 的连接时，用户将指定此密钥的值。 若要获取 API 密钥，请执行以下操作：

• 请求 API 密钥以试用该 API。 此不需要 Azure 订阅。

• 向 Azure 订阅添加文本分析 API。 在订阅中有了 API 资源后，请从密钥部分获取 API 密钥：

  

开始教程

• 如果您使用的是逻辑应用，请参阅：

  • 创建 Azure 逻辑应用自定义连接器

• 如果您使用的是 Power Automate 或 Power Apps，请参阅：

  • 从 OpenAPI 定义创建自定义连接器
  • 根据 Postman 集合创建自定义连接器
  • 从头开始创建自定义连接器

高级指南

本节中的教程和视频将为您提供所需的见解，帮助您在实施过程中利用 Power Platform 连接器。

教程

以下教程提供了有关特定自定义连接器方案的更多详细信息：

• 扩展 OpenAPI 定义
• 为自定义连接器创建 Postman 集合
• 使用 Microsoft Entra ID 进行身份验证
• 为 Web API 创建连接器
• 使用 Webhook 作为触发器
• 创建逻辑应用 SOAP API 连接器

Video

以下 45 分钟的视频向您演示 Power Platform 连接器如何工作。 另外还演示了如何创建简单的高级自定义连接器。

另请参见

所有连接器的列表

提供反馈

我们非常感谢大家提出有关连接器平台问题或新功能想法的反馈。 要提供反馈，请转到提交问题或获取连接器帮助，然后选择反馈类型。