Pipeline Runs - Cancel

Cancel a pipeline run by its run ID.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel?api-version=2018-06-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/cancel?isRecursive={isRecursive}&api-version=2018-06-01

URI Parameters

Name In Required Type Description
factoryName
path True
  • string

The factory name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True
  • string

The resource group name.

Regex pattern: ^[-\w\._\(\)]+$

runId
path True
  • string

The pipeline run identifier.

subscriptionId
path True
  • string

The subscription identifier.

api-version
query True
  • string

The API version.

isRecursive
query
  • boolean

If true, cancel all the Child pipelines that are triggered by the current pipeline.

Responses

Name Type Description
200 OK

Pipeline run has been canceled successfully.

Other Status Codes

An error response received from the Azure Data Factory service.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

PipelineRuns_Cancel

Sample Request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelineruns/16ac5348-ff82-4f95-a80d-638c1d47b721/cancel?api-version=2018-06-01

Sample Response

Definitions

CloudError

The object that defines the structure of an Azure Data Factory error response.

Name Type Description
error.code
  • string

Error code.

error.details

Array with additional error details.

error.message
  • string

Error message.

error.target
  • string

Property name/path in request associated with error.