Skip to content
DocsTry Aspire
DocsTry

IDistributedApplicationPipeline Methods

InterfaceMethods4 members
Represents a pipeline for executing deployment steps in a distributed application.
AddPipelineConfiguration(Func<PipelineConfigurationContext, Task>)Section titled AddPipelineConfiguration(Func<PipelineConfigurationContext, Task>)abstract
Registers a callback to be executed during the pipeline configuration phase.
public interface IDistributedApplicationPipeline
{
public abstract void AddPipelineConfiguration(
Func<PipelineConfigurationContext, Task> callback)
{
// ...
}
}
callbackFunc<PipelineConfigurationContext, Task>The callback function to execute during the configuration phase.
AddStep(string, Func<PipelineStepContext, Task>, object?, object?)Section titled AddStep(string, Func<PipelineStepContext, Task>, object?, object?)abstract
Adds a deployment step to the pipeline.
public interface IDistributedApplicationPipeline
{
public abstract void AddStep(
string name,
Func<PipelineStepContext, Task> action,
object? dependsOn = null,
object? requiredBy = null)
{
// ...
}
}
namestringThe unique name of the step.
actionFunc<PipelineStepContext, Task>The action to execute for this step.
dependsOnobject?optionalThe name of the step this step depends on, or a list of step names.
requiredByobject?optionalThe name of the step that requires this step, or a list of step names.
AddStep(PipelineStep)Section titled AddStep(PipelineStep)abstract
Adds a deployment step to the pipeline.
public interface IDistributedApplicationPipeline
{
public abstract void AddStep(
PipelineStep step)
{
// ...
}
}
stepPipelineStepThe pipeline step to add.
ExecuteAsync(PipelineContext)Section titled ExecuteAsync(PipelineContext)abstractTask
Executes all steps in the pipeline in dependency order.
public interface IDistributedApplicationPipeline
{
public abstract Task ExecuteAsync(
PipelineContext context)
{
// ...
}
}
contextPipelineContextThe pipeline context for the execution.
TaskA task representing the asynchronous operation.