Skip to content
Proud to collaborate with Microsoft for Startups

runner.execution-restart-azure-vm ​

Restart 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 restart
runner_group_uuiduuidNo—Runner group UUID
organization_uuiduuidNo—Organization UUID

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuidstringNo—UUID of the RunnerGroup this action operates on, echoed onto workflow state; picked from the organization's list of runner groups.
old_runner_execution_uuidstringNo—UUID of the RunnerExecution stopped/replaced during this restart; output-only echo, never a caller input.
new_runner_execution_uuidstringNo—UUID of the replacement RunnerExecution created by this restart; output-only echo, never a caller input.
registration_tokenstringNo—Ephemeral provider runner-registration token. Marked sensitive so SensitiveDataMiddleware vaults it instead of persisting it in cleartext state_data (SECRET-HANDLING-001).
provider_execution_refstringNo——
completed_atstringNo——
failed_atstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—load_execution—
getting_registration_tokenNoNo—launch_replacement—
launching_replacementNoNo—complete—
loading_executionNoNo—stop_old_execution—
stopping_old_executionNoNo—get_registration_token—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedload_executionloading_execution—
loading_executionstop_old_executionstopping_old_execution—
stopping_old_executionget_registration_tokengetting_registration_token—
getting_registration_tokenlaunch_replacementlaunching_replacement—
launching_replacementcompletecompleted—
* (any state)failfailed—

API Usage ​

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

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