DockerComposeAspireDashboardResource

Handle

📦 Aspire.Hosting.Docker v13.4.0

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

property otlpGrpcEndpoint EndpointReference get

Gets the OTLP gRPC endpoint for telemetry data.

property primaryEndpoint EndpointReference get

Gets the primary endpoint of the Aspire Dashboard.

Methods

method withForwardedHeaders builder

Configures whether forwarded headers processing is enabled for the Aspire dashboard container.

withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource

Parameters

enabled boolean optional = True

Returns

DockerComposeAspireDashboardResource

method withHostPort builder

Configures the port used to access the Aspire Dashboard from a browser.

withHostPort(port?: number): DockerComposeAspireDashboardResource

Parameters

port number optional

Returns

DockerComposeAspireDashboardResource