Aspire.Hosting.Foundry 13.3.5-preview.1.26270.6

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Aspire.Hosting.Foundry. 
dotnet add package Aspire.Hosting.Foundry --version 13.3.5-preview.1.26270.6
                    


                    

                
NuGet\Install-Package Aspire.Hosting.Foundry -Version 13.3.5-preview.1.26270.6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Aspire.Hosting.Foundry" Version="13.3.5-preview.1.26270.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Aspire.Hosting.Foundry" Version="13.3.5-preview.1.26270.6" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Aspire.Hosting.Foundry" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Aspire.Hosting.Foundry --version 13.3.5-preview.1.26270.6
                    


                    

                
#r "nuget: Aspire.Hosting.Foundry, 13.3.5-preview.1.26270.6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Aspire.Hosting.Foundry@13.3.5-preview.1.26270.6
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Aspire.Hosting.Foundry&version=13.3.5-preview.1.26270.6&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Aspire.Hosting.Foundry&version=13.3.5-preview.1.26270.6&prerelease
                    


                            Install as a Cake Tool

Aspire.Hosting.Foundry library

Provides extension methods and resource definitions for an Aspire AppHost to configure Microsoft Foundry.

Getting started

Prerequisites

Install the package

In your AppHost project, install the Aspire Microsoft Foundry Hosting library with NuGet:

dotnet add package Aspire.Hosting.Foundry

Configure Azure Provisioning for local development

Adding Azure resources to the Aspire application model will automatically enable development-time provisioning for Azure resources so that you don't need to configure them manually. Provisioning requires a number of settings to be available via .NET configuration. Set these values in user secrets in order to allow resources to be configured automatically.

{
    "Azure": {
      "SubscriptionId": "<your subscription id>",
      "ResourceGroupPrefix": "<prefix for the resource group>",
      "Location": "<azure location>"
    }
}

Usage example

Then, in the AppHost.cs file of AppHost, add a Microsoft Foundry deployment and consume the connection using the following methods:

var chat = builder.AddFoundry("foundry")
                  .AddDeployment("chat", "Phi-4", "1", "Microsoft");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(chat);

The WithReference method passes that connection information into a connection string named chat in the MyService project.

Configuring deployment rate limits

The SkuCapacity property controls the rate limit in thousands of tokens per minute (TPM). For example, a value of 10 means 10,000 TPM. The default is 1 (1,000 TPM). Use WithProperties to configure it:

var chat = builder.AddFoundry("foundry")
                  .AddDeployment("chat", "gpt-4", "1", "OpenAI")
                  .WithProperties(d => d.SkuCapacity = 10);

See the Azure AI quota management documentation for available quota limits per model and region.

In the Program.cs file of MyService, the connection can be consumed using a client library like Aspire.Azure.AI.Inference or Aspire.OpenAI if the model is compatible with the OpenAI API:

Note: The format parameter of the AddDeployment() method can be found in the Microsoft Foundry portal in the details page of the model, right after the Quick facts text.

Inference client usage
builder.AddAzureChatCompletionsClient("chat")
       .AddChatClient();
OpenAI client usage
builder.AddOpenAIClient("chat")
       .AddChatClient();

Emulator usage

Aspire supports the usage of Foundry Local. Add the following to your AppHost project:

// AppHost
var chat = builder.AddFoundry("foundry")
                  .RunAsFoundryLocal()
                  .AddDeployment("chat", "phi-3.5-mini", "1", "Microsoft");

When the AppHost starts up, the local Foundry service will also be started.

This requires the local machine to have Foundry Local installed and running.

Connection Properties

When you reference Microsoft Foundry resources using WithReference, the following connection properties are made available to the consuming project:

Microsoft Foundry resource

The Microsoft Foundry resource exposes the following connection properties:

Property Name Description
Uri The endpoint URI for the Microsoft Foundry resource, with the format https://<resource_name>.services.ai.azure.com/ or the emulator service URI when running Foundry Local (e.g., http://127.0.0.1:61799/v1)
Key The API key when using Foundry Local

Microsoft Foundry deployment

The Microsoft Foundry deployment resource inherits all properties from its parent Microsoft Foundry resource and adds:

Property Name Description
ModelName The deployment name when targeting Azure or model identifier when running Foundry Local, e.g., Phi-4, my-chat
Format The deployment format, e.g., OpenAI, Microsoft, xAi, Deepseek
Version The deployment version, e.g., 1, 2025-08-07

Microsoft Foundry project

The Microsoft Foundry project resource exposes the following connection properties:

Property Name Description
Uri The project endpoint URI, with the format https://<account>.services.ai.azure.com/api/projects/<project>
ConnectionString The connection string, with the format Endpoint=<uri>
ApplicationInsightsConnectionString The Application Insights connection string for telemetry

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called chat becomes CHAT_URI.

Microsoft Foundry project usage

You can create a Microsoft Foundry project resource to organize agents and model deployments:

var foundry = builder.AddFoundry("foundry");
var project = foundry.AddProject("my-project");

var chat = project.AddModelDeployment("chat", "gpt-4", "1.0", "OpenAI");

var myService = builder.AddPythonApp("agent", "./app", "main:app")
                       .WithReference(project);

The project can also be configured with additional Azure resources:

var appInsights = builder.AddAzureApplicationInsights("ai");
var keyVault = builder.AddAzureKeyVault("kv");

var project = foundry.AddProject("my-project")
                     .WithAppInsights(appInsights)
                     .WithKeyVault(keyVault);

Hosted agent usage

To deploy a containerized application as a hosted agent in Microsoft Foundry:

var foundry = builder.AddFoundry("foundry");
var project = foundry.AddProject("my-project");

builder.AddPythonApp("agent", "./app", "main:app")
       .PublishAsHostedAgent(project);

In run mode, the agent runs locally with health check endpoints and OpenTelemetry instrumentation. In publish mode, the agent is deployed as a hosted agent in Microsoft Foundry.

Prompt agent usage

Prompt agents are declarative agents defined by a model, instructions, and tools. They are always deployed to Azure Foundry — even during local development (aspire run) — and local services communicate with the cloud-provisioned agent.

Tools are project-level resources that can be reused across multiple agents:

var foundry = builder.AddFoundry("foundry");
var project = foundry.AddProject("my-project");
var chat = project.AddModelDeployment("gpt41", FoundryModel.OpenAI.Gpt41);

// Create tools at the project level
var codeInterp = project.AddCodeInterpreterTool("code-interp");
var webSearch = project.AddWebSearchTool("web-search");

// Add agent with tools
var agent = project.AddPromptAgent(chat, "joker-agent",
    instructions: "You are good at telling jokes.")
    .WithTool(codeInterp)
    .WithTool(webSearch);

builder.AddPythonApp("app", "./app", "main:app")
       .WithReference(agent);

Available tools

Prompt agents support several tool types, all created as project-level resources:

Tool Extension Method Description
Code Interpreter project.AddCodeInterpreterTool(name) Runs Python code in a sandbox
File Search project.AddFileSearchTool(name, vectorStoreIds) Searches uploaded documents via vector search
Web Search project.AddWebSearchTool(name) Retrieves real-time web information
Azure AI Search project.AddAISearchTool(name).WithReference(search) Grounds responses using Azure AI Search indexes
Bing Grounding project.AddBingGroundingTool(name).WithReference(conn) Grounds responses using Bing Search
SharePoint project.AddSharePointTool(name, connectionIds) Searches SharePoint data
Microsoft Fabric project.AddFabricTool(name, connectionIds) Queries data through Fabric data agents
Azure Functions project.AddAzureFunctionTool(name, ...) Invokes serverless Azure Functions
Function Calling project.AddFunctionTool(name, funcName, params) Calls application-defined functions
Image Generation project.AddImageGenerationTool(name) Generates and edits images (preview)
Computer Use project.AddComputerUseTool(name, w, h) Interacts with a computer desktop (preview)

Azure AI Search tool example

var search = builder.AddAzureSearch("search");
var aiSearch = project.AddAISearchTool("search-tool").WithReference(search);

var agent = project.AddPromptAgent(chat, "research-agent")
    .WithTool(aiSearch);

Bing Grounding tool example

Note: The Bing Search resource (Microsoft.Bing/accounts) cannot be provisioned via Bicep or ARM templates. You must create it manually in the Azure portal. Once created, Aspire can automatically provision the Foundry project connection for you.

The simplest approach is to pass the Bing resource ID directly — Aspire will create the connection with the correct authentication and metadata:

var bingResourceId = "/subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Bing/accounts/{name}";
var bing = project.AddBingGroundingTool("bing-tool").WithReference(bingResourceId);

var agent = project.AddPromptAgent(chat, "news-agent")
    .WithTool(bing);

Alternatively, you can create the connection yourself for full control:

var bingConnection = project.AddBingGroundingConnection("bing-conn", bingResourceId);
var bing = project.AddBingGroundingTool("bing-tool").WithReference(bingConnection);

Tool reuse across agents

Tools are project-level resources, so they can be shared across multiple agents:

var codeInterp = project.AddCodeInterpreterTool("code-interp");
var webSearch = project.AddWebSearchTool("web-search");

var agent1 = project.AddPromptAgent(chat, "agent-1").WithTool(codeInterp).WithTool(webSearch);
var agent2 = project.AddPromptAgent(chat, "agent-2").WithTool(codeInterp);

Additional documentation

Feedback & contributing

https://github.com/microsoft/aspire

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
13.3.5-preview.1.26270.6 139 5/21/2026
13.3.4-preview.1.26268.8 191 5/19/2026
13.3.3-preview.1.26264.13 356 5/15/2026
13.3.2-preview.1.26263.11 175 5/14/2026
13.3.1-preview.1.26261.7 327 5/12/2026
13.3.0-preview.1.26256.5 379 5/7/2026
13.2.4-preview.1.26224.4 1,456 4/24/2026
13.2.3-preview.1.26217.6 556 4/21/2026
13.2.2-preview.1.26207.2 2,927 4/8/2026
13.2.1-preview.1.26180.6 342 3/31/2026
13.2.0-preview.1.26170.3 2,826 3/23/2026