Aspire.Hosting.Azure.Search

Aspire.Hosting.Azure.Search library

Provides extension methods and resource definitions for an Aspire AppHost to configure Azure AI Search Service.

Getting started

Prerequisites

• Azure subscription - create one for free

Install the package

Install the Aspire Azure AI Search Hosting library with NuGet:

dotnet add package Aspire.Hosting.Azure.Search

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 AI Search service and consume the connection using the following methods:

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

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

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");

Connection Properties

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

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

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

Feedback & contributing

https://github.com/microsoft/aspire