DockerComposeEnvironmentResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Docker / DockerComposeEnvironmentResource

DockerComposeEnvironmentResource

Docs Reference TypeScript APIs Aspire.Hosting.Docker DockerComposeEnvironmentResource

Handle TypeScript

📦 Aspire.Hosting.Docker v13.2.0-preview.1.26159.1

interface DockerComposeEnvironmentResource
  extends IComputeEnvironmentResource,
    IResource {
  dashboardEnabled: boolean;
  defaultNetworkName: string;
  readonly name: string;
  configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => void): DockerComposeEnvironmentResource;
  withDashboard(enabled?: boolean): DockerComposeEnvironmentResource;
  withProperties(configure: (obj: DockerComposeEnvironmentResource) => void): DockerComposeEnvironmentResource;
}

Implements

• IComputeEnvironmentResource
• IResource

Search members of DockerComposeEnvironmentResource…

method property

8 members Clear filters

Properties

property dashboardEnabled boolean get · set

Gets the DashboardEnabled property

property defaultNetworkName string get · set

Gets the DefaultNetworkName property

property name string get

Gets the Name property

Methods

method configureDashboard builder

Configures the Aspire dashboard resource for the Docker Compose environment

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

Parameters

configure (obj: DockerComposeAspireDashboardResource) => void

Returns

DockerComposeEnvironmentResource

method withDashboard builder

Enables or disables the Aspire dashboard for the Docker Compose environment

withDashboard(enabled?: boolean): DockerComposeEnvironmentResource

Parameters

enabled boolean optional = True

Returns

DockerComposeEnvironmentResource

method withProperties builder

Configures properties of the Docker Compose environment

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

Parameters

configure (obj: DockerComposeEnvironmentResource) => void

Returns

DockerComposeEnvironmentResource