DockerComposeEnvironmentExtensions.WithDashboard Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, Action<IResourceBuilder<DockerComposeAspireDashboardResource>>) |
Configures the dashboard properties for this Docker Compose environment. |
| WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, Boolean) |
Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment. |
WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, Action<IResourceBuilder<DockerComposeAspireDashboardResource>>)
Configures the dashboard properties for this Docker Compose environment.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeEnvironmentResource> WithDashboard(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeEnvironmentResource> builder, Action<Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeAspireDashboardResource>> configure);
static member WithDashboard : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeEnvironmentResource> * Action<Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeAspireDashboardResource>> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeEnvironmentResource>
<Extension()>
Public Function WithDashboard (builder As IResourceBuilder(Of DockerComposeEnvironmentResource), configure As Action(Of IResourceBuilder(Of DockerComposeAspireDashboardResource))) As IResourceBuilder(Of DockerComposeEnvironmentResource)
Parameters
The Docker Compose environment resource builder.
A method that can be used for customizing the dashboard service.
Returns
A reference to the IResourceBuilder<T>.
Applies to
WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, Boolean)
Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeEnvironmentResource> WithDashboard(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeEnvironmentResource> builder, bool enabled = true);
static member WithDashboard : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeEnvironmentResource> * bool -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.Docker.DockerComposeEnvironmentResource>
<Extension()>
Public Function WithDashboard (builder As IResourceBuilder(Of DockerComposeEnvironmentResource), Optional enabled As Boolean = true) As IResourceBuilder(Of DockerComposeEnvironmentResource)
Parameters
The Docker Compose environment resource builder.
- enabled
- Boolean
Whether to enable the dashboard. Default is true.
Returns
A reference to the IResourceBuilder<T>.