DockerComposeAspireDashboardResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Docker / DockerComposeAspireDashboardResource

DockerComposeAspireDashboardResource

Docs Reference TypeScript APIs Aspire.Hosting.Docker DockerComposeAspireDashboardResource

Handle TypeScript

📦 Aspire.Hosting.Docker v13.2.0-preview.1.26159.1

interface DockerComposeAspireDashboardResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport {
  entrypoint: string;
  readonly name: string;
  readonly otlpGrpcEndpoint: EndpointReference;
  readonly primaryEndpoint: EndpointReference;
  shellExecution: boolean;
  withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource;
  withHostPort(port?: number): DockerComposeAspireDashboardResource;
}

Implements

• IComputeResource
• IResource
• IResourceWithArgs
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport

Search members of DockerComposeAspireDashboardResource…

method property

9 members Clear filters

Properties

property entrypoint string get · set

Gets the Entrypoint property

property name string get

Gets the Name property

property otlpGrpcEndpoint EndpointReference get

Gets the OtlpGrpcEndpoint property

property primaryEndpoint EndpointReference get

Gets the PrimaryEndpoint property

property shellExecution boolean get · set

Gets the ShellExecution property

Methods

method withForwardedHeaders builder

Enables or disables forwarded headers support for the Aspire dashboard

withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource

Parameters

enabled boolean optional = True

Returns

DockerComposeAspireDashboardResource

method withHostPort builder

Sets the host port for the Aspire dashboard

withHostPort(port?: number): DockerComposeAspireDashboardResource

Parameters

port number optional

Returns

DockerComposeAspireDashboardResource