runner.execution-launch-azure-vmss-generic ​
Launch one generic command execution on an Azure VM Scale Set.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-runners-azure |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | Runner group UUID; resolved from the execution when omitted. |
organization_uuid | uuid | No | — | Organization UUID; resolved from the execution when omitted. |
runner_execution_uuid | uuid | No | — | Existing execution UUID to reuse; created when omitted. |
command | string | Yes | — | Command to run on the instance. |
environment | json | No | — | 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 ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_execution_uuid | uuid | No | — | RunnerExecution echoed from input. |
runner_group_uuid | uuid | No | — | Runner group UUID resolved for the execution. |
organization_uuid | uuid | No | — | Organization UUID resolved for the execution. |
vmss_name | string | No | — | Scale set backing the runner group. |
resource_group | string | No | — | Resource group holding the scale set. |
instance_ref | string | No | — | Instance reference within the scale set that runs this execution. |
provider_execution_ref | string | No | — | Provider-side reference for the launched execution. |
completed_at | string | No | — | ISO timestamp when the action finalised. |
failed_at | string | No | — | ISO timestamp when the action failed. |
failure_reason | string | No | — | Populated only when the workflow ends in FAILED. |
failure_type | string | No | — | Engine exception class. |
failed_action | string | No | — | Failed transition action. |
failed_at_state | string | No | — | State where failure occurred. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Failed DAG layer if the engine supplies one. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | prepare | — |
launching_execution | No | No | — | complete | — |
preparing | No | No | — | launch_execution | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | prepare | preparing | — |
preparing | launch_execution | launching_execution | — |
launching_execution | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.execution-launch-azure-vmss-generic",
"initial_data": {
"command": "value"
}
}