Connections > Azure AI Search connection properties > Connect to Azure AI Search
  

Connect to Azure AI Search

Let's configure the Azure AI Search connection properties for Azure AI Search.

Before you begin

Before you get started, you'll need to get the API key from your Azure AI Search service account.
Check out Prerequisites to learn about the authentication requirements before you configure a connection.

Connection details

The following table describes the basic connection properties:
Property
Description
Connection Name
Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
Description
Description of the connection. Maximum length is 4000 characters.
Type
Azure AI Search
Use Secret Vault
Stores sensitive credentials for this connection in the secrets manager that is configured for your organization.
This property appears only if secrets manager is set up for your organization.
This property is not supported by Data Ingestion and Replication.
When you enable the secret vault in the connection, you can select which credentials that the Secure Agent retrieves from the secrets manager. If you don't enable this option, the credentials are stored in the repository or on a local Secure Agent, depending on how your organization is configured.
For information about how to configure and use a secrets manager, see Secrets manager configuration.
Runtime Environment
The name of the runtime environment where you want to run tasks.
Select a Secure agent or serverless runtime environment.
Hosted Agent is not applicable for mappings in advanced mode.
Host Name
The host name of the Azure search service that you want to connect to.
For example, https://rnddev.search.windows.net
API Key
The admin API key to authenticate Azure AI Search connection requests.
For example, yavMPJHTY11p08JTPkM3NW1ImhJraYycrLAzSeCEQQ5j