ExecutableLaunchConfiguration

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

ExecutableLaunchConfiguration

Docs Reference Search C# APIs Aspire.Hosting ExecutableLaunchConfiguration

Classnet10.0

📦 Aspire.Hosting v13.5.3

Base properties shared by all launch configurations handed to an IDE or extension host.

Experimental — ASPIREEXTENSION001 · Learn more

namespace Aspire.Hosting.ApplicationModel;

public class ExecutableLaunchConfiguration
{
    // ...
}

Source

Remarks

A launch configuration describes how a resource should be started when Aspire is running inside an IDE debug session. It is serialized to JSON and attached to the underlying orchestrator object, so the property names below (and any added by derived types) are part of the IDE contract.

Integrations create a derived type and supply it through ResourceBuilderExtensions.WithDebugSupport or its asynchronous overload.

Constructors1

ExecutableLaunchConfiguration(string)

Base properties shared by all launch configurations handed to an IDE or extension host.

View all constructors

Properties2

Modeget; set

string

Gets or sets the launch mode, one of the values on ExecutableLaunchMode.

Typeget; set

string

Gets or sets the launch configuration type identifier.

View all properties

Examples

A launch configuration for a hypothetical language integration:

internal sealed class ContosoLaunchConfiguration() : ExecutableLaunchConfiguration("contoso")
{
    [JsonPropertyName("script_path")]
    public string ScriptPath { get; set; } = string.Empty;
}