Watch Aspire live streamsDocsTry Aspire

DockerComposeEnvironmentResource

Handle
📦 Aspire.Hosting.Docker v13.6.5
interface DockerComposeEnvironmentResource
extends IComputeEnvironmentResource,
IComputeEnvironmentWithVolumeMounts,
IResource {
dashboardEnabled: boolean;
defaultNetworkName: string;
configureComposeFile(configure: (obj: ComposeFile) => Promise<void>): DockerComposeEnvironmentResource;
configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => Promise<void>): DockerComposeEnvironmentResource;
configureEnvFile(configure: (obj: Dict<string,Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable>) => Promise<void>): DockerComposeEnvironmentResource;
getHostAddressExpression(endpointReference: EndpointReference): ReferenceExpression;
withDashboard(enabled?: boolean): DockerComposeEnvironmentResource;
withProperties(configure: (obj: DockerComposeEnvironmentResource) => Promise<void>): DockerComposeEnvironmentResource;
}

Properties

propertydashboardEnabledbooleanget · set
Determines whether to include an Aspire dashboard for telemetry visualization in this environment.
propertydefaultNetworkNamestringget · set
The name of an existing network to be used.

Methods

Configures the Docker Compose file for the environment resource.
configureComposeFile(configure: (obj: ComposeFile) => Promise<void>): DockerComposeEnvironmentResource
configure(obj: ComposeFile) => Promise<void>A method that can be used for customizing the `ComposeFile`.
DockerComposeEnvironmentResource
methodconfigureDashboardbuilder
Configures the dashboard properties for this Docker Compose environment.
configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => Promise<void>): DockerComposeEnvironmentResource
configure(obj: DockerComposeAspireDashboardResource) => Promise<void>A method that can be used for customizing the dashboard service.
DockerComposeEnvironmentResource
methodconfigureEnvFilebuilder
Configures the captured environment variables for the Docker Compose environment before they are written to the .env file.
configureEnvFile(configure: (obj: Dict<string,Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable>) => Promise<void>): DockerComposeEnvironmentResource
configure(obj: Dict<string,Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable>) => Promise<void>A method that can be used for customizing the captured environment variables.
DockerComposeEnvironmentResource
Invokes the GetHostAddressExpression method
getHostAddressExpression(endpointReference: EndpointReference): ReferenceExpression
endpointReferenceEndpointReference
ReferenceExpression
methodwithDashboardbuilder
Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.
withDashboard(enabled?: boolean): DockerComposeEnvironmentResource
enabledbooleanoptional= TrueWhether to enable the dashboard. Default is true.
DockerComposeEnvironmentResource
methodwithPropertiesbuilder
Allows setting the properties of a Docker Compose environment resource.
withProperties(configure: (obj: DockerComposeEnvironmentResource) => Promise<void>): DockerComposeEnvironmentResource
configure(obj: DockerComposeEnvironmentResource) => Promise<void>A method that can be used for customizing the `DockerComposeEnvironmentResource`.
DockerComposeEnvironmentResource