withCommand

Docs / Reference / Search TypeScript APIs / Aspire.Hosting / withCommand

withCommand

Docs Reference Search TypeScript APIs Aspire.Hosting withCommand

Function

📦 Aspire.Hosting v13.2.0-preview.1.26159.1

interface ContainerResource {
  // ... omitted for brevity
  withCommand(
      name: string,
      displayName: string,
      executeCommand: callback,
      commandOptions?: CommandOptions): IResource;
}

Signature

method withCommand builder

Adds a resource command

withCommand(name: string, displayName: string, executeCommand: (arg: ExecuteCommandContext) => ExecuteCommandResult, commandOptions?: CommandOptions): IResource

Parameters

name string

displayName string

executeCommand (arg: ExecuteCommandContext) => ExecuteCommandResult

commandOptions CommandOptions optional

Returns

IResource

Applies to

This function is an extension method on the following types:

type ContainerResource

type ExecutableResource

type ProjectResource

type ParameterResource

type ConnectionStringResource

type ContainerRegistryResource

type DotnetToolResource

type ExternalServiceResource

type CSharpAppResource