Aspire.Hosting.Docker

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

Aspire.Hosting.Docker

Docs Reference Search TypeScript APIs Aspire.Hosting.Docker

Official

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

7 Functions

4 Types

Search types, functions, members in Aspire.Hosting.Docker...

function handle method property

4 types and 103 members Clear filters

Types

handle DockerComposeAspireDashboardResource 9 members

handle DockerComposeEnvironmentResource 8 members

handle DockerComposeServiceResource 2 members

handle Service 84 members

Functions

function addDockerComposeEnvironment builder

Adds a Docker Compose publishing environment

addDockerComposeEnvironment(name: string): DockerComposeEnvironmentResource

function configureDashboard builder

Configures the Aspire dashboard resource for the Docker Compose environment

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

function publishAsDockerComposeService builder

Publishes the resource as a Docker Compose service with custom service configuration

publishAsDockerComposeService(configure: (arg1: DockerComposeServiceResource, arg2: Service) => void): IComputeResource

function withDashboard builder

Enables or disables the Aspire dashboard for the Docker Compose environment

withDashboard(enabled?: boolean): DockerComposeEnvironmentResource

function withForwardedHeaders builder

Enables or disables forwarded headers support for the Aspire dashboard

withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource

function withHostPort builder

Sets the host port for the Aspire dashboard

withHostPort(port?: number): DockerComposeAspireDashboardResource

function withProperties builder

Configures properties of the Docker Compose environment

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