Skip to content
Proud to collaborate with Microsoft for Startups

runner.execution-sync-azure-vmss ​

Sync runner execution state from an Azure VM Scale Set.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-runners-azure
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_execution_uuiduuidYes—RunnerExecution this action operates on.
runner_group_uuiduuidNo—Runner group UUID; resolved from the execution when omitted.
organization_uuiduuidNo—Organization UUID; resolved from the execution when omitted.

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_execution_uuiduuidNo—RunnerExecution echoed from input.
runner_group_uuiduuidNo—Runner group UUID resolved for the execution.
organization_uuiduuidNo—Organization UUID resolved for the execution.
vmss_namestringNo—Scale set backing the runner group.
resource_groupstringNo—Resource group holding the scale set.
instance_refstringNo—Instance reference within the scale set that runs this execution.
instance_statestringNo—Provider power/provisioning state of the instance.
runner_execution_statusstringNo—Execution status after reconciliation.
instance_missingbooleanNo—True when the instance is gone from the scale set.
completed_atstringNo—ISO timestamp when the action finalised.
failed_atstringNo—ISO timestamp when the action failed.
failure_reasonstringNo—Populated only when the workflow ends in FAILED.
failure_typestringNo—Engine exception class.
failed_actionstringNo—Failed transition action.
failed_at_statestringNo—State where failure occurred.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Failed DAG layer if the engine supplies one.
errorstringNo—Error message.
error_typestringNo—Error class.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "runner.execution-sync-azure-vmss",
  "initial_data": {
    "runner_execution_uuid": "value"
  }
}