Skip to content
Docs Try Aspire

DockerComposeEnvironmentExtensions

Class static net8.0
📦 Aspire.Hosting.Docker v13.2.0
Provides extension methods for adding Docker Compose environment resources to the application model.
namespace Aspire.Hosting;
public static class DockerComposeEnvironmentExtensions
{
// ...
}
AddDockerComposeEnvironment(IDistributedApplicationBuilder, string)extensionats export
IResourceBuilder<DockerComposeEnvironmentResource>
Adds a Docker Compose environment to the application model.
ConfigureComposeFile(IResourceBuilder<DockerComposeEnvironmentResource>, Action<ComposeFile>)extensionats ignored
IResourceBuilder<DockerComposeEnvironmentResource>
Configures the Docker Compose file for the environment resource.
ConfigureEnvFile(IResourceBuilder<DockerComposeEnvironmentResource>, Action<IDictionary<string, CapturedEnvironmentVariable>>)extensionats ignored
IResourceBuilder<DockerComposeEnvironmentResource>
Configures the captured environment variables for the Docker Compose environment before they are written to the .env file.
WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, bool)extensionats export
IResourceBuilder<DockerComposeEnvironmentResource>
Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.
WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, Action<IResourceBuilder<DockerComposeAspireDashboardResource>>)extensionats export
IResourceBuilder<DockerComposeEnvironmentResource>
Configures the dashboard properties for this Docker Compose environment.
WithProperties(IResourceBuilder<DockerComposeEnvironmentResource>, Action<DockerComposeEnvironmentResource>)extensionats export
IResourceBuilder<DockerComposeEnvironmentResource>
Allows setting the properties of a Docker Compose environment resource.
View all methods