PipelineStepFactoryExtensions Methods

WithPipelineConfiguration(IResourceBuilder<T>, Func<PipelineConfigurationContext, Task>)extensionIResourceBuilder<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

builderIResourceBuilder<T>The resource builder.

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

Returns

IResourceBuilder<T>The resource builder for chaining.

WithPipelineConfiguration(IResourceBuilder<T>, Action<PipelineConfigurationContext>)extensionIResourceBuilder<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

builderIResourceBuilder<T>The resource builder.

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

Returns

IResourceBuilder<T>The resource builder for chaining.

WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, PipelineStep>)extensionIResourceBuilder<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

builderIResourceBuilder<T>The resource builder.

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

Returns

IResourceBuilder<T>The resource builder for chaining.

Remarks

This overload is not available in polyglot AppHosts. Use the overload that takes a step name and callback instead.

WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, Task<PipelineStep>>)extensionIResourceBuilder<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

builderIResourceBuilder<T>The resource builder.

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

Returns

IResourceBuilder<T>The resource builder for chaining.

Remarks

This overload is not available in polyglot AppHosts. Use the overload that takes a step name and callback instead.

WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, IEnumerable<PipelineStep>>)extensionIResourceBuilder<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

builderIResourceBuilder<T>The resource builder.

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

Returns

IResourceBuilder<T>The resource builder for chaining.

Remarks

This overload is not available in polyglot AppHosts. Use the overload that takes a step name and callback instead, and call it multiple times.

WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, Task<IEnumerable<PipelineStep>>>)extensionIResourceBuilder<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

builderIResourceBuilder<T>The resource builder.

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

Returns

IResourceBuilder<T>The resource builder for chaining.

Remarks

This overload is not available in polyglot AppHosts. Use the overload that takes a step name and callback instead, and call it multiple times.

WithPipelineStepFactory(IResourceBuilder<T>, string, Func<PipelineStepContext, Task>, string[]?, string[]?, string[]?, string?)

extensionIResourceBuilder<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,
        string stepName,
        Func<PipelineStepContext, Task> callback,
        string[]? dependsOn = null,
        string[]? requiredBy = null,
        string[]? tags = null,
        string? description = null)
    {
        // ...
    }
}

PipelineStepFactoryExtensions.cs#L113-L126

Parameters

builderIResourceBuilder<T>The resource builder.

stepNamestringThe unique name of the pipeline step.

callbackFunc<PipelineStepContext, Task>The callback to execute when the step runs.

dependsOnstring[]?optionalOptional step names that this step depends on.

requiredBystring[]?optionalOptional step names that require this step.

tagsstring[]?optionalOptional tags that categorize this step.

descriptionstring?optionalAn optional human-readable description of the step.

Returns

IResourceBuilder<T>The resource builder for chaining.