Aspire.Hosting.Azure.CognitiveServices
13.5.3
Prefix Reserved
dotnet add package Aspire.Hosting.Azure.CognitiveServices --version 13.5.3
NuGet\Install-Package Aspire.Hosting.Azure.CognitiveServices -Version 13.5.3
<PackageReference Include="Aspire.Hosting.Azure.CognitiveServices" Version="13.5.3" />
<PackageVersion Include="Aspire.Hosting.Azure.CognitiveServices" Version="13.5.3" />
<PackageReference Include="Aspire.Hosting.Azure.CognitiveServices" />
paket add Aspire.Hosting.Azure.CognitiveServices --version 13.5.3
#r "nuget: Aspire.Hosting.Azure.CognitiveServices, 13.5.3"
#:package Aspire.Hosting.Azure.CognitiveServices@13.5.3
#addin nuget:?package=Aspire.Hosting.Azure.CognitiveServices&version=13.5.3
#tool nuget:?package=Aspire.Hosting.Azure.CognitiveServices&version=13.5.3
Azure OpenAI hosting integration
Use this integration to model, configure, and orchestrate Azure OpenAI in an Aspire solution.
Getting started
Prerequisites
- Azure subscription - create one for free
Add the integration
From your AppHost directory, add the Aspire.Hosting.Azure.CognitiveServices integration with the Aspire CLI:
aspire add Aspire.Hosting.Azure.CognitiveServices
Configure Azure Provisioning for local development
Adding Azure resources to the AppHost 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 AppHost configuration. From your AppHost directory, set these values with aspire secret set:
aspire secret set Azure:SubscriptionId "<your subscription id>"
aspire secret set Azure:ResourceGroupPrefix "<prefix for the resource group>"
aspire secret set Azure:Location "<azure location>"
NOTE: Developers must have Owner access to the target subscription so that role assignments can be configured for the provisioned resources.
Usage example
In the AppHost, add an Azure OpenAI service and reference it from another resource with either C# or TypeScript:
C#
var openai = builder.AddAzureOpenAI("openai");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(openai);
TypeScript
const openai = await builder.addAzureOpenAI("openai");
const myService = await builder.addNodeApp("myService", "../my-service", "server.js")
.withReference(openai);
Connection Properties
When you reference Azure OpenAI resources using WithReference, the following connection properties are made available to the consuming project:
Azure OpenAI resource
The Azure OpenAI resource exposes the following connection properties:
| Property Name | Description |
|---|---|
Uri |
The endpoint URI for the Azure OpenAI resource, typically https://<resource-name>.openai.azure.com/ |
Azure OpenAI deployment
The Azure OpenAI deployment resource inherits all properties from its parent Azure OpenAI resource and adds:
| Property Name | Description |
|---|---|
ModelName |
The name of the Azure OpenAI deployment, e.g., chat |
Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called chat becomes CHAT_URI.
Additional documentation
- https://aspire.dev/integrations/gallery/
- https://aspire.dev/integrations/cloud/azure/azure-openai/azure-openai-host/
- https://learn.microsoft.com/azure/ai-services/openai/
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 (>= 13.5.3)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.57.0)
- Azure.Identity (>= 1.21.0)
- Azure.Provisioning (>= 1.5.0)
- Azure.Provisioning.CognitiveServices (>= 1.2.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.ResourceManager.Authorization (>= 1.1.6)
- Azure.ResourceManager.KeyVault (>= 1.4.0)
- Azure.ResourceManager.Resources (>= 1.11.2)
- Azure.Security.KeyVault.Secrets (>= 4.11.0)
- Google.Protobuf (>= 3.34.1)
- Grpc.AspNetCore (>= 2.80.0)
- Grpc.Net.ClientFactory (>= 2.80.0)
- Grpc.Tools (>= 2.80.0)
- Humanizer.Core (>= 3.0.10)
- JsonPatch.Net (>= 5.0.2)
- KubernetesClient (>= 19.0.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.11)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.11)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.30)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.11)
- Microsoft.Extensions.Hosting (>= 10.0.11)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Http (>= 10.0.11)
- Microsoft.Extensions.Logging (>= 10.0.11)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.11)
- Microsoft.Extensions.Options (>= 10.0.11)
- Microsoft.Extensions.Primitives (>= 10.0.11)
- ModelContextProtocol (>= 1.3.0)
- Newtonsoft.Json (>= 13.0.4)
- OpenTelemetry.Exporter.OpenTelemetryProtocol (>= 1.15.3)
- OpenTelemetry.Extensions.Hosting (>= 1.15.3)
- Polly.Core (>= 8.6.6)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.25.29)
- System.IO.Hashing (>= 10.0.8)
- System.Text.Json (>= 10.0.11)
- YamlDotNet (>= 16.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (6)
Showing the top 6 popular GitHub repositories that depend on Aspire.Hosting.Azure.CognitiveServices:
| Repository | Stars |
|---|---|
|
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
|
|
|
dotnet/eShop
A reference .NET application implementing an eCommerce site
|
|
|
dotnet/extensions
This repository contains a suite of libraries that provide facilities commonly needed when creating production-ready applications.
|
|
|
microsoft/Generative-AI-for-beginners-dotnet
Five lessons, learn how to really apply AI to your .NET Applications
|
|
|
Azure-Samples/eShopOnAzure
A variant of https://github.com/dotnet/eShop that uses Azure services
|
|
|
Azure-Samples/eShopLite
eShopLite is a set of reference .NET applications implementing an eCommerce site with features like Semantic Search, MCP, Reasoning models and more.
|
| Version | Downloads | Last Updated |
|---|---|---|
| 13.5.3 | 7,838 | 8/25/2026 |
| 13.5.2 | 7,402 | 8/21/2026 |
| 13.5.1 | 1,361 | 8/20/2026 |
| 13.5.0 | 2,441 | 8/18/2026 |
| 13.4.6 | 37,084 | 6/19/2026 |
| 13.4.5 | 4,794 | 6/17/2026 |
| 13.4.4 | 5,517 | 6/15/2026 |
| 13.4.3 | 6,801 | 6/8/2026 |
| 13.4.2 | 6,015 | 6/3/2026 |
| 13.4.1 | 2,695 | 6/3/2026 |
| 13.4.0 | 4,057 | 6/1/2026 |
| 13.3.5 | 8,268 | 5/21/2026 |
| 13.3.4 | 2,964 | 5/19/2026 |
| 13.3.3 | 6,028 | 5/15/2026 |
| 13.3.2 | 3,320 | 5/14/2026 |
| 13.3.1 | 3,274 | 5/12/2026 |
| 13.3.0 | 9,877 | 5/7/2026 |
| 13.2.4 | 11,229 | 4/24/2026 |
| 13.2.3 | 4,125 | 4/21/2026 |
| 13.2.2 | 8,178 | 4/8/2026 |