Pipeline Run - Cancel Pipeline Run

Service:

Synapse

API Version:

2020-12-01

Cancel a pipeline run by its run ID.

POST {endpoint}/pipelineruns/{runId}/cancel?api-version=2020-12-01

With optional parameters:

POST {endpoint}/pipelineruns/{runId}/cancel?isRecursive={isRecursive}&api-version=2020-12-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.
runId	path	True	string	The pipeline run identifier.
api-version	query	True	string	The Synapse client 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	CloudError	An error response received from the Azure Synapse service.

Examples

PipelineRuns_Cancel

Sample request

HTTP

POST exampleWorkspace.dev.azuresynapse.net/pipelineruns/16ac5348-ff82-4f95-a80d-638c1d47b721/cancel?api-version=2020-12-01

Sample response

Status code:

200

Definitions

CloudError

Object

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

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.