withPipelineStepFactory

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /Aspire.Hosting
5. /withPipelineStepFactory

Method

📦 Aspire.Hosting v13.6.4

interface ContainerResource {
  // ... omitted for brevity
  withPipelineStepFactory(
      stepName: string,
      callback: callback,
      dependsOn?: string[],
      requiredBy?: string[],
      tags?: string[],
      description?: string): IResource;
}

Signature

methodwithPipelineStepFactorybuilder

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

withPipelineStepFactory(stepName: string, callback: (arg: PipelineStepContext) => Promise<void>, dependsOn?: string[], requiredBy?: string[], tags?: string[], description?: string): IResource

Parameters

stepNamestringThe unique name of the pipeline step.

callback(arg: PipelineStepContext) => Promise<void>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.

descriptionstringoptionalAn optional human-readable description of the step.

Returns

IResource

Applies to

This method applies to the following types:

typeContainerResource

typeExecutableResource

typeProjectResource

typeParameterResource

typeContainerRegistryResource

typeDotnetToolResource

typeExternalServiceResource

typeCSharpAppResource