数据工厂连接器认证
注意
本文介绍提交数据工厂连接器进行认证的要求和过程。 在开始认证过程之前,请先仔细阅读整篇文章。
为数据源开发自定义连接器的数据源所有者可能希望将自定义连接器更广泛地分发给数据工厂用户。 在最终用户创建、使用和验证自定义连接器后,数据源所有者可以提交该连接器进行Microsoft认证。
通过认证数据工厂连接器,连接器可在以下体验中公开、开箱即用、Microsoft Fabric 数据工厂和Microsoft Power BI:
- Microsoft Fabric 数据流 Gen2
- Microsoft Power BI 数据流 Gen1
- Microsoft Power BI Datamart
- Microsoft Power BI 语义模型(在 Power BI 服务中)
- Microsoft Power BI Desktop
- 用于 Microsoft Fabric 和 Microsoft Power BI 的本地数据网关
经认证的连接器包括:
由合作伙伴开发人员维护
由合作伙伴开发人员提供支持
Microsoft 已认证
由 Microsoft 分发
我们与合作伙伴合作,努力确保他们在维护方面具有支持,但连接器本身的客户问题将定向到合作伙伴开发人员。
注意
如今,可以利用 Power Query SDK 创建一个连接器,该连接器可以通过数据工厂连接器认证计划进行认证。 转到 Power Query SDK 概述 ,了解有关此工具的详细信息。
认证概述
先决条件
为了确保为客户提供最佳体验,我们仅考虑满足一组认证先决条件的连接器:
连接器必须为公共产品。
对于初始发布版本,连接器必须被视为代码完整。 程序允许频繁迭代和更新。 Microsoft 不提供技术支持或自定义连接器开发咨询。 建议利用公共资源,例如 SDK 文档和示例存储库。 如果需要进一步的帮助,我们可以共享已知第三方行业自定义连接器开发顾问列表,这些顾问可能需要与任何Microsoft计划或合作关系分开直接参与。 Microsoft 不隶属于这些顾问中的任何一个,并且不对其服务的使用负责。 Microsoft 提供方便性列表,无需任何保障、建议或保证。 若要了解详细信息,请联系Microsoft认证联系人。
开发人员必须提供当前和将来使用情况的估计值。
连接器必须已可供客户直接使用,以满足用户需求或业务方案。 可以通过将已完成的连接器直接分发给最终用户和组织,从而使用专用预览版计划满足此条件。 我们建议连接器的开发人员使用 自我分发机制 ,并运行其自己的连接器的内部测试,以循环访问受控制组下的连接器。 每个用户或组织都应能够提供反馈和验证连接器业务需要,并且连接器正在成功满足其业务需求。
连接器必须在客户的预期使用量级别成功工作。
在 Fabric Ideas 论坛中必须有一个线索,由客户驱动,以指示要求在数据工厂和/或 Power BI 中公开提供连接器。 没有设定的参与阈值。 但是,参与度越多,连接器的有证据需求就越强。
存在这些先决条件,以确保进行认证的连接器具有重要的客户和业务需要用于和支持的认证后。
流程和时间线
经认证的连接器通过每月 Power BI Desktop 版本发布,因此每个版本的截止时间会从每个 Power BI Desktop 发布日期往回推算。 从注册到发布的认证过程的预期持续时间会因连接器提交的质量和复杂性而异。 对于任何连接器评审和审批,Microsoft 不提供任何特定的时间线保证。 每个连接器评审的硬截止时间在以下步骤中概述,但 Microsoft 不保证遵守这些时间线。
注册:认证自定义连接器的意向通知。 必须在目标 Power BI Desktop 发布前的 15 个月(两个月)进行注册。
- 例如,对于 4 月 Power BI Desktop 版本,最后期限为 2 月 15 日。
提交:提交连接器文件以供 Microsoft 评审。 此提交必须在目标 Power BI Desktop 发布前的当月 1 日进行。
- 例如,对于 4 月 Power BI Desktop 版本,最后期限为 3 月 1 日。
技术评审:连接器文件的最终化,通过 Microsoft 评审和认证。 此评审必须在目标 Power BI Desktop 发布前的当月 15 日进行。
- 例如,对于 4 月 Power BI Desktop 版本,最后期限为 3 月 15 日。
由于技术评审的复杂性和潜在的延迟、重新架构和测试问题,强烈建议尽早提交,为初始发布和认证留出较长的准备时间。
认证要求
我们对认证会有一组特定的要求。 我们认识到,并不是每个开发人员都能满足这些要求,我们希望引入一个功能集,能够在短时间内满足开发人员需求。
提交文件(项目)
确保提交中包含以下连接器文件:
连接器 (.mez) 文件
- .mez 文件应遵循样式标准,并将其命名为类似于产品或服务名称。 它不应包含“Fabric”、“Power BI”、“连接器”或“API”等字词。
- 将 .mez 文件命名为:
ProductName.mez
用于测试的 Power BI Desktop (.pbix) 文件
- 需要一个示例 Power BI 报表 (.pbix) 来测试连接器。
- 该报表应包含至少一个查询,以便测试导航表中的每一项。
- 如果没有设置架构(例如数据库),报表需要包含连接器可能处理的每个“类型”表的查询。
将帐户测试到数据源
- 使用测试帐户来测试连接器和进行故障排除。
- 提供持久性测试帐户,以便可以使用相同的帐户来认证任何将来的更新。
测试说明
- 提供有关如何使用连接器并测试其功能的任何文档。
指向外部依赖项的链接(例如 ODBC 驱动程序)
功能和样式
连接器必须遵循一组功能和样式规则,以满足与其他经认证连接器一致的可用性标准。
连接器必须:
- 使用节文档格式。
- 包含节文档上方的版本标头/修饰。
- 提供函数文档元数据。
- 具有 TestConnection 处理程序。
- 遵循命名约定(例如,
DataSourceKind.FunctionName
)。 它不应包含“Fabric”、“Power BI”、“连接器”或“API”等字词。 - 以表格格式返回数据,将数据按列组织为表格,如同对关系数据源所做的一样。 不支持基于多维数据集、维度和度量值的多维格式。
- 在 Import 和 DirectQuery 模式下的运作方式相同,返回相同的结果。
- 在初始版本上,Beta 标志设置为 True。
FunctionName
应该对域(例如“内容”、“表”、“文档”、“数据库”等)有意义。连接器应:
- 具有图标。
- 提供导航表。
- 将字符串放在
resources.resx
文件中。 URL 和值应在连接器代码中硬编码,而不是放在resources.resx
文件中。
安全性
连接器必须处理特定安全注意事项。
如果使用
Extension.CurrentCredentials()
:- 是否需要使用? 如果需要,会将凭据发送到何处?
- 是否保证通过 HTTPS 发出请求?
- 可以使用 HTTPS 强制帮助程序函数。
- 如果通过 GET 使用
Web.Contents()
发送凭据:- 可以将其变成 POST 吗?
- 如果需要 GET,连接器必须使用
Web.Contents()
选项记录中的CredentialQueryString
记录来传入敏感凭据。
如果使用 Diagnostics.* 函数:
- 验证正在跟踪的内容;数据不得包含 PII 或大量不必要的数据。
- 如果在开发中实现了重要的跟踪,则应实现一个变量或功能标志,用于确定是否应启用跟踪。 在提交进行认证之前,必须将跟踪关闭。
如果使用
Expression.Evaluate()
:- 验证表达式的来源及其所在位置(即,可以动态构造对等的
Extension.CurrentCredentials()
调用)。 Expression
不应由用户提供,也不应接受用户输入。Expression
不应是动态的(也就是说,不应该从 Web 调用中检索)。
- 验证表达式的来源及其所在位置(即,可以动态构造对等的
注册认证
如果有兴趣获得自定义连接器的认证,则确保场景和连接器满足本文中所述的 先决条件和要求。 否则会导致认证延迟,因为团队需要解决任何问题或不一致,才能继续认证。
确保连接器代码已完成,并在 Power BI Desktop 的创作中进行了测试,并在Power BI 服务中刷新和使用。 确保已使用本地数据网关在 Power BI 服务中测试完整的端到端刷新。
要开始,请完成注册表单,Microsoft 联系人将联系您以开始该过程。
完成认证后
通过 Microsoft Fabric 和 Microsoft Power BI 体验认证并发布连接器后,应执行一些操作以确保正确使用生产部署的公开可用的认证连接器。
- 在认证之前(例如 Power BI Desktop 和数据网关)之前,最终用户应使用环境中包含的认证连接器版本,并删除在认证之前使用的任何现有 .mez 或 .pqx 文件(自定义连接器)。 否则,可能会导致 Power Query 无意中使用测试自定义连接器,而不是新认证的连接器。
- 自定义连接器应仅用于测试连接器的新版本。
- 与最终用户和客户合作时,请确保在测试完成并且新的认证连接器版本可用后,移除在认证之前用于测试的自定义连接器版本。