Configuring an ADF Linked Service Connection for HubSpot
For information on how to enable a connection for use with linked services, see Configuring a Linked Service Connection.
Field labels in this walkthrough follow the underlying Azure Data Factory property names, with the connection column that carries each value named alongside. The exact labels shown in the BimlFlex Connection Editor may differ.
After selecting HubSpot from the Linked Service Type dropdown, the form required for creating a HubSpot Linked Service will appear.
Source Only Connector
A HubSpot connection is used as a source. It is not available as a target.
Choosing an Authentication Method
| Method | Credentials | Additional Settings |
|---|---|---|
| OAuth | Client Id, Client Secret, Access Token and Refresh Token | None |
Recommendation: Store the Client Secret, the Access Token and the Refresh Token in Azure Key Vault rather than entering them as plaintext.
Complete Example: OAuth with Azure Key Vault
| Field | Example Value |
|---|---|
| Connect via Integration Runtime | AutoResolveIntegrationRuntime |
| Client Id | <client-id-of-hubspot-app> |
| Azure Key Vault Linked Service | bfx-kv |
| Secret Name (for Client Secret) | BFX-SRC-HubSpotClientSecret |
| Secret Name (for Access Token) | BFX-SRC-HubSpotAccessToken |
| Secret Name (for Refresh Token) | BFX-SRC-HubSpotRefreshToken |
Required Fields
Common Required Fields
A HubSpot Linked Service connection uses a single Authentication Type, so the same fields are required on every connection.
These common required fields are:
- Connect via Integration Runtime
- Client Id
- Client Secret (or Azure Key Vault)
- Access Token (or Azure Key Vault)
- Refresh Token (or Azure Key Vault)
Connect via Integration Runtime
Connect via Integration Runtime names the integration runtime for a HubSpot Linked Service connection.
The default value is AutoResolveIntegrationRuntime.
To use another runtime, select it from the dropdown or choose + New to add one.
When a custom value is saved in the linked service form, it will be added to the custom integration runtimes.
The custom values that appear in this dropdown can be maintained in Settings under Azure - AzureIntegrationRuntime.
Authentication Type
The HubSpot Linked Service connection signs in with the client credentials of a HubSpot application and the tokens obtained when the OAuth integration was first authorized. The form has no Authentication Type field for this connector.
OAuth
The Client Id is the client ID of the HubSpot application and is stored in the connection's LS_ServicePrincipalId column. It maps to the ADF clientId property.
The Client Secret supplies the client secret of the application as plaintext in the LS_ServicePrincipalKey column, or as an Azure Key Vault reference held in the LS_ServicePrincipalKeyKVS_ fields that resolves to the secret at runtime. It maps to the ADF clientSecret property.
The Access Token is entered as plaintext in the LS_AccessToken column, or as an Azure Key Vault reference held in the LS_AccessTokenKVS_ fields that resolves to the token at runtime. It maps to the ADF accessToken property.
The Refresh Token is entered as plaintext in the LS_RefreshToken column, or as an Azure Key Vault reference held in the LS_RefreshTokenKVS_ fields that resolves to the token at runtime. It maps to the ADF refreshToken property.
For each of the three secrets, when an Azure Key Vault reference is set, the plaintext value is not written to the linked service.
It is suggested that Azure Key Vault be used in place of manually entering the Client Secret, the Access Token and the Refresh Token.
Azure Data Factory Linked Service Additional Information
For additional information on ADF HubSpot Linked Service and its connection requirements see the Azure Data Factory HubSpot Connector documentation.