Skip to content
Docs Try Aspire

ResourceCommandSnapshot Properties

Record Properties 9 members
A snapshot of a resource command.
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; init; }
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; init; }
DisplayName Section titled DisplayName string
The display name visible in UI for the command.
public string DisplayName { get; init; }
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; init; }
The icon variant.
public IconVariant? IconVariant { get; init; }
A flag indicating whether the command is highlighted in the UI.
public bool IsHighlighted { get; init; }
The name of command. The name uniquely identifies the command.
public string Name { get; init; }
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; init; }
The state of the command.
public ResourceCommandState State { get; init; }