Configuring an ADF Linked Service Connection for Azure Data Explorer
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 Azure Data Explorer (Kusto) from the Linked Service Type dropdown, the form required for creating an Azure Data Explorer Linked Service will appear.
Source Only Connector
An Azure Data Explorer connection is used as a source. It is not available as a target.
Each object is read through a dataset that takes the table from the TargetObjectName parameter, and the query on the copy source reads the object.
Choosing an Authentication Method
| Method | Credentials | Additional Settings |
|---|---|---|
| Service Principal | Service Principal Id, Service Principal Key and Tenant | None |
Recommendation: Store the Service Principal Key in Azure Key Vault rather than entering it as plaintext.
Complete Example: Service Principal with Azure Key Vault
| Field | Example Value |
|---|---|
| Connect via Integration Runtime | AutoResolveIntegrationRuntime |
| Endpoint | https://contoso.westus.kusto.windows.net |
| Database | SalesTelemetry |
| Tenant | contoso.onmicrosoft.com |
| Service Principal Id | {Application (Client) Id} |
| Azure Key Vault Linked Service | bfx-kv |
| Secret Name (for Service Principal Key) | BFX-SRC-DataExplorerServicePrincipalKey |
Required Fields
Common Required Fields
An Azure Data Explorer 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
- Endpoint
- Database
- Tenant
- Service Principal Id
- Service Principal Key (or Azure Key Vault)
Connect via Integration Runtime
Connect via Integration Runtime names the integration runtime for an Azure Data Explorer 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.
The runtime is stored in the connection's LS_ConnectVia_IntegrationRuntime column. Any value other than AutoResolveIntegrationRuntime is written to the linked service as the runtime it connects through.
Endpoint
The Endpoint is the URL of the Azure Data Explorer cluster, in the form https://<clusterName>.<regionName>.kusto.windows.net (for example, https://contoso.westus.kusto.windows.net).
It is stored in the connection's LS_Endpoint column and maps to the ADF endpoint property.
Database
The Database names the Azure Data Explorer database the connector reads from (for example, SalesTelemetry).
It is stored in the connection's LS_Db column and maps to the ADF database property.
Service Principal
The Azure Data Explorer Linked Service connection authenticates with a service principal.
The Tenant is the domain name or tenant id under which the application resides. It is stored in the connection's LS_Tenant column and maps to the ADF tenant property.
The Service Principal Id supplies the application's client id and is stored in the connection's LS_ServicePrincipalId column. It maps to the ADF servicePrincipalId property.
The Service Principal Key supplies the application's key as plaintext in the LS_ServicePrincipalKey column, or as an Azure Key Vault reference held in the LS_ServicePrincipalKeyKVS_ fields that resolves to the key at runtime. It maps to the ADF servicePrincipalKey property.
It is suggested that Azure Key Vault be used in place of manually entering the Service Principal Key.
Credential
When the connection's LS_Credential column names an Azure Data Factory credential for a user-assigned managed identity, it is written to the linked service as the credential reference.
Azure Data Factory Linked Service Additional Information
For additional information on ADF Azure Data Explorer Linked Service and its connection requirements see the Azure Data Factory Azure Data Explorer Connector documentation.