Configuring an ADF Linked Service Connection for Azure Search
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 Search from the Linked Service Type dropdown, the form required for creating an Azure Search Linked Service will appear.
The Azure Search option is offered on a connection whose Connection Type is Rest API.
Azure Data Factory accepts a search index only as the sink of a copy, and a connection of this type does not drive a pipeline in a build.
Authentication Method
| Method | Credentials | Additional Settings |
|---|---|---|
| Admin Key | Admin Key | None |
Recommendation: Store the Admin Key in Azure Key Vault rather than entering it as plaintext.
Complete Example: Admin Key with Azure Key Vault
| Field | Example Value |
|---|---|
| Connect via Integration Runtime | AutoResolveIntegrationRuntime |
| Url | https://contoso-search.search.windows.net |
| Azure Key Vault Linked Service | bfx-kv |
| Secret Name (for Admin Key) | BFX-SearchAdminKey |
Required Fields
Common Required Fields
An Azure Search Linked Service connection uses a single authentication method, 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 an Azure Search 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.
Url
The Url is the URL of the search service (for example, https://contoso-search.search.windows.net).
It is stored in the connection's LS_Url column and maps to the ADF url property.
Admin Key
The Admin Key is the admin key for the search service.
The Admin Key field accepts the key as plaintext in the LS_Key column, or an Azure Key Vault reference held in the LS_KeyKVS_ columns that resolves to the key at runtime. It maps to the ADF key property.
It is suggested that Azure Key Vault be used in place of manually entering the Admin Key.
Azure Data Factory Linked Service Additional Information
For additional information on ADF Azure Search Linked Service and its connection requirements see the Azure Data Factory Azure AI Search Connector documentation.