Aspire.Hosting.Docker
Official
📦 Aspire.Hosting.Docker v13.4.0 16 Functions
14 Types
14 types and 204 members
Types
handle
CapturedEnvironmentVariable 6 members handle
ComposeFile 21 members handle
Config 10 members handle
ConfigReference 10 members handle
DockerComposeAspireDashboardResource 4 members handle
DockerComposeEnvironmentResource 10 members handle
DockerComposeServiceResource 1 members handle
Network 16 members handle
Secret 8 members handle
SecretReference 10 members handle
Service 97 members handle
ServiceDependency 2 members handle
Ulimit 4 members handle
Volume 18 members Functions
method
addConfig 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 method
addDockerComposeEnvironment builder Adds a Docker Compose environment to the application model.
addDockerComposeEnvironment(name: string): DockerComposeEnvironmentResource method
addNetwork Adds a top-level network definition to the Docker Compose file.
addNetwork(name: string, driver?: string, external?: boolean, configure?: (obj: Network) => Promise<void>): ComposeFile method
addSecret Adds a top-level secret definition to the Docker Compose file.
addSecret(name: string, file?: string, external?: boolean, configure?: (obj: Secret) => Promise<void>): ComposeFile method
addService Adds a service definition to the Docker Compose file.
addService(name: string, image?: string, configure?: (obj: Service) => Promise<void>): ComposeFile method
addVolume Adds a top-level volume definition to the Docker Compose file.
addVolume(name: string, driver?: string, external?: boolean, configure?: (obj: Volume) => Promise<void>): ComposeFile method
addVolume 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 method
asEnvironmentPlaceholder Creates a Docker Compose environment variable placeholder from a parameter builder
asEnvironmentPlaceholder(dockerComposeService: DockerComposeServiceResource): string method
configureComposeFile builder Configures the Docker Compose file for the environment resource.
configureComposeFile(configure: (obj: ComposeFile) => Promise<void>): DockerComposeEnvironmentResource method
configureDashboard builder Configures the dashboard properties for this Docker Compose environment.
configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => Promise<void>): 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 method
publishAsDockerComposeService builder Publishes the specified resource as a Docker Compose service.
publishAsDockerComposeService(configure: (arg1: DockerComposeServiceResource, arg2: Service) => Promise<void>): IComputeResource method
withDashboard builder Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.
withDashboard(enabled?: boolean): DockerComposeEnvironmentResource method
withForwardedHeaders builder Configures whether forwarded headers processing is enabled for the Aspire dashboard container.
withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource method
withHostPort builder Configures the port used to access the Aspire Dashboard from a browser.
withHostPort(port?: number): DockerComposeAspireDashboardResource method
withProperties builder Allows setting the properties of a Docker Compose environment resource.
withProperties(configure: (obj: DockerComposeEnvironmentResource) => Promise<void>): DockerComposeEnvironmentResource