ResourceCommandAnnotation
Class sealed net8.0
Represents a command annotation for a resource.
namespace Aspire.Hosting.ApplicationModel;
public sealed class ResourceCommandAnnotation : Aspire.Hosting.ApplicationModel.IResourceAnnotation{ // ...} 11 members
Constructors1
Section titled ConstructorsResourceCommandAnnotation(string, string, Func<UpdateCommandStateContext, ResourceCommandState>, Func<ExecuteCommandContext, Task<ExecuteCommandResult>>, string?, object?, string?, string?, IconVariant?, bool) Initializes a new instance of the
ResourceCommandAnnotation class. Properties10
Section titled PropertiesConfirmationMessagegetstring? When a confirmation message is specified, the UI will prompt with an OK/Cancel dialog and the confirmation message before starting the command.
DisplayDescriptiongetstring? Optional description of the command, to be shown in the UI. Could be used as a tooltip. May be localized.
DisplayNamegetstring The display name visible in UI.
ExecuteCommandgetFunc<ExecuteCommandContext, Task<ExecuteCommandResult>> A callback that is executed when the command is executed. The result is used to indicate success or failure in the UI.
IconNamegetstring? The icon name for the command. The name should be a valid FluentUI icon name. https://aka.ms/fluentui-system-icons
IconVariantget The icon variant for the command.
IsHighlightedgetbool A flag indicating whether the command is highlighted in the UI.
Namegetstring The name of command. The name uniquely identifies the command.
Parametergetobject? Optional parameter that configures the command in some way. Clients must return any value provided by the server when invoking the command.
UpdateStategetFunc<UpdateCommandStateContext, ResourceCommandState> A callback that is used to update the command state. The callback is executed when the command's resource snapshot is updated.