DockerComposeEnvironmentResource

Handle

📦 Aspire.Hosting.Docker v13.4.0

interface DockerComposeEnvironmentResource
  extends IComputeEnvironmentResource,
    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;
}

10 members

Properties

property dashboardEnabled boolean get · set

Determines whether to include an Aspire dashboard for telemetry visualization in this environment.

property defaultNetworkName string get · set

The name of an existing network to be used.

Methods

method configureComposeFile builder

Configures the Docker Compose file for the environment resource.

configureComposeFile(configure: (obj: ComposeFile) => Promise<void>): DockerComposeEnvironmentResource

Parameters

configure (obj: ComposeFile) => Promise<void>

Returns

DockerComposeEnvironmentResource

method configureDashboard builder

Configures the dashboard properties for this Docker Compose environment.

configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => Promise<void>): DockerComposeEnvironmentResource

Parameters

configure (obj: DockerComposeAspireDashboardResource) => Promise<void>

Returns

DockerComposeEnvironmentResource

method configureEnvFile builder

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

Parameters

configure (obj: Dict<string,Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable>) => Promise<void>

Returns

DockerComposeEnvironmentResource

method getHostAddressExpression

Invokes the GetHostAddressExpression method

getHostAddressExpression(endpointReference: EndpointReference): ReferenceExpression

Parameters

endpointReference EndpointReference

Returns

ReferenceExpression

method withDashboard builder

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

withDashboard(enabled?: boolean): DockerComposeEnvironmentResource

Parameters

enabled boolean optional = True

Returns

DockerComposeEnvironmentResource

method withProperties builder

Allows setting the properties of a Docker Compose environment resource.

withProperties(configure: (obj: DockerComposeEnvironmentResource) => Promise<void>): DockerComposeEnvironmentResource

Parameters

configure (obj: DockerComposeEnvironmentResource) => Promise<void>

Returns

DockerComposeEnvironmentResource