Task - Add Collection

Reference

Service:: Batch Service

API Version:: 2024-07-01.20.0

Adds a collection of Tasks to the specified Job.
Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

POST {batchUrl}/jobs/{jobId}/addtaskcollection?api-version=2024-07-01.20.0

With optional parameters:

POST {batchUrl}/jobs/{jobId}/addtaskcollection?timeout={timeout}&api-version=2024-07-01.20.0

URI Parameters

Name	In	Required	Type	Description
batchUrl	path	True	string	The base URL for all Azure Batch service requests.
jobId	path	True	string	The ID of the Job to which the Task collection is to be added.
api-version	query	True	string	Client API Version.
timeout	query		integer int32	The maximum time that the server can spend processing the request, in seconds. The default is 2 minutes. If the value is larger than 120, the default will be used instead.

Request Header

Media Types: "application/json; odata=minimalmetadata"

Name	Type	Description
client-request-id	string uuid	The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Whether the server should return the client-request-id in the response.
ocp-date	string date-time-rfc1123	The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Request Body

Media Types: "application/json; odata=minimalmetadata"

Name	Required	Type	Description
value	True	TaskAddParameter[]	The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.

Responses

Name	Type	Description
200 OK	TaskAddCollectionResult	A response containing the results of the add Task collection operation. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Unexpected error

Name

Type

Description

200 OK

TaskAddCollectionResult

A response containing the results of the add Task collection operation.

Headers

client-request-id: string
request-id: string

Other Status Codes

BatchError

Unexpected error

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Authorization

Type: apiKey
In: header

Examples

Add a basic collection of tasks

Add a complex collection of tasks

Add a basic collection of tasks

Sample request

HTTP

POST account.region.batch.azure.com/jobs/jobId/addtaskcollection?api-version=2024-07-01.20.0



{
  "value": [
    {
      "id": "simple1",
      "commandLine": "cmd /c dir /s"
    },
    {
      "id": "simple2",
      "commandLine": "cmd /c dir /s"
    }
  ]
}

Sample response

Status code:: 200

{
  "value": [
    {
      "status": "success",
      "taskId": "simple1",
      "eTag": "0x8D3D623CD661246",
      "lastModified": "2016-09-06T07:02:44.7589958Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1"
    },
    {
      "status": "success",
      "taskId": "simple2",
      "eTag": "0x8D3D623CD7072CC",
      "lastModified": "2016-09-06T07:02:44.8270028Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2"
    }
  ]
}

Add a complex collection of tasks

Sample request

HTTP

POST account.region.batch.azure.com/jobs/jobId/addtaskcollection?api-version=2024-07-01.20.0



{
  "value": [
    {
      "id": "complex1",
      "commandLine": "cmd /c dir /s",
      "resourceFiles": [
        {
          "autoStorageContainerName": "containerName",
          "filePath": "data"
        }
      ],
      "environmentSettings": [
        {
          "name": "env1",
          "value": "value1"
        },
        {
          "name": "env2",
          "value": "value2"
        }
      ],
      "affinityInfo": {
        "affinityId": "affinityId"
      },
      "constraints": {
        "maxWallClockTime": "P1D",
        "retentionTime": "P2D",
        "maxTaskRetryCount": 5
      },
      "requiredSlots": 2,
      "multiInstanceSettings": {
        "numberOfInstances": 3,
        "coordinationCommandLine": "cmd /c echo coordinating",
        "commonResourceFiles": [
          {
            "httpUrl": "https://common.blob.core.windows.net/",
            "filePath": "common.exe"
          }
        ]
      }
    },
    {
      "id": "simple3",
      "commandLine": "cmd /c dir /s"
    }
  ]
}

Sample response

Status code:: 200

{
  "value": [
    {
      "taskId": "simple3",
      "status": "success",
      "eTag": "0x8D3D623CE295629",
      "lastModified": "2016-09-06T07:02:46.0386857Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3"
    },
    {
      "taskId": "complex1",
      "status": "success",
      "eTag": "0x8D3D623CE29A412",
      "lastModified": "2016-09-06T07:02:46.0406802Z",
      "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1"
    }
  ]
}

Definitions

Name	Description
AccessScope	The Batch resources to which the token grants access.
AffinityInformation	A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task.
ApplicationPackageReference	A reference to an Package to be deployed to Compute Nodes.
AuthenticationTokenSettings	The settings for an authentication token that the Task can use to perform Batch service operations.
AutoUserScope	The scope for the auto user
AutoUserSpecification	Specifies the parameters for the auto user that runs a Task on the Batch service.
BatchError	An error response received from the Azure Batch service.
BatchErrorDetail	An item of additional information included in an Azure Batch error response.
ComputeNodeIdentityReference	The reference to a user assigned identity associated with the Batch pool which a compute node will use.
ContainerHostBatchBindMountEntry	The entry of path and mount mode you want to mount into task container.
ContainerHostDataPath	The paths which will be mounted to container task's container.
ContainerRegistry	A private container registry.
ContainerWorkingDirectory	The location of the container Task working directory.
DependencyAction	An action that the Batch service performs on Tasks that depend on this Task.
ElevationLevel	The elevation level of the user.
EnvironmentSetting	An environment variable to be set on a Task process.
ErrorMessage	An error message received in an Azure Batch error response.
ExitCodeMapping	How the Batch service should respond if a Task exits with a particular exit code.
ExitCodeRangeMapping	A range of exit codes and how the Batch service should respond to exit codes within that range.
ExitConditions	Specifies how the Batch service should respond when the Task completes.
ExitOptions	Specifies how the Batch service responds to a particular exit condition.
HttpHeader	An HTTP header name-value pair
JobAction	An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'.
MultiInstanceSettings	Settings which specify how to run a multi-instance Task.
OutputFile	A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process.
OutputFileBlobContainerDestination	Specifies a file upload destination within an Azure blob storage container.
OutputFileDestination	The destination to which a file should be uploaded.
OutputFileUploadCondition	The conditions under which a Task output file or set of files should be uploaded.
OutputFileUploadOptions	Details about an output file upload operation, including under what conditions to perform the upload.
ResourceFile	A single file or multiple files to be downloaded to a Compute Node.
TaskAddCollectionParameter	A collection of Azure Batch Tasks to add.
TaskAddCollectionResult	The result of adding a collection of Tasks to a Job.
TaskAddParameter	An Azure Batch Task to add.
TaskAddResult	Result for a single Task added as part of an add Task collection operation.
TaskAddStatus	The status of the add Task request.
TaskConstraints	Execution constraints to apply to a Task.
TaskContainerSettings	The container settings for a Task.
TaskDependencies	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.
TaskIdRange	A range of Task IDs that a Task can depend on. All Tasks with IDs in the range must complete successfully before the dependent Task can be scheduled.
UserIdentity	The definition of the user identity under which the Task is run.

AccessScope

The Batch resources to which the token grants access.

Name	Type	Description
job	string	Grants access to perform all operations on the Job containing the Task.

AffinityInformation

A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task.

Name	Type	Description
affinityId	string	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.

ApplicationPackageReference

A reference to an Package to be deployed to Compute Nodes.

Name	Type	Description
applicationId	string	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.

AuthenticationTokenSettings

The settings for an authentication token that the Task can use to perform Batch service operations.

Name	Type	Description
access	AccessScope[]	The Batch resources to which the token grants access. 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.

AutoUserScope

The scope for the auto user

Name	Type	Description
pool	string	Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool.
task	string	Specifies that the service should create a new user for the Task.

AutoUserSpecification

Specifies the parameters for the auto user that runs a Task on the Batch service.

Name	Type	Description
elevationLevel	ElevationLevel	The elevation level of the auto user. The default value is nonAdmin.
scope	AutoUserScope	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, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks.

BatchError

An error response received from the Azure Batch service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	ErrorMessage	A message describing the error, intended to be suitable for display in a user interface.
values	BatchErrorDetail[]	A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

An item of additional information included in an Azure Batch error response.

Name	Type	Description
key	string	An identifier specifying the meaning of the Value property.
value	string	The additional information included with the error response.

ComputeNodeIdentityReference

The reference to a user assigned identity associated with the Batch pool which a compute node will use.

Name	Type	Description
resourceId	string	The ARM resource id of the user assigned identity.

ContainerHostBatchBindMountEntry

The entry of path and mount mode you want to mount into task container.

Name	Type	Description
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.
source	ContainerHostDataPath	The path which be mounted to container customer can select.

ContainerHostDataPath

The paths which will be mounted to container task's container.

Name	Type	Description
Applications	string	The applications path.
JobPrep	string	The job-prep task path.
Shared	string	The path for multi-instances task to shared their files.
Startup	string	The path for start task.
Task	string	The task path.
VfsMounts	string	The path contains all virtual file systems are mounted on this node.

ContainerRegistry

A private container registry.

Name	Type	Description
identityReference	ComputeNodeIdentityReference	The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. The reference to a user assigned identity associated with the Batch pool which a compute node will use.
password	string	The password to log into the registry server.
registryServer	string	The registry URL. If omitted, the default is "docker.io".
username	string	The user name to log into the registry server.

ContainerWorkingDirectory

The location of the container Task working directory.

Name	Type	Description
containerImageDefault	string	Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch.
taskWorkingDirectory	string	Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch.

DependencyAction

An action that the Batch service performs on Tasks that depend on this Task.

Name	Type	Description
block	string	Blocks tasks waiting on this task, preventing them from being scheduled.
satisfy	string	Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run.

ElevationLevel

The elevation level of the user.

Name	Type	Description
admin	string	The user is a user with elevated access and operates with full Administrator permissions.
nonadmin	string	The user is a standard user without elevated access.

EnvironmentSetting

An environment variable to be set on a Task process.

Name	Type	Description
name	string	The name of the environment variable.
value	string	The value of the environment variable.

ErrorMessage

An error message received in an Azure Batch error response.

Name	Type	Description
lang	string	The language code of the error message
value	string	The text of the message.

ExitCodeMapping

How the Batch service should respond if a Task exits with a particular exit code.

Name	Type	Description
code	integer	A process exit code.
exitOptions	ExitOptions	How the Batch service should respond if the Task exits with this exit code.

ExitCodeRangeMapping

A range of exit codes and how the Batch service should respond to exit codes within that range.

Name	Type	Description
end	integer	The last exit code in the range.
exitOptions	ExitOptions	How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive).
start	integer	The first exit code in the range.

ExitConditions

Specifies how the Batch service should respond when the Task completes.

Name	Type	Description
default	ExitOptions	How the Batch service should respond if the Task fails with an exit condition not covered by any of the other properties. 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 behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.
exitCodeRanges	ExitCodeRangeMapping[]	A list of Task exit code ranges and how the Batch service should respond to them.
exitCodes	ExitCodeMapping[]	A list of individual Task exit codes and how the Batch service should respond to them.
fileUploadError	ExitOptions	How the Batch service should respond if a file upload error occurs. 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.
preProcessingError	ExitOptions	How the Batch service should respond if the Task fails to start due to an error.

ExitOptions

Specifies how the Batch service responds to a particular exit condition.

Name	Type	Description
dependencyAction	DependencyAction	An action that the Batch service performs on Tasks that depend on this Task. Possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks.
jobAction	JobAction	An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'. 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).

HttpHeader

An HTTP header name-value pair

Name	Type	Description
name	string	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

JobAction

An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'.

Name	Type	Description
disable	string	Disable the Job. This is equivalent to calling the disable Job API, with a disableTasks value of requeue.
none	string	Take no action.
terminate	string	Terminate the Job. The terminateReason in the Job's executionInfo is set to "TaskFailed".

MultiInstanceSettings

Settings which specify how to run a multi-instance Task.

Name	Type	Description
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.
coordinationCommandLine	string	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.
numberOfInstances	integer	The number of Compute Nodes required by the Task. If omitted, the default is 1.

OutputFile

A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process.

Name	Type	Description
destination	OutputFileDestination	The destination for the output file(s).
filePattern	string	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.
uploadOptions	OutputFileUploadOptions	Additional options for the upload operation, including under what conditions to perform the upload.

OutputFileBlobContainerDestination

Specifies a file upload destination within an Azure blob storage container.

Name	Type	Description
containerUrl	string	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	ComputeNodeIdentityReference	The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl The identity must have write access to the 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.
uploadHeaders	HttpHeader[]	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://docs.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

The destination to which a file should be uploaded.

Name	Type	Description
container	OutputFileBlobContainerDestination	A location in Azure blob storage to which files are uploaded.

OutputFileUploadCondition

The conditions under which a Task output file or set of files should be uploaded.

Name	Type	Description
taskcompletion	string	Upload the file(s) after the Task process exits, no matter what the exit code was.
taskfailure	string	Upload the file(s) only after the Task process exits with a nonzero exit code.
tasksuccess	string	Upload the file(s) only after the Task process exits with an exit code of 0.

OutputFileUploadOptions

Details about an output file upload operation, including under what conditions to perform the upload.

Name	Type	Description
uploadCondition	OutputFileUploadCondition	The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion.

ResourceFile

A single file or multiple files to be downloaded to a Compute Node.

Name	Type	Description
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.
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.
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.
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 '..').
httpUrl	string	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.
identityReference	ComputeNodeIdentityReference	The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl The reference to a user assigned identity associated with the Batch pool which a compute node will use.
storageContainerUrl	string	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.