Skip to content
Proud to collaborate with Microsoft for Startups

runner.execution-launch-azure-vm ​

Launch one runner execution on an Azure Virtual Machine

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-runners-azure
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—Runner group UUID
organization_uuiduuidNo—Organization UUID
runner_execution_uuiduuidNo—Existing execution UUID to reuse
commandjsonNo—Command to run (generic mode)
environmentdictNo—Extra environment variables for the runner. Marked sensitive so SensitiveDataMiddleware vaults the map instead of persisting it in cleartext state_data (SECRET-HANDLING-001). Two residual exposures remain, so avoid credentials here: the value reaches the VM custom-data payload, and the outbound scheduled-transition/Kafka input_data copy still carries cleartext until the engine's input_data redaction writer is enabled. Key Vault-backed secret env for VM runners is still not wired up.
github_workflow_run_refintegerNo—GitHub Actions run id for correlation; sent by runner.dispatch-from-job-queued on the legacy direct-launch path.
actor_uuidstringNo—Actor attribution forwarded by the dispatcher; audit-only.

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.
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.
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—prepare—
getting_registration_tokenNoNo—launch_execution—
launching_executionNoNo—complete—
preparingNoNo—get_registration_token—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedpreparepreparing—
preparingget_registration_tokengetting_registration_token—
getting_registration_tokenlaunch_executionlaunching_execution—
launching_executioncompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "runner.execution-launch-azure-vm",
  "initial_data": {
    "runner_group_uuid": "value"
  }
}