Skip to content
Proud to collaborate with Microsoft for Startups

cluster.status-azure-vm ​

Return provider status for a Azure VM-backed Kubernetes cluster.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-clusters-azure
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID for audit/tenant context.
provider_connection_uuiduuidYes—Azure CloudConnection UUID.
provider_cluster_refstringYes—VM name or provider resource ID backing the cluster.
resource_groupstringNo—Explicit Azure subscription override.
zonestringYes—Azure region for the VM.
actorstringNo—Caller requesting status.
timeout_secondsintegerNo—Reserved for future polling status reads.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input.
provider_connection_uuiduuidNo—Azure CloudConnection UUID.
provider_cluster_refstringNo—VM resource ref.
describe_vmjsonNo—Output from azure.compute.vm.describe.
provider_statusjsonNo—Normalized provider status object.
resource_groupstringNo—Resolved Azure subscription.
vm_namestringNo—VM instance name.
statusstringNo—Normalized lifecycle status.
phasestringNo—Raw GCE VM status.
reachablebooleanNo—True when the backing VM is running.
private_ipstringNo—VM private IP.
public_ipstringNo—VM public IP if present.
checked_atstringNo—ISO status timestamp.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step or child workflow.
failed_layerjsonNo—Engine failed layer if applicable.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—describe_vm—
describing_vmNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingdescribe_vmdescribing_vm—
describing_vmcompletecompleted—
* (any state)failfailed—

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"
  }
}