Aspire.Hosting.Azure.CognitiveServices 13.1.0

Prefix Reserved

dotnet add package Aspire.Hosting.Azure.CognitiveServices --version 13.1.0

NuGet\Install-Package Aspire.Hosting.Azure.CognitiveServices -Version 13.1.0

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="13.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Aspire.Hosting.Azure.CognitiveServices" Version="13.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Aspire.Hosting.Azure.CognitiveServices" />
                    

                            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.Azure.CognitiveServices --version 13.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Aspire.Hosting.Azure.CognitiveServices, 13.1.0"

#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@13.1.0

#: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=13.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Aspire.Hosting.Azure.CognitiveServices&version=13.1.0
                    

                            Install as a Cake Tool

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 an Aspire AppHost to configure Azure OpenAI.

Getting started

Prerequisites

Azure subscription - create one for free

Install the package

In your AppHost project, install the 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 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");

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

Feedback & contributing

https://github.com/dotnet/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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Aspire.Hosting.Azure (>= 13.1.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.50.0)
- Azure.Identity (>= 1.17.0)
- Azure.Provisioning (>= 1.4.0)
- Azure.Provisioning.CognitiveServices (>= 1.1.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.ResourceManager.Authorization (>= 1.1.6)
- Azure.ResourceManager.KeyVault (>= 1.3.3)
- Azure.ResourceManager.Resources (>= 1.11.1)
- Azure.Security.KeyVault.Secrets (>= 4.8.0)
- Google.Protobuf (>= 3.33.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 (>= 18.0.5)
- 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.22)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.1)
- 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.4)
- Polly.Core (>= 8.6.4)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.23)
- System.IO.Hashing (>= 9.0.10)

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	27.1K
dotnet/eShop A reference .NET application implementing an eCommerce site	10.0K
dotnet/extensions This repository contains a suite of libraries that provide facilities commonly needed when creating production-ready applications.	3.1K
Azure-Samples/eShopOnAzure A variant of https://github.com/dotnet/eShop that uses Azure services	262
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.	150

Version	Downloads	Last Updated
13.1.0	4,853	12/17/2025
13.0.2	10,018	12/4/2025
13.0.1	6,693	11/26/2025
13.0.0	16,618	11/11/2025
9.5.2	10,442	10/23/2025
9.5.1	21,156	10/3/2025
9.5.0	13,224	9/25/2025
9.4.2	18,281	9/2/2025
9.4.1	12,370	8/12/2025
9.4.0	10,990	7/29/2025
9.3.1	35,057	6/10/2025
9.3.0	18,955	5/19/2025
9.2.1	5,283	4/24/2025
9.2.0	9,720	4/10/2025
9.1.0	67,243	2/25/2025
9.0.0	77,512	11/12/2024
9.0.0-rc.1.24511.1	5,847	10/15/2024
8.2.2	2,391	10/24/2024
8.2.1	7,221	9/26/2024
8.2.0	18,137	8/29/2024
8.1.0	11,548	7/23/2024
8.0.2	5,650	6/28/2024
8.0.1	6,569	5/21/2024
8.0.0	7,847	5/21/2024
8.0.0-preview.7.24251.11	5,985	5/7/2024
8.0.0-preview.6.24214.1	3,339	4/23/2024
8.0.0-preview.5.24201.12	3,149	4/9/2024