IDistributedApplicationBuilder.ExecutionContext Property

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.dll

Package:: Aspire.Hosting v8.2.0

Source:: IDistributedApplicationBuilder.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Execution context for this invocation of the AppHost.

public Aspire.Hosting.DistributedApplicationExecutionContext ExecutionContext { get; }

member this.ExecutionContext : Aspire.Hosting.DistributedApplicationExecutionContext

Public ReadOnly Property ExecutionContext As DistributedApplicationExecutionContext

Property Value

DistributedApplicationExecutionContext

Examples

An example of using the IsRunMode property on the IDistributedApplicationBuilder via the ApplicationBuilder. In this case an extension method is used to generate a stable node name for RabbitMQ for local development runs.

private static IResourceBuilder<RabbitMQServerResource> RunWithStableNodeName(this IResourceBuilder<RabbitMQServerResource> builder)
{
    if (builder.ApplicationBuilder.ExecutionContext.IsRunMode)
    {
        builder.WithEnvironment(context =>
        {
            // Set a stable node name so queue storage is consistent between sessions
            var nodeName = $"{builder.Resource.Name}@localhost";
            context.EnvironmentVariables["RABBITMQ_NODENAME"] = nodeName;
        });
    }

    return builder;
}

Remarks

The ExecutionContext property provides access key information about the context in which the distributed application is running. The most important properties that the DistributedApplicationExecutionContext provides is the IsPublishMode and IsRunMode properties. Developers building .NET Aspire based applications may whish to change the application model depending on whether they are running locally, or whether they are publishing to the cloud.

Applies to

Share via