Configuring an ADF Linked Service Connection for Shopify
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.
The Linked Service Type dropdown of the BimlFlex Connection Editor has no Shopify entry, and the editor has no Shopify form. The build reads each field on this page from the connection column or the Additional Settings key named with it.
Source Only Connector
A Shopify connection is used as a source. It is not available as a target.
Objects of a Shopify connection are typed as Table or View.
The dataset addresses each object as a table, taking the table name from the TargetObjectName parameter.
Each Shopify object is copied whole. The copy passes the TargetSchemaName parameter and the source object name in the TargetObjectName parameter to the dataset, and BimlFlex composes no source query for the object.
A filled Override SQL on the object holds a GraphQL query and is passed whole as the copy source query. When the Override SQL is empty, the text of the object's Override SQL extension point is passed the same way.
The object's Where SQL, Group By SQL and Order By SQL and the Append Source SQL extension point do not apply to a Shopify object.
Choosing an Authentication Method
| Method | Credentials | Additional Settings |
|---|---|---|
| Access Token | Access Token | None |
Recommendation: Store the Access Token in Azure Key Vault rather than entering it as plaintext.
Complete Example: Access Token with Azure Key Vault
| Field | Example Value |
|---|---|
| Connect via Integration Runtime | AutoResolveIntegrationRuntime |
| Host | contoso.myshopify.com |
| Azure Key Vault Linked Service | bfx-kv |
| Secret Name (for Access Token) | BFX-LND-ShopifyAccessToken |
Required Fields
Common Required Fields
A Shopify 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
Connect via Integration Runtime names the integration runtime for a Shopify 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.
Host
The Host identifies the Shopify store the connector reads from (for example, contoso.myshopify.com).
It is stored in the connection's LS_Host column and maps to the ADF host property.
When the Host column is empty, the value is read from the connection's Additional Settings (LS_AdditionalSettings) under the key host.
Authentication Type
The Shopify Linked Service connection signs in with an access token. BimlFlex does not read the connection's Authentication Type column for this connector. BimlFlex has no interactive sign-in for Shopify. The access token is typed in or referenced from Azure Key Vault.
Access Token
The Access Token authorizes API access to the Shopify store.
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 BimlFlex Connection Editor has no field for the Shopify Access Token, so the token or its Key Vault reference is held in these connection columns.
It is suggested that Azure Key Vault be used in place of manually entering the Access Token.
Azure Data Factory Linked Service Additional Information
For additional information on ADF Shopify Linked Service and its connection requirements see the Azure Data Factory Shopify Connector documentation.