Skip to content
Proud to collaborate with Microsoft for Startups

runner.execution-stop-azure-vm ​

Stop a runner execution on an Azure VM

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners-azure
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_execution_uuiduuidYes—Execution UUID to stop
runner_group_uuiduuidNo—Runner group UUID
organization_uuiduuidNo—Organization UUID
reasonstringNo—Optional stop reason

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_execution_uuidstringNo—UUID of the RunnerExecution this action operates on, echoed onto workflow state; picked from the organization's (optionally group-scoped) list of executions.
runner_group_uuidstringNo—UUID of the RunnerGroup this action operates on, echoed onto workflow state; picked from the organization's list of runner groups.
organization_uuidstringNo—UUID of the caller's organization, echoed onto workflow state; injected server-side from the authenticated request.
completed_atstringNo——
failed_atstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—stop_execution—
stopping_executionNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedstop_executionstopping_execution—
stopping_executioncompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "runner.execution-stop-azure-vm",
  "initial_data": {
    "runner_execution_uuid": "value"
  }
}