Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

DistributedApplicationPipeline

Interface
📦 Aspire.Hosting v17.0.0

Represents a pipeline for executing deployment steps in a distributed application.

type DistributedApplicationPipeline interface{}

Methods

methodAddStep
Adds an application-level pipeline step in a TypeScript-friendly shape.
AddStep(
stepName string,
callback func(arg PipelineStepContext),
options ...*AddStepOptions,
) error
stepNamestringThe unique name of the pipeline step.
callbackfunc(arg PipelineStepContext)callbackThe callback to execute when the step runs.
options...*AddStepOptionsOptional settings, described under Options.

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

DependsOn[]stringOptional step names that this step depends on.
RequiredBy[]stringOptional step names that require this step.
error

Returns error.

methodConfigure
Registers a pipeline configuration callback in a TypeScript-friendly shape.
Configure(callback func(arg PipelineConfigurationContext)) error
callbackfunc(arg PipelineConfigurationContext)callbackThe callback to execute during pipeline configuration.
error

Returns error.

Disables the publish and deploy validation that requires build-only containers to be consumed by another resource.
DisableBuildOnlyContainerValidation() DistributedApplicationPipeline
DistributedApplicationPipeline

The distributed application pipeline for chaining.

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

Applies to

This interface applies to the following types: