Aspire.Hosting.Azure.AIFoundry
9.4.2-preview.1.25428.12
Prefix Reserved
dotnet add package Aspire.Hosting.Azure.AIFoundry --version 9.4.2-preview.1.25428.12
NuGet\Install-Package Aspire.Hosting.Azure.AIFoundry -Version 9.4.2-preview.1.25428.12
<PackageReference Include="Aspire.Hosting.Azure.AIFoundry" Version="9.4.2-preview.1.25428.12" />
<PackageVersion Include="Aspire.Hosting.Azure.AIFoundry" Version="9.4.2-preview.1.25428.12" />
<PackageReference Include="Aspire.Hosting.Azure.AIFoundry" />
paket add Aspire.Hosting.Azure.AIFoundry --version 9.4.2-preview.1.25428.12
#r "nuget: Aspire.Hosting.Azure.AIFoundry, 9.4.2-preview.1.25428.12"
#:package Aspire.Hosting.Azure.AIFoundry@9.4.2-preview.1.25428.12
#addin nuget:?package=Aspire.Hosting.Azure.AIFoundry&version=9.4.2-preview.1.25428.12&prerelease
#tool nuget:?package=Aspire.Hosting.Azure.AIFoundry&version=9.4.2-preview.1.25428.12&prerelease
Aspire.Hosting.Azure.AIFoundry library
Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure AI Foundry.
Getting started
Prerequisites
- Azure subscription - create one for free
Install the package
In your AppHost project, install the .NET Aspire Azure AI Foundry Hosting library with NuGet:
dotnet add package Aspire.Hosting.Azure.AIFoundry
Configure Azure Provisioning for local development
Adding Azure resources to the .NET 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 an Azure AI Foundry deployment and consume the connection using the following methods:
var chat = builder.AddAzureAIFoundry("foundry")
.AddDeployment("chat", "Phi-4", "1", "Microsoft");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(chat).WaitFor(chat);
The WithReference
method passes that connection information into a connection string named chat
in the MyService
project.
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 Azure AI 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 the Foundry Local. Add the following to your AppHost project:
// AppHost
var chat = builder.AddAzureAIFoundry("foundry")
.RunAsFoundryLocal()
.AddDeployment("chat", "phi-3.5-mini", "1", "Microsoft");
When the AppHost starts up the local foundry service also be started.
This requires the local machine to have the Foundry Local installed and running.
Additional documentation
- https://learn.microsoft.com/azure/ai-foundry/what-is-azure-ai-foundry
- https://learn.microsoft.com/azure/ai-foundry/foundry-local/
- https://github.com/dotnet/aspire/tree/main/src/Components/README.md
Feedback & contributing
Product | Versions 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. |
-
net8.0
- Aspire.Hosting.Azure (>= 9.4.2)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.47.0)
- Azure.Identity (>= 1.14.2)
- Azure.Provisioning (>= 1.2.1)
- Azure.Provisioning.CognitiveServices (>= 1.1.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.ResourceManager.Authorization (>= 1.1.4)
- Azure.ResourceManager.KeyVault (>= 1.3.2)
- Azure.ResourceManager.Resources (>= 1.11.0)
- Azure.Security.KeyVault.Secrets (>= 4.8.0)
- Google.Protobuf (>= 3.31.1)
- Grpc.AspNetCore (>= 2.71.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.Tools (>= 2.72.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 17.0.4)
- Microsoft.AI.Foundry.Local (>= 0.1.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.18)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Newtonsoft.Json (>= 13.0.3)
- Polly.Core (>= 8.6.2)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.11)
- System.IO.Hashing (>= 9.0.7)
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 |
---|---|---|
9.4.2-preview.1.25428.12 | 161 | 9/2/2025 |
9.4.1-preview.1.25408.4 | 443 | 8/12/2025 |
9.4.0-preview.1.25378.8 | 283 | 7/29/2025 |