BatchJobPreparationAndReleaseTaskStatusListResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-job-preparation-and-release-task-status-list-result-schema.json",
  "title": "BatchJobPreparationAndReleaseTaskStatusListResult",
  "description": "The result of listing the status of the Job Preparation and Job Release Tasks\nfor a Job.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-batch-jobs-api-openapi.yml#/components/schemas/BatchJobPreparationAndReleaseTaskStatusListResult",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "A list of Job Preparation and Job Release Task execution information.",
      "items": {
        "$ref": "#/$defs/BatchJobPreparationAndReleaseTaskStatus"
      }
    },
    "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."
          }
        ]
      }
    },
    "BatchJobPreparationAndReleaseTaskStatus": {
      "type": "object",
      "description": "The status of the Job Preparation and Job Release Tasks on a Compute Node.",
      "properties": {
        "poolId": {
          "type": "string",
          "description": "The ID of the Pool containing the Compute Node to which this entry refers."
        },
        "nodeId": {
          "type": "string",
          "description": "The ID of the Compute Node to which this entry refers."
        },
        "nodeUrl": {
          "type": "string",
          "format": "uri",
          "description": "The URL of the Compute Node to which this entry refers."
        },
        "jobPreparationTaskExecutionInfo": {
          "$ref": "#/$defs/BatchJobPreparationTaskExecutionInfo",
          "description": "Information about the execution status of the Job Preparation Task on this Compute Node."
        },
        "jobReleaseTaskExecutionInfo": {
          "$ref": "#/$defs/BatchJobReleaseTaskExecutionInfo",
          "description": "Information about the execution status of the Job Release Task on this Compute Node. This property is set only if the Job Release Task has run on the Compute Node."
        }
      }
    },
    "BatchJobPreparationTaskExecutionInfo": {
      "type": "object",
      "description": "Contains information about the execution of a Job Preparation Task on a Compute\nNode.",
      "properties": {
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running."
        },
        "endTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the Job Preparation Task completed. This property is set only if the Task is in the Completed state."
        },
        "state": {
          "$ref": "#/$defs/BatchJobPreparationTaskState",
          "description": "The current state of the Job Preparation Task on the Compute Node."
        },
        "taskRootDirectory": {
          "type": "string",
          "description": "The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files."
        },
        "taskRootDirectoryUrl": {
          "type": "string",
          "format": "uri",
          "description": "The URL to the root directory of the Job Preparation Task on the Compute Node."
        },
        "exitCode": {
          "type": "integer",
          "format": "int32",
          "description": "The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. 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. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated."
        },
        "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."
        },
        "retryCount": {
          "type": "integer",
          "format": "int32",
          "description": "The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints."
        },
        "lastRetryTime": {
          "type": "string",
          "format": "date-time",
          "description": "The most recent time at which a retry of the Job Preparation Task started running. This property is set only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not."
        },
        "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."
        }
      },
      "required": [
        "startTime",
        "state",
        "retryCount"
      ]
    },
    "BatchJobPreparationTaskState": {
      "type": "string",
      "description": "BatchJobPreparationTaskState enums",
      "enum": [
        "running",
        "completed"
      ],
      "x-ms-enum": {
        "name": "BatchJobPreparationTaskState",
        "modelAsString": true,
        "values": [
          {
            "name": "Running",
            "value": "running",
            "description": "The Task is currently running (including retrying)."
          },
          {
            "name": "Completed",
            "value": "completed",
            "description": "The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures)."
          }
        ]
      }
    },
    "BatchJobReleaseTaskExecutionInfo": {
      "type": "object",
      "description": "Contains information about the execution of a Job Release Task on a Compute\nNode.",
      "properties": {
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running."
        },
        "endTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the Job Release Task completed. This property is set only if the Task is in the Completed state."
        },
        "state": {
          "$ref": "#/$defs/BatchJobReleaseTaskState",
          "description": "The current state of the Job Release Task on the Compute Node."
        },
        "taskRootDirectory": {
          "type": "string",
          "description": "The root directory of the Job Release Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files."
        },
        "taskRootDirectoryUrl": {
          "type": "string",
          "format": "uri",
          "description": "The URL to the root directory of the Job Release Task on the Compute Node."
        },
        "exitCode": {
          "type": "integer",
          "format": "int32",
          "description": "The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. 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. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated."
        },
        "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."
        },
        "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."
        }
      },
      "required": [
        "startTime",
        "state"
      ]
    },
    "BatchJobReleaseTaskState": {
      "type": "string",
      "description": "BatchJobReleaseTaskState enums",
      "enum": [
        "running",
        "completed"
      ],
      "x-ms-enum": {
        "name": "BatchJobReleaseTaskState",
        "modelAsString": true,
        "values": [
          {
            "name": "Running",
            "value": "running",
            "description": "The Task is currently running (including retrying)."
          },
          {
            "name": "Completed",
            "value": "completed",
            "description": "The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures)."
          }
        ]
      }
    },
    "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."
        }
      }
    }
  }
}