Aspire.Hosting.Docker

Official

📦 Aspire.Hosting.Dockerv13.4.0

16Functions

14Types

14 types and 204 members

Types

handleCapturedEnvironmentVariable6 members

handleComposeFile21 members

handleConfig10 members

handleConfigReference10 members

handleDockerComposeAspireDashboardResource4 members

handleDockerComposeEnvironmentResource10 members

handleDockerComposeServiceResource1 members

handleNetwork16 members

handleSecret8 members

handleSecretReference10 members

handleService97 members

handleServiceDependency2 members

handleUlimit4 members

handleVolume18 members

Functions

methodaddConfig

Adds a top-level config definition to the Docker Compose file.

addConfig(name: string, file?: string, content?: string, external?: boolean, configure?: (obj: Config) => Promise<void>): ComposeFile

methodaddDockerComposeEnvironmentbuilder

Adds a Docker Compose environment to the application model.

addDockerComposeEnvironment(name: string): DockerComposeEnvironmentResource

methodaddNetwork

Adds a top-level network definition to the Docker Compose file.

addNetwork(name: string, driver?: string, external?: boolean, configure?: (obj: Network) => Promise<void>): ComposeFile

methodaddSecret

Adds a top-level secret definition to the Docker Compose file.

addSecret(name: string, file?: string, external?: boolean, configure?: (obj: Secret) => Promise<void>): ComposeFile

methodaddService

Adds a service definition to the Docker Compose file.

addService(name: string, image?: string, configure?: (obj: Service) => Promise<void>): ComposeFile

methodaddVolume

Adds a top-level volume definition to the Docker Compose file.

addVolume(name: string, driver?: string, external?: boolean, configure?: (obj: Volume) => Promise<void>): ComposeFile

methodaddVolume

Adds a volume mount to a generated Docker Compose service.

addVolume(source: string, target: string, type?: string, isReadOnly?: boolean, configure?: (obj: Volume) => Promise<void>): Service

methodasEnvironmentPlaceholder

Creates a Docker Compose environment variable placeholder from a parameter builder

asEnvironmentPlaceholder(dockerComposeService: DockerComposeServiceResource): string

methodconfigureComposeFilebuilder

Configures the Docker Compose file for the environment resource.

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

methodconfigureDashboardbuilder

Configures the dashboard properties for this Docker Compose environment.

configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => Promise<void>): 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

methodpublishAsDockerComposeServicebuilder

Publishes the specified resource as a Docker Compose service.

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

methodwithDashboardbuilder

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

withDashboard(enabled?: boolean): DockerComposeEnvironmentResource

methodwithForwardedHeadersbuilder

Configures whether forwarded headers processing is enabled for the Aspire dashboard container.

withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource

methodwithHostPortbuilder

Configures the port used to access the Aspire Dashboard from a browser.

withHostPort(port?: number): DockerComposeAspireDashboardResource

methodwithPropertiesbuilder

Allows setting the properties of a Docker Compose environment resource.

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