Work with project connections

Completed

Each Azure AI Foundry project includes connected resources, which are defined both at the parent (Azure AI Foundry resource or hub) level, and at the project level. Each resource is a connection to an external service, such as Azure storage, Azure AI Search, Azure OpenAI, or another Azure AI Foundry resource.

With the Azure AI Foundry SDK, you can connect to a project and retrieve connections; which you can then use to consume the connected services.

The AIProjectClient object in Python has a connections property, which you can use to access the resource connections in the project. Methods of the connections object include:

• connections.list(): Returns a collection of connection objects, each representing a connection in the project. You can filter the results by specifying an optional connection_type parameter with a valid enumeration, such as ConnectionType.AZURE_OPEN_AI.
• connections.get(connection_name, include_credentials): Returns a connection object for the connection with the name specified. If the include_credentials parameter is True (the default value), the credentials required to connect to the connection are returned - for example, in the form of an API key for an Azure AI services resource.

The connection objects returned by these methods include connection-specific properties, including credentials, which you can use to connect to the associated resource.

The following code example lists all of the resource connections that have been added to a project:

from azure.identity import DefaultAzureCredential
from azure.ai.projects import AIProjectClient

try:

    # Get project client
    project_endpoint = "https://....."
    project_client = AIProjectClient(            
            credential=DefaultAzureCredential(),
            endpoint=project_endpoint,
        )

    ## List all connections in the project
    connections = project_client.connections
    print("List all connections:")
    for connection in connections.list():
        print(f"{connection.name} ({connection.type})")

except Exception as ex:
    print(ex)

The AIProjectClient object in C# has a GetConnectionsClient() method, which returns a ConnectionsClient object that you can use to access the resource connections in the project. Methods of the ConnectionsClient object include:

• GetConnections(): Returns a collection of ConnectionResponse objects, each representing a connection in the project. You can filter the results by specifying an optional ConnectionType parameter with a valid enumeration, such as ConnectionType.AzureOpenAI.
• GetConnection(connectionName): Returns a connection object for the connection with the name specified.

The connection objects returned by these methods include connection-specific properties, including credentials, which you can use to connect to the associated resource.

The following code example lists all of the resource connections (including the default Azure AI Foundry resource) in a project:

using System;
using Azure;
using Azure.AI.Projects;
using Azure.Identity;

namespace my_foundry_client{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                // Get project client
                var projectEndpoint = "https://.....";
                var projectClient = new AIProjectClient(projectEndpoint, new DefaultAzureCredential());

                // List all connections in the project
                var connectionsClient = projectClient.GetConnectionsClient();
                Console.WriteLine("Connections:");
                foreach (var connection in connectionsClient.GetConnections())
                {
                    Console.WriteLine(connection);
                    Console.Write(connection.Name);
                }

            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }
        }
    }
}