PipelineStepFactoryExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Hosting / PipelineStepFactoryExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting PipelineStepFactoryExtensions Methods

Class Methods 6 members

Provides extension methods for adding pipeline steps to resources.

WithPipelineConfiguration(IResourceBuilder<T>, Func<PipelineConfigurationContext, Task>) extension IResourceBuilder<T>

Registers a callback to be executed during the pipeline configuration phase, allowing modification of step dependencies and relationships.

public static class PipelineStepFactoryExtensions
{
    public static IResourceBuilder<T> WithPipelineConfiguration<T>(
        this IResourceBuilder<T> builder,
        Func<PipelineConfigurationContext, Task> callback)
    {
        // ...
    }
}

PipelineStepFactoryExtensions.cs

Parameters

builder IResourceBuilder<T> The resource builder.

callback Func<PipelineConfigurationContext, Task> The callback function to execute during the configuration phase.

Returns

IResourceBuilder<T> The resource builder for chaining.

WithPipelineConfiguration(IResourceBuilder<T>, Action<PipelineConfigurationContext>) extension IResourceBuilder<T>

Registers a callback to be executed during the pipeline configuration phase, allowing modification of step dependencies and relationships.

public static class PipelineStepFactoryExtensions
{
    public static IResourceBuilder<T> WithPipelineConfiguration<T>(
        this IResourceBuilder<T> builder,
        Action<PipelineConfigurationContext> callback)
    {
        // ...
    }
}

PipelineStepFactoryExtensions.cs

Parameters

builder IResourceBuilder<T> The resource builder.

callback Action<PipelineConfigurationContext> The callback function to execute during the configuration phase.

Returns

IResourceBuilder<T> The resource builder for chaining.

WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, PipelineStep>) extension IResourceBuilder<T>

Adds a pipeline step to the resource that will be executed during deployment.

public static class PipelineStepFactoryExtensions
{
    public static IResourceBuilder<T> WithPipelineStepFactory<T>(
        this IResourceBuilder<T> builder,
        Func<PipelineStepFactoryContext, PipelineStep> factory)
    {
        // ...
    }
}

PipelineStepFactoryExtensions.cs

Parameters

builder IResourceBuilder<T> The resource builder.

factory Func<PipelineStepFactoryContext, PipelineStep> A factory function that creates the pipeline step.

Returns

IResourceBuilder<T> The resource builder for chaining.

WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, Task<PipelineStep>>) extension IResourceBuilder<T>

Adds a pipeline step to the resource that will be executed during deployment.

public static class PipelineStepFactoryExtensions
{
    public static IResourceBuilder<T> WithPipelineStepFactory<T>(
        this IResourceBuilder<T> builder,
        Func<PipelineStepFactoryContext, Task<PipelineStep>> factory)
    {
        // ...
    }
}

PipelineStepFactoryExtensions.cs

Parameters

builder IResourceBuilder<T> The resource builder.

factory Func<PipelineStepFactoryContext, Task<PipelineStep>> An async factory function that creates the pipeline step.

Returns

IResourceBuilder<T> The resource builder for chaining.

WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, IEnumerable<PipelineStep>>) extension IResourceBuilder<T>

Adds multiple pipeline steps to the resource that will be executed during deployment.

public static class PipelineStepFactoryExtensions
{
    public static IResourceBuilder<T> WithPipelineStepFactory<T>(
        this IResourceBuilder<T> builder,
        Func<PipelineStepFactoryContext, IEnumerable<PipelineStep>> factory)
    {
        // ...
    }
}

PipelineStepFactoryExtensions.cs

Parameters

builder IResourceBuilder<T> The resource builder.

factory Func<PipelineStepFactoryContext, IEnumerable<PipelineStep>> A factory function that creates multiple pipeline steps.

Returns

IResourceBuilder<T> The resource builder for chaining.

WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, Task<IEnumerable<PipelineStep>>>) extension IResourceBuilder<T>

Adds multiple pipeline steps to the resource that will be executed during deployment.

public static class PipelineStepFactoryExtensions
{
    public static IResourceBuilder<T> WithPipelineStepFactory<T>(
        this IResourceBuilder<T> builder,
        Func<PipelineStepFactoryContext, Task<IEnumerable<PipelineStep>>> factory)
    {
        // ...
    }
}

PipelineStepFactoryExtensions.cs

Parameters

builder IResourceBuilder<T> The resource builder.

factory Func<PipelineStepFactoryContext, Task<IEnumerable<PipelineStep>>> An async factory function that creates multiple pipeline steps.

Returns

IResourceBuilder<T> The resource builder for chaining.