on-success-or-failure-hook.md

title	description	ms.date	monikerRange
onSuccessOrFailureHook definition	Used to run steps for rollback actions or clean-up.	11/12/2024	>=azure-pipelines-2020

onSuccessOrFailureHook definition

:::moniker range=">=azure-pipelines-2020"

Used to run steps for rollback actions or clean-up.

:::moniker-end

:::moniker range=">=azure-pipelines-2020"

onSuccessOrFailureHook:
  failure: # Runs on failure of any step.
    steps: [ task | script | powershell | pwsh | bash | checkout | download | downloadBuild | getPackage | publish | template | reviewApp ] # A list of steps to run.
    pool: string | pool # Pool where post on failure steps will run.
  success: # Runs on success of all of the steps.
    steps: [ task | script | powershell | pwsh | bash | checkout | download | downloadBuild | getPackage | publish | template | reviewApp ] # A list of steps to run.
    pool: string | pool # Pool where on success steps will run.

:::moniker-end

:::moniker range=">=azure-pipelines-2020"

Note

This definition is a supporting definition and is not intended for use directly in a pipeline. This article provides the YAML syntax for this supporting type, but does not show usage examples. For more information on using the definitions that this type supports, see the following definition links.

Definitions that reference this definition: jobs.deployment.strategy.runOnce, jobs.deployment.strategy.rolling, jobs.deployment.strategy.canary

:::moniker-end

Properties

:::moniker range=">=azure-pipelines-2020"

failure onFailureHook.
Runs on failure of any step.

:::moniker-end

:::moniker range=">=azure-pipelines-2020"

success onSuccessHook.
Runs on success of all of the steps.

:::moniker-end