Skip to content
Docs Try Aspire

YarpResource

Handle TypeScript
📦 Aspire.Hosting.Yarp v13.2.0-preview.1.26159.1
interface YarpResource
extends IComputeResource,
IContainerFilesDestinationResource,
IResource,
IResourceWithArgs,
IResourceWithEndpoints,
IResourceWithEnvironment,
IResourceWithProbes,
IResourceWithWaitSupport,
IResourceWithServiceDiscovery {
publishWithStaticFiles(resourceWithFiles: IResourceWithContainerFiles): YarpResource;
withConfiguration(configurationBuilder: (obj: IYarpConfigurationBuilder) => void): YarpResource;
withHostHttpsPort(port: number): YarpResource;
withHostPort(port: number): YarpResource;
withStaticFiles(): YarpResource;
}

Methods

method publishWithStaticFiles builder
In publish mode, generates a Dockerfile that copies static files from the specified resource into /app/wwwroot.
publishWithStaticFiles(resourceWithFiles: IResourceWithContainerFiles): YarpResource
resourceWithFiles IResourceWithContainerFiles
YarpResource
method withConfiguration builder
Configure the YARP resource.
withConfiguration(configurationBuilder: (obj: IYarpConfigurationBuilder) => void): YarpResource
configurationBuilder (obj: IYarpConfigurationBuilder) => void
YarpResource
method withHostHttpsPort builder
Configures the host HTTPS port that the YARP resource is exposed on instead of using randomly assigned port.
withHostHttpsPort(port: number): YarpResource
port number
YarpResource
method withHostPort builder
Configures the host port that the YARP resource is exposed on instead of using randomly assigned port.
withHostPort(port: number): YarpResource
port number
YarpResource
method withStaticFiles builder
Enables static file serving in the YARP resource. Static files are served from the wwwroot folder.
withStaticFiles(): YarpResource
YarpResource