Manage connections in Partner Connect
You can perform administrative tasks with Azure Databricks workspace connections to partner solutions, such as:
- Managing users of partner accounts.
- Managing the Azure Databricks service principal and related Azure Databricks personal access token that a connection uses.
- Disconnecting a workspace from a partner.
To administer Partner Connect, you must sign in to your workspace as a workspace admin. For more information, see Manage users.
Manage partner account users
For partners that allow users to use Partner Connect to sign in to that partner’s account or website (such as Fivetran and Rivery), when someone in your organization connects from one of your Azure Databricks workspaces to a partner for the first time, that person becomes the partner account administrator for that partner across all of your organization’s workspaces. To enable other users within your organization to sign in to that partner, your partner account administrator must first add those users to your organization’s partner account. Some partners allow the partner account administrator to delegate this permission as well. For details, see the documentation on the partner’s website.
If no one can add users to your organization’s partner account (for example, your partner account administrator is no longer available), contact the partner for assistance. For support links, see the list of Azure Databricks Partner Connect partners.
Connect data managed by Unity Catalog to partner solutions
If your workspace is Unity Catalog-enabled, you can connect select partner solutions to data managed by Unity Catalog. When you create the connection using Partner Connect, you can choose whether the partner uses the legacy Hive metastore (hive_metastore) or another catalog that you own. Metastore admins can select any catalog in the metastore that’s assigned to your workspace.
Note
If a partner solution doesn’t support Unity Catalog with Partner Connect, you can only use the workspace default catalog. If the default catalog isn’t hive_metastore and you don’t own the default catalog, you’ll receive an error.
For a list of partners that support Unity Catalog with Partner Connect, see the Azure Databricks Partner Connect partners list.
For information about troubleshooting connections, see Troubleshoot Partner Connect.
Manage service principals and personal access tokens
For partners that require Azure Databricks service principals, when someone in your Azure Databricks workspace connects to a specific partner for the first time, Partner Connect creates an Azure Databricks service principal in your workspace for use with that partner. Partner Connect generates service principal display names by using the format <PARTNER-NAME>_USER. For example, for the partner Fivetran, the service principal’s display name is FIVETRAN_USER.
Partner Connect also creates an Azure Databricks personal access token and associates it with that Azure Databricks service principal. Partner Connect provides this token’s value to the partner behind the scenes to complete the connection to that partner. You cannot view or get this token’s value. This token does not expire until you or someone else deletes it. See also Disconnect from a partner.
Partner Connect grants the following access permissions to Azure Databricks service principals in your workspace:
| Partners | Permissions |
|---|---|
| Fivetran, Matillion, Power BI, Tableau, erwin Data Modeler | These solutions do not require Azure Databricks service principals. |
| dbt Cloud, Hevo Data, Rivery, Rudderstack, Snowplow | * The CAN USE token permission to create a personal access token. * SQL warehouse creation permission. * Access to your workspace. * Access to Databricks SQL. * (Unity Catalog) The USE CATALOG privilege on the selected catalog.* (Unity Catalog) The CREATE SCHEMA privilege on the selected catalog.* (Legacy Hive metastore) The USAGE privilege on the hive_metastore catalog.* (Legacy Hive metastore) The CREATE privilege on the hive_metastore catalog so Partner Connect can create objects in the legacy Hive metastore on your behalf.* Ownership of the tables that it creates. The service principal cannot query any tables that it does not create. |
| Prophecy | * The CAN USE token permission to create a personal access token. * Access your workspace. * Cluster creation permission. The service principal cannot access any clusters that it does not create. * Job creation permission. The service principal cannot access any jobs that it does not create. |
| John Snow Labs, Labelbox | * The CAN USE token permission to create a personal access token. * Access to your workspace. |
| Anomalo, AtScale, Census, Hex, Hightouch, Lightup, Monte Carlo, Preset, Privacera, Qlik Sense, Sigma, Stardog | * The CAN USE token permission to create a personal access token. * The CAN USE privilege on the selected Databricks SQL warehouse. * The SELECT privilege on the selected schema.* (Unity Catalog) The USE CATALOG privilege on the selected catalog.* (Unity Catalog) The USE SCHEMA privilege on the selected schema.* (Legacy Hive metastore) The USAGE privilege on the selected schema.* (Legacy Hive metastore) The READ METADATA privilege for the selected schema. |
| Dataiku | * The CAN USE token permission to create a personal access token. * SQL warehouse creation permission. * (Unity Catalog) The USE CATALOG privilege on the selected catalog.* (Unity Catalog) The USE SCHEMA privilege on the selected schemas.* (Unity Catalog) The CREATE SCHEMA privilege on the selected catalog.* (Legacy Hive metastore) The USAGE privilege on the hive_metastore catalog and on the selected schemas.* (Legacy Hive metastore) The CREATE privilege on the hive_metastore catalog so Partner Connect can create objects in the legacy Hive metastore on your behalf.* (Legacy Hive metastore) The SELECT privilege on the selected schemas. |
Disconnect from a partner
If the tile for a partner has a check mark icon, this means that someone in your Azure Databricks workspace has already created a connection to that partner. To disconnect from that partner, you reset that partner’s tile in Partner Connect. Resetting a partner’s tile does the following:
- Clears the check mark icon from the partner’s tile.
- Deletes the associated SQL warehouse or cluster if the partner requires one.
- Deletes the associated Azure Databricks service principal, if the partner requires one. Deleting a service principal also deletes that service principal’s related Azure Databricks personal access token. This token’s value is what completes the connection between your workspace and the partner. For more information, see Manage service principals and personal access tokens.
Warning
Deleting a SQL warehouse, a cluster, an Azure Databricks service principal, or an Azure Databricks service principal’s personal access token is permanent and cannot be undone.
Resetting a partner’s tile does not delete your organization’s related partner account or change related connection settings with the partner. However, resetting a partner’s tile does break the connection between the workspace and the related partner account. To reconnect, you must create a new connection from the workspace to the partner, and then you must manually edit the original connection settings in the related partner account to match the new connection settings.
To reset a partner’s tile, click the tile, click Delete Connection, and then follow the on-screen directions.
Alternatively, you can manually disconnect an Azure Databricks workspace from a partner by deleting the related Azure Databricks service principal in your workspace that is associated with that partner. You might want to do this if you want to disconnect your workspace from a partner but still keep other associated resources and still keep the check mark icon displayed on the tile. Deleting a service principal also deletes that service principal’s related personal access token. This token’s value is what completes the connection between your workspace and the partner. For more information, see Manage service principals and personal access tokens.
To delete an Azure Databricks service principal, you use the Databricks REST API as follows:
- Get the Azure Databricks service principal’s application ID by calling the
GET /preview/scim/v2/ServicePrincipalsoperation in the Workspace Service Principals API for your workspace. Make a note of the service principal’sapplicationIdin the response. - Use the service principal’s
applicationIdto call theDELETE /preview/scim/v2/ServicePrincipalsoperation in the Workspace Service Principals API for your workspace.
For example, to get the list of available service principal display names and application IDs for a workspace, you can call curl as follows:
curl --netrc --request GET \
https://<databricks-instance>/api/2.0/preview/scim/v2/ServicePrincipals \
| jq '[ .Resources[] | { displayName: .displayName, applicationId: .applicationId } ]'
Replace <databricks-instance> with the Azure Databricks per-workspace URL, for example adb-1234567890123456.7.azuredatabricks.net for your workspace.
The service principal’s display name is in the output’s displayName field. Partner Connect generates service principal display names using the format <PARTNER-NAME>_USER. For example, for the partner Fivetran, the service principal’s display name is FIVETRAN_USER.
The service principal’s application ID value is in the output’s applicationId field, for example 123456a7-8901-2b3c-45de-f678a901b2c.
To delete the service principal, you can call curl as follows:
curl --netrc --request DELETE \
https://<databricks-instance>/api/2.0/preview/scim/v2/ServicePrincipals/<application-id>
Replace:
<databricks-instance>with the per-workspace URL, for exampleadb-1234567890123456.7.azuredatabricks.netfor your workspace.<application-id>with the service principal’s application ID value.
The preceding examples use a .netrc file and jq. Note that in this case, the .netrc file uses your personal access token value–not the one for the service principal.
After you disconnect your workspace from a partner, you might want to clean up any related resources that the partner creates in the workspace. This could include a SQL warehouse or cluster and any related data storage locations. For more information, see Create a SQL warehouse or Delete a compute.
If you’re sure that there are no other workspaces across your organization that are connected to the partner, you might also want to delete your organization’s account with that partner. To do this, contact the partner for assistance. For support links, see the appropriate partner connection guide.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for