Aspire.Hosting.Azure.CognitiveServices
9.5.2
Prefix Reserved
dotnet add package Aspire.Hosting.Azure.CognitiveServices --version 9.5.2
NuGet\Install-Package Aspire.Hosting.Azure.CognitiveServices -Version 9.5.2
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.Azure.CognitiveServices" Version="9.5.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Aspire.Hosting.Azure.CognitiveServices" Version="9.5.2" />
<PackageReference Include="Aspire.Hosting.Azure.CognitiveServices" />
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.Azure.CognitiveServices --version 9.5.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Aspire.Hosting.Azure.CognitiveServices, 9.5.2"
#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.Azure.CognitiveServices@9.5.2
#: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.Azure.CognitiveServices&version=9.5.2
#tool nuget:?package=Aspire.Hosting.Azure.CognitiveServices&version=9.5.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Aspire.Hosting.Azure.CognitiveServices library
Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure OpenAI.
Getting started
Prerequisites
- Azure subscription - create one for free
Install the package
In your AppHost project, install the .NET Aspire Azure Hosting Cognitive Services library with NuGet:
dotnet add package Aspire.Hosting.Azure.CognitiveServices
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>"
}
}
NOTE: Developers must have Owner access to the target subscription so that role assignments can be configured for the provisioned resources.
Usage example
Then, in the AppHost.cs file of AppHost, add an Azure OpenAI service and consume the connection using the following methods:
var openai = builder.AddAzureOpenAI("openai");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(openai);
The WithReference method passes that connection information into a connection string named openai in the MyService project. In the Program.cs file of MyService, the connection can be consumed using the client library Aspire.Azure.AI.OpenAI:
builder.AddAzureOpenAIClient("openai");
Additional documentation
- https://learn.microsoft.com/dotnet/api/overview/azure/ai.openai-readme
- 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Aspire.Hosting.Azure (>= 9.5.2)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.47.3)
- Azure.Identity (>= 1.15.0)
- Azure.Provisioning (>= 1.3.0)
- Azure.Provisioning.CognitiveServices (>= 1.1.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.ResourceManager.Authorization (>= 1.1.5)
- Azure.ResourceManager.KeyVault (>= 1.3.2)
- Azure.ResourceManager.Resources (>= 1.11.1)
- Azure.Security.KeyVault.Secrets (>= 4.8.0)
- Google.Protobuf (>= 3.32.0)
- 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.14)
- 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.20)
- 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.3)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.11)
- System.IO.Hashing (>= 9.0.8)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (5)
Showing the top 5 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.
|
|
|
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 | |
|---|---|---|---|
| 9.5.2 | 2,021 | 10/23/2025 | |
| 9.5.1 | 11,866 | 10/3/2025 | |
| 9.5.0 | 8,075 | 9/25/2025 | |
| 9.4.2 | 13,837 | 9/2/2025 | |
| 9.4.1 | 11,054 | 8/12/2025 | |
| 9.4.0 | 9,304 | 7/29/2025 | |
| 9.3.1 | 28,685 | 6/10/2025 | |
| 9.3.0 | 16,162 | 5/19/2025 | |
| 9.2.1 | 5,003 | 4/24/2025 | |
| 9.2.0 | 9,049 | 4/10/2025 | |
| 9.1.0 | 64,752 | 2/25/2025 | |
| 9.0.0 | 70,596 | 11/12/2024 | |
| 9.0.0-rc.1.24511.1 | 5,688 | 10/15/2024 | |
| 8.2.2 | 2,345 | 10/24/2024 | |
| 8.2.1 | 7,080 | 9/26/2024 | |
| 8.2.0 | 17,759 | 8/29/2024 | |
| 8.1.0 | 11,427 | 7/23/2024 | |
| 8.0.2 | 5,574 | 6/28/2024 | |
| 8.0.1 | 6,531 | 5/21/2024 | |
| 8.0.0 | 7,651 | 5/21/2024 | |
| 8.0.0-preview.7.24251.11 | 5,939 | 5/7/2024 | |
| 8.0.0-preview.6.24214.1 | 3,321 | 4/23/2024 | |
| 8.0.0-preview.5.24201.12 | 3,120 | 4/9/2024 |