BatchJobListResult

The result of listing the Jobs in an Account.

BatchComputeJob SchedulingHigh Performance ComputingCloudMicrosoftMicrosoft AzureParallel ProcessingSchedulingInfrastructure

Properties

Name Type Description
value array The list of Jobs.
odata.nextLink string The URL to get the next set of results.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-batch-batch-job-list-result-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-job-list-result-schema.json",
  "title": "BatchJobListResult",
  "description": "The result of listing the Jobs in an Account.",
  "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/BatchJobListResult",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The list of Jobs.",
      "items": {
        "$ref": "#/$defs/BatchJob"
      }
    },
    "odata.nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The URL to get the next set of results."
    }
  },
  "$defs": {
    "AutoUserScope": {
      "type": "string",
      "description": "AutoUserScope enums",
      "enum": [
        "task",
        "pool"
      ],
      "x-ms-enum": {
        "name": "AutoUserScope",
        "modelAsString": true,
        "values": [
          {
            "name": "Task",
            "value": "task",
            "description": "Specifies that the service should create a new user for the Task."
          },
          {
            "name": "Pool",
            "value": "pool",
            "description": "Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool."
          }
        ]
      }
    },
    "AutoUserSpecification": {
      "type": "object",
      "description": "Specifies the options for the auto user that runs an Azure Batch Task.",
      "properties": {
        "scope": {
          "$ref": "#/$defs/AutoUserScope",
          "description": "The scope for the auto user. The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks."
        },
        "elevationLevel": {
          "$ref": "#/$defs/ElevationLevel",
          "description": "The elevation level of the auto user. The default value is nonAdmin."
        }
      }
    },
    "AutomaticOsUpgradePolicy": {
      "type": "object",
      "description": "The configuration parameters used for performing automatic OS upgrade.",
      "properties": {
        "disableAutomaticRollback": {
          "type": "boolean",
          "description": "Whether OS image rollback feature should be disabled."
        },
        "enableAutomaticOSUpgrade": {
          "type": "boolean",
          "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br /><br /> If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pools/create-pool#windowsconfiguration) cannot be set to true.",
          "x-ms-client-name": "enableAutomaticOsUpgrade"
        },
        "useRollingUpgradePolicy": {
          "type": "boolean",
          "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS."
        },
        "osRollingUpgradeDeferral": {
          "type": "boolean",
          "description": "Defer OS upgrades on the TVMs if they are running tasks."
        }
      }
    },
    "Azure.Core.eTag": {
      "type": "string",
      "description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.\nIt lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.\n\nIt is a string of ASCII characters placed between double quotes, like \"675af34563dc-tr34\"."
    },
    "AzureBlobFileSystemConfiguration": {
      "type": "object",
      "description": "Information used to connect to an Azure Storage Container using Blobfuse.",
      "properties": {
        "accountName": {
          "type": "string",
          "description": "The Azure Storage Account name."
        },
        "containerName": {
          "type": "string",
          "description": "The Azure Blob Storage Container name."
        },
        "accountKey": {
          "type": "string",
          "format": "password",
          "description": "The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified.",
          "x-ms-secret": true
        },
        "sasKey": {
          "type": "string",
          "format": "password",
          "description": "The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified.",
          "x-ms-secret": true
        },
        "blobfuseOptions": {
          "type": "string",
          "description": "Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux."
        },
        "relativeMountPath": {
          "type": "string",
          "description": "The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable."
        },
        "identityReference": {
          "$ref": "#/$defs/BatchNodeIdentityReference",
          "description": "The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified."
        }
      },
      "required": [
        "accountName",
        "containerName",
        "relativeMountPath"
      ]
    },
    "AzureFileShareConfiguration": {
      "type": "object",
      "description": "Information used to connect to an Azure Fileshare.",
      "properties": {
        "accountName": {
          "type": "string",
          "description": "The Azure Storage account name."
        },
        "accountKey": {
          "type": "string",
          "format": "password",
          "description": "The Azure Storage account key.",
          "x-ms-secret": true
        },
        "azureFileUrl": {
          "type": "string",
          "format": "uri",
          "description": "The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'."
        },
        "relativeMountPath": {
          "type": "string",
          "description": "The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable."
        },
        "mountOptions": {
          "type": "string",
          "description": "Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux."
        }
      },
      "required": [
        "accountName",
        "accountKey",
        "azureFileUrl",
        "relativeMountPath"
      ]
    },
    "BatchAllTasksCompleteMode": {
      "type": "string",
      "description": "The action the Batch service should take when all Tasks in the Job are in the completed state.",
      "enum": [
        "noaction",
        "terminatejob"
      ],
      "x-ms-enum": {
        "name": "BatchAllTasksCompleteMode",
        "modelAsString": true,
        "values": [
          {
            "name": "NoAction",
            "value": "noaction",
            "description": "Do nothing. The Job remains active unless terminated or disabled by some other means."
          },
          {
            "name": "TerminateJob",
            "value": "terminatejob",
            "description": "Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'."
          }
        ]
      }
    },
    "BatchApplicationPackageReference": {
      "type": "object",
      "description": "A reference to an Package to be deployed to Compute Nodes.",
      "properties": {
        "applicationId": {
          "type": "string",
          "description": "The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName})."
        },
        "version": {
          "type": "string",
          "description": "The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error."
        }
      },
      "required": [
        "applicationId"
      ]
    },
    "BatchAutoPoolSpecification": {
      "type": "object",
      "description": "Specifies characteristics for a temporary 'auto pool'. The Batch service will\ncreate this auto Pool when the Job is submitted.",
      "properties": {
        "autoPoolIdPrefix": {
          "type": "string",
          "description": "A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long."
        },
        "poolLifetimeOption": {
          "$ref": "#/$defs/BatchPoolLifetimeOption",
          "description": "The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools."
        },
        "keepAlive": {
          "type": "boolean",
          "description": "Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option."
        },
        "pool": {
          "$ref": "#/$defs/BatchPoolSpecification",
          "description": "The Pool specification for the auto Pool."
        }
      },
      "required": [
        "poolLifetimeOption"
      ]
    },
    "BatchContainerConfiguration": {
      "type": "object",
      "description": "The configuration for container-enabled Pools.",
      "properties": {
        "type": {
          "$ref": "#/$defs/ContainerType",
          "description": "The container technology to be used."
        },
        "containerImageNames": {
          "type": "array",
          "description": "The collection of container Image names. This is the full Image reference, as would be specified to \"docker pull\". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry.",
          "items": {
            "type": "string"
          }
        },
        "containerRegistries": {
          "type": "array",
          "description": "Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.",
          "items": {
            "$ref": "#/$defs/ContainerRegistryReference"
          }
        }
      },
      "required": [
        "type"
      ]
    },
    "BatchDiffDiskSettings": {
      "type": "object",
      "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the\ncompute node (VM).",
      "properties": {
        "placement": {
          "$ref": "#/$defs/DiffDiskPlacement",
          "description": "Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements."
        }
      }
    },
    "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."
          }
        ]
      }
    },
    "BatchInboundNatPool": {
      "type": "object",
      "description": "A inbound NAT Pool that can be used to address specific ports on Compute Nodes\nin a Batch Pool externally.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters.  If any invalid values are provided the request fails with HTTP status code 400."
        },
        "protocol": {
          "$ref": "#/$defs/InboundEndpointProtocol",
          "description": "The protocol of the endpoint."
        },
        "backendPort": {
          "type": "integer",
          "format": "int32",
          "description": "The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400."
        },
        "frontendPortRangeStart": {
          "type": "integer",
          "format": "int32",
          "description": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400."
        },
        "frontendPortRangeEnd": {
          "type": "integer",
          "format": "int32",
          "description": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400."
        },
        "networkSecurityGroupRules": {
          "type": "array",
          "description": "A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.",
          "items": {
            "$ref": "#/$defs/NetworkSecurityGroupRule"
          }
        }
      },
      "required": [
        "name",
        "protocol",
        "backendPort",
        "frontendPortRangeStart",
        "frontendPortRangeEnd"
      ]
    },
    "BatchJob": {
      "type": "object",
      "description": "An Azure Batch Job.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).",
          "readOnly": true
        },
        "displayName": {
          "type": "string",
          "description": "The display name for the Job.",
          "readOnly": true
        },
        "usesTaskDependencies": {
          "type": "boolean",
          "description": "Whether Tasks in the Job can define dependencies on each other. The default is false.",
          "readOnly": true
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "The URL of the Job.",
          "readOnly": true
        },
        "eTag": {
          "$ref": "#/$defs/Azure.Core.eTag",
          "description": "The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime.",
          "readOnly": true
        },
        "lastModified": {
          "type": "string",
          "format": "date-time",
          "description": "The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state.",
          "readOnly": true
        },
        "creationTime": {
          "type": "string",
          "format": "date-time",
          "description": "The creation time of the Job.",
          "readOnly": true
        },
        "state": {
          "$ref": "#/$defs/BatchJobState",
          "description": "The current state of the Job.",
          "readOnly": true
        },
        "stateTransitionTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the Job entered its current state.",
          "readOnly": true
        },
        "previousState": {
          "$ref": "#/$defs/BatchJobState",
          "description": "The previous state of the Job. This property is not set if the Job is in its initial Active state.",
          "readOnly": true
        },
        "previousStateTransitionTime": {
          "type": "string",
          "format": "date-time",
          "description": "The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state.",
          "readOnly": true
        },
        "priority": {
          "type": "integer",
          "format": "int32",
          "description": "The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0."
        },
        "allowTaskPreemption": {
          "type": "boolean",
          "description": "Whether Tasks in this job can be preempted by other high priority jobs. (This property is not available by default. Please contact support for more information) If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API."
        },
        "maxParallelTasks": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum number of tasks that can be executed in parallel for the job. (This property is not available by default. Please contact support for more information) The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API.",
          "default": -1
        },
        "constraints": {
          "$ref": "#/$defs/BatchJobConstraints",
          "description": "The execution constraints for the Job."
        },
        "jobManagerTask": {
          "$ref": "#/$defs/BatchJobManagerTask",
          "description": "Details of a Job Manager Task to be launched when the Job is started.",
          "readOnly": true
        },
        "jobPreparationTask": {
          "$ref": "#/$defs/BatchJobPreparationTask",
          "description": "The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job.",
          "readOnly": true
        },
        "jobReleaseTask": {
          "$ref": "#/$defs/BatchJobReleaseTask",
          "description": "The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job.",
          "readOnly": true
        },
        "commonEnvironmentSettings": {
          "type": "array",
          "description": "The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.",
          "items": {
            "$ref": "#/$defs/EnvironmentSetting"
          },
          "readOnly": true
        },
        "poolInfo": {
          "$ref": "#/$defs/BatchPoolInfo",
          "description": "The Pool settings associated with the Job."
        },
        "onAllTasksComplete": {
          "$ref": "#/$defs/BatchAllTasksCompleteMode",
          "description": "The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction.",
          "x-ms-client-name": "allTasksCompleteMode"
        },
        "onTaskFailure": {
          "$ref": "#/$defs/BatchTaskFailureMode",
          "description": "The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.",
          "readOnly": true,
          "x-ms-client-name": "taskFailureMode"
        },
        "networkConfiguration": {
          "$ref": "#/$defs/BatchJobNetworkConfiguration",
          "description": "(This property is not available by default. Please contact support for more information) The network configuration for the Job.",
          "readOnly": true
        },
        "metadata": {
          "type": "array",
          "description": "A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.",
          "items": {
            "$ref": "#/$defs/BatchMetadataItem"
          }
        },
        "executionInfo": {
          "$ref": "#/$defs/BatchJobExecutionInfo",
          "description": "The execution information for the Job.",
          "readOnly": true
        },
        "stats": {
          "$ref": "#/$defs/BatchJobStatistics",
          "description": "Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.",
          "readOnly": true,
          "x-ms-client-name": "jobStatistics"
        }
      },
      "required": [
        "id",
        "url",
        "eTag",
        "lastModified",
        "creationTime",
        "state",
        "stateTransitionTime",
        "poolInfo"
      ]
    },
    "BatchJobConstraints": {
      "type": "object",
      "description": "The execution constraints for a Job.",
      "properties": {
        "maxWallClockTime": {
          "type": "string",
          "format": "duration",
          "description": "The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. The time duration is specified in ISO 8601 format."
        },
        "maxTaskRetryCount": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries)."
        }
      }
    },
    "BatchJobExecutionInfo": {
      "type": "object",
      "description": "Contains information about the execution of a Job in the Azure Batch service.",
      "properties": {
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "The start time of the Job. This is the time at which the Job was created."
        },
        "endTime": {
          "type": "string",
          "format": "date-time",
          "description": "The completion time of the Job. This property is set only if the Job is in the completed state."
        },
        "poolId": {
          "type": "string",
          "description": "The ID of the Pool to which this Job is assigned. This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool."
        },
        "schedulingError": {
          "$ref": "#/$defs/BatchJobSchedulingError",
          "description": "Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting the Job."
        },
        "terminateReason": {
          "type": "string",
          "description": "A string describing the reason the Job ended. This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a Job' operation.",
          "x-ms-client-name": "terminationReason"
        }
      },
      "required": [
        "startTime"
      ]
    },
    "BatchJobManagerTask": {
      "type": "object",
      "description": "Specifies details of a Job Manager Task.\nThe Job Manager Task is automatically started when the Job is created. The\nBatch service tries to schedule the Job Manager Task before any other Tasks in\nthe Job. When shrinking a Pool, the Batch service tries to preserve Nodes where\nJob Manager Tasks are running for as long as possible (that is, Compute Nodes\nrunning 'normal' Tasks are removed before Compute Nodes running Job Manager\nTasks). When a Job Manager Task fails and needs to be restarted, the system\ntries to schedule it at the highest priority. If there are no idle Compute\nNodes available, the system may terminate one of the running Tasks in the Pool\nand return it to the queue in order to make room for the Job Manager Task to\nrestart. Note that a Job Manager Task in one Job does not have priority over\nTasks in other Jobs. Across Jobs, only Job level priorities are observed. For\nexample, if a Job Manager in a priority 0 Job needs to be restarted, it will\nnot displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery\noperation is triggered on a Node. Examples of recovery operations include (but\nare not limited to) when an unhealthy Node is rebooted or a Compute Node\ndisappeared due to host failure. Retries due to recovery operations are\nindependent of and are not counted against the maxTaskRetryCount. Even if the\nmaxTaskRetryCount is 0, an internal retry due to a recovery operation may\noccur. Because of this, all Tasks should be idempotent. This means Tasks need\nto tolerate being interrupted and restarted without causing any corruption or\nduplicate data. The best practice for long running Tasks is to use some form of\ncheckpointing.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024."
        },
        "commandLine": {
          "type": "string",
          "description": "The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables)."
        },
        "containerSettings": {
          "$ref": "#/$defs/BatchTaskContainerSettings",
          "description": "The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files."
        },
        "resourceFiles": {
          "type": "array",
          "description": "A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files.  When the max size is exceeded, the reques

# --- truncated at 32 KB (150 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-job-list-result-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/microsoft-azure-batch-batch-job-list-result"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.