Aspire.Hosting.Docker
Official
📦 Aspire.Hosting.Docker v13.3.0 10 Functions
11 Types
11 types and 174 members
Types
handle
CapturedEnvironmentVariable 6 members handle
ComposeFile 16 members handle
Config 10 members handle
DockerComposeAspireDashboardResource 4 members handle
DockerComposeEnvironmentResource 10 members handle
DockerComposeServiceResource 1 members handle
Network 16 members handle
Secret 8 members handle
Service 90 members handle
ServiceDependency 2 members handle
Volume 18 members Functions
method
addDockerComposeEnvironment builder Adds a Docker Compose publishing environment
addDockerComposeEnvironment(name: string): DockerComposeEnvironmentResource method
asEnvironmentPlaceholder Creates a Docker Compose environment variable placeholder from a parameter builder
asEnvironmentPlaceholder(dockerComposeService: DockerComposeServiceResource): string method
configureComposeFile builder Configures the generated Docker Compose file before it is written to disk
configureComposeFile(configure: (obj: ComposeFile) => Promise<void>): DockerComposeEnvironmentResource method
configureDashboard builder Configures the Aspire dashboard resource for the Docker Compose environment
configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => Promise<void>): DockerComposeEnvironmentResource method
configureEnvFile builder Configures the captured environment variables written to the Docker Compose .env file
configureEnvFile(configure: (obj: Dict<string,Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable>) => Promise<void>): DockerComposeEnvironmentResource method
publishAsDockerComposeService builder Publishes the resource as a Docker Compose service with custom service configuration
publishAsDockerComposeService(configure: (arg1: DockerComposeServiceResource, arg2: Service) => Promise<void>): IComputeResource method
withDashboard builder Enables or disables the Aspire dashboard for the Docker Compose environment
withDashboard(enabled?: boolean): DockerComposeEnvironmentResource method
withForwardedHeaders builder Enables or disables forwarded headers support for the Aspire dashboard
withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource method
withHostPort builder Sets the host port for the Aspire dashboard
withHostPort(port?: number): DockerComposeAspireDashboardResource method
withProperties builder Configures properties of the Docker Compose environment
withProperties(configure: (obj: DockerComposeEnvironmentResource) => Promise<void>): DockerComposeEnvironmentResource