Define Workflow Variables

Workflow variables are used as placeholders to share data between the execution steps of the workflow. Input parameters are copied as variables at the beginning of the workflow execution. After a workflow step is run, output parameters can be copied to the workflow variables and used as inputs for other workflow steps.

Note: A workflow attribute must not have the same name as a workflow parameter.

Variable Example

{
    "name": "vmName",
    "description": "The description of the variable",
    "type": "string"
}

Variable Schema

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "http://example.com/example.json",
    "type": "object",
    "readOnly": false,
    "writeOnly": false,
    "minProperties": 0,
    "title": "The Root Schema",
    "description": "The root schema comprises the entire JSON document.",
    "additionalProperties": true,
    "required": [
        "name",
        "description",
        "type"
    ],
    "properties": {
        "name": {
            "$id": "#/properties/name",
            "type": "string",
            "readOnly": false,
            "writeOnly": false,
            "minLength": 0,
            "title": "The Name Schema",
            "description": "An explanation about the purpose of this instance.",
            "default": "",
            "examples": [
                "vmName"
            ]
        },
        "description": {
            "$id": "#/properties/description",
            "type": "string",
            "readOnly": false,
            "writeOnly": false,
            "minLength": 0,
            "title": "The Description Schema",
            "description": "An explanation about the purpose of this instance.",
            "default": "",
            "examples": [
                "The description of the variable"
            ]
        },
        "type": {
            "$id": "#/properties/type",
            "type": "string",
            "readOnly": false,
            "writeOnly": false,
            "minLength": 0,
            "title": "The Type Schema",
            "description": "An explanation about the purpose of this instance.",
            "default": "",
            "examples": [
                "string",
                "number",
                "boolean"
            ]
        }
    }
}