Skip to content
Docs Try Aspire

ResourceCommandAnnotation Properties

Class Properties 10 members
Represents a command annotation for a resource.
ConfirmationMessage Section titled ConfirmationMessage nullable string?
When a confirmation message is specified, the UI will prompt with an OK/Cancel dialog and the confirmation message before starting the command.
public string? ConfirmationMessage { get; }
DisplayDescription Section titled DisplayDescription nullable string?
Optional description of the command, to be shown in the UI. Could be used as a tooltip. May be localized.
public string? DisplayDescription { get; }
DisplayName Section titled DisplayName string
The display name visible in UI.
public string DisplayName { get; }
ExecuteCommand Section titled ExecuteCommand Func<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.
public Func<ExecuteCommandContext, Task<ExecuteCommandResult>> ExecuteCommand { get; }
IconName Section titled IconName nullable string?
The icon name for the command. The name should be a valid FluentUI icon name. https://aka.ms/fluentui-system-icons
public string? IconName { get; }
The icon variant for the command.
public IconVariant? IconVariant { get; }
A flag indicating whether the command is highlighted in the UI.
public bool IsHighlighted { get; }
The name of command. The name uniquely identifies the command.
public string Name { get; }
Parameter Section titled Parameter nullable object?
Optional parameter that configures the command in some way. Clients must return any value provided by the server when invoking the command.
public object? Parameter { get; }
UpdateState Section titled UpdateState Func<UpdateCommandStateContext, ResourceCommandState>
A callback that is used to update the command state. The callback is executed when the command's resource snapshot is updated.
public Func<UpdateCommandStateContext, ResourceCommandState> UpdateState { get; }