DistributedApplicationBuilder

Classnet10.0

📦 Aspire.Hosting v13.5.4

A builder for creating instances of DistributedApplication.

namespace Aspire.Hosting;

public class DistributedApplicationBuilder
    : Aspire.Hosting.IDistributedApplicationBuilder
{
    // ...
}

IDistributedApplicationBuilder

17 members

Remarks

The DistributedApplicationBuilder is the primary implementation of IDistributedApplicationBuilder within Aspire. Typically a developer would interact with instances of this class via the IDistributedApplicationBuilder interface which was created using one of the DistributedApplication.CreateBuilder overloads.

For more information on how to configure the DistributedApplication using the the builder pattern see IDistributedApplicationBuilder.

Constructors2

DistributedApplicationBuilder(string[])

Initializes a new instance of the DistributedApplicationBuilder class with the specified options.

DistributedApplicationBuilder(DistributedApplicationOptions)

Initializes a new instance of the DistributedApplicationBuilder class with the specified options.

View all constructors

Properties12

AppHostAssemblyget

Assembly?

Assembly of the AppHost project.

AppHostDirectoryget

string

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

AppHostPathget

string

Configurationget

ConfigurationManager

Gets the set of key/value configuration properties.

Environmentget

IHostEnvironment

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

Eventingget

IDistributedApplicationEventing

Eventing infrastructure for AppHost lifecycle.

ExecutionContextget

DistributedApplicationExecutionContext

Execution context for this invocation of the AppHost.

FileSystemServiceget

IFileSystemService

Gets the service for managing Aspire file system operations.

Pipelineget

IDistributedApplicationPipeline

Gets the deployment pipeline for this distributed application.

Resourcesget

IResourceCollection

Gets the collection of resources for the distributed application.

Servicesget

IServiceCollection

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

UserSecretsManagerget

IUserSecretsManager

Gets the service for managing user secrets.

View all properties

Methods3

AddResource(T)

IResourceBuilder<T>

Adds a resource of type T to the distributed application.

Build

DistributedApplication

Builds and returns a new DistributedApplication instance. This can only be called once.

CreateResourceBuilder(T)

IResourceBuilder<T>

Creates a new resource builder based on an existing resource.

View all methods