Skip to content
Docs Try Aspire

IDistributedApplicationPipeline Methods

Interface Methods 4 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)
{
// ...
}
}
callback Func<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)
{
// ...
}
}
name string The unique name of the step.
action Func<PipelineStepContext, Task> The action to execute for this step.
dependsOn object? optional The name of the step this step depends on, or a list of step names.
requiredBy object? optional The 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)
{
// ...
}
}
step PipelineStep The pipeline step to add.
ExecuteAsync(PipelineContext) Section titled ExecuteAsync(PipelineContext) abstract Task
Executes all steps in the pipeline in dependency order.
public interface IDistributedApplicationPipeline
{
public abstract Task ExecuteAsync(
PipelineContext context)
{
// ...
}
}
context PipelineContext The pipeline context for the execution.
Task A task representing the asynchronous operation.