BeforeStartEvent

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

BeforeStartEvent

Docs Reference Search C# APIs Aspire.Hosting BeforeStartEvent

Classnet10.0

📦 Aspire.Hosting v13.5.4

This event is published before the application starts.

namespace Aspire.Hosting.ApplicationModel;

public class BeforeStartEvent
    : Aspire.Hosting.Eventing.IDistributedApplicationEvent
{
    // ...
}

IDistributedApplicationEvent

Implements

• IDistributedApplicationEvent

Source

ATS export

Type ID: Aspire.Hosting/BeforeStartEvent

Public instance properties are exported as ATS capabilities.

Remarks

Subscribing to this event is analogous to implementing the IDistributedApplicationLifecycleHook.BeforeStartAsync method. This event provides access to the IServiceProvider interface to resolve dependencies including DistributedApplicationModel service which is passed in as an argument in IDistributedApplicationLifecycleHook.BeforeStartAsync.

Constructors1

BeforeStartEvent(IServiceProvider, DistributedApplicationModel)

This event is published before the application starts.

View all constructors

Properties2

Modelget

DistributedApplicationModel

The DistributedApplicationModel instance.

Servicesget

IServiceProvider

The IServiceProvider instance.

View all properties

Examples

Subscribe to the event and resolve the distributed application model.

var builder = DistributedApplication.CreateBuilder(args);
builder.Eventing.Subscribe<BeforeStartEvent>(async (@event, cancellationToken) => {
  var appModel = @event.Services.GetRequiredService<DistributedApplicationModel>();
  // Mutate the distributed application model.
});