Skip to content

Cancel pipeline run api #1782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sergey-shandar merged 2 commits into from
Oct 3, 2017
Merged

Cancel pipeline run api #1782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20e3e1f
Cancel pipeline run api
milantomic6 Oct 2, 2017
7ed6255
CR issues
milantomic6 Oct 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions ...on/datafactory/resource-manager/Microsoft.DataFactory/2017-09-01-preview/datafactory.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1770,6 +1770,48 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/cancelpipelinerun/{runId}": {
"post": {
"operationId": "Factories_CancelPipelineRun",
"x-ms-examples": {
"Factories_CancelPipelineRun": {
"$ref": "./examples/Factories_CancelPipelineRun.json"
}
},
"description": "Cancel a pipeline run by its run ID.",
"tags": [
"pipelineruns"
],
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"$ref": "#/parameters/factoryName"
},
{
"$ref": "#/parameters/runId"
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
Copy link
Copy Markdown
Member

@bgold09 bgold09 Oct 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if the pipeline run has already finished?

Copy link
Copy Markdown
Contributor Author

@milantomic6 milantomic6 Oct 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If pipeline run is in terminal state we return bad request.

"200": {
Copy link
Copy Markdown
Member

@bgold09 bgold09 Oct 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the user gets an OK response, does that mean the run has been cancelled? Or does it mean that we've started the process of cancelling it?

Copy link
Copy Markdown
Contributor Author

@milantomic6 milantomic6 Oct 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok means it is fully cancelled.

Copy link
Copy Markdown
Contributor

@sergey-shandar sergey-shandar Oct 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@milantomic6 could you add to description.

"description": "Pipeline run has been canceled successfully. "
},
"default": {
"description": "An error response received from the Azure Data Factory service.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers": {
"get": {
"tags": [
Expand Down
21 changes: 21 additions & 0 deletions ...anager/Microsoft.DataFactory/2017-09-01-preview/examples/Factories_CancelPipelineRun.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"parameters": {
"subscriptionId": "12345678-1234-1234-12345678abc",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"runId": "39692ed9-c722-4d33-b8e1-1f4a9deac57f",
"api-version": "2017-09-01-preview"
},
"responses": {
"200": {
"headers": {
"Date": "Mon, 02 Oct 2017 17:27:33 GMT",
"x-ms-request-id": "fd3867ea-c65c-470d-a17b-d83c8864cf90",
"X-Content-Type-Options": "nosniff",
"x-ms-ratelimit-remaining-subscription-writes": "1113",
"x-ms-correlation-request-id": "d0b45db5-c155-4991-95d9-22655c72c986"
},
"body": null
}
}
}