Aspire.Hosting.Azure.Search

Aspire.Hosting.Azure.Search library

Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure Search Service.

Getting started

Prerequisites

• Azure subscription - create one for free
• Azure Search Service - create an Azure Search Service resource

Install the package

Install the .NET Aspire Azure Search Hosting library with NuGet:

dotnet add package Aspire.Hosting.Azure.Search

Usage example

Then, in the Program.cs file of AppHost, add an Azure Search service and consume the connection using the following methods:

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

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

The AddAzureSearch method will read connection information from the AppHost's configuration (for example, from "user secrets") under the ConnectionStrings:search config key. The WithReference method passes that connection information into a connection string named search in the MyService project. In the Program.cs file of MyService, the connection can be consumed using the client library Aspire.Azure.Search.Documents:

builder.AddAzureSearchClient("search");

Additional documentation

• https://learn.microsoft.com/azure/search/search-howto-dotnet-sdk
• https://github.com/dotnet/aspire/tree/main/src/Components/README.md

Feedback & contributing

https://github.com/dotnet/aspire