DockerComposeEnvironmentExtensions Methods

AddDockerComposeEnvironment(IDistributedApplicationBuilder, string) extension IResourceBuilder<DockerComposeEnvironmentResource>

Adds a Docker Compose environment to the application model.

public static class DockerComposeEnvironmentExtensions
{
    public static IResourceBuilder<DockerComposeEnvironmentResource> AddDockerComposeEnvironment(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}

DockerComposeEnvironmentExtensions.cs#L72-L94

Parameters

builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder.

name string The name of the Docker Compose environment resource.

Returns

IResourceBuilder<DockerComposeEnvironmentResource> A reference to the ApplicationModel.IResourceBuilder`1.

ConfigureComposeFile(IResourceBuilder<DockerComposeEnvironmentResource>, Action<ComposeFile>) extension IResourceBuilder<DockerComposeEnvironmentResource>

Configures the Docker Compose file for the environment resource.

public static class DockerComposeEnvironmentExtensions
{
    public static IResourceBuilder<DockerComposeEnvironmentResource> ConfigureComposeFile(
        this IResourceBuilder<DockerComposeEnvironmentResource> builder,
        Action<ComposeFile> configure)
    {
        // ...
    }
}

DockerComposeEnvironmentExtensions.cs#L127-L131

Parameters

builder IResourceBuilder<DockerComposeEnvironmentResource> The Docker compose environment resource builder.

configure Action<ComposeFile> A method that can be used for customizing the ComposeFile.

Returns

IResourceBuilder<DockerComposeEnvironmentResource> A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This callback runs after the Docker Compose model has been generated and before it is written to disk. Use it to customize the generated ComposeFile for the environment.

ConfigureEnvFile(IResourceBuilder<DockerComposeEnvironmentResource>, Action<IDictionary<string, CapturedEnvironmentVariable>>)

extension IResourceBuilder<DockerComposeEnvironmentResource>

Configures the captured environment variables for the Docker Compose environment before they are written to the .env file.

public static class DockerComposeEnvironmentExtensions
{
    public static IResourceBuilder<DockerComposeEnvironmentResource> ConfigureEnvFile(
        this IResourceBuilder<DockerComposeEnvironmentResource> builder,
        Action<IDictionary<string, CapturedEnvironmentVariable>> configure)
    {
        // ...
    }
}

DockerComposeEnvironmentExtensions.cs#L149-L153

Parameters

builder IResourceBuilder<DockerComposeEnvironmentResource> The Docker Compose environment resource builder.

configure Action<IDictionary<string, CapturedEnvironmentVariable>> A method that can be used for customizing the captured environment variables.

Returns

IResourceBuilder<DockerComposeEnvironmentResource> A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This callback is invoked during the prepare phase, allowing programmatic modification of the environment variables that will be written to the environment-specific .env file adjacent to the Docker Compose file.

WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, bool) extension IResourceBuilder<DockerComposeEnvironmentResource>

Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.

public static class DockerComposeEnvironmentExtensions
{
    public static IResourceBuilder<DockerComposeEnvironmentResource> WithDashboard(
        this IResourceBuilder<DockerComposeEnvironmentResource> builder,
        bool enabled = true)
    {
        // ...
    }
}

DockerComposeEnvironmentExtensions.cs#L165-L169

Parameters

builder IResourceBuilder<DockerComposeEnvironmentResource> The Docker Compose environment resource builder.

enabled bool optional Whether to enable the dashboard. Default is true.

Returns

IResourceBuilder<DockerComposeEnvironmentResource> A reference to the ApplicationModel.IResourceBuilder`1.

WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, Action<IResourceBuilder<DockerComposeAspireDashboardResource>>)

extension IResourceBuilder<DockerComposeEnvironmentResource>

Configures the dashboard properties for this Docker Compose environment.

public static class DockerComposeEnvironmentExtensions
{
    public static IResourceBuilder<DockerComposeEnvironmentResource> WithDashboard(
        this IResourceBuilder<DockerComposeEnvironmentResource> builder,
        Action<IResourceBuilder<DockerComposeAspireDashboardResource>> configure)
    {
        // ...
    }
}

DockerComposeEnvironmentExtensions.cs#L181-L189

Parameters

builder IResourceBuilder<DockerComposeEnvironmentResource> The Docker Compose environment resource builder.

configure Action<IResourceBuilder<DockerComposeAspireDashboardResource>> A method that can be used for customizing the dashboard service.

Returns

IResourceBuilder<DockerComposeEnvironmentResource> A reference to the ApplicationModel.IResourceBuilder`1.

WithProperties(IResourceBuilder<DockerComposeEnvironmentResource>, Action<DockerComposeEnvironmentResource>) extension IResourceBuilder<DockerComposeEnvironmentResource>

Allows setting the properties of a Docker Compose environment resource.

public static class DockerComposeEnvironmentExtensions
{
    public static IResourceBuilder<DockerComposeEnvironmentResource> WithProperties(
        this IResourceBuilder<DockerComposeEnvironmentResource> builder,
        Action<DockerComposeEnvironmentResource> configure)
    {
        // ...
    }
}

DockerComposeEnvironmentExtensions.cs#L106-L111

Parameters

builder IResourceBuilder<DockerComposeEnvironmentResource> The Docker Compose environment resource builder.

configure Action<DockerComposeEnvironmentResource> A method that can be used for customizing the DockerComposeEnvironmentResource.

Returns

IResourceBuilder<DockerComposeEnvironmentResource> A reference to the ApplicationModel.IResourceBuilder`1.