BatchTaskListSubtasksResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-task-list-subtasks-result-schema.json",
  "title": "BatchTaskListSubtasksResult",
  "description": "The result of listing the subtasks of a Task.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-batch-tasks-api-openapi.yml#/components/schemas/BatchTaskListSubtasksResult",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The list of subtasks.",
      "items": {
        "$ref": "#/$defs/BatchSubtask"
      }
    },
    "odata.nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The URL to get the next set of results."
    }
  },
  "$defs": {
    "BatchErrorSourceCategory": {
      "type": "string",
      "description": "BatchErrorSourceCategory enums",
      "enum": [
        "usererror",
        "servererror"
      ],
      "x-ms-enum": {
        "name": "BatchErrorSourceCategory",
        "modelAsString": true,
        "values": [
          {
            "name": "UserError",
            "value": "usererror",
            "description": "The error is due to a user issue, such as misconfiguration."
          },
          {
            "name": "ServerError",
            "value": "servererror",
            "description": "The error is due to an internal server issue."
          }
        ]
      }
    },
    "BatchNodeInfo": {
      "type": "object",
      "description": "Information about the Compute Node on which a Task ran.",
      "properties": {
        "affinityId": {
          "type": "string",
          "description": "An identifier for the Node on which the Task ran, which can be passed when adding a Task to request that the Task be scheduled on this Compute Node."
        },
        "nodeUrl": {
          "type": "string",
          "format": "uri",
          "description": "The URL of the Compute Node on which the Task ran."
        },
        "poolId": {
          "type": "string",
          "description": "The ID of the Pool on which the Task ran."
        },
        "nodeId": {
          "type": "string",
          "description": "The ID of the Compute Node on which the Task ran."
        },
        "taskRootDirectory": {
          "type": "string",
          "description": "The root directory of the Task on the Compute Node."
        },
        "taskRootDirectoryUrl": {
          "type": "string",
          "format": "uri",
          "description": "The URL to the root directory of the Task on the Compute Node."
        }
      }
    },
    "BatchSubtask": {
      "type": "object",
      "description": "Information about an Azure Batch subtask.",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32",
          "description": "The ID of the subtask."
        },
        "nodeInfo": {
          "$ref": "#/$defs/BatchNodeInfo",
          "description": "Information about the Compute Node on which the subtask ran."
        },
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running."
        },
        "endTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the subtask completed. This property is set only if the subtask is in the Completed state."
        },
        "exitCode": {
          "type": "integer",
          "format": "int32",
          "description": "The exit code of the program specified on the subtask command line. This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code."
        },
        "containerInfo": {
          "$ref": "#/$defs/BatchTaskContainerExecutionInfo",
          "description": "Information about the container under which the Task is executing. This property is set only if the Task runs in a container context."
        },
        "failureInfo": {
          "$ref": "#/$defs/BatchTaskFailureInfo",
          "description": "Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure."
        },
        "state": {
          "$ref": "#/$defs/BatchSubtaskState",
          "description": "The current state of the subtask."
        },
        "stateTransitionTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the subtask entered its current state."
        },
        "previousState": {
          "$ref": "#/$defs/BatchSubtaskState",
          "description": "The previous state of the subtask. This property is not set if the subtask is in its initial running state."
        },
        "previousStateTransitionTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state."
        },
        "result": {
          "$ref": "#/$defs/BatchTaskExecutionResult",
          "description": "The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property."
        }
      }
    },
    "BatchSubtaskState": {
      "type": "string",
      "description": "BatchSubtaskState enums",
      "enum": [
        "preparing",
        "running",
        "completed"
      ],
      "x-ms-enum": {
        "name": "BatchSubtaskState",
        "modelAsString": true,
        "values": [
          {
            "name": "Preparing",
            "value": "preparing",
            "description": "The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node."
          },
          {
            "name": "Running",
            "value": "running",
            "description": "The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing."
          },
          {
            "name": "Completed",
            "value": "completed",
            "description": "The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated."
          }
        ]
      }
    },
    "BatchTaskContainerExecutionInfo": {
      "type": "object",
      "description": "Contains information about the container which a Task is executing.",
      "properties": {
        "containerId": {
          "type": "string",
          "description": "The ID of the container."
        },
        "state": {
          "type": "string",
          "description": "The state of the container. This is the state of the container according to the Docker service. It is equivalent to the status field returned by \"docker inspect\"."
        },
        "error": {
          "type": "string",
          "description": "Detailed error information about the container. This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by \"docker inspect\"."
        }
      }
    },
    "BatchTaskExecutionResult": {
      "type": "string",
      "description": "BatchTaskExecutionResult enums",
      "enum": [
        "success",
        "failure"
      ],
      "x-ms-enum": {
        "name": "BatchTaskExecutionResult",
        "modelAsString": true,
        "values": [
          {
            "name": "Success",
            "value": "success",
            "description": "The Task ran successfully."
          },
          {
            "name": "Failure",
            "value": "failure",
            "description": "There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited."
          }
        ]
      }
    },
    "BatchTaskFailureInfo": {
      "type": "object",
      "description": "Information about a Task failure.",
      "properties": {
        "category": {
          "$ref": "#/$defs/BatchErrorSourceCategory",
          "description": "The category of the Task error."
        },
        "code": {
          "type": "string",
          "description": "An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically."
        },
        "message": {
          "type": "string",
          "description": "A message describing the Task error, intended to be suitable for display in a user interface."
        },
        "details": {
          "type": "array",
          "description": "A list of additional details related to the error.",
          "items": {
            "$ref": "#/$defs/NameValuePair"
          }
        }
      },
      "required": [
        "category"
      ]
    },
    "NameValuePair": {
      "type": "object",
      "description": "Represents a name-value pair.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name in the name-value pair."
        },
        "value": {
          "type": "string",
          "description": "The value in the name-value pair."
        }
      }
    }
  }
}