{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-functions/json-schema/microsoft-azure-functions-workflow-schema.json",
  "title": "Workflow",
  "description": "The workflow type.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-functions-workflows-api-openapi.yml#/components/schemas/Workflow",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/WorkflowProperties",
      "description": "The workflow properties.",
      "x-ms-client-flatten": true
    },
    "identity": {
      "$ref": "#/$defs/ManagedServiceIdentity",
      "description": "Managed service identity."
    }
  },
  "allOf": [
    {
      "$ref": "#/$defs/WorkflowResource"
    }
  ],
  "$defs": {
    "FlowAccessControlConfiguration": {
      "type": "object",
      "description": "The access control configuration.",
      "properties": {
        "triggers": {
          "$ref": "#/$defs/FlowAccessControlConfigurationPolicy",
          "description": "The access control configuration for invoking workflow triggers."
        },
        "contents": {
          "$ref": "#/$defs/FlowAccessControlConfigurationPolicy",
          "description": "The access control configuration for accessing workflow run contents."
        },
        "actions": {
          "$ref": "#/$defs/FlowAccessControlConfigurationPolicy",
          "description": "The access control configuration for workflow actions."
        },
        "workflowManagement": {
          "$ref": "#/$defs/FlowAccessControlConfigurationPolicy",
          "description": "The access control configuration for workflow management."
        }
      }
    },
    "FlowAccessControlConfigurationPolicy": {
      "type": "object",
      "description": "The access control configuration policy.",
      "properties": {
        "allowedCallerIpAddresses": {
          "type": "array",
          "description": "The allowed caller IP address ranges.",
          "items": {
            "$ref": "#/$defs/IpAddressRange"
          },
          "x-ms-identifiers": []
        },
        "openAuthenticationPolicies": {
          "$ref": "#/$defs/OpenAuthenticationAccessPolicies",
          "description": "The authentication policies for workflow."
        }
      }
    },
    "FlowEndpoints": {
      "type": "object",
      "description": "The flow endpoints configuration.",
      "properties": {
        "outgoingIpAddresses": {
          "type": "array",
          "description": "The outgoing ip address.",
          "items": {
            "$ref": "#/$defs/IpAddress"
          },
          "x-ms-identifiers": [
            "address"
          ]
        },
        "accessEndpointIpAddresses": {
          "type": "array",
          "description": "The access endpoint ip address.",
          "items": {
            "$ref": "#/$defs/IpAddress"
          },
          "x-ms-identifiers": [
            "address"
          ]
        }
      }
    },
    "FlowEndpointsConfiguration": {
      "type": "object",
      "description": "The endpoints configuration.",
      "properties": {
        "workflow": {
          "$ref": "#/$defs/FlowEndpoints",
          "description": "The workflow endpoints."
        },
        "connector": {
          "$ref": "#/$defs/FlowEndpoints",
          "description": "The connector endpoints."
        }
      }
    },
    "IpAddress": {
      "type": "object",
      "description": "The ip address.",
      "properties": {
        "address": {
          "type": "string",
          "description": "The address."
        }
      }
    },
    "IpAddressRange": {
      "type": "object",
      "description": "The ip address range.",
      "properties": {
        "addressRange": {
          "type": "string",
          "description": "The IP address range."
        }
      }
    },
    "Kind": {
      "type": "string",
      "description": "The workflow kind.",
      "enum": [
        "Stateful",
        "Stateless"
      ],
      "x-ms-enum": {
        "name": "Kind",
        "modelAsString": true,
        "values": [
          {
            "name": "Stateful",
            "value": "Stateful"
          },
          {
            "name": "Stateless",
            "value": "Stateless"
          }
        ]
      }
    },
    "ManagedServiceIdentity": {
      "type": "object",
      "description": "Managed service identity.",
      "properties": {
        "type": {
          "$ref": "#/$defs/ManagedServiceIdentityType",
          "description": "Type of managed service identity."
        },
        "tenantId": {
          "type": "string",
          "description": "Tenant of managed service identity.",
          "readOnly": true
        },
        "principalId": {
          "type": "string",
          "description": "Principal Id of managed service identity.",
          "readOnly": true
        },
        "userAssignedIdentities": {
          "type": "object",
          "description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
          "additionalProperties": {
            "$ref": "#/$defs/UserAssignedIdentity"
          }
        }
      }
    },
    "ManagedServiceIdentityType": {
      "type": "string",
      "description": "Type of managed service identity.",
      "enum": [
        "SystemAssigned",
        "UserAssigned",
        "SystemAssigned, UserAssigned",
        "None"
      ],
      "x-ms-enum": {
        "name": "ManagedServiceIdentityType",
        "modelAsString": false
      }
    },
    "OpenAuthenticationAccessPolicies": {
      "type": "object",
      "description": "AuthenticationPolicy of type Open.",
      "properties": {
        "policies": {
          "type": "object",
          "description": "Open authentication policies.",
          "additionalProperties": {
            "$ref": "#/$defs/OpenAuthenticationAccessPolicy"
          }
        }
      }
    },
    "OpenAuthenticationAccessPolicy": {
      "type": "object",
      "description": "Open authentication access policy defined by user.",
      "properties": {
        "type": {
          "$ref": "#/$defs/OpenAuthenticationProviderType",
          "description": "Type of provider for OAuth."
        },
        "claims": {
          "type": "array",
          "description": "The access policy claims.",
          "items": {
            "$ref": "#/$defs/OpenAuthenticationPolicyClaim"
          },
          "x-ms-identifiers": [
            "name"
          ]
        }
      }
    },
    "OpenAuthenticationPolicyClaim": {
      "type": "object",
      "description": "Open authentication policy claim.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the claim."
        },
        "value": {
          "type": "string",
          "description": "The value of the claim."
        }
      }
    },
    "OpenAuthenticationProviderType": {
      "type": "string",
      "description": "Open authentication policy provider type.",
      "enum": [
        "AAD"
      ],
      "x-ms-enum": {
        "name": "OpenAuthenticationProviderType",
        "modelAsString": true,
        "values": [
          {
            "name": "AAD",
            "value": "AAD"
          }
        ]
      }
    },
    "ParameterType": {
      "type": "string",
      "description": "The parameter type.",
      "enum": [
        "NotSpecified",
        "String",
        "SecureString",
        "Int",
        "Float",
        "Bool",
        "Array",
        "Object",
        "SecureObject"
      ],
      "x-ms-enum": {
        "name": "ParameterType",
        "modelAsString": true,
        "values": [
          {
            "name": "NotSpecified",
            "value": "NotSpecified"
          },
          {
            "name": "String",
            "value": "String"
          },
          {
            "name": "SecureString",
            "value": "SecureString"
          },
          {
            "name": "Int",
            "value": "Int"
          },
          {
            "name": "Float",
            "value": "Float"
          },
          {
            "name": "Bool",
            "value": "Bool"
          },
          {
            "name": "Array",
            "value": "Array"
          },
          {
            "name": "Object",
            "value": "Object"
          },
          {
            "name": "SecureObject",
            "value": "SecureObject"
          }
        ]
      }
    },
    "ResourceReference": {
      "type": "object",
      "description": "The resource reference.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The resource id."
        },
        "name": {
          "type": "string",
          "description": "Gets the resource name.",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "description": "Gets the resource type.",
          "readOnly": true
        }
      }
    },
    "UserAssignedIdentity": {
      "type": "object",
      "description": "User Assigned identity.",
      "properties": {
        "principalId": {
          "type": "string",
          "description": "Principal Id of user assigned identity",
          "readOnly": true
        },
        "clientId": {
          "type": "string",
          "description": "Client Id of user assigned identity",
          "readOnly": true
        }
      }
    },
    "WorkflowParameter": {
      "type": "object",
      "description": "The workflow parameters.",
      "properties": {
        "type": {
          "$ref": "#/$defs/ParameterType",
          "description": "The type."
        },
        "value": {
          "description": "The value."
        },
        "metadata": {
          "description": "The metadata."
        },
        "description": {
          "type": "string",
          "description": "The description."
        }
      }
    },
    "WorkflowProperties": {
      "type": "object",
      "description": "The workflow properties.",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/WorkflowProvisioningState",
          "description": "Gets the provisioning state.",
          "readOnly": true
        },
        "createdTime": {
          "type": "string",
          "format": "date-time",
          "description": "Gets the created time.",
          "readOnly": true
        },
        "changedTime": {
          "type": "string",
          "format": "date-time",
          "description": "Gets the changed time.",
          "readOnly": true
        },
        "state": {
          "$ref": "#/$defs/WorkflowState",
          "description": "The state."
        },
        "version": {
          "type": "string",
          "description": "Gets the version.",
          "readOnly": true
        },
        "accessEndpoint": {
          "type": "string",
          "description": "Gets the access endpoint.",
          "readOnly": true
        },
        "endpointsConfiguration": {
          "$ref": "#/$defs/FlowEndpointsConfiguration",
          "description": "The endpoints configuration."
        },
        "accessControl": {
          "$ref": "#/$defs/FlowAccessControlConfiguration",
          "description": "The access control configuration."
        },
        "sku": {
          "$ref": "#/$defs/WorkflowSku",
          "description": "The sku.",
          "readOnly": true
        },
        "integrationAccount": {
          "$ref": "#/$defs/ResourceReference",
          "description": "The integration account."
        },
        "integrationServiceEnvironment": {
          "$ref": "#/$defs/ResourceReference",
          "description": "The integration service environment."
        },
        "definition": {
          "description": "The definition."
        },
        "parameters": {
          "type": "object",
          "description": "The parameters.",
          "additionalProperties": {
            "$ref": "#/$defs/WorkflowParameter"
          }
        },
        "kind": {
          "$ref": "#/$defs/Kind",
          "description": "The workflow kind."
        }
      }
    },
    "WorkflowProvisioningState": {
      "type": "string",
      "description": "The workflow provisioning state.",
      "enum": [
        "NotSpecified",
        "Accepted",
        "Running",
        "Ready",
        "Creating",
        "Created",
        "Deleting",
        "Deleted",
        "Canceled",
        "Failed",
        "Succeeded",
        "Moving",
        "Updating",
        "Registering",
        "Registered",
        "Unregistering",
        "Unregistered",
        "Completed",
        "Renewing",
        "Pending",
        "Waiting",
        "InProgress"
      ],
      "x-ms-enum": {
        "name": "WorkflowProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "NotSpecified",
            "value": "NotSpecified"
          },
          {
            "name": "Accepted",
            "value": "Accepted"
          },
          {
            "name": "Running",
            "value": "Running"
          },
          {
            "name": "Ready",
            "value": "Ready"
          },
          {
            "name": "Creating",
            "value": "Creating"
          },
          {
            "name": "Created",
            "value": "Created"
          },
          {
            "name": "Deleting",
            "value": "Deleting"
          },
          {
            "name": "Deleted",
            "value": "Deleted"
          },
          {
            "name": "Canceled",
            "value": "Canceled"
          },
          {
            "name": "Failed",
            "value": "Failed"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded"
          },
          {
            "name": "Moving",
            "value": "Moving"
          },
          {
            "name": "Updating",
            "value": "Updating"
          },
          {
            "name": "Registering",
            "value": "Registering"
          },
          {
            "name": "Registered",
            "value": "Registered"
          },
          {
            "name": "Unregistering",
            "value": "Unregistering"
          },
          {
            "name": "Unregistered",
            "value": "Unregistered"
          },
          {
            "name": "Completed",
            "value": "Completed"
          },
          {
            "name": "Renewing",
            "value": "Renewing"
          },
          {
            "name": "Pending",
            "value": "Pending"
          },
          {
            "name": "Waiting",
            "value": "Waiting"
          },
          {
            "name": "InProgress",
            "value": "InProgress"
          }
        ]
      }
    },
    "WorkflowResource": {
      "type": "object",
      "description": "The base resource type.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The resource id.",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "Gets the resource name.",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "description": "Gets the resource type.",
          "readOnly": true
        },
        "location": {
          "type": "string",
          "description": "The resource location."
        },
        "tags": {
          "type": "object",
          "description": "The resource tags.",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "WorkflowSku": {
      "type": "object",
      "description": "The sku type.",
      "properties": {
        "name": {
          "$ref": "#/$defs/WorkflowSkuName",
          "description": "The name."
        },
        "plan": {
          "$ref": "#/$defs/ResourceReference",
          "description": "The reference to plan."
        }
      },
      "required": [
        "name"
      ]
    },
    "WorkflowSkuName": {
      "type": "string",
      "description": "The sku name.",
      "enum": [
        "NotSpecified",
        "Free",
        "Shared",
        "Basic",
        "Standard",
        "Premium"
      ],
      "x-ms-enum": {
        "name": "WorkflowSkuName",
        "modelAsString": true,
        "values": [
          {
            "name": "NotSpecified",
            "value": "NotSpecified"
          },
          {
            "name": "Free",
            "value": "Free"
          },
          {
            "name": "Shared",
            "value": "Shared"
          },
          {
            "name": "Basic",
            "value": "Basic"
          },
          {
            "name": "Standard",
            "value": "Standard"
          },
          {
            "name": "Premium",
            "value": "Premium"
          }
        ]
      }
    },
    "WorkflowState": {
      "type": "string",
      "description": "The workflow state.",
      "enum": [
        "NotSpecified",
        "Completed",
        "Enabled",
        "Disabled",
        "Deleted",
        "Suspended"
      ],
      "x-ms-enum": {
        "name": "WorkflowState",
        "modelAsString": true,
        "values": [
          {
            "name": "NotSpecified",
            "value": "NotSpecified"
          },
          {
            "name": "Completed",
            "value": "Completed"
          },
          {
            "name": "Enabled",
            "value": "Enabled"
          },
          {
            "name": "Disabled",
            "value": "Disabled"
          },
          {
            "name": "Deleted",
            "value": "Deleted"
          },
          {
            "name": "Suspended",
            "value": "Suspended"
          }
        ]
      }
    }
  }
}