Task - Get

• CloudTask

A response containing the task.

• BatchError

The error from the Batch service.

• string

You can pass the affinityId of a compute node to indicate that this task needs to run on that compute node. Note that this is just a soft affinity. If the target node is busy or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere.

• string

• string

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.

• string[]

The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the job which contains the task.

• enum:
  • nonAdmin
  • admin

nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.

• enum:
  • task
  • pool

Values are:

pool - specifies that the task runs as the common auto user account which is created on every node in a pool. task - specifies that the service should create a new user for the task. The default value is task.

• string

• ErrorMessage

• BatchErrorDetail[]

• string

• string

• AffinityInformation

• ApplicationPackageReference[]

Application packages are downloaded and deployed to a shared directory, not the task working directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails.

• AuthenticationTokenSettings

If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.

• string

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.

• TaskConstraints

• TaskContainerSettings

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.

• string
  date-time

• TaskDependencies

This task will not be scheduled until all tasks that it depends on have completed successfully. If any of those tasks fail and exhaust their retry counts, this task will never be scheduled.

• string

The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

• string

This is an opaque string. You can use it to detect whether the task has changed between requests. In particular, you can be pass the ETag when updating a task to specify that your changes should take effect only if nobody else has modified the task in the meantime.

• EnvironmentSetting[]

• TaskExecutionInformation

• ExitConditions

How the Batch service should respond when the task completes.

• string

The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.

• string
  date-time

• MultiInstanceSettings

Multi-instance tasks are commonly used to support MPI tasks.

• ComputeNodeInformation

• OutputFile[]

For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed.

• enum:
  • active
  • preparing
  • running
  • completed

This property is not set if the task is in its initial Active state.

• string
  date-time

This property is not set if the task is in its initial Active state.

• ResourceFile[]

For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed.

• enum:
  • active
  • preparing
  • running
  • completed

Values are:

active - The task is queued and able to run, but is not currently assigned to a compute node. A task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run. preparing - The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the 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 node. running - The task is running on a compute node. This includes task-level preparation such as downloading resource files or deploying application packages specified on the task - it does not necessarily mean that the task command line has started executing. completed - 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.

• string
  date-time

• TaskStatistics

• string

• UserIdentity

If omitted, the task runs as a non-administrative user unique to the task.

• string

• string

• string

• string

• string

• string

• string

• string

If omitted, the default is "docker.io".

• string

• string

• string

• string

• string

• integer
  int32

• ExitOptions

• integer
  int32

• ExitOptions

• integer
  int32

• ExitOptions

This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.

• ExitCodeRangeMapping[]

• ExitCodeMapping[]

• ExitOptions

If the task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.

• ExitOptions

• enum:
  • satisfy
  • block

Values are:

satisfy - Satisfy the task's dependencies. block - Block the task's dependencies.

The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an erro and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

• enum:
  • none
  • disable
  • terminate

Values are:

none - Take no action. disable - Disable the job. This is equivalent to calling the disable job API, with a disableTasks value of requeue. terminate - Terminate the job. The terminateReason in the job's executionInfo is set to "TaskFailed". The default is none for exit code 0 and terminate for all other exit conditions.

If the job's onTaskFailed property is noAction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

• ResourceFile[]

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).

• string

A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages.

• integer
  int32

If omitted, the default is 1.

• string

• string

• OutputFileDestination

• string

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.

• OutputFileUploadOptions

• string

The URL must include a Shared Access Signature (SAS) granting write permissions to the container.

• string

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.

• OutputFileBlobContainerDestination

• enum:
  • taskSuccess
  • taskFailure
  • taskCompletion

The default is taskCompletion.

• string

This URL must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

• string

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 node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

• string

• integer
  int32

Note that this value specifically controls the number of retries. 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. If the maximum retry count is -1, the Batch service retries the task without limit.

• string
  duration

If this is not specified, there is no time limit on how long the task may run.

• string
  duration

The default is infinite, i.e. the task directory will be retained until the compute node is removed or reimaged.

• string

• string

This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by "docker inspect".

• string

This is the state of the container according to the Docker service. It is equivalent to the status field returned by "docker inspect".

• string

These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.

• string

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.

• ContainerRegistry

This setting can be omitted if was already provided at pool creation.

• TaskIdRange[]

• string[]

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.

• TaskContainerExecutionInformation

This property is set only if the task runs in a container context.

• string
  date-time

This property is set only if the task is in the Completed state.

• integer
  int32

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.

• TaskFailureInformation

This property is set only if the task is in the completed state and encountered a failure.

• string
  date-time

This property is set only if the requeueCount is nonzero.

• string
  date-time

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.

• integer
  int32

When the user removes 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 nodes be requeued for execution. This count tracks how many times the task has been requeued for these reasons.

• enum:
  • success
  • failure

If the value is 'failed', then the details of the failure can be found in the failureInfo property.

• integer
  int32

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.

• string
  date-time

'Running' corresponds to the running state, so if the task specifies resource files or application 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.

• enum:
  • userError
  • serverError

• string

• NameValuePair[]

• string

• integer
  int32

• integer
  int32

• string
  duration

• string
  date-time

• number
  double

• integer
  int64

• string
  date-time

• string

• string
  duration

• string
  duration

• string
  duration

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.

• number
  double

• integer
  int64

• AutoUserSpecification

The userName and autoUser properties are mutually exclusive; you must specify one but not both.

• string

The userName and autoUser properties are mutually exclusive; you must specify one but not both.