ExecutableLaunchConfiguration Constructors

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

Constructors

Docs Reference Search C# APIs Aspire.Hosting ExecutableLaunchConfiguration Constructors

ClassConstructors1 member

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

Constructor(string)

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

public class ExecutableLaunchConfiguration
{
    public ExecutableLaunchConfiguration(
        string type)
    {
        // ...
    }
}

ExecutableLaunchConfiguration.cs#L79-L97

Parameters

typestringThe launch configuration type identifier, for example KnownLaunchConfigurationTypes.Project.

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.

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;
}