Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

HttpCommandExportOptions

Struct
📦 Aspire.Hosting v17.0.0

ATS-friendly configuration for resource HTTP commands.

type HttpCommandExportOptions struct {
CommandOptions *CommandOptions `json:"CommandOptions"`
Description *string `json:"Description"`
ConfirmationMessage *string `json:"ConfirmationMessage"`
IconName *string `json:"IconName"`
IconVariant *IconVariant `json:"IconVariant"`
IsHighlighted bool `json:"IsHighlighted"`
CommandName *string `json:"CommandName"`
EndpointName *string `json:"EndpointName"`
MethodName *string `json:"MethodName"`
PrepareRequest func(...any) any `json:"PrepareRequest"`
ResultMode HttpCommandResultMode `json:"ResultMode"`
}

Fields

CommandOptions*CommandOptionsoptional
Optional command configuration.
Description*string
Optional description of the command, to be shown in the UI.
ConfirmationMessage*string
When a confirmation message is specified, the UI will prompt with an OK/Cancel dialog before starting the command.
IconName*string
The icon name for the command.
IconVariant*IconVariantoptional
The icon variant.
IsHighlightedbool
A flag indicating whether the command is highlighted in the UI.
CommandName*string
Gets or sets the command name.
EndpointName*string
Gets or sets the HTTP endpoint name to send the request to when the command is invoked.
MethodName*string
Gets or sets the HTTP method name to use when sending the request.
PrepareRequestfunc(...any) anyoptionalcallback
Gets or sets a callback to be invoked to configure the request before it is sent.
ResultModeHttpCommandResultMode
Gets or sets how the HTTP response content should be returned as command result data.