cluster.status-azure-vm ​
Return provider status for a Azure VM-backed Kubernetes cluster.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-clusters-azure |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID for audit/tenant context. |
provider_connection_uuid | uuid | Yes | — | Azure CloudConnection UUID. |
provider_cluster_ref | string | Yes | — | VM name or provider resource ID backing the cluster. |
resource_group | string | No | — | Explicit Azure subscription override. |
zone | string | Yes | — | Azure region for the VM. |
actor | string | No | — | Caller requesting status. |
timeout_seconds | integer | No | — | Reserved for future polling status reads. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Organization UUID echoed from input. |
provider_connection_uuid | uuid | No | — | Azure CloudConnection UUID. |
provider_cluster_ref | string | No | — | VM resource ref. |
describe_vm | json | No | — | Output from azure.compute.vm.describe. |
provider_status | json | No | — | Normalized provider status object. |
resource_group | string | No | — | Resolved Azure subscription. |
vm_name | string | No | — | VM instance name. |
status | string | No | — | Normalized lifecycle status. |
phase | string | No | — | Raw GCE VM status. |
reachable | boolean | No | — | True when the backing VM is running. |
private_ip | string | No | — | VM private IP. |
public_ip | string | No | — | VM public IP if present. |
checked_at | string | No | — | ISO status timestamp. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | string | No | — | Failed logical step or child workflow. |
failed_layer | json | No | — | Engine failed layer if applicable. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
failed_at | string | No | — | ISO failure timestamp. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | describe_vm | — |
describing_vm | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | describe_vm | describing_vm | — |
describing_vm | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "cluster.status-azure-vm",
"initial_data": {
"organization_uuid": "value",
"provider_connection_uuid": "value",
"provider_cluster_ref": "value",
"zone": "value"
}
}