ExecutionConfigurationBuilder

Docs / Reference / Search C# APIs / Aspire.Hosting / ExecutionConfigurationBuilder

ExecutionConfigurationBuilder

Docs Reference Search C# APIs Aspire.Hosting ExecutionConfigurationBuilder

Class sealed net10.0

📦 Aspire.Hosting v13.1.2

Provides a builder for constructing an IExecutionConfigurationResult for a specific resource in the distributed application model. This resolves command line arguments and environment variables and potentially additional metadata through registered gatherers.

namespace Aspire.Hosting.ApplicationModel;

public sealed class ExecutionConfigurationBuilder
    : Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder
{
    // ...
}

IExecutionConfigurationBuilder

Implements

• IExecutionConfigurationBuilder

Source

Remarks

Use ExecutionConfigurationBuilder when you need to programmatically assemble configuration for a resource, typically by aggregating multiple configuration sources using the gatherer pattern. This builder collects configuration from registered IExecutionConfigurationGatherer instances, which encapsulate logic for gathering resource-specific command line arguments, environment variables, and other metadata.

The gatherer pattern allows for modular and extensible configuration assembly, where each gatherer can contribute part of the final configuration and allows for collecting only the relevant configuration supported in a given context (i.e. only applying certificate configuration gatherers in supported environments).

Typical usage involves creating a builder for a resource, adding one or more configuration gatherers, and then building the configuration asynchronously.

Methods3

AddExecutionConfigurationGatherer(IExecutionConfigurationGatherer)

IExecutionConfigurationBuilder

Adds a configuration gatherer to the builder.

BuildAsync(DistributedApplicationExecutionContext, ILogger?, CancellationToken)

Task<IExecutionConfigurationResult>

Builds the processed resource configuration (resolved arguments and environment variables).

Create(IResource)static

IExecutionConfigurationBuilder

Creates a new instance of IExecutionConfigurationBuilder.

View all methods

Examples

var resolvedConfiguration = await ExecutionConfigurationBuilder
    .Create(myResource);
    .WithArgumentsConfig()
    .WithEnvironmentVariablesConfig()
    .BuildAsync(executionContext).ConfigureAwait(false);