Azure.Batch (preview:2024-07-01.20.0)

2025/02/14 • 12 updated methods

Jobs_ListJobs (updated)
Description :  Lists all of the Jobs in the specified Account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_ListJobs",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "stats": [
              {
                "#name": "readIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "writeIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "numSucceededTasks",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "numFailedTasks",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "numTaskRetries",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. A maximum of 1000 applications can be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs. ,
Required: False ,
}
string ,
$select:
{
Description: An OData $select clause. ,
Required: False ,
}
array ,
$expand:
{
Description: An OData $expand clause. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}
,
$schema:
{
Description: The result of listing the Jobs in an Account. ,
}
{
value:
{
Description: The list of Jobs. ,
Required: False ,
}
[
{
id:
{
Description: A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the Job. ,
Required: False ,
}
string ,
usesTaskDependencies:
{
Description: Whether Tasks in the Job can define dependencies on each other. The default is false. ,
Required: False ,
}
boolean ,
url:
{
Description: The URL of the Job. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Job. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the Job. ,
Enum:
{
active: The Job is available to have Tasks scheduled. ,
disabling: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). ,
disabled: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. ,
enabling: A user has requested that the Job be enabled, but the enable operation is still in progress. ,
terminating: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). ,
completed: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. ,
deleting: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Job entered its current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Job. This property is not set if the Job is in its initial Active state. ,
Enum:
{
active: The Job is available to have Tasks scheduled. ,
disabling: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). ,
disabled: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. ,
enabling: A user has requested that the Job be enabled, but the enable operation is still in progress. ,
terminating: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). ,
completed: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. ,
deleting: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state. ,
Format: date-time ,
Required: False ,
}
string ,
priority:
{
Description: The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
allowTaskPreemption:
{
Description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. ,
Required: False ,
}
boolean ,
maxParallelTasks:
{
Description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. ,
Format: int32 ,
Required: False ,
}
integer ,
constraints:
{
Description: The execution constraints for the Job. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
jobManagerTask:
{
Description: Details of a Job Manager Task to be launched when the Job is started. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Manager Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Manager Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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 property is not supported and must not be specified. ,
Format: int32 ,
Required: False ,
}
integer ,
killJobOnCompletion:
{
Description: Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
runExclusive:
{
Description: Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. ,
Required: False ,
}
boolean ,
applicationPackageReferences:
{
Description: 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 Application 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
allowLowPriorityNode:
{
Description: Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobPreparationTask:
{
Description: The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Preparation Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Preparation Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
waitForSuccess:
{
Description: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
rerunOnNodeRebootAfterSuccess:
{
Description: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobReleaseTask:
{
Description: The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Release Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
maxWallClockTime:
{
Description: The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: The minimum time to retain the Task directory for the Job Release Task on the Compute Node. 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. ,
Format: duration ,
Required: False ,
}
string ,
userIdentity:
{
Description: The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
commonEnvironmentSettings:
{
Description: The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
poolInfo:
{
Description: The Pool settings associated with the Job. ,
Required: True ,
}
{
poolId:
{
Description: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
string ,
autoPoolSpecification:
{
Description: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
{
autoPoolIdPrefix:
{
Description: A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. ,
Required: False ,
}
string ,
poolLifetimeOption:
{
Description: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. ,
Enum:
{
jobschedule: The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. ,
job: The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. ,
}
,
Required: True ,
}
enum ,
keepAlive:
{
Description: Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. ,
Required: False ,
}
boolean ,
pool:
{
Description: The Pool specification for the auto Pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). ,
Required: True ,
}
string ,
virtualMachineConfiguration:
{
Description: The virtual machine configuration for the Pool. This property must be specified. ,
Required: False ,
}
{
imageReference:
{
Description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ,
Required: True ,
}
{
publisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. ,
Required: False ,
}
string ,
version:
{
Description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
virtualMachineImageId:
{
Description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSKUId:
{
Description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. ,
Required: False ,
}
[
{
lun:
{
Description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in gigabytes. ,
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
licenseType:
{
Description: This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. ,
Required: False ,
}
{
type:
{
Description: The container technology to be used. ,
Enum:
{
dockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
criCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. ,
Required: False ,
}
[
string ,
]
,
}
,
nodePlacementConfiguration:
{
Description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
regional: All nodes in the pool will be allocated in the same region. ,
zonal: Nodes in the pool will be spread across different availability zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extension. ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: The version of script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: JSON formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Settings for the operating system disk of the Virtual Machine. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). ,
Required: False ,
}
{
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
cachedisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in GB when creating new OS disk. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: The storage account type for managed disk. ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs. ,
Enum:
{
NonPersistedTPM: NonPersistedTPM ,
VMGuestStateOnly: VMGuestStateOnly ,
}
,
Required: False ,
}
enum ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. ,
Required: True ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. ,
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: True ,
}
enum ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: True ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
taskSlotsPerNode:
{
Description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Required: False ,
}
{
nodeFillType:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Enum:
{
spread: Tasks should be assigned evenly across all Compute Nodes in the Pool. ,
pack: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. ,
}
,
Required: True ,
}
enum ,
}
,
resizeTimeout:
{
Description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
resourceTags:
{
Description: The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScale:
{
Description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. ,
Required: False ,
}
boolean ,
autoScaleFormula:
{
Description: The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. ,
Required: False ,
}
string ,
autoScaleEvaluationInterval:
{
Description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
enableInterNodeCommunication:
{
Description: Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. ,
Required: False ,
}
boolean ,
networkConfiguration:
{
Description: The network configuration for the Pool. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVNetAssignmentScope:
{
Description: The scope of dynamic vnet assignment. ,
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Description: The configuration for endpoints on Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
inboundNATPools:
{
Description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Enum:
{
tcp: Use TCP for the endpoint. ,
udp: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Description: The action that should be taken for a specified IP address, subnet range or tag. ,
Enum:
{
allow: Allow access. ,
deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
provision:
{
Description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. ,
Enum:
{
batchmanaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
usermanaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
nopublicipaddresses: No public IP Address will be created. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
startTask:
{
Description: A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. ,
Required: False ,
}
{
commandLine:
{
Description: The command line of the StartTask. 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). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the StartTask. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: 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. 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, however this is not recommended for a start task or any task. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. ,
Required: False ,
}
boolean ,
}
,
applicationPackageReferences:
{
Description: The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
userAccounts:
{
Description: The list of user Accounts to be created on each Compute Node in the Pool. ,
Required: False ,
}
[
{
name:
{
Description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user Account. ,
Format: password ,
Required: True ,
}
string ,
elevationLevel:
{
Description: The elevation level of the user Account. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). ,
Format: password ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: The login mode for the user. The default is 'batch'. ,
Enum:
{
batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
mountConfiguration:
{
Description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage Account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The Azure Blob Storage Container name. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
sasKey:
{
Description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
username:
{
Description: The user to use for authentication against the CIFS file system. ,
Required: True ,
}
string ,
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Description: The password to use for authentication against the CIFS file system. ,
Format: password ,
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage account name. ,
Required: True ,
}
string ,
azureFileUrl:
{
Description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage account key. ,
Format: password ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
targetNodeCommunicationMode:
{
Description: The desired node communication mode for the pool. If omitted, the default value is Default. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
upgradePolicy:
{
Description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. ,
Enum:
{
automatic: TAll virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. ,
Format: duration ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
}
,
onAllTasksComplete:
{
Description: The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
terminatejob: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
onTaskFailure:
{
Description: The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
performexitoptionsjobaction: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for the Job. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: True ,
}
string ,
skipWithdrawFromVNet:
{
Description: Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. ,
Required: True ,
}
boolean ,
}
,
metadata:
{
Description: A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
executionInfo:
{
Description: The execution information for the Job. ,
Required: False ,
}
{
startTime:
{
Description: The start time of the Job. This is the time at which the Job was created. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The completion time of the Job. This property is set only if the Job is in the completed state. ,
Format: date-time ,
Required: False ,
}
string ,
poolId:
{
Description: The ID of the Pool to which this Job is assigned. This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool. ,
Required: False ,
}
string ,
schedulingError:
{
Description: Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting the Job. ,
Required: False ,
}
{
category:
{
Description: The category of the Job scheduling error. ,
Enum:
{
usererror: The error is due to a user issue, such as misconfiguration. ,
servererror: The error is due to an internal server issue. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the Job scheduling error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional error details related to the scheduling error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
terminateReason:
{
Description: A string describing the reason the Job ended. This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a Job' operation. ,
Required: False ,
}
string ,
}
,
stats:
{
Description: Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: The total wall clock time of all Tasks in the Job. 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 a Task was retried, this includes the wall clock time of all the Task retries. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by all Tasks in the Job. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by all Tasks in the Job. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total amount of data in GiB read from disk by all Tasks in the Job. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total amount of data in GiB written to disk by all Tasks in the Job. ,
Format: float ,
Required: True ,
}
number ,
numSucceededTasks:
{
Description: The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numFailedTasks:
{
Description: The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numTaskRetries:
{
Description: The total number of retries on all the Tasks in the Job during the given time range. ,
Format: int64 ,
Required: True ,
}
string ,
waitTime:
{
Description: The total wait time of all Tasks in the Job. 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.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. ,
Format: duration ,
Required: True ,
}
string ,
}
,
}
,
]
,
odata.nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
Jobs_GetJob (updated)
Description :  Gets information about the specified Job.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_GetJob",
  "$responses": {
    "200": {
      "$properties": {
        "stats": [
          {
            "#name": "readIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "writeIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numSucceededTasks",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numFailedTasks",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numTaskRetries",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ,
Required: False ,
}
string ,
jobId:
{
Description: The ID of the Job. ,
Required: True ,
}
string ,
$select:
{
Description: An OData $select clause. ,
Required: False ,
}
array ,
$expand:
{
Description: An OData $expand clause. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}
,
$schema:
{
Description: An Azure Batch Job. ,
}
{
id:
{
Description: A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the Job. ,
Required: False ,
}
string ,
usesTaskDependencies:
{
Description: Whether Tasks in the Job can define dependencies on each other. The default is false. ,
Required: False ,
}
boolean ,
url:
{
Description: The URL of the Job. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Job. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the Job. ,
Enum:
{
active: The Job is available to have Tasks scheduled. ,
disabling: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). ,
disabled: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. ,
enabling: A user has requested that the Job be enabled, but the enable operation is still in progress. ,
terminating: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). ,
completed: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. ,
deleting: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Job entered its current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Job. This property is not set if the Job is in its initial Active state. ,
Enum:
{
active: The Job is available to have Tasks scheduled. ,
disabling: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). ,
disabled: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. ,
enabling: A user has requested that the Job be enabled, but the enable operation is still in progress. ,
terminating: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). ,
completed: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. ,
deleting: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state. ,
Format: date-time ,
Required: False ,
}
string ,
priority:
{
Description: The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
allowTaskPreemption:
{
Description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. ,
Required: False ,
}
boolean ,
maxParallelTasks:
{
Description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. ,
Format: int32 ,
Required: False ,
}
integer ,
constraints:
{
Description: The execution constraints for the Job. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
jobManagerTask:
{
Description: Details of a Job Manager Task to be launched when the Job is started. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Manager Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Manager Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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 property is not supported and must not be specified. ,
Format: int32 ,
Required: False ,
}
integer ,
killJobOnCompletion:
{
Description: Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
runExclusive:
{
Description: Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. ,
Required: False ,
}
boolean ,
applicationPackageReferences:
{
Description: 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 Application 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
allowLowPriorityNode:
{
Description: Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobPreparationTask:
{
Description: The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Preparation Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Preparation Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
waitForSuccess:
{
Description: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
rerunOnNodeRebootAfterSuccess:
{
Description: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobReleaseTask:
{
Description: The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Release Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
maxWallClockTime:
{
Description: The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: The minimum time to retain the Task directory for the Job Release Task on the Compute Node. 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. ,
Format: duration ,
Required: False ,
}
string ,
userIdentity:
{
Description: The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
commonEnvironmentSettings:
{
Description: The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
poolInfo:
{
Description: The Pool settings associated with the Job. ,
Required: True ,
}
{
poolId:
{
Description: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
string ,
autoPoolSpecification:
{
Description: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
{
autoPoolIdPrefix:
{
Description: A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. ,
Required: False ,
}
string ,
poolLifetimeOption:
{
Description: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. ,
Enum:
{
jobschedule: The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. ,
job: The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. ,
}
,
Required: True ,
}
enum ,
keepAlive:
{
Description: Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. ,
Required: False ,
}
boolean ,
pool:
{
Description: The Pool specification for the auto Pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). ,
Required: True ,
}
string ,
virtualMachineConfiguration:
{
Description: The virtual machine configuration for the Pool. This property must be specified. ,
Required: False ,
}
{
imageReference:
{
Description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ,
Required: True ,
}
{
publisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. ,
Required: False ,
}
string ,
version:
{
Description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
virtualMachineImageId:
{
Description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSKUId:
{
Description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. ,
Required: False ,
}
[
{
lun:
{
Description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in gigabytes. ,
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
licenseType:
{
Description: This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. ,
Required: False ,
}
{
type:
{
Description: The container technology to be used. ,
Enum:
{
dockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
criCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. ,
Required: False ,
}
[
string ,
]
,
}
,
nodePlacementConfiguration:
{
Description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
regional: All nodes in the pool will be allocated in the same region. ,
zonal: Nodes in the pool will be spread across different availability zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extension. ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: The version of script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: JSON formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Settings for the operating system disk of the Virtual Machine. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). ,
Required: False ,
}
{
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
cachedisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in GB when creating new OS disk. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: The storage account type for managed disk. ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs. ,
Enum:
{
NonPersistedTPM: NonPersistedTPM ,
VMGuestStateOnly: VMGuestStateOnly ,
}
,
Required: False ,
}
enum ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. ,
Required: True ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. ,
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: True ,
}
enum ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: True ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
taskSlotsPerNode:
{
Description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Required: False ,
}
{
nodeFillType:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Enum:
{
spread: Tasks should be assigned evenly across all Compute Nodes in the Pool. ,
pack: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. ,
}
,
Required: True ,
}
enum ,
}
,
resizeTimeout:
{
Description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
resourceTags:
{
Description: The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScale:
{
Description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. ,
Required: False ,
}
boolean ,
autoScaleFormula:
{
Description: The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. ,
Required: False ,
}
string ,
autoScaleEvaluationInterval:
{
Description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
enableInterNodeCommunication:
{
Description: Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. ,
Required: False ,
}
boolean ,
networkConfiguration:
{
Description: The network configuration for the Pool. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVNetAssignmentScope:
{
Description: The scope of dynamic vnet assignment. ,
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Description: The configuration for endpoints on Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
inboundNATPools:
{
Description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Enum:
{
tcp: Use TCP for the endpoint. ,
udp: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Description: The action that should be taken for a specified IP address, subnet range or tag. ,
Enum:
{
allow: Allow access. ,
deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
provision:
{
Description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. ,
Enum:
{
batchmanaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
usermanaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
nopublicipaddresses: No public IP Address will be created. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
startTask:
{
Description: A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. ,
Required: False ,
}
{
commandLine:
{
Description: The command line of the StartTask. 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). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the StartTask. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: 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. 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, however this is not recommended for a start task or any task. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. ,
Required: False ,
}
boolean ,
}
,
applicationPackageReferences:
{
Description: The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
userAccounts:
{
Description: The list of user Accounts to be created on each Compute Node in the Pool. ,
Required: False ,
}
[
{
name:
{
Description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user Account. ,
Format: password ,
Required: True ,
}
string ,
elevationLevel:
{
Description: The elevation level of the user Account. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). ,
Format: password ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: The login mode for the user. The default is 'batch'. ,
Enum:
{
batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
mountConfiguration:
{
Description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage Account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The Azure Blob Storage Container name. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
sasKey:
{
Description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
username:
{
Description: The user to use for authentication against the CIFS file system. ,
Required: True ,
}
string ,
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Description: The password to use for authentication against the CIFS file system. ,
Format: password ,
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage account name. ,
Required: True ,
}
string ,
azureFileUrl:
{
Description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage account key. ,
Format: password ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
targetNodeCommunicationMode:
{
Description: The desired node communication mode for the pool. If omitted, the default value is Default. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
upgradePolicy:
{
Description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. ,
Enum:
{
automatic: TAll virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. ,
Format: duration ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
}
,
onAllTasksComplete:
{
Description: The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
terminatejob: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
onTaskFailure:
{
Description: The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
performexitoptionsjobaction: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for the Job. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: True ,
}
string ,
skipWithdrawFromVNet:
{
Description: Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. ,
Required: True ,
}
boolean ,
}
,
metadata:
{
Description: A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
executionInfo:
{
Description: The execution information for the Job. ,
Required: False ,
}
{
startTime:
{
Description: The start time of the Job. This is the time at which the Job was created. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The completion time of the Job. This property is set only if the Job is in the completed state. ,
Format: date-time ,
Required: False ,
}
string ,
poolId:
{
Description: The ID of the Pool to which this Job is assigned. This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool. ,
Required: False ,
}
string ,
schedulingError:
{
Description: Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting the Job. ,
Required: False ,
}
{
category:
{
Description: The category of the Job scheduling error. ,
Enum:
{
usererror: The error is due to a user issue, such as misconfiguration. ,
servererror: The error is due to an internal server issue. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the Job scheduling error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional error details related to the scheduling error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
terminateReason:
{
Description: A string describing the reason the Job ended. This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a Job' operation. ,
Required: False ,
}
string ,
}
,
stats:
{
Description: Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: The total wall clock time of all Tasks in the Job. 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 a Task was retried, this includes the wall clock time of all the Task retries. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by all Tasks in the Job. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by all Tasks in the Job. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total amount of data in GiB read from disk by all Tasks in the Job. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total amount of data in GiB written to disk by all Tasks in the Job. ,
Format: float ,
Required: True ,
}
number ,
numSucceededTasks:
{
Description: The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numFailedTasks:
{
Description: The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numTaskRetries:
{
Description: The total number of retries on all the Tasks in the Job during the given time range. ,
Format: int64 ,
Required: True ,
}
string ,
waitTime:
{
Description: The total wait time of all Tasks in the Job. 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.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. ,
Format: duration ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
Jobs_ReplaceJob (updated)
Description :  This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_ReplaceJob",
  "$parameters": {
    "job": {
      "$properties": {
        "stats": [
          {
            "#name": "readIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "writeIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numSucceededTasks",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numFailedTasks",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numTaskRetries",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ,
Required: False ,
}
string ,
jobId:
{
Description: The ID of the Job whose properties you want to update. ,
Required: True ,
}
string ,
job:
{
Description: A job with updated properties ,
Required: True ,
}
{
id:
{
Description: A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the Job. ,
Required: False ,
}
string ,
usesTaskDependencies:
{
Description: Whether Tasks in the Job can define dependencies on each other. The default is false. ,
Required: False ,
}
boolean ,
url:
{
Description: The URL of the Job. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Job. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the Job. ,
Enum:
{
active: The Job is available to have Tasks scheduled. ,
disabling: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). ,
disabled: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. ,
enabling: A user has requested that the Job be enabled, but the enable operation is still in progress. ,
terminating: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). ,
completed: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. ,
deleting: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Job entered its current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Job. This property is not set if the Job is in its initial Active state. ,
Enum:
{
active: The Job is available to have Tasks scheduled. ,
disabling: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). ,
disabled: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. ,
enabling: A user has requested that the Job be enabled, but the enable operation is still in progress. ,
terminating: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). ,
completed: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. ,
deleting: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state. ,
Format: date-time ,
Required: False ,
}
string ,
priority:
{
Description: The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
allowTaskPreemption:
{
Description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. ,
Required: False ,
}
boolean ,
maxParallelTasks:
{
Description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. ,
Format: int32 ,
Required: False ,
}
integer ,
constraints:
{
Description: The execution constraints for the Job. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
jobManagerTask:
{
Description: Details of a Job Manager Task to be launched when the Job is started. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Manager Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Manager Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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 property is not supported and must not be specified. ,
Format: int32 ,
Required: False ,
}
integer ,
killJobOnCompletion:
{
Description: Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
runExclusive:
{
Description: Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. ,
Required: False ,
}
boolean ,
applicationPackageReferences:
{
Description: 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 Application 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
allowLowPriorityNode:
{
Description: Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobPreparationTask:
{
Description: The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Preparation Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Preparation Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
waitForSuccess:
{
Description: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
rerunOnNodeRebootAfterSuccess:
{
Description: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobReleaseTask:
{
Description: The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Release Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
maxWallClockTime:
{
Description: The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: The minimum time to retain the Task directory for the Job Release Task on the Compute Node. 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. ,
Format: duration ,
Required: False ,
}
string ,
userIdentity:
{
Description: The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
commonEnvironmentSettings:
{
Description: The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
poolInfo:
{
Description: The Pool settings associated with the Job. ,
Required: True ,
}
{
poolId:
{
Description: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
string ,
autoPoolSpecification:
{
Description: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
{
autoPoolIdPrefix:
{
Description: A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. ,
Required: False ,
}
string ,
poolLifetimeOption:
{
Description: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. ,
Enum:
{
jobschedule: The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. ,
job: The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. ,
}
,
Required: True ,
}
enum ,
keepAlive:
{
Description: Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. ,
Required: False ,
}
boolean ,
pool:
{
Description: The Pool specification for the auto Pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). ,
Required: True ,
}
string ,
virtualMachineConfiguration:
{
Description: The virtual machine configuration for the Pool. This property must be specified. ,
Required: False ,
}
{
imageReference:
{
Description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ,
Required: True ,
}
{
publisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. ,
Required: False ,
}
string ,
version:
{
Description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
virtualMachineImageId:
{
Description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSKUId:
{
Description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. ,
Required: False ,
}
[
{
lun:
{
Description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in gigabytes. ,
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
licenseType:
{
Description: This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. ,
Required: False ,
}
{
type:
{
Description: The container technology to be used. ,
Enum:
{
dockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
criCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. ,
Required: False ,
}
[
string ,
]
,
}
,
nodePlacementConfiguration:
{
Description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
regional: All nodes in the pool will be allocated in the same region. ,
zonal: Nodes in the pool will be spread across different availability zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extension. ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: The version of script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: JSON formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Settings for the operating system disk of the Virtual Machine. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). ,
Required: False ,
}
{
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
cachedisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in GB when creating new OS disk. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: The storage account type for managed disk. ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs. ,
Enum:
{
NonPersistedTPM: NonPersistedTPM ,
VMGuestStateOnly: VMGuestStateOnly ,
}
,
Required: False ,
}
enum ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. ,
Required: True ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. ,
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: True ,
}
enum ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: True ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
taskSlotsPerNode:
{
Description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Required: False ,
}
{
nodeFillType:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Enum:
{
spread: Tasks should be assigned evenly across all Compute Nodes in the Pool. ,
pack: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. ,
}
,
Required: True ,
}
enum ,
}
,
resizeTimeout:
{
Description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
resourceTags:
{
Description: The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScale:
{
Description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. ,
Required: False ,
}
boolean ,
autoScaleFormula:
{
Description: The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. ,
Required: False ,
}
string ,
autoScaleEvaluationInterval:
{
Description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
enableInterNodeCommunication:
{
Description: Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. ,
Required: False ,
}
boolean ,
networkConfiguration:
{
Description: The network configuration for the Pool. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVNetAssignmentScope:
{
Description: The scope of dynamic vnet assignment. ,
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Description: The configuration for endpoints on Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
inboundNATPools:
{
Description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Enum:
{
tcp: Use TCP for the endpoint. ,
udp: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Description: The action that should be taken for a specified IP address, subnet range or tag. ,
Enum:
{
allow: Allow access. ,
deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
provision:
{
Description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. ,
Enum:
{
batchmanaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
usermanaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
nopublicipaddresses: No public IP Address will be created. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
startTask:
{
Description: A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. ,
Required: False ,
}
{
commandLine:
{
Description: The command line of the StartTask. 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). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the StartTask. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: 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. 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, however this is not recommended for a start task or any task. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. ,
Required: False ,
}
boolean ,
}
,
applicationPackageReferences:
{
Description: The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
userAccounts:
{
Description: The list of user Accounts to be created on each Compute Node in the Pool. ,
Required: False ,
}
[
{
name:
{
Description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user Account. ,
Format: password ,
Required: True ,
}
string ,
elevationLevel:
{
Description: The elevation level of the user Account. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). ,
Format: password ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: The login mode for the user. The default is 'batch'. ,
Enum:
{
batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
mountConfiguration:
{
Description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage Account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The Azure Blob Storage Container name. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
sasKey:
{
Description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
username:
{
Description: The user to use for authentication against the CIFS file system. ,
Required: True ,
}
string ,
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Description: The password to use for authentication against the CIFS file system. ,
Format: password ,
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage account name. ,
Required: True ,
}
string ,
azureFileUrl:
{
Description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage account key. ,
Format: password ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
targetNodeCommunicationMode:
{
Description: The desired node communication mode for the pool. If omitted, the default value is Default. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
upgradePolicy:
{
Description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. ,
Enum:
{
automatic: TAll virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. ,
Format: duration ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
}
,
onAllTasksComplete:
{
Description: The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
terminatejob: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
onTaskFailure:
{
Description: The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
performexitoptionsjobaction: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for the Job. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: True ,
}
string ,
skipWithdrawFromVNet:
{
Description: Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. ,
Required: True ,
}
boolean ,
}
,
metadata:
{
Description: A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
executionInfo:
{
Description: The execution information for the Job. ,
Required: False ,
}
{
startTime:
{
Description: The start time of the Job. This is the time at which the Job was created. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The completion time of the Job. This property is set only if the Job is in the completed state. ,
Format: date-time ,
Required: False ,
}
string ,
poolId:
{
Description: The ID of the Pool to which this Job is assigned. This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool. ,
Required: False ,
}
string ,
schedulingError:
{
Description: Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting the Job. ,
Required: False ,
}
{
category:
{
Description: The category of the Job scheduling error. ,
Enum:
{
usererror: The error is due to a user issue, such as misconfiguration. ,
servererror: The error is due to an internal server issue. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the Job scheduling error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional error details related to the scheduling error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
terminateReason:
{
Description: A string describing the reason the Job ended. This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a Job' operation. ,
Required: False ,
}
string ,
}
,
stats:
{
Description: Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: The total wall clock time of all Tasks in the Job. 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 a Task was retried, this includes the wall clock time of all the Task retries. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by all Tasks in the Job. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by all Tasks in the Job. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total amount of data in GiB read from disk by all Tasks in the Job. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total amount of data in GiB written to disk by all Tasks in the Job. ,
Format: float ,
Required: True ,
}
number ,
numSucceededTasks:
{
Description: The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numFailedTasks:
{
Description: The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numTaskRetries:
{
Description: The total number of retries on all the Tasks in the Job during the given time range. ,
Format: int64 ,
Required: True ,
}
string ,
waitTime:
{
Description: The total wait time of all Tasks in the Job. 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.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. ,
Format: duration ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
dataserviceid:
{
Description: The OData ID of the resource to which the request applied. ,
}
string ,
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
Tasks_ListTasks (updated)
Description :  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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Tasks_ListTasks",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "stats": [
              {
                "#name": "readIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "writeIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /jobs/{jobId}/tasks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. A maximum of 1000 applications can be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
jobId:
{
Description: The ID of the Job. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasks. ,
Required: False ,
}
string ,
$select:
{
Description: An OData $select clause. ,
Required: False ,
}
array ,
$expand:
{
Description: An OData $expand clause. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}
,
$schema:
{
Description: The result of listing the Tasks in a Job. ,
}
{
value:
{
Description: The list of Tasks. ,
Required: False ,
}
[
{
id:
{
Description: 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. ,
Required: False ,
}
string ,
displayName:
{
Description: 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. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Task. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Task. 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. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Task. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Task. ,
Format: date-time ,
Required: False ,
}
string ,
exitConditions:
{
Description: How the Batch service should respond when the Task completes. ,
Required: False ,
}
{
exitCodes:
{
Description: A list of individual Task exit codes and how the Batch service should respond to them. ,
Required: False ,
}
[
{
code:
{
Description: A process exit code. ,
Format: int32 ,
Required: True ,
}
integer ,
exitOptions:
{
Description: How the Batch service should respond if the Task exits with this exit code. ,
Required: True ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
exitCodeRanges:
{
Description: A list of Task exit code ranges and how the Batch service should respond to them. ,
Required: False ,
}
[
{
start:
{
Description: The first exit code in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
end:
{
Description: The last exit code in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
exitOptions:
{
Description: How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive). ,
Required: True ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
preProcessingError:
{
Description: How the Batch service should respond if the Task fails to start due to an error. ,
Required: False ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
fileUploadError:
{
Description: 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. ,
Required: False ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
default:
{
Description: 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. ,
Required: False ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
state:
{
Description: The current state of the Task. ,
Enum:
{
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 Compute 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 Compute Node. ,
running: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying 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. ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Task entered its current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Task. This property is not set if the Task is in its initial Active state. ,
Enum:
{
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 Compute 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 Compute Node. ,
running: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying 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. ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Task entered its previous state. This property is not set if the Task is in its initial Active state. ,
Format: date-time ,
Required: False ,
}
string ,
commandLine:
{
Description: 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). ,
Required: False ,
}
string ,
containerSettings:
{
Description: 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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
affinityInfo:
{
Description: A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. ,
Required: False ,
}
{
affinityId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
constraints:
{
Description: The execution constraints that apply to this Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
userIdentity:
{
Description: The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
executionInfo:
{
Description: Information about the execution of the Task. ,
Required: False ,
}
{
startTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time at which the Task completed. This property is set only if the Task is in the Completed state. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
containerInfo:
{
Description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. ,
Required: False ,
}
{
containerId:
{
Description: The ID of the container. ,
Required: False ,
}
string ,
state:
{
Description: 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". ,
Required: False ,
}
string ,
error:
{
Description: 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". ,
Required: False ,
}
string ,
}
,
failureInfo:
{
Description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. ,
Required: False ,
}
{
category:
{
Description: The category of the Task error. ,
Enum:
{
usererror: The error is due to a user issue, such as misconfiguration. ,
servererror: The error is due to an internal server issue. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the Task error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details related to the error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
retryCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
lastRetryTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
requeueCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
lastRequeueTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. ,
Enum:
{
success: The Task ran successfully. ,
failure: There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited. ,
}
,
Required: False ,
}
enum ,
}
,
nodeInfo:
{
Description: Information about the Compute Node on which the Task ran. ,
Required: False ,
}
{
affinityId:
{
Description: 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. ,
Required: False ,
}
string ,
nodeUrl:
{
Description: The URL of the Compute Node on which the Task ran. ,
Required: False ,
}
string ,
poolId:
{
Description: The ID of the Pool on which the Task ran. ,
Required: False ,
}
string ,
nodeId:
{
Description: The ID of the Compute Node on which the Task ran. ,
Required: False ,
}
string ,
taskRootDirectory:
{
Description: The root directory of the Task on the Compute Node. ,
Required: False ,
}
string ,
taskRootDirectoryUrl:
{
Description: The URL to the root directory of the Task on the Compute Node. ,
Required: False ,
}
string ,
}
,
multiInstanceSettings:
{
Description: An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task. ,
Required: False ,
}
{
numberOfInstances:
{
Description: The number of Compute Nodes required by the Task. If omitted, the default is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinationCommandLine:
{
Description: 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. ,
Required: True ,
}
string ,
commonResourceFiles:
{
Description: 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
stats:
{
Description: Resource usage statistics for the Task. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by the Task. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by the Task. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total gibibytes read from disk by the Task. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total gibibytes written to disk by the Task. ,
Format: float ,
Required: True ,
}
number ,
waitTime:
{
Description: 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.). ,
Format: duration ,
Required: True ,
}
string ,
}
,
dependsOn:
{
Description: 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. ,
Required: False ,
}
{
taskIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
taskIdRanges:
{
Description: 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. ,
Required: False ,
}
[
{
start:
{
Description: The first Task ID in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
end:
{
Description: The last Task ID in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
applicationPackageReferences:
{
Description: 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
odata.nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
Tasks_GetTask (updated)
Description :  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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Tasks_GetTask",
  "$responses": {
    "200": {
      "$properties": {
        "stats": [
          {
            "#name": "readIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "writeIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /jobs/{jobId}/tasks/{taskId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ,
Required: False ,
}
string ,
jobId:
{
Description: The ID of the Job that contains the Task. ,
Required: True ,
}
string ,
taskId:
{
Description: The ID of the Task to get information about. ,
Required: True ,
}
string ,
$select:
{
Description: An OData $select clause. ,
Required: False ,
}
array ,
$expand:
{
Description: An OData $expand clause. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
dataserviceid:
{
Description: The OData ID of the resource to which the request applied. ,
}
string ,
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}
,
$schema:
{
Description: 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:
{
Description: 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. ,
Required: False ,
}
string ,
displayName:
{
Description: 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. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Task. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Task. 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. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Task. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Task. ,
Format: date-time ,
Required: False ,
}
string ,
exitConditions:
{
Description: How the Batch service should respond when the Task completes. ,
Required: False ,
}
{
exitCodes:
{
Description: A list of individual Task exit codes and how the Batch service should respond to them. ,
Required: False ,
}
[
{
code:
{
Description: A process exit code. ,
Format: int32 ,
Required: True ,
}
integer ,
exitOptions:
{
Description: How the Batch service should respond if the Task exits with this exit code. ,
Required: True ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
exitCodeRanges:
{
Description: A list of Task exit code ranges and how the Batch service should respond to them. ,
Required: False ,
}
[
{
start:
{
Description: The first exit code in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
end:
{
Description: The last exit code in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
exitOptions:
{
Description: How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive). ,
Required: True ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
preProcessingError:
{
Description: How the Batch service should respond if the Task fails to start due to an error. ,
Required: False ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
fileUploadError:
{
Description: 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. ,
Required: False ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
default:
{
Description: 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. ,
Required: False ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
state:
{
Description: The current state of the Task. ,
Enum:
{
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 Compute 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 Compute Node. ,
running: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying 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. ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Task entered its current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Task. This property is not set if the Task is in its initial Active state. ,
Enum:
{
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 Compute 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 Compute Node. ,
running: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying 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. ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Task entered its previous state. This property is not set if the Task is in its initial Active state. ,
Format: date-time ,
Required: False ,
}
string ,
commandLine:
{
Description: 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). ,
Required: False ,
}
string ,
containerSettings:
{
Description: 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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
affinityInfo:
{
Description: A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. ,
Required: False ,
}
{
affinityId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
constraints:
{
Description: The execution constraints that apply to this Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
userIdentity:
{
Description: The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
executionInfo:
{
Description: Information about the execution of the Task. ,
Required: False ,
}
{
startTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time at which the Task completed. This property is set only if the Task is in the Completed state. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
containerInfo:
{
Description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. ,
Required: False ,
}
{
containerId:
{
Description: The ID of the container. ,
Required: False ,
}
string ,
state:
{
Description: 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". ,
Required: False ,
}
string ,
error:
{
Description: 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". ,
Required: False ,
}
string ,
}
,
failureInfo:
{
Description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. ,
Required: False ,
}
{
category:
{
Description: The category of the Task error. ,
Enum:
{
usererror: The error is due to a user issue, such as misconfiguration. ,
servererror: The error is due to an internal server issue. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the Task error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details related to the error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
retryCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
lastRetryTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
requeueCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
lastRequeueTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. ,
Enum:
{
success: The Task ran successfully. ,
failure: There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited. ,
}
,
Required: False ,
}
enum ,
}
,
nodeInfo:
{
Description: Information about the Compute Node on which the Task ran. ,
Required: False ,
}
{
affinityId:
{
Description: 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. ,
Required: False ,
}
string ,
nodeUrl:
{
Description: The URL of the Compute Node on which the Task ran. ,
Required: False ,
}
string ,
poolId:
{
Description: The ID of the Pool on which the Task ran. ,
Required: False ,
}
string ,
nodeId:
{
Description: The ID of the Compute Node on which the Task ran. ,
Required: False ,
}
string ,
taskRootDirectory:
{
Description: The root directory of the Task on the Compute Node. ,
Required: False ,
}
string ,
taskRootDirectoryUrl:
{
Description: The URL to the root directory of the Task on the Compute Node. ,
Required: False ,
}
string ,
}
,
multiInstanceSettings:
{
Description: An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task. ,
Required: False ,
}
{
numberOfInstances:
{
Description: The number of Compute Nodes required by the Task. If omitted, the default is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinationCommandLine:
{
Description: 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. ,
Required: True ,
}
string ,
commonResourceFiles:
{
Description: 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
stats:
{
Description: Resource usage statistics for the Task. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by the Task. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by the Task. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total gibibytes read from disk by the Task. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total gibibytes written to disk by the Task. ,
Format: float ,
Required: True ,
}
number ,
waitTime:
{
Description: 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.). ,
Format: duration ,
Required: True ,
}
string ,
}
,
dependsOn:
{
Description: 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. ,
Required: False ,
}
{
taskIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
taskIdRanges:
{
Description: 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. ,
Required: False ,
}
[
{
start:
{
Description: The first Task ID in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
end:
{
Description: The last Task ID in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
applicationPackageReferences:
{
Description: 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
Tasks_ReplaceTask (updated)
Description :  Updates the properties of the specified Task.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Tasks_ReplaceTask",
  "$parameters": {
    "task": {
      "$properties": {
        "stats": [
          {
            "#name": "readIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "writeIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /jobs/{jobId}/tasks/{taskId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ,
Required: False ,
}
string ,
jobId:
{
Description: The ID of the Job containing the Task. ,
Required: True ,
}
string ,
taskId:
{
Description: The ID of the Task to update. ,
Required: True ,
}
string ,
task:
{
Description: The Task to update. ,
Required: True ,
}
{
id:
{
Description: 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. ,
Required: False ,
}
string ,
displayName:
{
Description: 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. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Task. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Task. 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. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Task. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Task. ,
Format: date-time ,
Required: False ,
}
string ,
exitConditions:
{
Description: How the Batch service should respond when the Task completes. ,
Required: False ,
}
{
exitCodes:
{
Description: A list of individual Task exit codes and how the Batch service should respond to them. ,
Required: False ,
}
[
{
code:
{
Description: A process exit code. ,
Format: int32 ,
Required: True ,
}
integer ,
exitOptions:
{
Description: How the Batch service should respond if the Task exits with this exit code. ,
Required: True ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
exitCodeRanges:
{
Description: A list of Task exit code ranges and how the Batch service should respond to them. ,
Required: False ,
}
[
{
start:
{
Description: The first exit code in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
end:
{
Description: The last exit code in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
exitOptions:
{
Description: How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive). ,
Required: True ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
preProcessingError:
{
Description: How the Batch service should respond if the Task fails to start due to an error. ,
Required: False ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
fileUploadError:
{
Description: 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. ,
Required: False ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
default:
{
Description: 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. ,
Required: False ,
}
{
jobAction:
{
Description: 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). ,
Enum:
{
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 terminationReason in the Job's executionInfo is set to "TaskFailed". ,
}
,
Required: False ,
}
enum ,
dependencyAction:
{
Description: 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. ,
Enum:
{
satisfy: Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run. ,
block: Blocks tasks waiting on this task, preventing them from being scheduled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
state:
{
Description: The current state of the Task. ,
Enum:
{
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 Compute 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 Compute Node. ,
running: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying 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. ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Task entered its current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Task. This property is not set if the Task is in its initial Active state. ,
Enum:
{
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 Compute 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 Compute Node. ,
running: The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying 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. ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Task entered its previous state. This property is not set if the Task is in its initial Active state. ,
Format: date-time ,
Required: False ,
}
string ,
commandLine:
{
Description: 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). ,
Required: False ,
}
string ,
containerSettings:
{
Description: 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. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
affinityInfo:
{
Description: A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. ,
Required: False ,
}
{
affinityId:
{
Description: 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. ,
Required: True ,
}
string ,
}
,
constraints:
{
Description: The execution constraints that apply to this Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
userIdentity:
{
Description: The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
executionInfo:
{
Description: Information about the execution of the Task. ,
Required: False ,
}
{
startTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time at which the Task completed. This property is set only if the Task is in the Completed state. ,
Format: date-time ,
Required: False ,
}
string ,
exitCode:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
containerInfo:
{
Description: Information about the container under which the Task is executing. This property is set only if the Task runs in a container context. ,
Required: False ,
}
{
containerId:
{
Description: The ID of the container. ,
Required: False ,
}
string ,
state:
{
Description: 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". ,
Required: False ,
}
string ,
error:
{
Description: 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". ,
Required: False ,
}
string ,
}
,
failureInfo:
{
Description: Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. ,
Required: False ,
}
{
category:
{
Description: The category of the Task error. ,
Enum:
{
usererror: The error is due to a user issue, such as misconfiguration. ,
servererror: The error is due to an internal server issue. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the Task error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details related to the error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
retryCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
lastRetryTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
requeueCount:
{
Description: 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. ,
Format: int32 ,
Required: True ,
}
integer ,
lastRequeueTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. ,
Enum:
{
success: The Task ran successfully. ,
failure: There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited. ,
}
,
Required: False ,
}
enum ,
}
,
nodeInfo:
{
Description: Information about the Compute Node on which the Task ran. ,
Required: False ,
}
{
affinityId:
{
Description: 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. ,
Required: False ,
}
string ,
nodeUrl:
{
Description: The URL of the Compute Node on which the Task ran. ,
Required: False ,
}
string ,
poolId:
{
Description: The ID of the Pool on which the Task ran. ,
Required: False ,
}
string ,
nodeId:
{
Description: The ID of the Compute Node on which the Task ran. ,
Required: False ,
}
string ,
taskRootDirectory:
{
Description: The root directory of the Task on the Compute Node. ,
Required: False ,
}
string ,
taskRootDirectoryUrl:
{
Description: The URL to the root directory of the Task on the Compute Node. ,
Required: False ,
}
string ,
}
,
multiInstanceSettings:
{
Description: An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task. ,
Required: False ,
}
{
numberOfInstances:
{
Description: The number of Compute Nodes required by the Task. If omitted, the default is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
coordinationCommandLine:
{
Description: 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. ,
Required: True ,
}
string ,
commonResourceFiles:
{
Description: 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
stats:
{
Description: Resource usage statistics for the Task. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by the Task. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by the Task. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total gibibytes read from disk by the Task. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total gibibytes written to disk by the Task. ,
Format: float ,
Required: True ,
}
number ,
waitTime:
{
Description: 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.). ,
Format: duration ,
Required: True ,
}
string ,
}
,
dependsOn:
{
Description: 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. ,
Required: False ,
}
{
taskIds:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
taskIdRanges:
{
Description: 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. ,
Required: False ,
}
[
{
start:
{
Description: The first Task ID in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
end:
{
Description: The last Task ID in the range. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
applicationPackageReferences:
{
Description: 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
dataserviceid:
{
Description: The OData ID of the resource to which the request applied. ,
}
string ,
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
JobSchedules_ListJobSchedules (updated)
Description :  Lists all of the Job Schedules in the specified Account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobSchedules_ListJobSchedules",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "stats": [
              {
                "#name": "readIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "writeIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "numSucceededTasks",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "numFailedTasks",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "numTaskRetries",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /jobschedules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. A maximum of 1000 applications can be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. ,
Required: False ,
}
string ,
$select:
{
Description: An OData $select clause. ,
Required: False ,
}
array ,
$expand:
{
Description: An OData $expand clause. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}
,
$schema:
{
Description: The result of listing the Job Schedules in an Account. ,
}
{
value:
{
Description: The list of Job Schedules. ,
Required: False ,
}
[
{
id:
{
Description: A string that uniquely identifies the schedule within the Account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the schedule. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Job Schedule. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Job Schedule. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the Job Schedule. ,
Enum:
{
active: The Job Schedule is active and will create Jobs as per its schedule. ,
completed: The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly. ,
disabled: The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run. ,
terminating: The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active. ,
deleting: The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted. ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Job Schedule entered the current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state. ,
Enum:
{
active: The Job Schedule is active and will create Jobs as per its schedule. ,
completed: The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly. ,
disabled: The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run. ,
terminating: The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active. ,
deleting: The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted. ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. ,
Required: False ,
}
{
doNotRunUntil:
{
Description: The earliest time at which any Job may be created under this Job Schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately. ,
Format: date-time ,
Required: False ,
}
string ,
doNotRunAfter:
{
Description: A time after which no Job will be created under this Job Schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active Job under this Job Schedule. If you do not specify a doNotRunAfter time, and you are creating a recurring Job Schedule, the Job Schedule will remain active until you explicitly terminate it. ,
Format: date-time ,
Required: False ,
}
string ,
startWindow:
{
Description: The time interval, starting from the time at which the schedule indicates a Job should be created, within which a Job must be created. If a Job is not created within the startWindow interval, then the 'opportunity' is lost; no Job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the Job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
recurrenceInterval:
{
Description: The time interval between the start times of two successive Jobs under the Job Schedule. A Job Schedule can have at most one active Job under it at any given time. Because a Job Schedule can have at most one active Job under it at any given time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
}
,
jobSpecification:
{
Description: The details of the Jobs to be created on this schedule. ,
Required: True ,
}
{
priority:
{
Description: The priority of Jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API. ,
Format: int32 ,
Required: False ,
}
integer ,
allowTaskPreemption:
{
Description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. ,
Required: False ,
}
boolean ,
maxParallelTasks:
{
Description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The display name for Jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
usesTaskDependencies:
{
Description: Whether Tasks in the Job can define dependencies on each other. The default is false. ,
Required: False ,
}
boolean ,
onAllTasksComplete:
{
Description: The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
terminatejob: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
onTaskFailure:
{
Description: The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
performexitoptionsjobaction: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for the Job. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: True ,
}
string ,
skipWithdrawFromVNet:
{
Description: Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. ,
Required: True ,
}
boolean ,
}
,
constraints:
{
Description: The execution constraints for Jobs created under this schedule. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
jobManagerTask:
{
Description: The details of a Job Manager Task to be launched when a Job is started under this schedule. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Manager Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Manager Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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 property is not supported and must not be specified. ,
Format: int32 ,
Required: False ,
}
integer ,
killJobOnCompletion:
{
Description: Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
runExclusive:
{
Description: Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. ,
Required: False ,
}
boolean ,
applicationPackageReferences:
{
Description: 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 Application 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
allowLowPriorityNode:
{
Description: Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobPreparationTask:
{
Description: The Job Preparation Task for Jobs created under this schedule. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Preparation Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Preparation Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
waitForSuccess:
{
Description: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
rerunOnNodeRebootAfterSuccess:
{
Description: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobReleaseTask:
{
Description: The Job Release Task for Jobs created under this schedule. The primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Release Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
maxWallClockTime:
{
Description: The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: The minimum time to retain the Task directory for the Job Release Task on the Compute Node. 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. ,
Format: duration ,
Required: False ,
}
string ,
userIdentity:
{
Description: The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
commonEnvironmentSettings:
{
Description: A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
poolInfo:
{
Description: The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. ,
Required: True ,
}
{
poolId:
{
Description: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
string ,
autoPoolSpecification:
{
Description: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
{
autoPoolIdPrefix:
{
Description: A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. ,
Required: False ,
}
string ,
poolLifetimeOption:
{
Description: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. ,
Enum:
{
jobschedule: The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. ,
job: The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. ,
}
,
Required: True ,
}
enum ,
keepAlive:
{
Description: Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. ,
Required: False ,
}
boolean ,
pool:
{
Description: The Pool specification for the auto Pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). ,
Required: True ,
}
string ,
virtualMachineConfiguration:
{
Description: The virtual machine configuration for the Pool. This property must be specified. ,
Required: False ,
}
{
imageReference:
{
Description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ,
Required: True ,
}
{
publisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. ,
Required: False ,
}
string ,
version:
{
Description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
virtualMachineImageId:
{
Description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSKUId:
{
Description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. ,
Required: False ,
}
[
{
lun:
{
Description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in gigabytes. ,
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
licenseType:
{
Description: This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. ,
Required: False ,
}
{
type:
{
Description: The container technology to be used. ,
Enum:
{
dockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
criCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. ,
Required: False ,
}
[
string ,
]
,
}
,
nodePlacementConfiguration:
{
Description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
regional: All nodes in the pool will be allocated in the same region. ,
zonal: Nodes in the pool will be spread across different availability zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extension. ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: The version of script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: JSON formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Settings for the operating system disk of the Virtual Machine. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). ,
Required: False ,
}
{
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
cachedisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in GB when creating new OS disk. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: The storage account type for managed disk. ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs. ,
Enum:
{
NonPersistedTPM: NonPersistedTPM ,
VMGuestStateOnly: VMGuestStateOnly ,
}
,
Required: False ,
}
enum ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. ,
Required: True ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. ,
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: True ,
}
enum ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: True ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
taskSlotsPerNode:
{
Description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Required: False ,
}
{
nodeFillType:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Enum:
{
spread: Tasks should be assigned evenly across all Compute Nodes in the Pool. ,
pack: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. ,
}
,
Required: True ,
}
enum ,
}
,
resizeTimeout:
{
Description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
resourceTags:
{
Description: The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScale:
{
Description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. ,
Required: False ,
}
boolean ,
autoScaleFormula:
{
Description: The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. ,
Required: False ,
}
string ,
autoScaleEvaluationInterval:
{
Description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
enableInterNodeCommunication:
{
Description: Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. ,
Required: False ,
}
boolean ,
networkConfiguration:
{
Description: The network configuration for the Pool. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVNetAssignmentScope:
{
Description: The scope of dynamic vnet assignment. ,
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Description: The configuration for endpoints on Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
inboundNATPools:
{
Description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Enum:
{
tcp: Use TCP for the endpoint. ,
udp: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Description: The action that should be taken for a specified IP address, subnet range or tag. ,
Enum:
{
allow: Allow access. ,
deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
provision:
{
Description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. ,
Enum:
{
batchmanaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
usermanaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
nopublicipaddresses: No public IP Address will be created. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
startTask:
{
Description: A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. ,
Required: False ,
}
{
commandLine:
{
Description: The command line of the StartTask. 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). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the StartTask. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: 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. 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, however this is not recommended for a start task or any task. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. ,
Required: False ,
}
boolean ,
}
,
applicationPackageReferences:
{
Description: The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
userAccounts:
{
Description: The list of user Accounts to be created on each Compute Node in the Pool. ,
Required: False ,
}
[
{
name:
{
Description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user Account. ,
Format: password ,
Required: True ,
}
string ,
elevationLevel:
{
Description: The elevation level of the user Account. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). ,
Format: password ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: The login mode for the user. The default is 'batch'. ,
Enum:
{
batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
mountConfiguration:
{
Description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage Account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The Azure Blob Storage Container name. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
sasKey:
{
Description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
username:
{
Description: The user to use for authentication against the CIFS file system. ,
Required: True ,
}
string ,
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Description: The password to use for authentication against the CIFS file system. ,
Format: password ,
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage account name. ,
Required: True ,
}
string ,
azureFileUrl:
{
Description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage account key. ,
Format: password ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
targetNodeCommunicationMode:
{
Description: The desired node communication mode for the pool. If omitted, the default value is Default. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
upgradePolicy:
{
Description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. ,
Enum:
{
automatic: TAll virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. ,
Format: duration ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
}
,
metadata:
{
Description: A list of name-value pairs associated with each Job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
}
,
executionInfo:
{
Description: Information about Jobs that have been and will be run under this schedule. ,
Required: False ,
}
{
nextRunTime:
{
Description: The next time at which a Job will be created under this schedule. This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no Job will be created at nextRunTime unless the Job is enabled before then. ,
Format: date-time ,
Required: False ,
}
string ,
recentJob:
{
Description: Information about the most recent Job under the Job Schedule. This property is present only if the at least one Job has run under the schedule. ,
Required: False ,
}
{
id:
{
Description: The ID of the Job. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Job. ,
Required: False ,
}
string ,
}
,
endTime:
{
Description: The time at which the schedule ended. This property is set only if the Job Schedule is in the completed state. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
stats:
{
Description: The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: The total wall clock time of all the Tasks in all the Jobs created under the schedule. 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 a Task was retried, this includes the wall clock time of all the Task retries. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by all Tasks in all Jobs created under the schedule. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by all Tasks in all Jobs created under the schedule. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total gibibytes read from disk by all Tasks in all Jobs created under the schedule. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total gibibytes written to disk by all Tasks in all Jobs created under the schedule. ,
Format: float ,
Required: True ,
}
number ,
numSucceededTasks:
{
Description: The total number of Tasks successfully completed during the given time range in Jobs created under the schedule. A Task completes successfully if it returns exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numFailedTasks:
{
Description: The total number of Tasks that failed during the given time range in Jobs created under the schedule. A Task fails if it exhausts its maximum retry count without returning exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numTaskRetries:
{
Description: The total number of retries during the given time range on all Tasks in all Jobs created under the schedule. ,
Format: int64 ,
Required: True ,
}
string ,
waitTime:
{
Description: The total wait time of all Tasks in all Jobs created under the schedule. 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.). This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. ,
Format: duration ,
Required: True ,
}
string ,
}
,
}
,
]
,
odata.nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
JobSchedules_GetJobSchedule (updated)
Description :  Gets information about the specified Job Schedule.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobSchedules_GetJobSchedule",
  "$responses": {
    "200": {
      "$properties": {
        "stats": [
          {
            "#name": "readIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "writeIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numSucceededTasks",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numFailedTasks",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numTaskRetries",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /jobschedules/{jobScheduleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ,
Required: False ,
}
string ,
jobScheduleId:
{
Description: The ID of the Job Schedule to get. ,
Required: True ,
}
string ,
$select:
{
Description: An OData $select clause. ,
Required: False ,
}
array ,
$expand:
{
Description: An OData $expand clause. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}
,
$schema:
{
Description: A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job. ,
}
{
id:
{
Description: A string that uniquely identifies the schedule within the Account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the schedule. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Job Schedule. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Job Schedule. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the Job Schedule. ,
Enum:
{
active: The Job Schedule is active and will create Jobs as per its schedule. ,
completed: The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly. ,
disabled: The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run. ,
terminating: The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active. ,
deleting: The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted. ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Job Schedule entered the current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state. ,
Enum:
{
active: The Job Schedule is active and will create Jobs as per its schedule. ,
completed: The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly. ,
disabled: The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run. ,
terminating: The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active. ,
deleting: The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted. ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. ,
Required: False ,
}
{
doNotRunUntil:
{
Description: The earliest time at which any Job may be created under this Job Schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately. ,
Format: date-time ,
Required: False ,
}
string ,
doNotRunAfter:
{
Description: A time after which no Job will be created under this Job Schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active Job under this Job Schedule. If you do not specify a doNotRunAfter time, and you are creating a recurring Job Schedule, the Job Schedule will remain active until you explicitly terminate it. ,
Format: date-time ,
Required: False ,
}
string ,
startWindow:
{
Description: The time interval, starting from the time at which the schedule indicates a Job should be created, within which a Job must be created. If a Job is not created within the startWindow interval, then the 'opportunity' is lost; no Job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the Job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
recurrenceInterval:
{
Description: The time interval between the start times of two successive Jobs under the Job Schedule. A Job Schedule can have at most one active Job under it at any given time. Because a Job Schedule can have at most one active Job under it at any given time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
}
,
jobSpecification:
{
Description: The details of the Jobs to be created on this schedule. ,
Required: True ,
}
{
priority:
{
Description: The priority of Jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API. ,
Format: int32 ,
Required: False ,
}
integer ,
allowTaskPreemption:
{
Description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. ,
Required: False ,
}
boolean ,
maxParallelTasks:
{
Description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The display name for Jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
usesTaskDependencies:
{
Description: Whether Tasks in the Job can define dependencies on each other. The default is false. ,
Required: False ,
}
boolean ,
onAllTasksComplete:
{
Description: The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
terminatejob: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
onTaskFailure:
{
Description: The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
performexitoptionsjobaction: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for the Job. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: True ,
}
string ,
skipWithdrawFromVNet:
{
Description: Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. ,
Required: True ,
}
boolean ,
}
,
constraints:
{
Description: The execution constraints for Jobs created under this schedule. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
jobManagerTask:
{
Description: The details of a Job Manager Task to be launched when a Job is started under this schedule. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Manager Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Manager Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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 property is not supported and must not be specified. ,
Format: int32 ,
Required: False ,
}
integer ,
killJobOnCompletion:
{
Description: Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
runExclusive:
{
Description: Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. ,
Required: False ,
}
boolean ,
applicationPackageReferences:
{
Description: 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 Application 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
allowLowPriorityNode:
{
Description: Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobPreparationTask:
{
Description: The Job Preparation Task for Jobs created under this schedule. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Preparation Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Preparation Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
waitForSuccess:
{
Description: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
rerunOnNodeRebootAfterSuccess:
{
Description: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobReleaseTask:
{
Description: The Job Release Task for Jobs created under this schedule. The primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Release Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
maxWallClockTime:
{
Description: The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: The minimum time to retain the Task directory for the Job Release Task on the Compute Node. 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. ,
Format: duration ,
Required: False ,
}
string ,
userIdentity:
{
Description: The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
commonEnvironmentSettings:
{
Description: A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
poolInfo:
{
Description: The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. ,
Required: True ,
}
{
poolId:
{
Description: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
string ,
autoPoolSpecification:
{
Description: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
{
autoPoolIdPrefix:
{
Description: A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. ,
Required: False ,
}
string ,
poolLifetimeOption:
{
Description: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. ,
Enum:
{
jobschedule: The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. ,
job: The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. ,
}
,
Required: True ,
}
enum ,
keepAlive:
{
Description: Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. ,
Required: False ,
}
boolean ,
pool:
{
Description: The Pool specification for the auto Pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). ,
Required: True ,
}
string ,
virtualMachineConfiguration:
{
Description: The virtual machine configuration for the Pool. This property must be specified. ,
Required: False ,
}
{
imageReference:
{
Description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ,
Required: True ,
}
{
publisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. ,
Required: False ,
}
string ,
version:
{
Description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
virtualMachineImageId:
{
Description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSKUId:
{
Description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. ,
Required: False ,
}
[
{
lun:
{
Description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in gigabytes. ,
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
licenseType:
{
Description: This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. ,
Required: False ,
}
{
type:
{
Description: The container technology to be used. ,
Enum:
{
dockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
criCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. ,
Required: False ,
}
[
string ,
]
,
}
,
nodePlacementConfiguration:
{
Description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
regional: All nodes in the pool will be allocated in the same region. ,
zonal: Nodes in the pool will be spread across different availability zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extension. ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: The version of script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: JSON formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Settings for the operating system disk of the Virtual Machine. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). ,
Required: False ,
}
{
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
cachedisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in GB when creating new OS disk. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: The storage account type for managed disk. ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs. ,
Enum:
{
NonPersistedTPM: NonPersistedTPM ,
VMGuestStateOnly: VMGuestStateOnly ,
}
,
Required: False ,
}
enum ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. ,
Required: True ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. ,
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: True ,
}
enum ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: True ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
taskSlotsPerNode:
{
Description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Required: False ,
}
{
nodeFillType:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Enum:
{
spread: Tasks should be assigned evenly across all Compute Nodes in the Pool. ,
pack: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. ,
}
,
Required: True ,
}
enum ,
}
,
resizeTimeout:
{
Description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
resourceTags:
{
Description: The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScale:
{
Description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. ,
Required: False ,
}
boolean ,
autoScaleFormula:
{
Description: The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. ,
Required: False ,
}
string ,
autoScaleEvaluationInterval:
{
Description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
enableInterNodeCommunication:
{
Description: Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. ,
Required: False ,
}
boolean ,
networkConfiguration:
{
Description: The network configuration for the Pool. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVNetAssignmentScope:
{
Description: The scope of dynamic vnet assignment. ,
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Description: The configuration for endpoints on Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
inboundNATPools:
{
Description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Enum:
{
tcp: Use TCP for the endpoint. ,
udp: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Description: The action that should be taken for a specified IP address, subnet range or tag. ,
Enum:
{
allow: Allow access. ,
deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
provision:
{
Description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. ,
Enum:
{
batchmanaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
usermanaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
nopublicipaddresses: No public IP Address will be created. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
startTask:
{
Description: A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. ,
Required: False ,
}
{
commandLine:
{
Description: The command line of the StartTask. 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). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the StartTask. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: 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. 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, however this is not recommended for a start task or any task. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. ,
Required: False ,
}
boolean ,
}
,
applicationPackageReferences:
{
Description: The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
userAccounts:
{
Description: The list of user Accounts to be created on each Compute Node in the Pool. ,
Required: False ,
}
[
{
name:
{
Description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user Account. ,
Format: password ,
Required: True ,
}
string ,
elevationLevel:
{
Description: The elevation level of the user Account. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). ,
Format: password ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: The login mode for the user. The default is 'batch'. ,
Enum:
{
batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
mountConfiguration:
{
Description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage Account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The Azure Blob Storage Container name. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
sasKey:
{
Description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
username:
{
Description: The user to use for authentication against the CIFS file system. ,
Required: True ,
}
string ,
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Description: The password to use for authentication against the CIFS file system. ,
Format: password ,
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage account name. ,
Required: True ,
}
string ,
azureFileUrl:
{
Description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage account key. ,
Format: password ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
targetNodeCommunicationMode:
{
Description: The desired node communication mode for the pool. If omitted, the default value is Default. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
upgradePolicy:
{
Description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. ,
Enum:
{
automatic: TAll virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. ,
Format: duration ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
}
,
metadata:
{
Description: A list of name-value pairs associated with each Job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
}
,
executionInfo:
{
Description: Information about Jobs that have been and will be run under this schedule. ,
Required: False ,
}
{
nextRunTime:
{
Description: The next time at which a Job will be created under this schedule. This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no Job will be created at nextRunTime unless the Job is enabled before then. ,
Format: date-time ,
Required: False ,
}
string ,
recentJob:
{
Description: Information about the most recent Job under the Job Schedule. This property is present only if the at least one Job has run under the schedule. ,
Required: False ,
}
{
id:
{
Description: The ID of the Job. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Job. ,
Required: False ,
}
string ,
}
,
endTime:
{
Description: The time at which the schedule ended. This property is set only if the Job Schedule is in the completed state. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
stats:
{
Description: The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: The total wall clock time of all the Tasks in all the Jobs created under the schedule. 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 a Task was retried, this includes the wall clock time of all the Task retries. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by all Tasks in all Jobs created under the schedule. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by all Tasks in all Jobs created under the schedule. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total gibibytes read from disk by all Tasks in all Jobs created under the schedule. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total gibibytes written to disk by all Tasks in all Jobs created under the schedule. ,
Format: float ,
Required: True ,
}
number ,
numSucceededTasks:
{
Description: The total number of Tasks successfully completed during the given time range in Jobs created under the schedule. A Task completes successfully if it returns exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numFailedTasks:
{
Description: The total number of Tasks that failed during the given time range in Jobs created under the schedule. A Task fails if it exhausts its maximum retry count without returning exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numTaskRetries:
{
Description: The total number of retries during the given time range on all Tasks in all Jobs created under the schedule. ,
Format: int64 ,
Required: True ,
}
string ,
waitTime:
{
Description: The total wait time of all Tasks in all Jobs created under the schedule. 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.). This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. ,
Format: duration ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
JobSchedules_ReplaceJobSchedule (updated)
Description :  This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobSchedules_ReplaceJobSchedule",
  "$parameters": {
    "jobSchedule": {
      "$properties": {
        "stats": [
          {
            "#name": "readIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "writeIOps",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numSucceededTasks",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numFailedTasks",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          },
          {
            "#name": "numTaskRetries",
            "Type": {
              "new": "string",
              "old": "integer"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /jobschedules/{jobScheduleId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ,
Required: False ,
}
string ,
jobScheduleId:
{
Description: The ID of the Job Schedule to update. ,
Required: True ,
}
string ,
jobSchedule:
{
Description: A Job Schedule with updated properties ,
Required: True ,
}
{
id:
{
Description: A string that uniquely identifies the schedule within the Account. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the schedule. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Job Schedule. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Job Schedule. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the Job Schedule. ,
Enum:
{
active: The Job Schedule is active and will create Jobs as per its schedule. ,
completed: The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly. ,
disabled: The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run. ,
terminating: The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active. ,
deleting: The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted. ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Job Schedule entered the current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state. ,
Enum:
{
active: The Job Schedule is active and will create Jobs as per its schedule. ,
completed: The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly. ,
disabled: The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run. ,
terminating: The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active. ,
deleting: The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted. ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state. ,
Format: date-time ,
Required: False ,
}
string ,
schedule:
{
Description: The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. ,
Required: False ,
}
{
doNotRunUntil:
{
Description: The earliest time at which any Job may be created under this Job Schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately. ,
Format: date-time ,
Required: False ,
}
string ,
doNotRunAfter:
{
Description: A time after which no Job will be created under this Job Schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active Job under this Job Schedule. If you do not specify a doNotRunAfter time, and you are creating a recurring Job Schedule, the Job Schedule will remain active until you explicitly terminate it. ,
Format: date-time ,
Required: False ,
}
string ,
startWindow:
{
Description: The time interval, starting from the time at which the schedule indicates a Job should be created, within which a Job must be created. If a Job is not created within the startWindow interval, then the 'opportunity' is lost; no Job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the Job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
recurrenceInterval:
{
Description: The time interval between the start times of two successive Jobs under the Job Schedule. A Job Schedule can have at most one active Job under it at any given time. Because a Job Schedule can have at most one active Job under it at any given time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
}
,
jobSpecification:
{
Description: The details of the Jobs to be created on this schedule. ,
Required: True ,
}
{
priority:
{
Description: The priority of Jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API. ,
Format: int32 ,
Required: False ,
}
integer ,
allowTaskPreemption:
{
Description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. ,
Required: False ,
}
boolean ,
maxParallelTasks:
{
Description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The display name for Jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
usesTaskDependencies:
{
Description: Whether Tasks in the Job can define dependencies on each other. The default is false. ,
Required: False ,
}
boolean ,
onAllTasksComplete:
{
Description: The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
terminatejob: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
onTaskFailure:
{
Description: The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
performexitoptionsjobaction: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for the Job. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: True ,
}
string ,
skipWithdrawFromVNet:
{
Description: Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. ,
Required: True ,
}
boolean ,
}
,
constraints:
{
Description: The execution constraints for Jobs created under this schedule. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
jobManagerTask:
{
Description: The details of a Job Manager Task to be launched when a Job is started under this schedule. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Manager Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Manager Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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 property is not supported and must not be specified. ,
Format: int32 ,
Required: False ,
}
integer ,
killJobOnCompletion:
{
Description: Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
runExclusive:
{
Description: Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. ,
Required: False ,
}
boolean ,
applicationPackageReferences:
{
Description: 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 Application 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
allowLowPriorityNode:
{
Description: Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobPreparationTask:
{
Description: The Job Preparation Task for Jobs created under this schedule. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Preparation Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Preparation Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
waitForSuccess:
{
Description: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
rerunOnNodeRebootAfterSuccess:
{
Description: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobReleaseTask:
{
Description: The Job Release Task for Jobs created under this schedule. The primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Release Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
maxWallClockTime:
{
Description: The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: The minimum time to retain the Task directory for the Job Release Task on the Compute Node. 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. ,
Format: duration ,
Required: False ,
}
string ,
userIdentity:
{
Description: The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
commonEnvironmentSettings:
{
Description: A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
poolInfo:
{
Description: The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. ,
Required: True ,
}
{
poolId:
{
Description: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
string ,
autoPoolSpecification:
{
Description: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
{
autoPoolIdPrefix:
{
Description: A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. ,
Required: False ,
}
string ,
poolLifetimeOption:
{
Description: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. ,
Enum:
{
jobschedule: The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. ,
job: The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. ,
}
,
Required: True ,
}
enum ,
keepAlive:
{
Description: Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. ,
Required: False ,
}
boolean ,
pool:
{
Description: The Pool specification for the auto Pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). ,
Required: True ,
}
string ,
virtualMachineConfiguration:
{
Description: The virtual machine configuration for the Pool. This property must be specified. ,
Required: False ,
}
{
imageReference:
{
Description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ,
Required: True ,
}
{
publisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. ,
Required: False ,
}
string ,
version:
{
Description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
virtualMachineImageId:
{
Description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSKUId:
{
Description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. ,
Required: False ,
}
[
{
lun:
{
Description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in gigabytes. ,
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
licenseType:
{
Description: This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. ,
Required: False ,
}
{
type:
{
Description: The container technology to be used. ,
Enum:
{
dockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
criCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. ,
Required: False ,
}
[
string ,
]
,
}
,
nodePlacementConfiguration:
{
Description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
regional: All nodes in the pool will be allocated in the same region. ,
zonal: Nodes in the pool will be spread across different availability zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extension. ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: The version of script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: JSON formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Settings for the operating system disk of the Virtual Machine. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). ,
Required: False ,
}
{
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
cachedisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in GB when creating new OS disk. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: The storage account type for managed disk. ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs. ,
Enum:
{
NonPersistedTPM: NonPersistedTPM ,
VMGuestStateOnly: VMGuestStateOnly ,
}
,
Required: False ,
}
enum ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. ,
Required: True ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. ,
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: True ,
}
enum ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: True ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
taskSlotsPerNode:
{
Description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Required: False ,
}
{
nodeFillType:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Enum:
{
spread: Tasks should be assigned evenly across all Compute Nodes in the Pool. ,
pack: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. ,
}
,
Required: True ,
}
enum ,
}
,
resizeTimeout:
{
Description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
resourceTags:
{
Description: The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScale:
{
Description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. ,
Required: False ,
}
boolean ,
autoScaleFormula:
{
Description: The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. ,
Required: False ,
}
string ,
autoScaleEvaluationInterval:
{
Description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
enableInterNodeCommunication:
{
Description: Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. ,
Required: False ,
}
boolean ,
networkConfiguration:
{
Description: The network configuration for the Pool. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVNetAssignmentScope:
{
Description: The scope of dynamic vnet assignment. ,
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Description: The configuration for endpoints on Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
inboundNATPools:
{
Description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Enum:
{
tcp: Use TCP for the endpoint. ,
udp: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Description: The action that should be taken for a specified IP address, subnet range or tag. ,
Enum:
{
allow: Allow access. ,
deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
provision:
{
Description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. ,
Enum:
{
batchmanaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
usermanaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
nopublicipaddresses: No public IP Address will be created. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
startTask:
{
Description: A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. ,
Required: False ,
}
{
commandLine:
{
Description: The command line of the StartTask. 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). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the StartTask. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: 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. 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, however this is not recommended for a start task or any task. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. ,
Required: False ,
}
boolean ,
}
,
applicationPackageReferences:
{
Description: The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
userAccounts:
{
Description: The list of user Accounts to be created on each Compute Node in the Pool. ,
Required: False ,
}
[
{
name:
{
Description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user Account. ,
Format: password ,
Required: True ,
}
string ,
elevationLevel:
{
Description: The elevation level of the user Account. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). ,
Format: password ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: The login mode for the user. The default is 'batch'. ,
Enum:
{
batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
mountConfiguration:
{
Description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage Account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The Azure Blob Storage Container name. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
sasKey:
{
Description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
username:
{
Description: The user to use for authentication against the CIFS file system. ,
Required: True ,
}
string ,
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Description: The password to use for authentication against the CIFS file system. ,
Format: password ,
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage account name. ,
Required: True ,
}
string ,
azureFileUrl:
{
Description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage account key. ,
Format: password ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
targetNodeCommunicationMode:
{
Description: The desired node communication mode for the pool. If omitted, the default value is Default. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
upgradePolicy:
{
Description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. ,
Enum:
{
automatic: TAll virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. ,
Format: duration ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
}
,
metadata:
{
Description: A list of name-value pairs associated with each Job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
}
,
executionInfo:
{
Description: Information about Jobs that have been and will be run under this schedule. ,
Required: False ,
}
{
nextRunTime:
{
Description: The next time at which a Job will be created under this schedule. This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no Job will be created at nextRunTime unless the Job is enabled before then. ,
Format: date-time ,
Required: False ,
}
string ,
recentJob:
{
Description: Information about the most recent Job under the Job Schedule. This property is present only if the at least one Job has run under the schedule. ,
Required: False ,
}
{
id:
{
Description: The ID of the Job. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Job. ,
Required: False ,
}
string ,
}
,
endTime:
{
Description: The time at which the schedule ended. This property is set only if the Job Schedule is in the completed state. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
stats:
{
Description: The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: The total wall clock time of all the Tasks in all the Jobs created under the schedule. 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 a Task was retried, this includes the wall clock time of all the Task retries. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by all Tasks in all Jobs created under the schedule. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by all Tasks in all Jobs created under the schedule. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total gibibytes read from disk by all Tasks in all Jobs created under the schedule. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total gibibytes written to disk by all Tasks in all Jobs created under the schedule. ,
Format: float ,
Required: True ,
}
number ,
numSucceededTasks:
{
Description: The total number of Tasks successfully completed during the given time range in Jobs created under the schedule. A Task completes successfully if it returns exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numFailedTasks:
{
Description: The total number of Tasks that failed during the given time range in Jobs created under the schedule. A Task fails if it exhausts its maximum retry count without returning exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numTaskRetries:
{
Description: The total number of retries during the given time range on all Tasks in all Jobs created under the schedule. ,
Format: int64 ,
Required: True ,
}
string ,
waitTime:
{
Description: The total wait time of all Tasks in all Jobs created under the schedule. 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.). This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. ,
Format: duration ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
dataserviceid:
{
Description: The OData ID of the resource to which the request applied. ,
}
string ,
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
Jobs_ListJobsFromSchedule (updated)
Description :  Lists the Jobs that have been created under the specified Job Schedule.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_ListJobsFromSchedule",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "stats": [
              {
                "#name": "readIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "writeIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "numSucceededTasks",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "numFailedTasks",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "numTaskRetries",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /jobschedules/{jobScheduleId}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. A maximum of 1000 applications can be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
jobScheduleId:
{
Description: The ID of the Job Schedule from which you want to get a list of Jobs. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. ,
Required: False ,
}
string ,
$select:
{
Description: An OData $select clause. ,
Required: False ,
}
array ,
$expand:
{
Description: An OData $expand clause. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}
,
$schema:
{
Description: The result of listing the Jobs in an Account. ,
}
{
value:
{
Description: The list of Jobs. ,
Required: False ,
}
[
{
id:
{
Description: A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the Job. ,
Required: False ,
}
string ,
usesTaskDependencies:
{
Description: Whether Tasks in the Job can define dependencies on each other. The default is false. ,
Required: False ,
}
boolean ,
url:
{
Description: The URL of the Job. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Job. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the Job. ,
Enum:
{
active: The Job is available to have Tasks scheduled. ,
disabling: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). ,
disabled: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. ,
enabling: A user has requested that the Job be enabled, but the enable operation is still in progress. ,
terminating: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). ,
completed: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. ,
deleting: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Job entered its current state. ,
Format: date-time ,
Required: False ,
}
string ,
previousState:
{
Description: The previous state of the Job. This property is not set if the Job is in its initial Active state. ,
Enum:
{
active: The Job is available to have Tasks scheduled. ,
disabling: A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate). ,
disabled: A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. ,
enabling: A user has requested that the Job be enabled, but the enable operation is still in progress. ,
terminating: The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). ,
completed: All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job. ,
deleting: A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks). ,
}
,
Required: False ,
}
enum ,
previousStateTransitionTime:
{
Description: The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state. ,
Format: date-time ,
Required: False ,
}
string ,
priority:
{
Description: The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
allowTaskPreemption:
{
Description: Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. ,
Required: False ,
}
boolean ,
maxParallelTasks:
{
Description: The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. ,
Format: int32 ,
Required: False ,
}
integer ,
constraints:
{
Description: The execution constraints for the Job. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
jobManagerTask:
{
Description: Details of a Job Manager Task to be launched when the Job is started. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
outputFiles:
{
Description: 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. ,
Required: False ,
}
[
{
filePattern:
{
Description: 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. ,
Required: True ,
}
string ,
destination:
{
Description: The destination for the output file(s). ,
Required: True ,
}
{
container:
{
Description: A location in Azure blob storage to which files are uploaded. ,
Required: False ,
}
{
path:
{
Description: 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. ,
Required: False ,
}
string ,
containerUrl:
{
Description: 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. ,
Required: True ,
}
string ,
identityReference:
{
Description: 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. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
uploadHeaders:
{
Description: 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. ,
Required: False ,
}
[
{
name:
{
Description: The case-insensitive name of the header to be used while uploading output files. ,
Required: True ,
}
string ,
value:
{
Description: The value of the header to be used while uploading output files. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
uploadOptions:
{
Description: Additional options for the upload operation, including under what conditions to perform the upload. ,
Required: True ,
}
{
uploadCondition:
{
Description: The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. ,
Enum:
{
tasksuccess: Upload the file(s) only after the Task process exits with an exit code of 0. ,
taskfailure: Upload the file(s) only after the Task process exits with a nonzero exit code. ,
taskcompletion: Upload the file(s) after the Task process exits, no matter what the exit code was. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Manager Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Manager Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
requiredSlots:
{
Description: 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 property is not supported and must not be specified. ,
Format: int32 ,
Required: False ,
}
integer ,
killJobOnCompletion:
{
Description: Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
runExclusive:
{
Description: Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. ,
Required: False ,
}
boolean ,
applicationPackageReferences:
{
Description: 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 Application 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. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
authenticationTokenSettings:
{
Description: 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. ,
Required: False ,
}
{
access:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
}
,
allowLowPriorityNode:
{
Description: Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobPreparationTask:
{
Description: The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the 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. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Preparation Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
constraints:
{
Description: Constraints that apply to the Job Preparation Task. ,
Required: False ,
}
{
maxWallClockTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
maxTaskRetryCount:
{
Description: 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). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
waitForSuccess:
{
Description: Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. ,
Required: False ,
}
boolean ,
userIdentity:
{
Description: The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
rerunOnNodeRebootAfterSuccess:
{
Description: Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true. ,
Required: False ,
}
boolean ,
}
,
jobReleaseTask:
{
Description: The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job. ,
Required: False ,
}
{
id:
{
Description: A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ,
Required: False ,
}
string ,
commandLine:
{
Description: The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the Job Release Task. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
maxWallClockTime:
{
Description: The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
retentionTime:
{
Description: The minimum time to retain the Task directory for the Job Release Task on the Compute Node. 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. ,
Format: duration ,
Required: False ,
}
string ,
userIdentity:
{
Description: The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
commonEnvironmentSettings:
{
Description: The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
poolInfo:
{
Description: The Pool settings associated with the Job. ,
Required: True ,
}
{
poolId:
{
Description: The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
string ,
autoPoolSpecification:
{
Description: Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. ,
Required: False ,
}
{
autoPoolIdPrefix:
{
Description: A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. ,
Required: False ,
}
string ,
poolLifetimeOption:
{
Description: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. ,
Enum:
{
jobschedule: The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. ,
job: The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule. ,
}
,
Required: True ,
}
enum ,
keepAlive:
{
Description: Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. ,
Required: False ,
}
boolean ,
pool:
{
Description: The Pool specification for the auto Pool. ,
Required: False ,
}
{
displayName:
{
Description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). ,
Required: True ,
}
string ,
virtualMachineConfiguration:
{
Description: The virtual machine configuration for the Pool. This property must be specified. ,
Required: False ,
}
{
imageReference:
{
Description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ,
Required: True ,
}
{
publisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. ,
Required: False ,
}
string ,
version:
{
Description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
virtualMachineImageId:
{
Description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSKUId:
{
Description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. ,
Required: False ,
}
[
{
lun:
{
Description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in gigabytes. ,
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
licenseType:
{
Description: This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. ,
Required: False ,
}
{
type:
{
Description: The container technology to be used. ,
Enum:
{
dockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
criCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. ,
Required: False ,
}
[
string ,
]
,
}
,
nodePlacementConfiguration:
{
Description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
regional: All nodes in the pool will be allocated in the same region. ,
zonal: Nodes in the pool will be spread across different availability zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extension. ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: The version of script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: JSON formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Settings for the operating system disk of the Virtual Machine. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). ,
Required: False ,
}
{
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
cachedisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in GB when creating new OS disk. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: The storage account type for managed disk. ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs. ,
Enum:
{
NonPersistedTPM: NonPersistedTPM ,
VMGuestStateOnly: VMGuestStateOnly ,
}
,
Required: False ,
}
enum ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. ,
Required: True ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. ,
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: True ,
}
enum ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: True ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
taskSlotsPerNode:
{
Description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Required: False ,
}
{
nodeFillType:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Enum:
{
spread: Tasks should be assigned evenly across all Compute Nodes in the Pool. ,
pack: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. ,
}
,
Required: True ,
}
enum ,
}
,
resizeTimeout:
{
Description: The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
resourceTags:
{
Description: The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ,
Required: False ,
}
string ,
targetDedicatedNodes:
{
Description: The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScale:
{
Description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false. ,
Required: False ,
}
boolean ,
autoScaleFormula:
{
Description: The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. ,
Required: False ,
}
string ,
autoScaleEvaluationInterval:
{
Description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). ,
Format: duration ,
Required: False ,
}
string ,
enableInterNodeCommunication:
{
Description: Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. ,
Required: False ,
}
boolean ,
networkConfiguration:
{
Description: The network configuration for the Pool. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVNetAssignmentScope:
{
Description: The scope of dynamic vnet assignment. ,
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Description: The configuration for endpoints on Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
inboundNATPools:
{
Description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Enum:
{
tcp: Use TCP for the endpoint. ,
udp: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Description: The action that should be taken for a specified IP address, subnet range or tag. ,
Enum:
{
allow: Allow access. ,
deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
provision:
{
Description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. ,
Enum:
{
batchmanaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
usermanaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
nopublicipaddresses: No public IP Address will be created. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
startTask:
{
Description: A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. ,
Required: False ,
}
{
commandLine:
{
Description: The command line of the StartTask. 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). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the StartTask. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: 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. 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, however this is not recommended for a start task or any task. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. ,
Required: False ,
}
boolean ,
}
,
applicationPackageReferences:
{
Description: The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
userAccounts:
{
Description: The list of user Accounts to be created on each Compute Node in the Pool. ,
Required: False ,
}
[
{
name:
{
Description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user Account. ,
Format: password ,
Required: True ,
}
string ,
elevationLevel:
{
Description: The elevation level of the user Account. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). ,
Format: password ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: The login mode for the user. The default is 'batch'. ,
Enum:
{
batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
mountConfiguration:
{
Description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage Account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The Azure Blob Storage Container name. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
sasKey:
{
Description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
username:
{
Description: The user to use for authentication against the CIFS file system. ,
Required: True ,
}
string ,
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Description: The password to use for authentication against the CIFS file system. ,
Format: password ,
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage account name. ,
Required: True ,
}
string ,
azureFileUrl:
{
Description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage account key. ,
Format: password ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
targetNodeCommunicationMode:
{
Description: The desired node communication mode for the pool. If omitted, the default value is Default. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
upgradePolicy:
{
Description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. ,
Enum:
{
automatic: TAll virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. ,
Format: duration ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
}
,
onAllTasksComplete:
{
Description: The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
terminatejob: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
onTaskFailure:
{
Description: The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. ,
Enum:
{
noaction: Do nothing. The Job remains active unless terminated or disabled by some other means. ,
performexitoptionsjobaction: Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. ,
}
,
Required: False ,
}
enum ,
networkConfiguration:
{
Description: The network configuration for the Job. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. ,
Required: True ,
}
string ,
skipWithdrawFromVNet:
{
Description: Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. ,
Required: True ,
}
boolean ,
}
,
metadata:
{
Description: A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
executionInfo:
{
Description: The execution information for the Job. ,
Required: False ,
}
{
startTime:
{
Description: The start time of the Job. This is the time at which the Job was created. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The completion time of the Job. This property is set only if the Job is in the completed state. ,
Format: date-time ,
Required: False ,
}
string ,
poolId:
{
Description: The ID of the Pool to which this Job is assigned. This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool. ,
Required: False ,
}
string ,
schedulingError:
{
Description: Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting the Job. ,
Required: False ,
}
{
category:
{
Description: The category of the Job scheduling error. ,
Enum:
{
usererror: The error is due to a user issue, such as misconfiguration. ,
servererror: The error is due to an internal server issue. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the Job scheduling error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional error details related to the scheduling error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
terminateReason:
{
Description: A string describing the reason the Job ended. This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a Job' operation. ,
Required: False ,
}
string ,
}
,
stats:
{
Description: Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. ,
Required: False ,
}
{
url:
{
Description: The URL of the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
userCPUTime:
{
Description: The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. ,
Format: duration ,
Required: True ,
}
string ,
kernelCPUTime:
{
Description: The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. ,
Format: duration ,
Required: True ,
}
string ,
wallClockTime:
{
Description: The total wall clock time of all Tasks in the Job. 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 a Task was retried, this includes the wall clock time of all the Task retries. ,
Format: duration ,
Required: True ,
}
string ,
readIOps:
{
Description: The total number of disk read operations made by all Tasks in the Job. ,
Format: int64 ,
Required: True ,
}
string ,
writeIOps:
{
Description: The total number of disk write operations made by all Tasks in the Job. ,
Format: int64 ,
Required: True ,
}
string ,
readIOGiB:
{
Description: The total amount of data in GiB read from disk by all Tasks in the Job. ,
Format: float ,
Required: True ,
}
number ,
writeIOGiB:
{
Description: The total amount of data in GiB written to disk by all Tasks in the Job. ,
Format: float ,
Required: True ,
}
number ,
numSucceededTasks:
{
Description: The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numFailedTasks:
{
Description: The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0. ,
Format: int64 ,
Required: True ,
}
string ,
numTaskRetries:
{
Description: The total number of retries on all the Tasks in the Job during the given time range. ,
Format: int64 ,
Required: True ,
}
string ,
waitTime:
{
Description: The total wait time of all Tasks in the Job. 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.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. ,
Format: duration ,
Required: True ,
}
string ,
}
,
}
,
]
,
odata.nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
Pools_ListPools (updated)
Description :  Lists all of the Pools which be mounted.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pools_ListPools",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "stats": [
              {
                "resourceStats": [
                  {
                    "#name": "diskReadIOps",
                    "Type": {
                      "new": "string",
                      "old": "integer"
                    }
                  },
                  {
                    "#name": "diskWriteIOps",
                    "Type": {
                      "new": "string",
                      "old": "integer"
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /pools
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
maxresults:
{
Description: The maximum number of items to return in the response. A maximum of 1000 applications can be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: An OData $filter clause. For more information on constructing this filter, see https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools. ,
Required: False ,
}
string ,
$select:
{
Description: An OData $select clause. ,
Required: False ,
}
array ,
$expand:
{
Description: An OData $expand clause. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}
,
$schema:
{
Description: The result of listing the Pools in an Account. ,
}
{
value:
{
Description: The list of Pools. ,
Required: False ,
}
[
{
id:
{
Description: A string that uniquely identifies the Pool within the Account. 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 an Account that differ only by case). ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Pool. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Pool. This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Pool. This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Pool. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the Pool. ,
Enum:
{
active: The Pool is available to run Tasks subject to the availability of Compute Nodes. ,
deleting: The user has requested that the Pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Pool entered its current state. ,
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Description: Whether the Pool is resizing. ,
Enum:
{
steady: The Pool is not resizing. There are no changes to the number of Compute Nodes in the Pool in progress. A Pool enters this state when it is created and when no operations are being performed on the Pool to change the number of Compute Nodes. ,
resizing: The Pool is resizing; that is, Compute Nodes are being added to or removed from the Pool. ,
stopping: The Pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Description: The time at which the Pool entered its current allocation state. ,
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
virtualMachineConfiguration:
{
Description: The virtual machine configuration for the Pool. This property must be specified. ,
Required: False ,
}
{
imageReference:
{
Description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ,
Required: True ,
}
{
publisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. ,
Required: False ,
}
string ,
version:
{
Description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
virtualMachineImageId:
{
Description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSKUId:
{
Description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. ,
Required: False ,
}
[
{
lun:
{
Description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in gigabytes. ,
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
licenseType:
{
Description: This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. ,
Required: False ,
}
{
type:
{
Description: The container technology to be used. ,
Enum:
{
dockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
criCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. ,
Required: False ,
}
[
string ,
]
,
}
,
nodePlacementConfiguration:
{
Description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
regional: All nodes in the pool will be allocated in the same region. ,
zonal: Nodes in the pool will be spread across different availability zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extension. ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: The version of script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: JSON formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Settings for the operating system disk of the Virtual Machine. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). ,
Required: False ,
}
{
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
cachedisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in GB when creating new OS disk. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: The storage account type for managed disk. ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs. ,
Enum:
{
NonPersistedTPM: NonPersistedTPM ,
VMGuestStateOnly: VMGuestStateOnly ,
}
,
Required: False ,
}
enum ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. ,
Required: True ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. ,
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: True ,
}
enum ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: True ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
resizeTimeout:
{
Description: The timeout for allocation of Compute Nodes to the Pool. This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes. ,
Format: duration ,
Required: False ,
}
string ,
resizeErrors:
{
Description: A list of errors encountered while performing the last resize on the Pool. This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the Pool resize error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the Pool resize error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
values:
{
Description: A list of additional error details related to the Pool resize error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
resourceTags:
{
Description: The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ,
Required: False ,
}
object ,
currentDedicatedNodes:
{
Description: The number of dedicated Compute Nodes currently in the Pool. ,
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Description: The number of Spot/Low-priority Compute Nodes currently in the Pool. Spot/Low-priority Compute Nodes which have been preempted are included in this count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetDedicatedNodes:
{
Description: The desired number of dedicated Compute Nodes in the Pool. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: The desired number of Spot/Low-priority Compute Nodes in the Pool. ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScale:
{
Description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false. ,
Required: False ,
}
boolean ,
autoScaleFormula:
{
Description: A formula for the desired number of Compute Nodes in the Pool. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. ,
Required: False ,
}
string ,
autoScaleEvaluationInterval:
{
Description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. ,
Format: duration ,
Required: False ,
}
string ,
autoScaleRun:
{
Description: The results and errors from the last execution of the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. ,
Required: False ,
}
{
timestamp:
{
Description: The time at which the autoscale formula was last evaluated. ,
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: The final values of all variables used in the evaluation of the autoscale formula. Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Description: Details of the error encountered evaluating the autoscale formula on the Pool, if the evaluation was unsuccessful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the autoscale error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
values:
{
Description: A list of additional error details related to the autoscale error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
enableInterNodeCommunication:
{
Description: Whether the Pool permits direct communication between Compute Nodes. This imposes restrictions on which Compute Nodes can be assigned to the Pool. Specifying this value can reduce the chance of the requested number of Compute Nodes to be allocated in the Pool. ,
Required: False ,
}
boolean ,
networkConfiguration:
{
Description: The network configuration for the Pool. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVNetAssignmentScope:
{
Description: The scope of dynamic vnet assignment. ,
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Description: The configuration for endpoints on Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
inboundNATPools:
{
Description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Enum:
{
tcp: Use TCP for the endpoint. ,
udp: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Description: The action that should be taken for a specified IP address, subnet range or tag. ,
Enum:
{
allow: Allow access. ,
deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
provision:
{
Description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. ,
Enum:
{
batchmanaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
usermanaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
nopublicipaddresses: No public IP Address will be created. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
startTask:
{
Description: A Task specified to run on each Compute Node as it joins the Pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line of the StartTask. 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). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the StartTask. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: 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. 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, however this is not recommended for a start task or any task. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. ,
Required: False ,
}
boolean ,
}
,
applicationPackageReferences:
{
Description: The list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
taskSlotsPerNode:
{
Description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Required: False ,
}
{
nodeFillType:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Enum:
{
spread: Tasks should be assigned evenly across all Compute Nodes in the Pool. ,
pack: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Description: The list of user Accounts to be created on each Compute Node in the Pool. ,
Required: False ,
}
[
{
name:
{
Description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user Account. ,
Format: password ,
Required: True ,
}
string ,
elevationLevel:
{
Description: The elevation level of the user Account. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). ,
Format: password ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: The login mode for the user. The default is 'batch'. ,
Enum:
{
batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: A list of name-value pairs associated with the Pool as metadata. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
stats:
{
Description: Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the BatchPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. ,
Required: False ,
}
{
url:
{
Description: The URL for the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
usageStats:
{
Description: Statistics related to Pool usage, such as the amount of core-time used. ,
Required: False ,
}
{
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
dedicatedCoreTime:
{
Description: The aggregated wall-clock time of the dedicated Compute Node cores being part of the Pool. ,
Format: duration ,
Required: True ,
}
string ,
}
,
resourceStats:
{
Description: Statistics related to resource consumption by Compute Nodes in the Pool. ,
Required: False ,
}
{
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
avgCPUPercentage:
{
Description: The average CPU usage across all Compute Nodes in the Pool (percentage per node). ,
Format: float ,
Required: True ,
}
number ,
avgMemoryGiB:
{
Description: The average memory usage in GiB across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
peakMemoryGiB:
{
Description: The peak memory usage in GiB across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
avgDiskGiB:
{
Description: The average used disk space in GiB across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
peakDiskGiB:
{
Description: The peak used disk space in GiB across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
diskReadIOps:
{
Description: The total number of disk read operations across all Compute Nodes in the Pool. ,
Format: int64 ,
Required: True ,
}
string ,
diskWriteIOps:
{
Description: The total number of disk write operations across all Compute Nodes in the Pool. ,
Format: int64 ,
Required: True ,
}
string ,
diskReadGiB:
{
Description: The total amount of data in GiB of disk reads across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
diskWriteGiB:
{
Description: The total amount of data in GiB of disk writes across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
networkReadGiB:
{
Description: The total amount of data in GiB of network reads across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
networkWriteGiB:
{
Description: The total amount of data in GiB of network writes across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
mountConfiguration:
{
Description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage Account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The Azure Blob Storage Container name. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
sasKey:
{
Description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
username:
{
Description: The user to use for authentication against the CIFS file system. ,
Required: True ,
}
string ,
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Description: The password to use for authentication against the CIFS file system. ,
Format: password ,
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage account name. ,
Required: True ,
}
string ,
azureFileUrl:
{
Description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage account key. ,
Format: password ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
identity:
{
Description: The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
{
type:
{
Description: The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: True ,
}
string ,
clientId:
{
Description: The client id of the user assigned identity. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
targetNodeCommunicationMode:
{
Description: The desired node communication mode for the pool. If omitted, the default value is Default. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
currentNodeCommunicationMode:
{
Description: The current state of the pool communication mode. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
upgradePolicy:
{
Description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. ,
Enum:
{
automatic: TAll virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. ,
Format: duration ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
odata.nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}
Pools_GetPool (updated)
Description :  Gets information about the specified Pool.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Pools_GetPool",
  "$responses": {
    "200": {
      "$properties": {
        "stats": [
          {
            "resourceStats": [
              {
                "#name": "diskReadIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              },
              {
                "#name": "diskWriteIOps",
                "Type": {
                  "new": "string",
                  "old": "integer"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /pools/{poolId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
timeOut:
{
Description: The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". ,
Format: int32 ,
Required: False ,
}
integer ,
client-request-id:
{
Description: 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. ,
Required: False ,
}
string ,
return-client-request-id:
{
Description: Whether the server should return the client-request-id in the response. ,
Required: False ,
}
boolean ,
ocp-date:
{
Description: 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. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Modified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Unmodified-Since:
{
Description: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. ,
Format: date-time-rfc7231 ,
Required: False ,
}
string ,
If-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. ,
Required: False ,
}
string ,
poolId:
{
Description: The ID of the Pool to get. ,
Required: True ,
}
string ,
$select:
{
Description: An OData $select clause. ,
Required: False ,
}
array ,
$expand:
{
Description: An OData $expand clause. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers. ,
}
string ,
last-modified:
{
Description: The time at which the resource was last modified. ,
}
string ,
client-request-id:
{
Description: The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true. ,
}
string ,
request-id:
{
Description: A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in. ,
}
string ,
}
,
$schema:
{
Description: A Pool in the Azure Batch service. ,
}
{
id:
{
Description: A string that uniquely identifies the Pool within the Account. 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 an Account that differ only by case). ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. ,
Required: False ,
}
string ,
url:
{
Description: The URL of the Pool. ,
Required: False ,
}
string ,
eTag:
{
Description: The ETag of the Pool. This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime. ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the Pool. This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the Pool. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the Pool. ,
Enum:
{
active: The Pool is available to run Tasks subject to the availability of Compute Nodes. ,
deleting: The user has requested that the Pool be deleted, but the delete operation has not yet completed. ,
}
,
Required: False ,
}
enum ,
stateTransitionTime:
{
Description: The time at which the Pool entered its current state. ,
Format: date-time ,
Required: False ,
}
string ,
allocationState:
{
Description: Whether the Pool is resizing. ,
Enum:
{
steady: The Pool is not resizing. There are no changes to the number of Compute Nodes in the Pool in progress. A Pool enters this state when it is created and when no operations are being performed on the Pool to change the number of Compute Nodes. ,
resizing: The Pool is resizing; that is, Compute Nodes are being added to or removed from the Pool. ,
stopping: The Pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. ,
}
,
Required: False ,
}
enum ,
allocationStateTransitionTime:
{
Description: The time at which the Pool entered its current allocation state. ,
Format: date-time ,
Required: False ,
}
string ,
vmSize:
{
Description: The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). ,
Required: False ,
}
string ,
virtualMachineConfiguration:
{
Description: The virtual machine configuration for the Pool. This property must be specified. ,
Required: False ,
}
{
imageReference:
{
Description: A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ,
Required: True ,
}
{
publisher:
{
Description: The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. ,
Required: False ,
}
string ,
offer:
{
Description: The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. ,
Required: False ,
}
string ,
version:
{
Description: The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. ,
Required: False ,
}
string ,
virtualMachineImageId:
{
Description: The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. ,
Required: False ,
}
string ,
exactVersion:
{
Description: The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. ,
Required: False ,
}
string ,
}
,
nodeAgentSKUId:
{
Description: The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. ,
Required: True ,
}
string ,
windowsConfiguration:
{
Description: Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. ,
Required: False ,
}
{
enableAutomaticUpdates:
{
Description: Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. ,
Required: False ,
}
boolean ,
}
,
dataDisks:
{
Description: The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. ,
Required: False ,
}
[
{
lun:
{
Description: The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. ,
Format: int32 ,
Required: True ,
}
integer ,
caching:
{
Description: The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in gigabytes. ,
Format: int32 ,
Required: True ,
}
integer ,
storageAccountType:
{
Description: The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
licenseType:
{
Description: This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. ,
Required: False ,
}
string ,
containerConfiguration:
{
Description: The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. ,
Required: False ,
}
{
type:
{
Description: The container technology to be used. ,
Enum:
{
dockerCompatible: A Docker compatible container technology will be used to launch the containers. ,
criCompatible: A CRI based technology will be used to launch the containers. ,
}
,
Required: True ,
}
enum ,
containerImageNames:
{
Description: The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ,
Required: False ,
}
[
string ,
]
,
containerRegistries:
{
Description: Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. ,
Required: False ,
}
[
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
diskEncryptionConfiguration:
{
Description: The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. ,
Required: False ,
}
{
targets:
{
Description: The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. ,
Required: False ,
}
[
string ,
]
,
}
,
nodePlacementConfiguration:
{
Description: The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. ,
Required: False ,
}
{
policy:
{
Description: Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. ,
Enum:
{
regional: All nodes in the pool will be allocated in the same region. ,
zonal: Nodes in the pool will be spread across different availability zones with best effort balancing. ,
}
,
Required: False ,
}
enum ,
}
,
extensions:
{
Description: The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. ,
Required: False ,
}
[
{
name:
{
Description: The name of the virtual machine extension. ,
Required: True ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: True ,
}
string ,
type:
{
Description: The type of the extension. ,
Required: True ,
}
string ,
typeHandlerVersion:
{
Description: The version of script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. ,
Required: False ,
}
boolean ,
settings:
{
Description: JSON formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisionAfterExtensions:
{
Description: The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
osDisk:
{
Description: Settings for the operating system disk of the Virtual Machine. ,
Required: False ,
}
{
ephemeralOSDiskSettings:
{
Description: Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). ,
Required: False ,
}
{
placement:
{
Description: Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. ,
Enum:
{
cachedisk: The Ephemeral OS Disk is stored on the VM cache. ,
}
,
Required: False ,
}
enum ,
}
,
caching:
{
Description: Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. ,
Enum:
{
none: The caching mode for the disk is not enabled. ,
readonly: The caching mode for the disk is read only. ,
readwrite: The caching mode for the disk is read and write. ,
}
,
Required: False ,
}
enum ,
diskSizeGB:
{
Description: The initial disk size in GB when creating new OS disk. ,
Format: int32 ,
Required: False ,
}
integer ,
managedDisk:
{
Description: The managed disk parameters. ,
Required: False ,
}
{
storageAccountType:
{
Description: The storage account type for managed disk. ,
Enum:
{
standard_lrs: The data disk should use standard locally redundant storage. ,
premium_lrs: The data disk should use premium locally redundant storage. ,
standardssd_lrs: The data disk / OS disk should use standard SSD locally redundant storage. ,
}
,
Required: False ,
}
enum ,
securityProfile:
{
Description: Specifies the security profile settings for the managed disk. ,
Required: False ,
}
{
securityEncryptionType:
{
Description: Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs. ,
Enum:
{
NonPersistedTPM: NonPersistedTPM ,
VMGuestStateOnly: VMGuestStateOnly ,
}
,
Required: False ,
}
enum ,
}
,
}
,
writeAcceleratorEnabled:
{
Description: Specifies whether writeAccelerator should be enabled or disabled on the disk. ,
Required: False ,
}
boolean ,
}
,
securityProfile:
{
Description: Specifies the security profile settings for the virtual machine or virtual machine scale set. ,
Required: False ,
}
{
encryptionAtHost:
{
Description: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. ,
Required: True ,
}
boolean ,
securityType:
{
Description: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. ,
Enum:
{
trustedLaunch: Trusted launch protects against advanced and persistent attack techniques. ,
confidentialVM: Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified. ,
}
,
Required: True ,
}
enum ,
uefiSettings:
{
Description: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. ,
Required: True ,
}
{
secureBootEnabled:
{
Description: Specifies whether secure boot should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
vTpmEnabled:
{
Description: Specifies whether vTPM should be enabled on the virtual machine. ,
Required: False ,
}
boolean ,
}
,
}
,
serviceArtifactReference:
{
Description: Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: False ,
}
{
id:
{
Description: The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ,
Required: True ,
}
string ,
}
,
}
,
resizeTimeout:
{
Description: The timeout for allocation of Compute Nodes to the Pool. This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes. ,
Format: duration ,
Required: False ,
}
string ,
resizeErrors:
{
Description: A list of errors encountered while performing the last resize on the Pool. This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady. ,
Required: False ,
}
[
{
code:
{
Description: An identifier for the Pool resize error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the Pool resize error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
values:
{
Description: A list of additional error details related to the Pool resize error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
resourceTags:
{
Description: The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ,
Required: False ,
}
object ,
currentDedicatedNodes:
{
Description: The number of dedicated Compute Nodes currently in the Pool. ,
Format: int32 ,
Required: False ,
}
integer ,
currentLowPriorityNodes:
{
Description: The number of Spot/Low-priority Compute Nodes currently in the Pool. Spot/Low-priority Compute Nodes which have been preempted are included in this count. ,
Format: int32 ,
Required: False ,
}
integer ,
targetDedicatedNodes:
{
Description: The desired number of dedicated Compute Nodes in the Pool. ,
Format: int32 ,
Required: False ,
}
integer ,
targetLowPriorityNodes:
{
Description: The desired number of Spot/Low-priority Compute Nodes in the Pool. ,
Format: int32 ,
Required: False ,
}
integer ,
enableAutoScale:
{
Description: Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false. ,
Required: False ,
}
boolean ,
autoScaleFormula:
{
Description: A formula for the desired number of Compute Nodes in the Pool. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. ,
Required: False ,
}
string ,
autoScaleEvaluationInterval:
{
Description: The time interval at which to automatically adjust the Pool size according to the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. ,
Format: duration ,
Required: False ,
}
string ,
autoScaleRun:
{
Description: The results and errors from the last execution of the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. ,
Required: False ,
}
{
timestamp:
{
Description: The time at which the autoscale formula was last evaluated. ,
Format: date-time ,
Required: True ,
}
string ,
results:
{
Description: The final values of all variables used in the evaluation of the autoscale formula. Each variable value is returned in the form $variable=value, and variables are separated by semicolons. ,
Required: False ,
}
string ,
error:
{
Description: Details of the error encountered evaluating the autoscale formula on the Pool, if the evaluation was unsuccessful. ,
Required: False ,
}
{
code:
{
Description: An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the autoscale error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
values:
{
Description: A list of additional error details related to the autoscale error. ,
Required: False ,
}
[
{
name:
{
Description: The name in the name-value pair. ,
Required: False ,
}
string ,
value:
{
Description: The value in the name-value pair. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
enableInterNodeCommunication:
{
Description: Whether the Pool permits direct communication between Compute Nodes. This imposes restrictions on which Compute Nodes can be assigned to the Pool. Specifying this value can reduce the chance of the requested number of Compute Nodes to be allocated in the Pool. ,
Required: False ,
}
boolean ,
networkConfiguration:
{
Description: The network configuration for the Pool. ,
Required: False ,
}
{
subnetId:
{
Description: The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration ,
Required: False ,
}
string ,
dynamicVNetAssignmentScope:
{
Description: The scope of dynamic vnet assignment. ,
Enum:
{
none: No dynamic VNet assignment is enabled. ,
job: Dynamic VNet assignment is done per-job. ,
}
,
Required: False ,
}
enum ,
endpointConfiguration:
{
Description: The configuration for endpoints on Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
inboundNATPools:
{
Description: A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. ,
Required: True ,
}
[
{
name:
{
Description: The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
protocol:
{
Description: The protocol of the endpoint. ,
Enum:
{
tcp: Use TCP for the endpoint. ,
udp: Use UDP for the endpoint. ,
}
,
Required: True ,
}
enum ,
backendPort:
{
Description: The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeStart:
{
Description: The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
frontendPortRangeEnd:
{
Description: The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
networkSecurityGroupRules:
{
Description: A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. ,
Required: False ,
}
[
{
priority:
{
Description: The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. ,
Format: int32 ,
Required: True ,
}
integer ,
access:
{
Description: The action that should be taken for a specified IP address, subnet range or tag. ,
Enum:
{
allow: Allow access. ,
deny: Deny access. ,
}
,
Required: True ,
}
enum ,
sourceAddressPrefix:
{
Description: The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. ,
Required: True ,
}
string ,
sourcePortRanges:
{
Description: The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
publicIPAddressConfiguration:
{
Description: The Public IPAddress configuration for Compute Nodes in the Batch Pool. ,
Required: False ,
}
{
provision:
{
Description: The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. ,
Enum:
{
batchmanaged: A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. ,
usermanaged: Public IPs are provided by the user and will be used to provision the Compute Nodes. ,
nopublicipaddresses: No public IP Address will be created. ,
}
,
Required: False ,
}
enum ,
ipAddressIds:
{
Description: The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. ,
Required: False ,
}
[
string ,
]
,
}
,
enableAcceleratedNetworking:
{
Description: Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. ,
Required: False ,
}
boolean ,
}
,
startTask:
{
Description: A Task specified to run on each Compute Node as it joins the Pool. ,
Required: False ,
}
{
commandLine:
{
Description: The command line of the StartTask. 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). ,
Required: True ,
}
string ,
containerSettings:
{
Description: The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ,
Required: False ,
}
{
containerRunOptions:
{
Description: 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. ,
Required: False ,
}
string ,
imageName:
{
Description: 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. ,
Required: True ,
}
string ,
registry:
{
Description: The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. ,
Required: False ,
}
{
username:
{
Description: The user name to log into the registry server. ,
Required: False ,
}
string ,
password:
{
Description: The password to log into the registry server. ,
Format: password ,
Required: False ,
}
string ,
registryServer:
{
Description: The registry URL. If omitted, the default is "docker.io". ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
workingDirectory:
{
Description: The location of the container Task working directory. The default is 'taskWorkingDirectory'. ,
Enum:
{
taskWorkingDirectory: Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. ,
containerImageDefault: Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. ,
}
,
Required: False ,
}
enum ,
containerHostBatchBindMounts:
{
Description: 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. ,
Required: False ,
}
[
{
source:
{
Description: The path which be mounted to container customer can select. ,
Enum:
{
Shared: The path for multi-instances task to shared their files. ,
Startup: The path for start task. ,
VfsMounts: The path contains all virtual file systems are mounted on this node. ,
Task: The task path. ,
JobPrep: The job-prep task path. ,
Applications: The applications path. ,
}
,
Required: False ,
}
enum ,
isReadOnly:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
resourceFiles:
{
Description: A list of files that the Batch service will download to the Compute Node before running the command line. 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. Files listed under this element are located in the Task's working directory. ,
Required: False ,
}
[
{
autoStorageContainerName:
{
Description: 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. ,
Required: False ,
}
string ,
storageContainerUrl:
{
Description: 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. ,
Required: False ,
}
string ,
httpUrl:
{
Description: 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. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: 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. ,
Required: False ,
}
string ,
filePath:
{
Description: 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 '..'). ,
Required: False ,
}
string ,
fileMode:
{
Description: 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. ,
Required: False ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
environmentSettings:
{
Description: A list of environment variable settings for the StartTask. ,
Required: False ,
}
[
{
name:
{
Description: The name of the environment variable. ,
Required: True ,
}
string ,
value:
{
Description: The value of the environment variable. ,
Required: False ,
}
string ,
}
,
]
,
userIdentity:
{
Description: The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task. ,
Required: False ,
}
{
username:
{
Description: 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. ,
Required: False ,
}
string ,
autoUser:
{
Description: The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both. ,
Required: False ,
}
{
scope:
{
Description: The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. ,
Enum:
{
task: Specifies that the service should create a new user for the Task. ,
pool: Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. ,
}
,
Required: False ,
}
enum ,
elevationLevel:
{
Description: The elevation level of the auto user. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
maxTaskRetryCount:
{
Description: 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. 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, however this is not recommended for a start task or any task. The default value is 0 (no retries). ,
Format: int32 ,
Required: False ,
}
integer ,
waitForSuccess:
{
Description: Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. ,
Required: False ,
}
boolean ,
}
,
applicationPackageReferences:
{
Description: The list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ,
Required: False ,
}
[
{
applicationId:
{
Description: The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ,
Required: True ,
}
string ,
version:
{
Description: The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error. ,
Required: False ,
}
string ,
}
,
]
,
taskSlotsPerNode:
{
Description: The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. ,
Format: int32 ,
Required: False ,
}
integer ,
taskSchedulingPolicy:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Required: False ,
}
{
nodeFillType:
{
Description: How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. ,
Enum:
{
spread: Tasks should be assigned evenly across all Compute Nodes in the Pool. ,
pack: As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool. ,
}
,
Required: True ,
}
enum ,
}
,
userAccounts:
{
Description: The list of user Accounts to be created on each Compute Node in the Pool. ,
Required: False ,
}
[
{
name:
{
Description: The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. ,
Required: True ,
}
string ,
password:
{
Description: The password for the user Account. ,
Format: password ,
Required: True ,
}
string ,
elevationLevel:
{
Description: The elevation level of the user Account. The default value is nonAdmin. ,
Enum:
{
nonadmin: The user is a standard user without elevated access. ,
admin: The user is a user with elevated access and operates with full Administrator permissions. ,
}
,
Required: False ,
}
enum ,
linuxUserConfiguration:
{
Description: The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. ,
Required: False ,
}
{
uid:
{
Description: The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. ,
Format: int32 ,
Required: False ,
}
integer ,
gid:
{
Description: The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. ,
Format: int32 ,
Required: False ,
}
integer ,
sshPrivateKey:
{
Description: The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done). ,
Format: password ,
Required: False ,
}
string ,
}
,
windowsUserConfiguration:
{
Description: The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options. ,
Required: False ,
}
{
loginMode:
{
Description: The login mode for the user. The default is 'batch'. ,
Enum:
{
batch: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. ,
interactive: The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
metadata:
{
Description: A list of name-value pairs associated with the Pool as metadata. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metadata item. ,
Required: True ,
}
string ,
value:
{
Description: The value of the metadata item. ,
Required: True ,
}
string ,
}
,
]
,
stats:
{
Description: Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the BatchPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. ,
Required: False ,
}
{
url:
{
Description: The URL for the statistics. ,
Required: True ,
}
string ,
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
usageStats:
{
Description: Statistics related to Pool usage, such as the amount of core-time used. ,
Required: False ,
}
{
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
dedicatedCoreTime:
{
Description: The aggregated wall-clock time of the dedicated Compute Node cores being part of the Pool. ,
Format: duration ,
Required: True ,
}
string ,
}
,
resourceStats:
{
Description: Statistics related to resource consumption by Compute Nodes in the Pool. ,
Required: False ,
}
{
startTime:
{
Description: The start time of the time range covered by the statistics. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdateTime:
{
Description: The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime. ,
Format: date-time ,
Required: True ,
}
string ,
avgCPUPercentage:
{
Description: The average CPU usage across all Compute Nodes in the Pool (percentage per node). ,
Format: float ,
Required: True ,
}
number ,
avgMemoryGiB:
{
Description: The average memory usage in GiB across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
peakMemoryGiB:
{
Description: The peak memory usage in GiB across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
avgDiskGiB:
{
Description: The average used disk space in GiB across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
peakDiskGiB:
{
Description: The peak used disk space in GiB across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
diskReadIOps:
{
Description: The total number of disk read operations across all Compute Nodes in the Pool. ,
Format: int64 ,
Required: True ,
}
string ,
diskWriteIOps:
{
Description: The total number of disk write operations across all Compute Nodes in the Pool. ,
Format: int64 ,
Required: True ,
}
string ,
diskReadGiB:
{
Description: The total amount of data in GiB of disk reads across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
diskWriteGiB:
{
Description: The total amount of data in GiB of disk writes across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
networkReadGiB:
{
Description: The total amount of data in GiB of network reads across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
networkWriteGiB:
{
Description: The total amount of data in GiB of network writes across all Compute Nodes in the Pool. ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
mountConfiguration:
{
Description: A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. ,
Required: False ,
}
[
{
azureBlobFileSystemConfiguration:
{
Description: The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage Account name. ,
Required: True ,
}
string ,
containerName:
{
Description: The Azure Blob Storage Container name. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
sasKey:
{
Description: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified. ,
Format: password ,
Required: False ,
}
string ,
blobfuseOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
identityReference:
{
Description: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. ,
Required: False ,
}
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
}
,
nfsMountConfiguration:
{
Description: The NFS file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
cifsMountConfiguration:
{
Description: The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
username:
{
Description: The user to use for authentication against the CIFS file system. ,
Required: True ,
}
string ,
source:
{
Description: The URI of the file system to mount. ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
password:
{
Description: The password to use for authentication against the CIFS file system. ,
Format: password ,
Required: True ,
}
string ,
}
,
azureFileShareConfiguration:
{
Description: The Azure File Share to mount on each node. This property is mutually exclusive with all other properties. ,
Required: False ,
}
{
accountName:
{
Description: The Azure Storage account name. ,
Required: True ,
}
string ,
azureFileUrl:
{
Description: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. ,
Required: True ,
}
string ,
accountKey:
{
Description: The Azure Storage account key. ,
Format: password ,
Required: True ,
}
string ,
relativeMountPath:
{
Description: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. ,
Required: True ,
}
string ,
mountOptions:
{
Description: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. ,
Required: False ,
}
string ,
}
,
}
,
]
,
identity:
{
Description: The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
{
type:
{
Description: The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Enum:
{
UserAssigned: Batch pool has user assigned identities with it. ,
None: Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
[
{
resourceId:
{
Description: The ARM resource id of the user assigned identity. ,
Required: True ,
}
string ,
clientId:
{
Description: The client id of the user assigned identity. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user assigned identity. ,
Required: False ,
}
string ,
}
,
]
,
}
,
targetNodeCommunicationMode:
{
Description: The desired node communication mode for the pool. If omitted, the default value is Default. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
currentNodeCommunicationMode:
{
Description: The current state of the pool communication mode. ,
Enum:
{
default: The node communication mode is automatically set by the Batch service. ,
classic: Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" and "BatchNodeManagement.{region}" service tags. ,
simplified: Nodes using the simplified communication mode require outbound TCP communication on port 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. ,
}
,
Required: False ,
}
enum ,
upgradePolicy:
{
Description: The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. ,
Required: False ,
}
{
mode:
{
Description: Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. ,
Enum:
{
automatic: TAll virtual machines in the scale set are automatically updated at the same time. ,
manual: You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action. ,
rolling: The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date. ,
}
,
Required: True ,
}
enum ,
automaticOSUpgradePolicy:
{
Description: Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. ,
Required: False ,
}
{
disableAutomaticRollback:
{
Description: Whether OS image rollback feature should be disabled. ,
Required: False ,
}
boolean ,
enableAutomaticOSUpgrade:
{
Description: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. ,
Required: False ,
}
boolean ,
useRollingUpgradePolicy:
{
Description: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. ,
Required: False ,
}
boolean ,
osRollingUpgradeDeferral:
{
Description: Defer OS upgrades on the TVMs if they are running tasks. ,
Required: False ,
}
boolean ,
}
,
rollingUpgradePolicy:
{
Description: The configuration parameters used while performing a rolling upgrade. ,
Required: False ,
}
{
enableCrossZoneUpgrade:
{
Description: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. ,
Required: False ,
}
boolean ,
maxBatchInstancePercent:
{
Description: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyInstancePercent:
{
Description: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. ,
Format: int32 ,
Required: False ,
}
integer ,
maxUnhealthyUpgradedInstancePercent:
{
Description: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. ,
Format: int32 ,
Required: False ,
}
integer ,
pauseTimeBetweenBatches:
{
Description: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.. ,
Format: duration ,
Required: False ,
}
string ,
prioritizeUnhealthyInstances:
{
Description: Upgrade all unhealthy instances in a scale set before any healthy instances. ,
Required: False ,
}
boolean ,
rollbackFailedInstancesOnPolicyBreach:
{
Description: Rollback failed instances to previous model if the Rolling Upgrade policy is violated. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: True ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
{
lang:
{
Description: The language code of the error message. ,
Required: False ,
}
string ,
value:
{
Description: The text of the message. ,
Required: False ,
}
string ,
}
,
values:
{
Description: A collection of key-value pairs containing additional details about the error. ,
Required: False ,
}
[
{
key:
{
Description: An identifier specifying the meaning of the Value property. ,
Required: False ,
}
string ,
value:
{
Description: The additional information included with the error response. ,
Required: False ,
}
string ,
}
,
]
,
}