BeforeStartEvent Constructors

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

Constructors

Docs Reference Search C# APIs Aspire.Hosting BeforeStartEvent Constructors

ClassConstructors1 member

This event is published before the application starts.

Constructor(IServiceProvider, DistributedApplicationModel)

This event is published before the application starts.

public class BeforeStartEvent
{
    public BeforeStartEvent(
        IServiceProvider services,
        DistributedApplicationModel model)
    {
        // ...
    }
}

BeforeStartEvent.cs#L30-L40

Parameters

servicesIServiceProviderThe IServiceProvider instance.

modelDistributedApplicationModelThe DistributedApplicationModel instance.

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.

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.ServiceProvider.GetRequiredService<DistributedApplicationModel>();
  // Mutate the distributed application model.
});