RequiredCommandAnnotation

Docs / Reference / Search C# APIs / Aspire.Hosting / RequiredCommandAnnotation

RequiredCommandAnnotation

Docs Reference Search C# APIs Aspire.Hosting RequiredCommandAnnotation

Class net8.0

📦 Aspire.Hosting v13.2.0

An annotation which declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start.

Experimental — ASPIRECOMMAND001

namespace Aspire.Hosting.ApplicationModel;

public class RequiredCommandAnnotation
    : Aspire.Hosting.ApplicationModel.IResourceAnnotation
{
    // ...
}

IResourceAnnotation

Implements

• IResourceAnnotation

Source

Constructors1

RequiredCommandAnnotation(string)

An annotation which declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start.

View all constructors

Properties3

Commandget

string

Gets the command string (file name or path) that should be validated.

HelpLinkget; init

string?

Gets or sets an optional help link URL to guide users when the command is missing.

ValidationCallbackget; init

Func<RequiredCommandValidationContext, Task<RequiredCommandValidationResult>>

Gets or sets an optional custom validation callback that will be invoked after the command has been resolved.

View all properties