DockerComposeEnvironmentExtensions Methods

AddDockerComposeEnvironment(IDistributedApplicationBuilder, string)extensionIResourceBuilder<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#L78-L100

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder.

namestringThe name of the Docker Compose environment resource.

Returns

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

ConfigureComposeFile(IResourceBuilder<DockerComposeEnvironmentResource>, Action<ComposeFile>)extensionIResourceBuilder<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#L135-L139

Parameters

builderIResourceBuilder<DockerComposeEnvironmentResource> The Docker compose environment resource builder.

configureAction<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>>)

extensionIResourceBuilder<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#L158-L162

Parameters

builderIResourceBuilder<DockerComposeEnvironmentResource>The Docker Compose environment resource builder.

configureAction<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)extensionIResourceBuilder<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#L175-L179

Parameters

builderIResourceBuilder<DockerComposeEnvironmentResource>The Docker Compose environment resource builder.

enabledbooloptionalWhether to enable the dashboard. Default is true.

Returns

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

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

extensionIResourceBuilder<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#L192-L200

Parameters

builderIResourceBuilder<DockerComposeEnvironmentResource>The Docker Compose environment resource builder.

configureAction<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>)extensionIResourceBuilder<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#L113-L118

Parameters

builderIResourceBuilder<DockerComposeEnvironmentResource>The Docker Compose environment resource builder.

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

Returns

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