ExecutableResource

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /Aspire.Hosting
5. /ExecutableResource

Handle

📦 Aspire.Hosting v13.6.0

interface ExecutableResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport {
  publishAsDockerFile(configure: (obj: ContainerResource) => Promise<void>): ExecutableResource;
  withExecutableCommand(command: string): ExecutableResource;
  withVolume(
      target: string,
      name: string,
      env: string,
      isReadOnly?: boolean): ExecutableResource;
  withWorkingDirectory(workingDirectory: string): ExecutableResource;
}

Implements

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

Methods

methodpublishAsDockerFilebuilder

Publishes an executable as a Docker file

publishAsDockerFile(configure: (obj: ContainerResource) => Promise<void>): ExecutableResource

Parameters

configure(obj: ContainerResource) => Promise<void>

Returns

ExecutableResource

methodwithExecutableCommandbuilder

Sets the command for the executable resource.

withExecutableCommand(command: string): ExecutableResource

Parameters

commandstring

Returns

ExecutableResource

methodwithVolumebuilder

Adds a volume to an executable resource.

withVolume(
    target: string,
    name: string,
    env: string,
    isReadOnly?: boolean): ExecutableResource

Parameters

targetstring

namestring

envstring

isReadOnlybooleanoptional= False

Returns

ExecutableResource

methodwithWorkingDirectorybuilder

Sets the working directory for the executable resource.

withWorkingDirectory(workingDirectory: string): ExecutableResource

Parameters

workingDirectorystring

Returns

ExecutableResource