Task - Add Collection

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 7 days. If a task has not completed within 7 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.

POST https://batch.core.windows.net/jobs/{jobId}/addtaskcollection?api-version=2018-08-01.7.0
POST https://batch.core.windows.net/jobs/{jobId}/addtaskcollection?timeout={timeout}&api-version=2018-08-01.7.0

URI Parameters

Name In Required Type Description
jobId
path True
  • string

The ID of the job to which the task collection is to be added.

timeout
query
  • integer
int32

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-version
query True
  • string

Client API Version.

Request Header

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

Name Required 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

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

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

Headers

  • client-request-id: string
  • request-id: string
Other Status Codes

Unexpected error

Examples

Add a basic collection of tasks
Add a complex collection of tasks

Add a basic collection of tasks

Sample Request

POST https://batch.core.windows.net/jobs/jobId/addtaskcollection?api-version=2018-08-01.7.0
client-request-id: 00000000-0000-0000-0000-000000000000
{
  "value": [
    {
      "id": "simple1",
      "commandLine": "cmd /c dir /s"
    },
    {
      "id": "simple2",
      "commandLine": "cmd /c dir /s"
    }
  ]
}

Sample Response

{
  "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

POST https://batch.core.windows.net/jobs/jobId/addtaskcollection?api-version=2018-08-01.7.0
client-request-id: 00000000-0000-0000-0000-000000000000
{
  "value": [
    {
      "id": "complex1",
      "commandLine": "cmd /c dir /s",
      "resourceFiles": [
        {
          "blobSource": "https://account.blob.core.windows.net/",
          "filePath": "file1"
        }
      ],
      "environmentSettings": [
        {
          "name": "env1",
          "value": "value1"
        },
        {
          "name": "env2",
          "value": "value2"
        }
      ],
      "affinityInfo": {
        "affinityId": "affinityId"
      },
      "constraints": {
        "maxWallClockTime": "P1D",
        "retentionTime": "P2D",
        "maxTaskRetryCount": 5
      },
      "multiInstanceSettings": {
        "numberOfInstances": 3,
        "coordinationCommandLine": "cmd /c echo coordinating",
        "commonResourceFiles": [
          {
            "blobSource": "https://common.blob.core.windows.net/",
            "filePath": "common.exe"
          }
        ]
      }
    },
    {
      "id": "simple3",
      "commandLine": "cmd /c dir /s"
    }
  ]
}

Sample Response

{
  "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

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

ContainerRegistry

A private container registry.

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.

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 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 file to be downloaded from Azure blob storage 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.

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

ApplicationPackageReference

A reference to an application package to be deployed to compute nodes.

Name Type Description
applicationId
  • string

The ID of the application to deploy.

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
  • string[]

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

The elevation level of the auto user.
The default value is nonAdmin.

scope

The scope for the auto user
The default value is task.

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

A message describing the error, intended to be suitable for display in a user interface.

values

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.

ContainerRegistry

A private container registry.

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

DependencyAction

An action that the Batch service performs on tasks that depend on this task.

Name Type Description
block
  • string

Block the task's dependencies.

satisfy
  • string

Satisfy the task's dependencies.

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

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

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

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 behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.

exitCodeRanges

A list of task exit code ranges and how the Batch service should respond to them.

exitCodes

A list of individual task exit codes and how the Batch service should respond to them.

fileUploadError

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

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

An action that the Batch service performs on tasks that depend on this task.
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 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).

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

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

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 node to another location after the Batch service has finished executing the task process.

Name Type Description
destination

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

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).
The URL must include a Shared Access Signature (SAS) granting write permissions to the 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.

OutputFileDestination

The destination to which a file should be uploaded.

Name Type Description
container

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

The conditions under which the task output file or set of files should be uploaded.
The default is taskcompletion.

ResourceFile

A file to be downloaded from Azure blob storage to a compute node.

Name Type Description
blobSource
  • string

The URL of the file within Azure Blob Storage.
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.

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 node. If this property is not specified for a Linux 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, relative to the task's working directory.

TaskAddCollectionParameter

A collection of Azure Batch tasks to add.

Name Type Description
value

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.

TaskAddCollectionResult

The result of adding a collection of tasks to a job.

Name Type Description
value

The results of the add task collection operation.

TaskAddParameter

An Azure Batch task to add.

Name Type Description
affinityInfo

A locality hint that can be used by the Batch service to select a compute node on which to start the new task.

applicationPackageReferences

A list of application 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 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

The settings for an authentication token that the task can use to perform Batch service operations.
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.

commandLine
  • string

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://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

constraints

The execution constraints that apply to this task.
If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the job, and the maxWallClockTime and retentionTime are infinite.

containerSettings

The settings for the container under which the 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.

dependsOn

The tasks that this task depends on.
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. If the job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob.

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.

environmentSettings

A list of environment variable settings for the task.

exitConditions

Specifies how the Batch service should respond when the task completes.
How the Batch service should respond when the task completes.

id
  • string

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. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a job that differ only by case).

multiInstanceSettings

An object that indicates that the task is a multi-instance task, and contains information about how to run the multi-instance task.
Multi-instance tasks are commonly used to support MPI tasks.

outputFiles

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.

resourceFiles

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.

userIdentity

The user identity under which the task runs.
If omitted, the task runs as a non-administrative user unique to the task.

TaskAddResult

Result for a single task added as part of an add task collection operation.

Name Type Description
eTag
  • string

The ETag of the task, if the task was successfully added.
You can use this to detect whether the task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the job in the meantime.

error

The error encountered while attempting to add the task.

lastModified
  • string

The last modified time of the task.

location
  • string

The URL of the task, if the task was successfully added.

status

The status of the add task request.

taskId
  • string

The ID of the task for which this is the result.

TaskAddStatus

The status of the add task request.

Name Type Description
clienterror
  • string

The task failed to add due to a client error and should not be retried without modifying the request as appropriate.

servererror
  • string

Task failed to add due to a server error and can be retried without modification.

success
  • string

The task was added successfully.

TaskConstraints

Execution constraints to apply to a task.

Name Type Description
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. Resource files and application packages are only downloaded again if the task is retried on a new compute node.

maxWallClockTime
  • string

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.

retentionTime
  • string

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 infinite, i.e. the task directory will be retained until the compute node is removed or reimaged.

TaskContainerSettings

The container settings for a task.

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

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

The private registry which contains the container image.
This setting can be omitted if was already provided at pool creation.

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.

Name Type Description
taskIdRanges

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.

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.

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.

Name Type Description
end
  • integer

The last task ID in the range.

start
  • integer

The first task ID in the range.

UserIdentity

The definition of the user identity under which the task is run.

Name Type Description
autoUser

The auto user under which the task is run.
The userName and autoUser properties are mutually exclusive; you must specify one 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.