PrimaryEndpoint EndpointReference getPrimaryEndpoint() EndpointReferenceAPI references are intentionally omitted from this search. To find API references, please search these dedicated API pages instead:
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}OtlpGrpcEndpoint EndpointReference getOtlpGrpcEndpoint() EndpointReferencePrimaryEndpoint EndpointReference getPrimaryEndpoint() EndpointReferenceResourceTypeDisplayName stringgetResourceTypeDisplayName() (string, error)WithForwardedHeaders(options ...*WithForwardedHeadersOptions) DockerComposeAspireDashboardResourceParameters
options...*WithForwardedHeadersOptions Optional settings, described under Options.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).Returns
DockerComposeAspireDashboardResource The resource builder.
Returns a handle; failures surface later via Err().
WithHostPort(options ...*WithHostPortOptions) DockerComposeAspireDashboardResourceParameters
options...*WithHostPortOptions Optional settings, described under Options.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.Returns
DockerComposeAspireDashboardResource The resource builder.
Returns a handle; failures surface later via Err().