Skip to content
Proud to collaborate with Microsoft for Startups

runner.execution-launch-azure-vmss-generic ​

Launch one generic command execution on an Azure VM Scale Set.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners-azure
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—Runner group UUID; resolved from the execution when omitted.
organization_uuiduuidNo—Organization UUID; resolved from the execution when omitted.
runner_execution_uuiduuidNo—Existing execution UUID to reuse; created when omitted.
commandstringYes—Command to run on the instance.
environmentjsonNo—Environment variables for the execution. Vaulted by the engine (persisted state_data holds a [VAULT:...] reference). Do not pass long-lived credentials here — bind them by reference through secret_environment instead.

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.
provider_execution_refstringNo—Provider-side reference for the launched execution.
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—prepare—
launching_executionNoNo—complete—
preparingNoNo—launch_execution—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedpreparepreparing—
preparinglaunch_executionlaunching_execution—
launching_executioncompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "runner.execution-launch-azure-vmss-generic",
  "initial_data": {
    "command": "value"
  }
}