IDistributedApplicationBuilder Properties

AppHostAssemblyabstractnullableAssembly?

Assembly of the AppHost project.

public abstract Assembly? AppHostAssembly { get; }

AppHostDirectoryabstractstring

Directory of the project where the AppHost is located. Defaults to the content root if there's no project.

public abstract string AppHostDirectory { get; }

ConfigurationabstractConfigurationManager

Gets the set of key/value configuration properties.

public abstract ConfigurationManager Configuration { get; }

Remarks

This can be mutated by adding more configuration sources, which will update its current view.

EnvironmentabstractIHostEnvironment

Gets the information about the hosting environment an application is running in.

public abstract IHostEnvironment Environment { get; }

EventingabstractIDistributedApplicationEventing

Eventing infrastructure for AppHost lifecycle.

public abstract IDistributedApplicationEventing Eventing { get; }

ExecutionContextabstractDistributedApplicationExecutionContext

Execution context for this invocation of the AppHost.

public abstract DistributedApplicationExecutionContext ExecutionContext { get; }

Remarks

The IDistributedApplicationBuilder.ExecutionContext property provides access key information about the context in which the distributed application is running. The most important properties that the DistributedApplicationExecutionContext provides is the DistributedApplicationExecutionContext.IsPublishMode and DistributedApplicationExecutionContext.IsRunMode properties. Developers building Aspire based applications may whish to change the application model depending on whether they are running locally, or whether they are publishing to the cloud.

An example of using the DistributedApplicationExecutionContext.IsRunMode property on the IDistributedApplicationBuilder via the IResourceBuilder`1.ApplicationBuilder. In this case an extension method is used to generate a stable node name for RabbitMQ for local development runs.

private static IResourceBuilder<RabbitMQServerResource> RunWithStableNodeName(
    this IResourceBuilder<RabbitMQServerResource> builder)
{
    if (builder.ApplicationBuilder.ExecutionContext.IsRunMode)
    {
        builder.WithEnvironment(context =>
        {
            // Set a stable node name so queue storage is consistent between sessions
            var nodeName = $"{builder.Resource.Name}@localhost";
            context.EnvironmentVariables["RABBITMQ_NODENAME"] = nodeName;
        });
    }

    return builder;
}

FileSystemServicevirtualIFileSystemService

Gets the service for managing Aspire file system operations.

public virtual IFileSystemService FileSystemService { get; }

IDistributedApplicationBuilder.cs#L164

Remarks

The IDistributedApplicationBuilder.FileSystemService provides a centralized way to manage temporary files and directories used by Aspire, enabling testability and consistent temp file management.

Resources and infrastructure code should use this service instead of static methods like Path.GetTempPath or Directory.CreateTempSubdirectory to ensure consistent directory management across the application.

PipelineabstractIDistributedApplicationPipeline

Gets the deployment pipeline for this distributed application.

public abstract IDistributedApplicationPipeline Pipeline { get; }

Remarks

The pipeline allows adding custom deployment steps that execute during the deploy process. Steps can declare dependencies on other steps to control execution order.

ResourcesabstractIResourceCollection

Gets the collection of resources for the distributed application.

public abstract IResourceCollection Resources { get; }

Remarks

This can be mutated by adding more resources, which will update its current view.

ServicesabstractIServiceCollection

Gets a collection of services for the application to compose. This is useful for adding user provided or framework provided services.

public abstract IServiceCollection Services { get; }

UserSecretsManagervirtualIUserSecretsManager

Gets the service for managing user secrets.

public virtual IUserSecretsManager UserSecretsManager { get; }

IDistributedApplicationBuilder.cs#L176

Remarks

The IDistributedApplicationBuilder.UserSecretsManager provides a centralized way to manage user secrets used by Aspire, enabling testability and consistent secret management.