Skip to content
Docs Try Aspire

PipelineStepFactoryExtensions Methods

Class Methods 7 members
Provides extension methods for adding pipeline steps to resources.
WithPipelineConfiguration(IResourceBuilder<T>, Func<PipelineConfigurationContext, Task>) Section titled 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)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
callback Func<PipelineConfigurationContext, Task> The callback function to execute during the configuration phase.
IResourceBuilder<T> The resource builder for chaining.
WithPipelineConfiguration(IResourceBuilder<T>, Action<PipelineConfigurationContext>) Section titled 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)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
callback Action<PipelineConfigurationContext> The callback function to execute during the configuration phase.
IResourceBuilder<T> The resource builder for chaining.
WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, PipelineStep>) Section titled 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)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
factory Func<PipelineStepFactoryContext, PipelineStep> A factory function that creates the pipeline step.
IResourceBuilder<T> The resource builder for chaining.
This overload is not available in polyglot app hosts. Use the overload that takes a step name and callback instead.
WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, Task<PipelineStep>>) Section titled 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)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
factory Func<PipelineStepFactoryContext, Task<PipelineStep>> An async factory function that creates the pipeline step.
IResourceBuilder<T> The resource builder for chaining.
This overload is not available in polyglot app hosts. Use the overload that takes a step name and callback instead.
WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, IEnumerable<PipelineStep>>) Section titled 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)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
factory Func<PipelineStepFactoryContext, IEnumerable<PipelineStep>> A factory function that creates multiple pipeline steps.
IResourceBuilder<T> The resource builder for chaining.
This overload is not available in polyglot app hosts. Use the overload that takes a step name and callback instead, and call it multiple times.
WithPipelineStepFactory(IResourceBuilder<T>, Func<PipelineStepFactoryContext, Task<IEnumerable<PipelineStep>>>) Section titled 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)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
factory Func<PipelineStepFactoryContext, Task<IEnumerable<PipelineStep>>> An async factory function that creates multiple pipeline steps.
IResourceBuilder<T> The resource builder for chaining.
This overload is not available in polyglot app hosts. 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?) Section titled WithPipelineStepFactory(IResourceBuilder<T>, string, Func<PipelineStepContext, Task>, string[]?, string[]?, string[]?, string?) 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,
string stepName,
Func<PipelineStepContext, Task> callback,
string[]? dependsOn = null,
string[]? requiredBy = null,
string[]? tags = null,
string? description = null)
{
// ...
}
}
builder IResourceBuilder<T> The resource builder.
stepName string The unique name of the pipeline step.
callback Func<PipelineStepContext, Task> The callback to execute when the step runs.
dependsOn string[]? optional Optional step names that this step depends on.
requiredBy string[]? optional Optional step names that require this step.
tags string[]? optional Optional tags that categorize this step.
description string? optional An optional human-readable description of the step.
IResourceBuilder<T> The resource builder for chaining.