HttpCommandOptions

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

HttpCommandOptions

Docs Reference Search C# APIs Aspire.Hosting HttpCommandOptions

Class net8.0

📦 Aspire.Hosting v13.3.0

Optional configuration for resource HTTP commands added with ResourceBuilderExtensions.WithHttpCommand.

namespace Aspire.Hosting.ApplicationModel;

public class HttpCommandOptions
    : Aspire.Hosting.ApplicationModel.CommandOptions
{
    // ...
}

CommandOptions

Inherits

CommandOptions→HttpCommandOptions

Source

Search members of HttpCommandOptions...

constructor property

7 members Clear filters

Constructors1

HttpCommandOptions

View all constructors

Properties6

EndpointSelectorget; set

Func<EndpointReference>

Gets or sets a callback that selects the HTTP endpoint to send the request to when the command is invoked.

GetCommandResultget; set

Func<HttpCommandResultContext, Task<ExecuteCommandResult>>

Gets or sets a callback to be invoked after the response is received to determine the result of the command invocation.

HttpClientNameget; set

string?

Gets or sets the name of the HTTP client to use when creating it via IHttpClientFactory.CreateClient.

Methodget; set

HttpMethod?

Gets or sets the HTTP method to use when sending the request.

PrepareRequestget; set

Func<HttpCommandRequestContext, Task>

Gets or sets a callback to be invoked to configure the request before it is sent.

ResultModeget; set

HttpCommandResultMode

Gets or sets how the HTTP response content should be returned as command result data when HttpCommandOptions.GetCommandResult is not specified. The default is HttpCommandResultMode.None.

View all properties