Watch Aspire live streamsDocsTry Aspire

DockerComposeAspireDashboardResource

Handle
📦 Aspire.Hosting.Docker v13.6.5
interface DockerComposeAspireDashboardResource
extends IComputeResource,
IResource,
IResourceWithArgs,
IResourceWithEndpoints,
IResourceWithEnvironment,
IResourceWithProbes,
IResourceWithWaitSupport {
readonly otlpGrpcEndpoint: EndpointReference;
readonly primaryEndpoint: EndpointReference;
withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource;
withHostPort(port?: number): DockerComposeAspireDashboardResource;
}

Properties

propertyotlpGrpcEndpointEndpointReferenceget
Gets the OTLP gRPC endpoint for telemetry data.
propertyprimaryEndpointEndpointReferenceget
Gets the primary endpoint of the Aspire Dashboard.

Methods

Configures whether forwarded headers processing is enabled for the Aspire dashboard container.
withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource
enabledbooleanoptional= TrueTrue to enable forwarded headers (`ASPIRE_DASHBOARD_FORWARDEDHEADERS_ENABLED=true`), false to disable it (sets the value to `false`).
DockerComposeAspireDashboardResource
methodwithHostPortbuilder
Configures the port used to access the Aspire Dashboard from a browser.
withHostPort(port?: number): DockerComposeAspireDashboardResource
portnumberoptionalThe port to bind on the host. If non-null, the dashboard will be exposed on the host. If `null`, the dashboard will not be exposed on the host but will only be reachable within the container network.
DockerComposeAspireDashboardResource