Aspire.Hosting.Docker
Official
📦 Aspire.Hosting.Dockerv17.0.0Import path
apphost/modules/aspire16Functions
14Types
14 types, 16 functions and 108 members
Handles
handle
CapturedEnvironmentVariable3 membershandle
ComposeFile13 membershandle
Config5 membershandle
ConfigReference5 membershandle
DockerComposeAspireDashboardResource5 membershandle
DockerComposeEnvironmentResource9 membershandle
DockerComposeServiceResource2 membershandle
Network8 membershandle
Secret4 membershandle
SecretReference5 membershandle
Service50 membershandle
ServiceDependency1 membershandle
Ulimit2 membershandle
Volume9 membersFunctions
ComposeFile
method
AddConfigAdds a top-level config definition to the Docker Compose file.
AddConfig(name string, options ...*AddConfigOptions) ComposeFilemethod
AddNetworkAdds a top-level network definition to the Docker Compose file.
AddNetwork(name string, options ...*AddNetworkOptions) ComposeFilemethod
AddSecretAdds a top-level secret definition to the Docker Compose file.
AddSecret(name string, options ...*AddSecretOptions) ComposeFilemethod
AddServiceAdds a service definition to the Docker Compose file.
AddService(name string, options ...*AddServiceOptions) ComposeFilemethod
AddVolumeAdds a top-level volume definition to the Docker Compose file.
AddVolume(name string, options ...*AddVolumeOptions) ComposeFileDistributedApplicationBuilder
DockerComposeAspireDashboardResource
method
WithForwardedHeadersbuilderConfigures whether forwarded headers processing is enabled for the Aspire dashboard container.
WithForwardedHeaders(options ...*WithForwardedHeadersOptions) DockerComposeAspireDashboardResourcemethod
WithHostPortbuilderConfigures the port used to access the Aspire Dashboard from a browser.
WithHostPort(options ...*WithHostPortOptions) DockerComposeAspireDashboardResourceDockerComposeEnvironmentResource
method
ConfigureComposeFilebuilderConfigures the Docker Compose file for the environment resource.
ConfigureComposeFile(configure func(obj ComposeFile)) DockerComposeEnvironmentResourcemethod
ConfigureDashboardbuilderConfigures the dashboard properties for this Docker Compose environment.
ConfigureDashboard(configure func(obj DockerComposeAspireDashboardResource)) DockerComposeEnvironmentResourcemethod
ConfigureEnvFilebuilderConfigures the captured environment variables for the Docker Compose environment before they are written to the .env file.
ConfigureEnvFile(configure func(obj *Dict[string, CapturedEnvironmentVariable])) DockerComposeEnvironmentResourcemethod
WithDashboardbuilderEnables the Aspire dashboard for telemetry visualization in this Docker Compose environment.
WithDashboard(options ...*WithDashboardOptions) DockerComposeEnvironmentResourcemethod
WithPropertiesbuilderAllows setting the properties of a Docker Compose environment resource.
WithProperties(configure func(obj DockerComposeEnvironmentResource)) DockerComposeEnvironmentResource