Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

ExecutionConfigurationBuilder

Interface
📦 Aspire.Hosting v17.0.0

Builder for gathering and resolving the execution configuration (arguments and environment variables) for a specific resource.

type ExecutionConfigurationBuilder interface{}

Methods

methodBuild
Builds the execution configuration for the specified builder.
Build(
executionContext DistributedApplicationExecutionContext,
options ...*BuildOptions,
) ExecutionConfigurationResult
executionContextDistributedApplicationExecutionContextThe execution context used while building the configuration.
options...*BuildOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*BuildOptions argument.

ResourceLogger*LoggerThe logger used while resolving values.
CancellationToken*CancellationTokenA cancellation token.
ExecutionConfigurationResult

The resolved execution configuration.

Returns a handle; failures surface later via Err().

Adds a command line arguments configuration gatherer to the builder.
WithArgumentsConfig() ExecutionConfigurationBuilder
ExecutionConfigurationBuilder

The builder with the configuration gatherer added.

Returns a handle; failures surface later via Err().

Adds a certificate trust configuration gatherer to the builder.
WithCertificateTrustConfig(configContextFactory func(arg CertificateTrustScope) *CertificateTrustExecutionConfigurationContext) ExecutionConfigurationBuilder
configContextFactoryfunc(arg CertificateTrustScope) *CertificateTrustExecutionConfigurationContextcallbackA factory function to create the configuration context.
ExecutionConfigurationBuilder

The builder with the configuration gatherer added.

Returns a handle; failures surface later via Err().

Adds an environment variables configuration gatherer to the builder.
WithEnvironmentVariablesConfig() ExecutionConfigurationBuilder
ExecutionConfigurationBuilder

The builder with the configuration gatherer added.

Returns a handle; failures surface later via Err().

Adds an HTTPS certificate configuration gatherer using certificate metadata instead of a raw X509 certificate.
WithHttpsCertificateConfig(configContextFactory func(arg *HttpsCertificateInfo) *HttpsCertificateExecutionConfigurationContext) ExecutionConfigurationBuilder
configContextFactoryfunc(arg *HttpsCertificateInfo) *HttpsCertificateExecutionConfigurationContextcallbackThe factory that creates the HTTPS certificate configuration context.
ExecutionConfigurationBuilder

The execution configuration builder.

Returns a handle; failures surface later via Err().

Applies to

This interface applies to the following types: