DistributedApplication

Classnet10.0

📦 Aspire.Hosting v13.5.4

Represents a distributed application that implements the Hosting.IHost and IAsyncDisposable interfaces.

namespace Aspire.Hosting;

public class DistributedApplication
    : Microsoft.Extensions.Hosting.IHost,
      System.IAsyncDisposable,
      System.IDisposable
{
    // ...
}

IHostIAsyncDisposableIDisposable

13 members

Remarks

The DistributedApplication is an implementation of the Hosting.IHost interface that orchestrates an Aspire application. To build an instance of the DistributedApplication class, use the DistributedApplication.CreateBuilder method to create an instance of the IDistributedApplicationBuilder interface. Using the IDistributedApplicationBuilder interface you can configure the resources that comprise the distributed application and describe the dependencies between them.

Once the distributed application has been defined use the IDistributedApplicationBuilder.Build method to create an instance of the DistributedApplication class. The DistributedApplication class exposes a DistributedApplication.Run method which then starts the distributed application and its resources.

The DistributedApplication.CreateBuilder method provides additional options for constructing the IDistributedApplicationBuilder including disabling the Aspire dashboard (see DistributedApplicationOptions.DisableDashboard) or allowing unsecured communication between the browser and dashboard, and dashboard and AppHost (see DistributedApplicationOptions.AllowUnsecuredTransport.

The following example shows creating a PostgreSQL server resource with a database and referencing that database in a .NET project.

var builder = DistributedApplication.CreateBuilder(args);
var inventoryDatabase = builder.AddPostgres(
    "mypostgres").AddDatabase("inventory");
builder.AddProject<Projects.InventoryService>()
       .WithReference(inventoryDatabase);

builder.Build().Run();

Constructors1

DistributedApplication(IHost)

Initializes a new instance of the DistributedApplication class.

View all constructors

Properties3

ResourceCommandsget

ResourceCommandService

Gets the service for executing resource commands.

ResourceNotificationsget

ResourceNotificationService

Gets the service for monitoring and responding to resource state changes in the distributed application.

Servicesget

IServiceProvider

Gets the IServiceProvider instance configured for the application.

View all properties

Methods9

CreateBuilderstatic

IDistributedApplicationBuilder

Creates a new instance of the IDistributedApplicationBuilder interface.

CreateBuilder(string[])staticats ignored

IDistributedApplicationBuilder

Creates a new instance of IDistributedApplicationBuilder with the specified command-line arguments.

CreateBuilder(DistributedApplicationOptions)static

IDistributedApplicationBuilder

Creates a new instance of the IDistributedApplicationBuilder interface with the specified options.

Disposevirtual

Disposes the distributed application by disposing the Hosting.IHost.

DisposeAsyncvirtual

ValueTask

Asynchronously disposes the distributed application by disposing the Hosting.IHost.

Run

Runs an application and blocks the calling thread until host shutdown is triggered and all Hosting.IHostedService instances are stopped.

RunAsync(CancellationToken)virtualats export

Task

Runs an application and returns a Task that only completes when the token is triggered or shutdown is triggered and all Hosting.IHostedService instances are stopped.

StartAsync(CancellationToken)virtual

Task

Starts the Hosting.IHostedService objects configured for the program. The application will run until interrupted or until IHostApplicationLifetime.StopApplication is called.

StopAsync(CancellationToken)virtual

Task

Attempts to gracefully stop the program.

View all methods