Skip to content
DocsTry Aspire
DocsTry

IDistributedApplicationLifecycleHook Methods

InterfaceMethods3 members
Defines an interface for hooks that are executed during the lifecycle of a distributed application.
AfterEndpointsAllocatedAsync(DistributedApplicationModel, CancellationToken)Section titled AfterEndpointsAllocatedAsync(DistributedApplicationModel, CancellationToken)virtualTask
Executes after the orchestrator allocates endpoints for resources in the application model.
public interface IDistributedApplicationLifecycleHook
{
public virtual Task AfterEndpointsAllocatedAsync(
DistributedApplicationModel appModel,
CancellationToken cancellationToken = default(CancellationToken))
{
// ...
}
}
appModelDistributedApplicationModelThe distributed application model.
cancellationTokenCancellationTokenoptionalA Threading.CancellationToken.
TaskA Tasks.Task representing the asynchronous operation.
AfterResourcesCreatedAsync(DistributedApplicationModel, CancellationToken)Section titled AfterResourcesCreatedAsync(DistributedApplicationModel, CancellationToken)virtualTask
Executes after the orchestrator has created the resources in the application model.
public interface IDistributedApplicationLifecycleHook
{
public virtual Task AfterResourcesCreatedAsync(
DistributedApplicationModel appModel,
CancellationToken cancellationToken = default(CancellationToken))
{
// ...
}
}
appModelDistributedApplicationModelThe DistributedApplicationModel for the distributed application.
cancellationTokenCancellationTokenoptionalA Threading.CancellationToken.
TaskA Tasks.Task representing the asynchronous operation.
There is no guarantee that the resources have fully started or are in a working state when this method is called.
BeforeStartAsync(DistributedApplicationModel, CancellationToken)Section titled BeforeStartAsync(DistributedApplicationModel, CancellationToken)virtualTask
Executes before the distributed application starts.
public interface IDistributedApplicationLifecycleHook
{
public virtual Task BeforeStartAsync(
DistributedApplicationModel appModel,
CancellationToken cancellationToken = default(CancellationToken))
{
// ...
}
}
appModelDistributedApplicationModelThe distributed application model.
cancellationTokenCancellationTokenoptionalA Threading.CancellationToken.
TaskA Tasks.Task representing the asynchronous operation.