Aspire.Hosting.Azure.Search 13.5.2

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package Aspire.Hosting.Azure.Search --version 13.5.2

NuGet\Install-Package Aspire.Hosting.Azure.Search -Version 13.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.Search" Version="13.5.2" />

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

<PackageVersion Include="Aspire.Hosting.Azure.Search" Version="13.5.2" />
                    

                            Directory.Packages.props

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

                            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.Search --version 13.5.2

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

#r "nuget: Aspire.Hosting.Azure.Search, 13.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.Search@13.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.Search&version=13.5.2
                    

                            Install as a Cake Addin

#tool nuget:?package=Aspire.Hosting.Azure.Search&version=13.5.2
                    

                            Install as a Cake Tool

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

Azure AI Search hosting integration

Use this integration to model, configure, and orchestrate Azure AI Search Service 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.Search integration with the Aspire CLI:

aspire add Aspire.Hosting.Azure.Search

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 AI Search service and reference it from another resource with either C# or TypeScript:

var search = builder.AddAzureSearch("search");

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

TypeScript

const search = await builder.addAzureSearch("search");

const myService = await builder.addNodeApp("myService", "../my-service", "server.js")
                       .withReference(search);

Connection Properties

When you reference an Azure AI Search service using WithReference, the following connection properties are made available to the consuming project:

Property Name	Description
`Uri`	The HTTPS endpoint of the Azure AI Search service in the format `https://{name}.search.windows.net`.

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

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.

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.5.2)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.57.0)
- Azure.Identity (>= 1.21.0)
- Azure.Provisioning (>= 1.5.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.Provisioning.Search (>= 1.0.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 (2)

Showing the top 2 NuGet packages that depend on Aspire.Hosting.Azure.Search:

Package	Downloads
Aspire.Hosting.Foundry Microsoft Foundry resource types for Aspire.	48.7K
AngryMonkey.CDM.Aspire.Hosting Aspire hosting integration for CDM: adds a CDM server to a distributed application and wires its Cosmos, Azure Storage and CloudLogin configuration.	94

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Aspire.Hosting.Azure.Search:

Repository	Stars
microsoft/semantic-kernel Integrate cutting-edge LLM technology quickly and easily into your apps	28.5K
dotnet/extensions This repository contains a suite of libraries that provide facilities commonly needed when creating production-ready applications.	3.2K
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.	168

Version	Downloads	Last Updated
13.5.3	2,063	8/25/2026
13.5.2	2,427	8/21/2026
13.5.1	661	8/20/2026
13.5.0	836	8/18/2026
13.4.6	30,529	6/19/2026
13.4.5	938	6/17/2026
13.4.4	2,764	6/15/2026
13.4.3	6,478	6/8/2026
13.4.2	3,871	6/3/2026
13.4.1	227	6/3/2026
13.4.0	853	6/1/2026
13.3.5	11,178	5/21/2026
13.3.4	579	5/19/2026
13.3.3	2,651	5/15/2026
13.3.2	413	5/14/2026
13.3.1	1,636	5/12/2026
13.3.0	7,218	5/7/2026
13.2.4	2,862	4/24/2026
13.2.3	1,348	4/21/2026
13.2.2	7,299	4/8/2026