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

propertyotlpGrpcEndpointEndpointReferenceget

Gets the OTLP gRPC endpoint for telemetry data.

propertyprimaryEndpointEndpointReferenceget

Gets the primary endpoint of the Aspire Dashboard.

Methods

methodwithForwardedHeadersbuilder

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

withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource

Parameters

enabledbooleanoptional= True

Returns

DockerComposeAspireDashboardResource

methodwithHostPortbuilder

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

withHostPort(port?: number): DockerComposeAspireDashboardResource

Parameters

portnumberoptional

Returns

DockerComposeAspireDashboardResource