Connector extensibility in Power BI

Custom connectors in Power BI extend connectivity so you can use data from hundreds of sources. This article covers connector extensibility capabilities, certified and uncertified connectors, security settings, and signing options to help you build, deploy, and use custom connectors safely in Power BI Desktop.

Power BI connects to data through existing connectors and generic sources like ODBC, OData, OLE DB, Web, CSV, XML, and JSON. Developers add new sources by using custom data extensions called custom connectors. Microsoft certifies and distributes some custom connectors as certified connectors.

Develop custom connectors (Power Query SDK)

Use the Power Query SDK in Visual Studio Code to author, validate, and package custom connectors:

• Install from the Visual Studio Marketplace: Power Query SDK for Visual Studio Code.
• Explore samples and advanced patterns in the GitHub repository: microsoft/DataConnectors on GitHub.
• Use the SDK to:
  • Create and edit .pq and .m source files with syntax coloring and schema validation
  • Build a .mez package (compressed connector bundle)
  • Run test queries by using the built-in query runner
  • Validate navigation tables, authentication flows, and data source kinds

To use an uncertified custom connector that you or someone else develops, adjust your Power BI Desktop security settings to let extensions load without validation or warning. These extensions can ignore privacy levels and handle credentials, and can send them over HTTP, so enable this setting only when you fully trust your custom connectors.

Alternatively, the developer can sign the connector with a certificate and give you the details you need to use it without changing your security settings. For more information, see Trusted third-party connectors.

Custom connectors

Uncertified custom connectors range from small, business-critical APIs to large, industry-specific services that don't yet have a Microsoft connector. Vendors distribute many connectors. If you need an industry- or business-specific connector, contact the vendor.

The default Power BI Desktop data extension security setting is to allow only Microsoft certified and other trusted third-party extensions to load. With this setting, if uncertified custom connectors are on your system, the Uncertified Connectors dialog box appears at startup and lists the connectors that can't load. For example:

If you don't need these connectors in this session, select OK to dismiss the error.

To prevent the uncertified connectors error, change your Data Extensions security setting or remove the uncertified connectors from your Custom Connectors folder.

Allow uncertified custom connectors

To use an uncertified custom connector:

1. Copy the connector file (.pq, .pqx, .m, or .mez) into your user Documents–scoped custom connectors folder:

   [Documents]\Microsoft Power BI Desktop\Custom Connectors

   If the folder doesn't exist, create it.

   Note

   If your organization enables OneDrive sync or Known Folder Move, the effective Documents path might be redirected. For example: C:\Users\<user>\OneDrive - Fabrikam\Documents.

   Don’t assume %USERPROFILE%\Documents. To reliably locate the correct folder in PowerShell:

   [Environment]::GetFolderPath('MyDocuments')
   Join-Path ([Environment]::GetFolderPath('MyDocuments')) 'Microsoft Power BI Desktop\Custom Connectors'
   

   Place the connector files there, then restart Power BI Desktop.

2. In Power BI Desktop, go to File > Options and settings > Options > Security to adjust the data extension security settings.

3. Under Data Extensions, select (Not Recommended) Allow any extension to load without validation or warning, then select OK.

   

4. Restart Power BI Desktop.

Sign custom connectors

If you sign a .mez package by using a trusted code signing certificate, users can load the connector without enabling the allow any extension data extension setting.

A properly signed connector from a trusted publisher loads under the recommended security setting. Unsigned or self-signed connectors trigger the uncertified dialog unless the permissive setting is enabled.

For more information about signing connectors, see Handling Power Query connector signing.

For certificate trust requirements and edge cases (root store, intermediate chains, revocation), see Trusted third-party connectors.

Certified connectors

Microsoft certifies a limited set of custom data extensions. Microsoft distributes these connectors but isn't responsible for their performance or continued functionality. The third-party developer maintains and supports the connector.

In Power BI Desktop, certified third-party connectors appear in the Get Data dialog box with generic and common connectors. You don't need to change security settings to use certified connectors.

Troubleshoot custom connector problems

The following table lists common problems you might encounter when working with custom connectors and provides guidance for resolving them.

Related content

• See Power Query connector certification to certify a custom connector.