CapabilityHostBuilder Methods

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Hosting.Foundry
5. /CapabilityHostBuilder
6. /Methods

ClassMethods4 members

A fluent builder for configuring a capability host on a Microsoft Foundry project.

WithAzureOpenAI(IResourceBuilder<FoundryResource>)CapabilityHostBuilder

Configures an Azure OpenAI-type Microsoft Foundry account for AI model calls.

public class CapabilityHostBuilder
{
    public CapabilityHostBuilder WithAzureOpenAI(
        IResourceBuilder<FoundryResource> openAI)
    {
        // ...
    }
}

ProjectResource.cs#L404-L406

Parameters

openAIIResourceBuilder<FoundryResource>The Microsoft Foundry resource builder.

Returns

CapabilityHostBuilderThe capability host builder for chaining.

WithCosmosDB(IResourceBuilder<AzureCosmosDBResource>)CapabilityHostBuilder

Configures the Cosmos DB resource for metadata and conversation state storage.

public class CapabilityHostBuilder
{
    public CapabilityHostBuilder WithCosmosDB(
        IResourceBuilder<AzureCosmosDBResource> cosmosDb)
    {
        // ...
    }
}

ProjectResource.cs#L368-L370

Parameters

cosmosDbIResourceBuilder<AzureCosmosDBResource>The Cosmos DB resource builder.

Returns

CapabilityHostBuilderThe capability host builder for chaining.

WithSearch(IResourceBuilder<AzureSearchResource>)CapabilityHostBuilder

Configures the Azure Search resource for vector search capabilities.

public class CapabilityHostBuilder
{
    public CapabilityHostBuilder WithSearch(
        IResourceBuilder<AzureSearchResource> search)
    {
        // ...
    }
}

ProjectResource.cs#L392-L394

Parameters

searchIResourceBuilder<AzureSearchResource>The Search resource builder.

Returns

CapabilityHostBuilderThe capability host builder for chaining.

WithStorage(IResourceBuilder<AzureStorageResource>)CapabilityHostBuilder

Configures the Storage resource for file storage.

public class CapabilityHostBuilder
{
    public CapabilityHostBuilder WithStorage(
        IResourceBuilder<AzureStorageResource> storage)
    {
        // ...
    }
}

ProjectResource.cs#L380-L382

Parameters

storageIResourceBuilder<AzureStorageResource>The Storage resource builder.

Returns

CapabilityHostBuilderThe capability host builder for chaining.