Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

DockerComposeAspireDashboardResource

Handle
📦 Aspire.Hosting.Docker v17.0.0

Represents a resource for the Aspire Dashboard. This resource is used to visualize telemetry data in the Aspire Hosting environment.

type DockerComposeAspireDashboardResource interface {
IComputeResource
Resource
ResourceWithArgs
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyOtlpGrpcEndpointEndpointReferenceget
Gets the OTLP gRPC endpoint for telemetry data.
OtlpGrpcEndpoint() EndpointReference
propertyPrimaryEndpointEndpointReferenceget
Gets the primary endpoint of the Aspire Dashboard.
PrimaryEndpoint() EndpointReference
propertyResourceTypeDisplayNamestringget
Gets the ResourceTypeDisplayName property
ResourceTypeDisplayName() (string, error)

Methods

Configures whether forwarded headers processing is enabled for the Aspire dashboard container.
WithForwardedHeaders(options ...*WithForwardedHeadersOptions) DockerComposeAspireDashboardResource
options...*WithForwardedHeadersOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithForwardedHeadersOptions argument.

Enabled*boolTrue to enable forwarded headers (ASPIRE_DASHBOARD_FORWARDEDHEADERS_ENABLED=true), false to disable it (sets the value to false).
DockerComposeAspireDashboardResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithHostPortbuilder
Configures the port used to access the Aspire Dashboard from a browser.
WithHostPort(options ...*WithHostPortOptions) DockerComposeAspireDashboardResource
options...*WithHostPortOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithHostPortOptions argument.

Port*float64The 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

The resource builder.

Returns a handle; failures surface later via Err().