--- title: "Gets information about the specified Task." method: GET path: "/jobs/{jobId}/tasks/{taskId}" tags: ["Tasks"] --- # Gets information about the specified Task. `GET /jobs/{jobId}/tasks/{taskId}` For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks. ## Path parameters - `jobId` string, required - `taskId` string, required ## Query parameters - `api-version` string, required - `timeOut` integer - `$select` string[] - `$expand` string[] ## Headers - `client-request-id` string - `return-client-request-id` boolean - `ocp-date` string, date-time-rfc7231 - `If-Modified-Since` string, date-time-rfc7231 - `If-Unmodified-Since` string, date-time-rfc7231 - `If-Match` string - `If-None-Match` string ## Response `200` The request has succeeded. - BatchTask — Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. - `id` string, required — A string that uniquely identifies the 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` string — A display name for the Task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. - `url` string, uri, required — The URL of the Task. - `eTag` string, required — The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It 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. It is a string of ASCII characters placed between double quotes, like "675af34563dc-tr34". - `lastModified` string, date-time, required — The last modified time of the Task. - `creationTime` string, date-time, required — The creation time of the Task. - `exitConditions` ExitConditions — Specifies how the Batch service should respond when the Task completes. - `exitCodes` ExitCodeMapping[] — A list of individual Task exit codes and how the Batch service should respond to them. - `code` integer, required — A process exit code. - `exitOptions` ExitOptions, required — Specifies how the Batch service responds to a particular exit condition. - `jobAction` 'none' | 'disable' | 'terminate' — BatchJobAction enums - `dependencyAction` 'satisfy' | 'block' — DependencyAction enums - `exitCodeRanges` ExitCodeRangeMapping[] — A list of Task exit code ranges and how the Batch service should respond to them. - `start` integer, required — The first exit code in the range. - `end` integer, required — The last exit code in the range. - `exitOptions` ExitOptions, required — Specifies how the Batch service responds to a particular exit condition. - `jobAction` 'none' | 'disable' | 'terminate' — BatchJobAction enums - `dependencyAction` 'satisfy' | 'block' — DependencyAction enums - `preProcessingError` ExitOptions — Specifies how the Batch service responds to a particular exit condition. - `jobAction` 'none' | 'disable' | 'terminate' — BatchJobAction enums - `dependencyAction` 'satisfy' | 'block' — DependencyAction enums - `fileUploadError` ExitOptions — Specifies how the Batch service responds to a particular exit condition. - `jobAction` 'none' | 'disable' | 'terminate' — BatchJobAction enums - `dependencyAction` 'satisfy' | 'block' — DependencyAction enums - `default` ExitOptions — Specifies how the Batch service responds to a particular exit condition. - `jobAction` 'none' | 'disable' | 'terminate' — BatchJobAction enums - `dependencyAction` 'satisfy' | 'block' — DependencyAction enums - `state` 'active' | 'preparing' | 'running' | 'completed', required — BatchTaskState enums - `stateTransitionTime` string, date-time, required — The time at which the Task entered its current state. - `previousState` 'active' | 'preparing' | 'running' | 'completed' — BatchTaskState enums - `previousStateTransitionTime` string, date-time — The time at which the Task entered its previous state. This property is not set if the Task is in its initial Active state. - `commandLine` string, required — The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. 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` BatchTaskContainerSettings — The container settings for a Task. - `containerRunOptions` string — Additional options to the container create command. These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. - `imageName` string, required — The Image to use to create the container in which the Task will run. This is the full Image reference, as would be specified to "docker pull". If no tag is provided as part of the Image name, the tag ":latest" is used as a default. - `registry` ContainerRegistryReference — A private container registry. - `username` string — The user name to log into the registry server. - `password` string, password — The password to log into the registry server. - `registryServer` string, uri — The registry URL. If omitted, the default is "docker.io". - `identityReference` BatchNodeIdentityReference — The reference to a user assigned identity associated with the Batch pool which a compute node will use. - `resourceId` string, arm-id — The ARM resource id of the user assigned identity. - `workingDirectory` 'taskWorkingDirectory' | 'containerImageDefault' — ContainerWorkingDirectory enums - `containerHostBatchBindMounts` ContainerHostBatchBindMountEntry[] — The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. - `source` 'Shared' | 'Startup' | 'VfsMounts' | 'Task' | 'JobPrep' | 'Applications' — The paths which will be mounted to container task's container. - `isReadOnly` boolean — Mount this source path as read-only mode or not. Default value is false (read/write mode). For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. - `resourceFiles` ResourceFile[] — A list of files that the Batch service will download to the Compute Node before running the command line. For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. - `autoStorageContainerName` string — The storage container name in the auto storage Account. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. - `storageContainerUrl` string, uri — The URL of the blob container within Azure Blob Storage. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. - `httpUrl` string, uri — The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. - `blobPrefix` string — The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. - `filePath` string — The location on the Compute Node to which to download the file(s), relative to the Task's working directory. If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..'). - `fileMode` string — The file permission mode attribute in octal format. This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file. - `identityReference` BatchNodeIdentityReference — The reference to a user assigned identity associated with the Batch pool which a compute node will use. - `resourceId` string, arm-id — The ARM resource id of the user assigned identity. - `outputFiles` OutputFile[] — A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. - `filePattern` string, required — A pattern indicating which file(s) to upload. Both relative and absolute paths are supported. Relative paths are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with "." it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\*.txt matches any file that does not start in '.' and ends with .txt in the Task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied. - `destination` OutputFileDestination, required — The destination to which a file should be uploaded. - `container` OutputFileBlobContainerDestination — Specifies a file upload destination within an Azure blob storage container. - `path` string — The destination blob or virtual directory within the Azure Storage container. If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name. - `containerUrl` string, uri, required — The URL of the container within Azure Blob Storage to which to upload the file(s). If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. - `identityReference` BatchNodeIdentityReference — The reference to a user assigned identity associated with the Batch pool which a compute node will use. - `resourceId` string, arm-id — The ARM resource id of the user assigned identity. - `uploadHeaders` OutputFileUploadHeader[] — A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types. - `name` string, required — The case-insensitive name of the header to be used while uploading output files. - `value` string — The value of the header to be used while uploading output files. - `uploadOptions` OutputFileUploadConfig, required — Options for an output file upload operation, including under what conditions to perform the upload. - `uploadCondition` 'tasksuccess' | 'taskfailure' | 'taskcompletion', required — OutputFileUploadCondition enums - `environmentSettings` EnvironmentSetting[] — A list of environment variable settings for the Task. - `name` string, required — The name of the environment variable. - `value` string — The value of the environment variable. - `affinityInfo` BatchAffinityInfo — A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task. - `affinityId` string, required — An opaque string representing the location of a Compute Node or a Task that has run previously. You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere. - `constraints` BatchTaskConstraints — Execution constraints to apply to a Task. - `maxWallClockTime` string, duration — The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. If this is not specified, there is no time limit on how long the Task may run. The time duration is specified in ISO 8601 format. - `retentionTime` string, duration — The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents. The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted. The time duration is specified in ISO 8601 format. - `maxTaskRetryCount` integer — The maximum number of times the 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 for the Task executable due to a nonzero exit code. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task after the first attempt. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries). - `requiredSlots` integer — The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1. - `userIdentity` UserIdentity — The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both. - `username` string — The name of the user identity under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. - `autoUser` AutoUserSpecification — Specifies the options for the auto user that runs an Azure Batch Task. - `scope` 'task' | 'pool' — AutoUserScope enums - `elevationLevel` 'nonadmin' | 'admin' — ElevationLevel enums - `executionInfo` BatchTaskExecutionInfo — Information about the execution of a Task. - `startTime` string, date-time — The time at which the Task started running. 'Running' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present only for Tasks that are in the running or completed state. - `endTime` string, date-time — The time at which the Task completed. This property is set only if the Task is in the Completed state. - `exitCode` integer — The exit code of the program specified on the Task command line. This property is set only if the Task 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 Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code. - `containerInfo` BatchTaskContainerExecutionInfo — Contains information about the container which a Task is executing. - `containerId` string — The ID of the container. - `state` string — 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` string — 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". - `failureInfo` BatchTaskFailureInfo — Information about a Task failure. - `category` 'usererror' | 'servererror', required — BatchErrorSourceCategory enums - `code` string — An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. - `message` string — A message describing the Task error, intended to be suitable for display in a user interface. - `details` NameValuePair[] — A list of additional details related to the error. - `name` string — The name in the name-value pair. - `value` string — The value in the name-value pair. - `retryCount` integer, required — 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. - `lastRetryTime` string, date-time — The most recent time at which a retry of the Task started running. This element is present 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. - `requeueCount` integer, required — The number of times the Task has been requeued by the Batch service as the result of a user request. When the user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons. - `lastRequeueTime` string, date-time — The most recent time at which the Task has been requeued by the Batch service as the result of a user request. This property is set only if the requeueCount is nonzero. - `result` 'success' | 'failure' — BatchTaskExecutionResult enums - `nodeInfo` BatchNodeInfo — Information about the Compute Node on which a Task ran. - `affinityId` string — 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` string, uri — The URL of the Compute Node on which the Task ran. - `poolId` string — The ID of the Pool on which the Task ran. - `nodeId` string — The ID of the Compute Node on which the Task ran. - `taskRootDirectory` string — The root directory of the Task on the Compute Node. - `taskRootDirectoryUrl` string, uri — The URL to the root directory of the Task on the Compute Node. - `multiInstanceSettings` MultiInstanceSettings — Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit. - `numberOfInstances` integer — The number of Compute Nodes required by the Task. If omitted, the default is 1. - `coordinationCommandLine` string, required — The command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main Task command. A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages. - `commonResourceFiles` ResourceFile[] — A list of files that the Batch service will download before running the coordination command line. The difference between common resource files and Task resource files is that common resource files are downloaded for all subtasks including the primary, whereas Task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the Task working directory, but instead are downloaded to the Task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. - `autoStorageContainerName` string — The storage container name in the auto storage Account. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. - `storageContainerUrl` string, uri — The URL of the blob container within Azure Blob Storage. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. - `httpUrl` string, uri — The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. - `blobPrefix` string — The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. - `filePath` string — The location on the Compute Node to which to download the file(s), relative to the Task's working directory. If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..'). - `fileMode` string — The file permission mode attribute in octal format. This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file. - `identityReference` BatchNodeIdentityReference — The reference to a user assigned identity associated with the Batch pool which a compute node will use. - `resourceId` string, arm-id — The ARM resource id of the user assigned identity. - `stats` BatchTaskStatistics — Resource usage statistics for a Task. - `url` string, uri, required — The URL of the statistics. - `startTime` string, date-time, required — The start time of the time range covered by the statistics. - `lastUpdateTime` string, date-time, required — The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. - `userCPUTime` string, duration, required — The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. The time duration is specified in ISO 8601 format. - `kernelCPUTime` string, duration, required — The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. The time duration is specified in ISO 8601 format. - `wallClockTime` string, duration, required — The total wall clock time of the Task. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If the Task was retried, this includes the wall clock time of all the Task retries. The time duration is specified in ISO 8601 format. - `readIOps` string, int64, required — The total number of disk read operations made by the Task. - `writeIOps` string, int64, required — The total number of disk write operations made by the Task. - `readIOGiB` number, float, required — The total gibibytes read from disk by the Task. - `writeIOGiB` number, float, required — The total gibibytes written to disk by the Task. - `waitTime` string, duration, required — The total wait time of the Task. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.). The time duration is specified in ISO 8601 format. - `dependsOn` BatchTaskDependencies — Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be scheduled. - `taskIds` string[] — The list of Task IDs that this Task depends on. All Tasks in this list must complete successfully before the dependent Task can be scheduled. The taskIds collection is limited to 64000 characters total (i.e. the combined length of all Task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using Task ID ranges instead. - `taskIdRanges` BatchTaskIdRange[] — The list of Task ID ranges that this Task depends on. All Tasks in all ranges must complete successfully before the dependent Task can be scheduled. - `start` integer, required — The first Task ID in the range. - `end` integer, required — The last Task ID in the range. - `applicationPackageReferences` BatchApplicationPackageReference[] — A list of Packages that the Batch service will deploy to the Compute Node before running the command line. Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails. - `applicationId` string, required — 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` string — 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. ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/azure/apis/batch-batch.md) · [All operations](https://skmtc.net/azure/apis/batch-batch/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/batch-batch/versions/8427acd8fd77/schema)