Edit

Share via


Add a new connection to your project

Important

Items marked (preview) in this article are currently in public preview. This preview is provided without a service-level agreement, and we don't recommend it for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews.

In this article, you learn how to add a new connection in Microsoft Foundry portal.

Connections are a way to authenticate and consume both Microsoft and other resources within your Foundry projects. They're required for scenarios such as building Standard Agents or building with Agent knowledge tools. Certain connections can be created in the Foundry UI while others require deployment through code in Bicep template. See our foundry-samples on GitHub. Read the table descriptions below to learn more.

Prerequisites

  • If you don't have one, create a project.
  • Make sure you can open your project in Microsoft Foundry.
  • Make sure you have permissions to add connections to the project or resource.

Connection types

Service connection type Preview Description
Azure AI Search Azure AI Search is an Azure resource that supports information retrieval over vector and textual data stored in search indexes. Required for Standard Agent deployment.
Azure Storage Azure Storage is a cloud storage solution for storing unstructured data such as documents, images, videos, and application installers. Required for Standard Agent deployment.
Azure Cosmos DB Azure Cosmos DB is a globally distributed, multi-model database service that offers low latency, high availability, and scalability across multiple regions. Required for Standard Agent deployment. Connection creation is supported only through code.
Azure OpenAI Azure OpenAI provides access to OpenAI models, including GPT-5, GPT-4o, DALLE-3, and Embeddings, with Azure security and enterprise capabilities.
Application Insights Azure Application Insights helps detect performance anomalies, diagnose issues, and understand application behavior.
Azure Key Vault Azure service for securely storing and accessing secrets. (See limitations below.)
Foundry Connect to other Foundry resources.
OpenAI Connect to your OpenAI models.
Serp Serp connects to Search Engine Results Pages (SERP) for real-time data access. Supports scenarios that need the latest search results.
API key API key connections handle authentication to your specified target on an individual basis.
Custom key Custom connections let you securely store and access keys while storing related properties, such as targets and versions. These connections are useful when you have many targets or scenarios where you don't need a credential to access the target. LangChain scenarios are a common example. You manage authentication for custom connections.
Grounding with Bing Search Connects to Bing Search to provide real-time web grounding for queries. Enables agents to reference current web data in responses.
Serverless Model Serverless Model connections allow serverless API deployment. Connection creation is supported only through code.
Azure Databricks Azure Databricks connections let Foundry Agents access workflows and Genie Spaces during runtime. Connection creation is supported only through code.
SharePoint SharePoint is a Microsoft platform for document storage and collaboration. It lets agents access and manage organizational documents. Connection creation is supported only through code.
Microsoft Fabric AI skills let you create conversational Q&A systems on Fabric using generative AI. Connection creation is supported only through code.
Grounding with Bing Custom Search Integrates with a custom Bing search instance for tailored web grounding. Connection creation is supported only through code.
Azure APIM APIM supports governance for AI models called in Foundry Agent Service. Connection creation is supported only through code.
Model Gateway Model Gateway supports governance for AI models called in Foundry Agent Service. Connection creation is supported only through code.

Azure Key Vault limitations

Foundry stores connections details in a managed Azure Key Vault if no Key Vault connection is created. Users that prefer to manage their secrets themselves can bring their own Azure Key Vault via a connection. All Foundry projects use a managed Azure Key Vault (not shown in your subscription). If you bring your own Azure Key Vault, note:

  • Only one Azure Key Vault connection per Foundry resource at a time.
  • You can delete an Azure Key Vault connection only if there are no other existing connections on the Foundry resource or project level.
  • Secret migration isn't supported; recreate connections after attaching the Key Vault.
  • Deleting the underlying Azure Key Vault breaks the Foundry resource (connections depend on stored secrets).
  • Deleting secrets in your BYO Key Vault may break connections to other services.

Azure Databricks connection (preview) limitations

It supports three connection types: Jobs, Genie, and Other. You can choose the Job or Genie space to associate with the connection in the Foundry UI. You can also use the Other connection type to let your agent access workspace operations in Azure Databricks. Authentication uses Microsoft Entra ID for users or service principals. For examples of using this connector, see Jobs and Genie. Usage of this connection is available only via the Foundry SDK and is integrated into agents as a FunctionTool. Usage of this connection in Foundry Playground isn't currently supported.

Create a new connection

Use the portal or a Bicep template to add a connection.

Follow these steps to create a new connection that's available for the current project.

  1. Sign in to Microsoft Foundry. Make sure the New Foundry toggle is on. These steps refer to Foundry (new).

  2. Select Operate in the upper-right navigation.

  3. Select Admin in the left pane.

  4. Select your project name in the Manage all projects list.

  5. Select Add connection in the upper-right corner.

  6. Select the service you want to connect to from the list of available external resources. For example, select Azure AI Search.

  7. Browse for and select your Azure AI Search service from the list of available services and then select the type of Authentication to use for the resource. Select Add connection.

    Tip

    Different connection types support different authentication methods. Using Microsoft Entra ID might require specific Azure role-based access permissions for your developers. For more information, visit Role-based access control.

Network isolation

For end-to-end network isolation with Foundry, you need private endpoints to connect to your connected resource. For example, if your Azure Storage account is set to public network access as Disabled, then a private endpoint should be deployed in your virtual network to access in Foundry.

For more on how to set private endpoints to your connected resources, see the following documentation:

Private resource Documentation
Azure Storage Use private endpoints
Azure Cosmos DB Configure Azure Private Link for Azure Cosmos DB
Azure AI Search Create a private endpoint for a secure connection
Azure OpenAI Securing Azure OpenAI inside a virtual network with private endpoints
Application Insights Use Azure Private Link to connect networks to Azure Monitor

Note

Cross-subscription connections used for model deployment are not supported (Foundry, Azure OpenAI). You can't connect to resources from different subscriptions for model deployments.