| title | description | ms.reviewer | ms.topic | ms.date |
|---|---|---|---|---|
.cancel operation command |
Learn how to use the `.cancel operation` command to cancel a long-running operation. |
odkadosh |
reference |
05/24/2023 |
This command cancels a long-running ingest from query operation. This command is useful when the operation is taking too long and you would like to abort it while running.
The cancel operation command isn't guaranteed to succeed. The output of the .cancel operation command indicates whether or not cancellation was successful.
Note
The cancel operation command is only supported for ingest from query commands, and not for canceling any other commands.
.cancel operation OperationId [with ( reason = ReasonPhrase )]
[!INCLUDE syntax-conventions-note]
| Name | Type | Required | Description |
|---|---|---|---|
| OperationId | guid |
✔️ | A guid of the operation ID returned from the running command. |
| ReasonPhrase | string |
The reason for canceling the running command. |
| Output parameter | Type | Description |
|---|---|---|
| OperationId | guid |
The operation ID of the operation that was canceled. |
| Operation | string |
The operation kind that was canceled. |
| StartedOn | datetime |
The start time of the operation that was canceled. |
| CancellationState | string |
Returns one of the following options: Cancelled successfully: the operation was canceled Cancel failed: the operation can't be canceled at this point. The operation may still be running or may have completed. |
| ReasonPhrase | string |
Reason why cancellation wasn't successful. |
.cancel operation 078b2641-f10d-4694-96f8-1ee2b75dda48 with(Reason="Command canceled by me")| OperationId | Operation | StartedOn | CancellationState | ReasonPhrase |
|---|---|---|---|---|
| c078b2641-f10d-4694-96f8-1ee2b75dda48 | TableSetOrAppend | 2022-07-18 09:03:55.1387320 | Canceled successfully | Command canceled by me |