自定义连接器概述
虽然 Azure 逻辑应用、Microsoft Power Automate 和 Microsoft Power Apps 提供超过 1,000 个连接器以连接到 Microsoft 服务和经过验证的服务,但您可能需要与未作为预生成连接器提供的服务通信。 自定义连接器可以解决这个问题,因为它可以让您创建(甚至共享)具有自己的触发器和操作的连接器。
自定义连接器是一个 REST API 包装器,允许逻辑应用、Power Automate 或 Power Apps 与 REST 或 SOAP API 通信。 这些 API 可以是:
逻辑应用还支持 SOAP API。
对于您计划创建和管理的公共 API,请考虑使用以下 Microsoft Azure 产品之一:
对于专用 API,Microsoft 通过本地数据网关提供本地数据连接。
请对您的 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 和连接器。
使用 OAuth 2.0 自动进行身份验证的新创建的自定义连接器具有每连接器重定向 URI。 现有 OAuth 2.0 连接器必须在 2024 年 2 月 17 日之前更新为使用每连接器重定向 URI。
- 如果您使用 Web 界面创建了自定义连接器,请编辑您的自定义连接器,转到安全性选项卡并选中复选框更新为唯一重定向 URL,然后保存以启用每连接器重定向 URI。
- 如果您使用使用命令行接口 (CLI) 工具的多重身份验证创建了自定义连接器,则需要使用 CLI 工具更新您的连接器才能设置
"redirectMode": "GlobalPerConnector"
。 - 通过“ 安全 ”选项卡中的设置或 CLI 工具将自定义连接器更新为使用每个连接器的重定向 URI 后,请从 OAuth 2.0 应用中删除全局重定向 URI。 您应该将新生成的唯一重定向 URL 添加到 OAuth 2.0 应用。
- 我们将从 2024 年 2 月 17 日开始对现有 OAuth 2.0 自定义连接器强制执行此更新。 任何未更新为使用每个连接器重定向 URI 的自定义连接器都将停止处理新连接,并向用户显示错误消息。
- 若要了解每个连接器重定向 URL 需要更新才能迁移到哪些自定义连接器,可以创建一个流,该流使用管理员连接器的“ 以管理员 身份获取自定义连接器”操作 Power Apps 并分析其结果。 本文后面附加的流使用相同方法获取所有自定义连接器。 然后,它对连接参数的属性应用筛选器条件以筛选出非 Oauth 自定义连接器,然后使用另一个筛选器来仅选择不使用每连接器唯一重定向 URL 的连接器。 最后,它将所选自定义连接器放入在流开始时初始化的数组变量中,并生成一个 HTML 表,显示这些连接器的名称和创建者。 您可以通过导入此解决方案来将此流导入到您的环境中。 您可以进一步扩展该流,以电子邮件形式将 HTML 表发送给自己。 或者,您可以扩展它以直接向连接器创建者发送电子邮件,并向他们提供需要更新的连接器的名称。
有了具有通过身份验证的访问权限的 API 之后,接下来要做的是说明您的 API 以便逻辑应用、Power Automate 或 Power Apps 可以与您的 API 进行通信。 以下方法均支持:
一个 OpenAPI 定义(以前称为 Swagger 文件)
Postman 集合
使用自定义连接器门户从头开始(仅 Power Automate 和 Power Apps)
虽然 OpenAPI 定义和 Postman 集合使用的格式不同,但两者都是与语言无关的机器可读文档,其中描述了 API。 根据 API 所用的语言和平台,还可以使用各种工具生成这些文档。 在后台,逻辑应用、Power Automate 和 Power Apps 使用 OpenAPI 来定义连接器。
自定义连接器的使用方式与预生成连接器的使用方式相同。 请先创建与 API 的连接,以使用该连接调用在自定义连接器中公开的任何操作。
在 中创建的 Power Automate 连接器在 中 Power Apps 可用,在 中创建的 Power Apps 连接器在 中 Power Automate 可用。 对于在逻辑应用中创建的连接器,此可用性并非如此。 但是,您可以重用 OpenAPI 定义或 Postman 集合在任何这些服务中重新创建连接器。 有关详细信息,请参阅相应教程:
提示
如果您更新(删除、添加或更改)API 中的字段,请执行以下步骤:
- 重新发布连接器,以便查看 API 的更新的 Swagger。
- 删除使用该连接器的任何应用中的任何连接/数据源。
- 将该连接器的连接/数据源重新添加到应用中。
您可以使用在逻辑应用、Power Automate 或 Power Apps 中共享资源的方式与组织中的用户共享连接器。 共享是可选的,但有时您可能需要与其他用户共享您的连接器。
有关详细信息,请参阅 在组织中 共享自定义连接器。
若要与逻辑应用、Power Automate 和 Power Apps 的所有用户共享连接器,可提交连接器进行 Microsoft 认证。 Microsoft 审查连接器、检查技术和内容合规性,并验证功能。
有关详细信息,请参阅提交连接器进行 Microsoft 认证。
当在链接到虚拟网络的 Power Platform 环境中使用连接器时,限制将适用:
使用自定义代码时,在自定义连接器 中编写代码中 介绍了限制。
在将环境关联到虚拟网络之前创建的自定义连接器需要重新保存。
我们非常感谢大家提出有关连接器平台问题或新功能想法的反馈。 要提供反馈,请转到提交问题或获取连接器帮助,然后选择反馈类型。