DockerComposeEnvironmentExtensions Methods
Class Methods 6 members
Provides extension methods for adding Docker Compose environment resources to the application model.
AddDockerComposeEnvironment(IDistributedApplicationBuilder, string) Section titled 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) { // ... }}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>) Section titled 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) { // ... }}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. ConfigureEnvFile(IResourceBuilder<DockerComposeEnvironmentResource>, Action<IDictionary<string, CapturedEnvironmentVariable>>) Section titled 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) { // ... }}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 .env file adjacent to the Docker Compose file.
WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, bool) Section titled 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) { // ... }}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>>) Section titled 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) { // ... }}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>) Section titled 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) { // ... }}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.