Job Schedule - Patch
Updates the properties of the specified Job Schedule.
This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep 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.
PATCH {batchUrl}/jobschedules/{jobScheduleId}?api-version=2020-09-01.12.0
PATCH {batchUrl}/jobschedules/{jobScheduleId}?timeout={timeout}&api-version=2020-09-01.12.0
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
batch
|
path | True |
|
The base URL for all Azure Batch service requests. |
job
|
path | True |
|
The ID of the Job Schedule to update. |
api-version
|
query | True |
|
Client API Version. |
timeout
|
query |
|
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. |
Request Header
Media Types: "application/json; odata=minimalmetadata"
Name | Required | Type | Description |
---|---|---|---|
client-request-id |
|
The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
|
Whether the server should return the client-request-id in the response. |
|
ocp-date |
|
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. |
|
If-Match |
|
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. |
|
If-None-Match |
|
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. |
|
If-Modified-Since |
|
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. |
|
If-Unmodified-Since |
|
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. |
Request Body
Media Types: "application/json; odata=minimalmetadata"
Name | Type | Description |
---|---|---|
jobSpecification |
The details of the Jobs to be created on this schedule. |
|
metadata |
A list of name-value pairs associated with the Job Schedule as metadata. |
|
schedule |
The schedule according to which Jobs will be created. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request to the Batch service was successful. Headers
|
|
Other Status Codes |
The error from the Batch service. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Impersonate your user account |
Authorization
Type:
apiKey
In:
header
Examples
JobSchedule patch
Sample Request
PATCH account.region.batch.azure.com/jobschedules/jobScheduleId?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
"schedule": {
"doNotRunUntil": "2025-01-01T12:30:00Z"
},
"jobSpecification": {
"priority": 0,
"usesTaskDependencies": false,
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"poolInfo": {
"poolId": "poolId"
}
}
}
Sample Response
Definitions
Application |
A reference to an Package to be deployed to Compute Nodes. |
Authentication |
The settings for an authentication token that the Task can use to perform Batch service operations. |
Auto |
Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. |
Auto |
The scope for the auto user |
Auto |
Specifies the parameters for the auto user that runs a Task on the Batch service. |
Azure |
Information used to connect to an Azure Storage Container using Blobfuse. |
Azure |
Information used to connect to an Azure Fileshare. |
Batch |
An error response received from the Azure Batch service. |
Batch |
An item of additional information included in an Azure Batch error response. |
Caching |
The type of caching to enable for the disk. |
Certificate |
A reference to a Certificate to be installed on Compute Nodes in a Pool. |
Certificate |
The location of the Certificate store on the Compute Node into which to install the Certificate. |
CIFSMount |
Information used to connect to a CIFS file system. |
Cloud |
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform. |
Compute |
How Tasks are distributed across Compute Nodes in a Pool. |
Container |
The configuration for container-enabled Pools. |
Container |
A private container registry. |
Container |
The container technology to be used. |
Container |
The location of the container Task working directory. |
Data |
Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them. |
Disk |
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Shared Image Gallery Image. |
Dynamic |
The scope of dynamic vnet assignment. |
Elevation |
The elevation level of the user. |
Environment |
An environment variable to be set on a Task process. |
Error |
An error message received in an Azure Batch error response. |
Image |
A reference to an Azure Virtual Machines Marketplace Image or a Shared Image Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation. |
Inbound |
The protocol of the endpoint. |
Inbound |
A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally. |
IPAddress |
The provisioning type for Public IP Addresses for the Pool. |
Job |
The execution constraints for a Job. |
Job |
Specifies details of a Job Manager Task. |
Job |
The network configuration for the Job. |
Job |
A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. |
Job |
A Job Release Task to run on Job completion on any Compute Node where the Job has run. |
Job |
The set of changes to be made to a Job Schedule. |
Job |
Specifies details of the Jobs to be created on a schedule. |
Linux |
Properties used to create a user Account on a Linux Compute Node. |
Login |
The login mode for the user |
Metadata |
A name-value pair associated with a Batch service resource. |
Mount |
The file system to mount on each node. |
Network |
The network configuration for a Pool. |
Network |
A network security group rule to apply to an inbound endpoint. |
Network |
The action that should be taken for a specified IP address, subnet range or tag. |
NFSMount |
Information used to connect to an NFS file system. |
On |
The action the Batch service should take when all Tasks in the Job are in the completed state. |
On |
The action the Batch service should take when any Task in the Job fails. |
Output |
A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process. |
Output |
Specifies a file upload destination within an Azure blob storage container. |
Output |
The destination to which a file should be uploaded. |
Output |
The conditions under which a Task output file or set of files should be uploaded. |
Output |
Details about an output file upload operation, including under what conditions to perform the upload. |
Pool |
The endpoint configuration for a Pool. |
Pool |
Specifies how a Job should be assigned to a Pool. |
Pool |
The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. |
Pool |
Specification for creating a new Pool. |
Public |
The public IP Address configuration of the networking configuration of a Pool. |
Resource |
A single file or multiple files to be downloaded to a Compute Node. |
Schedule |
The schedule according to which Jobs will be created |
Start |
A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged. |
Storage |
The storage Account type for use in creating data disks. |
Task |
Execution constraints to apply to a Task. |
Task |
The container settings for a Task. |
Task |
Specifies how Tasks should be distributed across Compute Nodes. |
User |
Properties used to create a user used to execute Tasks on an Azure Batch Compute Node. |
User |
The definition of the user identity under which the Task is run. |
Virtual |
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure. |
Windows |
Windows operating system settings to apply to the virtual machine. |
Windows |
Properties used to create a user Account on a Windows Compute Node. |
ApplicationPackageReference
A reference to an Package to be deployed to Compute Nodes.
Name | Type | Description |
---|---|---|
applicationId |
|
The ID of the application to deploy. |
version |
|
The version of the application to deploy. If omitted, the default version is deployed. |
AuthenticationTokenSettings
The settings for an authentication token that the Task can use to perform Batch service operations.
Name | Type | Description |
---|---|---|
access |
|
The Batch resources to which the token grants access. |
AutoPoolSpecification
Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.
Name | Type | Description |
---|---|---|
autoPoolIdPrefix |
|
A prefix to be added to the unique identifier when a Pool is automatically created. |
keepAlive |
|
Whether to keep an auto Pool alive after its lifetime expires. |
pool |
The Pool specification for the auto Pool. |
|
poolLifetimeOption |
The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. |
AutoUserScope
The scope for the auto user
Name | Type | Description |
---|---|---|
pool |
|
Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool. |
task |
|
Specifies that the service should create a new user for the Task. |
AutoUserSpecification
Specifies the parameters for the auto user that runs a Task on the Batch service.
Name | Type | Description |
---|---|---|
elevationLevel |
The elevation level of the auto user. |
|
scope |
The scope for the auto user |
AzureBlobFileSystemConfiguration
Information used to connect to an Azure Storage Container using Blobfuse.
Name | Type | Description |
---|---|---|
accountKey |
|
The Azure Storage Account key. |
accountName |
|
The Azure Storage Account name. |
blobfuseOptions |
|
Additional command line options to pass to the mount command. |
containerName |
|
The Azure Blob Storage Container name. |
relativeMountPath |
|
The relative path on the compute node where the file system will be mounted |
sasKey |
|
The Azure Storage SAS token. |
AzureFileShareConfiguration
Information used to connect to an Azure Fileshare.
Name | Type | Description |
---|---|---|
accountKey |
|
The Azure Storage account key. |
accountName |
|
The Azure Storage account name. |
azureFileUrl |
|
The Azure Files URL. |
mountOptions |
|
Additional command line options to pass to the mount command. |
relativeMountPath |
|
The relative path on the compute node where the file system will be mounted |
BatchError
An error response received from the Azure Batch service.
Name | Type | Description |
---|---|---|
code |
|
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
message |
A message describing the error, intended to be suitable for display in a user interface. |
|
values |
A collection of key-value pairs containing additional details about the error. |
BatchErrorDetail
An item of additional information included in an Azure Batch error response.
Name | Type | Description |
---|---|---|
key |
|
An identifier specifying the meaning of the Value property. |
value |
|
The additional information included with the error response. |
CachingType
The type of caching to enable for the disk.
Name | Type | Description |
---|---|---|
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. |
CertificateReference
A reference to a Certificate to be installed on Compute Nodes in a Pool.
Name | Type | Description |
---|---|---|
storeLocation |
The location of the Certificate store on the Compute Node into which to install the Certificate. |
|
storeName |
|
The name of the Certificate store on the Compute Node into which to install the Certificate. |
thumbprint |
|
The thumbprint of the Certificate. |
thumbprintAlgorithm |
|
The algorithm with which the thumbprint is associated. This must be sha1. |
visibility |
|
Which user Accounts on the Compute Node should have access to the private data of the Certificate. |
CertificateStoreLocation
The location of the Certificate store on the Compute Node into which to install the Certificate.
Name | Type | Description |
---|---|---|
currentuser |
|
Certificates should be installed to the CurrentUser Certificate store. |
localmachine |
|
Certificates should be installed to the LocalMachine Certificate store. |
CIFSMountConfiguration
Information used to connect to a CIFS file system.
Name | Type | Description |
---|---|---|
mountOptions |
|
Additional command line options to pass to the mount command. |
password |
|
The password to use for authentication against the CIFS file system. |
relativeMountPath |
|
The relative path on the compute node where the file system will be mounted |
source |
|
The URI of the file system to mount. |
username |
|
The user to use for authentication against the CIFS file system. |
CloudServiceConfiguration
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.
Name | Type | Description |
---|---|---|
osFamily |
|
The Azure Guest OS family to be installed on the virtual machines in the Pool. |
osVersion |
|
The Azure Guest OS version to be installed on the virtual machines in the Pool. |
ComputeNodeFillType
How Tasks are distributed across Compute Nodes in a Pool.
Name | Type | Description |
---|---|---|
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. |
spread |
|
Tasks should be assigned evenly across all Compute Nodes in the Pool. |
ContainerConfiguration
The configuration for container-enabled Pools.
Name | Type | Description |
---|---|---|
containerImageNames |
|
The collection of container Image names. |
containerRegistries |
Additional private registries from which containers can be pulled. |
|
type |
The container technology to be used. |
ContainerRegistry
A private container registry.
Name | Type | Description |
---|---|---|
password |
|
The password to log into the registry server. |
registryServer |
|
The registry URL. |
username |
|
The user name to log into the registry server. |
ContainerType
The container technology to be used.
Name | Type | Description |
---|---|---|
dockerCompatible |
|
A Docker compatible container technology will be used to launch the containers. |
ContainerWorkingDirectory
The location of the container Task working directory.
Name | Type | Description |
---|---|---|
containerImageDefault |
|
Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch. |
taskWorkingDirectory |
|
Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch. |
DataDisk
Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.
Name | Type | Description |
---|---|---|
caching |
The type of caching to be enabled for the data disks. |
|
diskSizeGB |
|
The initial disk size in gigabytes. |
lun |
|
The logical unit number. |
storageAccountType |
The storage Account type to be used for the data disk. |
DiskEncryptionConfiguration
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Shared Image Gallery Image.
Name | Type | Description |
---|---|---|
targets |
|
The list of disk targets Batch Service will encrypt on the compute node. |
DynamicVNetAssignmentScope
The scope of dynamic vnet assignment.
Name | Type | Description |
---|---|---|
job |
|
Dynamic VNet assignment is done per-job. |
none |
|
No dynamic VNet assignment is enabled. |
ElevationLevel
The elevation level of the user.
Name | Type | Description |
---|---|---|
admin |
|
The user is a user with elevated access and operates with full Administrator permissions. |
nonadmin |
|
The user is a standard user without elevated access. |
EnvironmentSetting
An environment variable to be set on a Task process.
Name | Type | Description |
---|---|---|
name |
|
The name of the environment variable. |
value |
|
The value of the environment variable. |
ErrorMessage
An error message received in an Azure Batch error response.
Name | Type | Description |
---|---|---|
lang |
|
The language code of the error message |
value |
|
The text of the message. |
ImageReference
A reference to an Azure Virtual Machines Marketplace Image or a Shared Image Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation.
Name | Type | Description |
---|---|---|
offer |
|
The offer type of the Azure Virtual Machines Marketplace Image. |
publisher |
|
The publisher of the Azure Virtual Machines Marketplace Image. |
sku |
|
The SKU of the Azure Virtual Machines Marketplace Image. |
version |
|
The version of the Azure Virtual Machines Marketplace Image. |
virtualMachineImageId |
|
The ARM resource identifier of the Shared Image 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. |
InboundEndpointProtocol
The protocol of the endpoint.
Name | Type | Description |
---|---|---|
tcp |
|
Use TCP for the endpoint. |
udp |
|
Use UDP for the endpoint. |
InboundNATPool
A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.
Name | Type | Description |
---|---|---|
backendPort |
|
The port number on the Compute Node. |
frontendPortRangeEnd |
|
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. |
frontendPortRangeStart |
|
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. |
name |
|
The name of the endpoint. |
networkSecurityGroupRules |
A list of network security group rules that will be applied to the endpoint. |
|
protocol |
The protocol of the endpoint. |
IPAddressProvisioningType
The provisioning type for Public IP Addresses for the Pool.
Name | Type | Description |
---|---|---|
batchmanaged |
|
A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. |
nopublicipaddresses |
|
No public IP Address will be created. |
usermanaged |
|
Public IPs are provided by the user and will be used to provision the Compute Nodes. |
JobConstraints
The execution constraints for a Job.
Name | Type | Description |
---|---|---|
maxTaskRetryCount |
|
The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. |
maxWallClockTime |
|
The maximum elapsed time that the Job may run, measured from the time the Job is created. |
JobManagerTask
Specifies details of a Job Manager Task.
Name | Type | Description |
---|---|---|
allowLowPriorityNode |
|
Whether the Job Manager Task may run on a low-priority Compute Node. |
applicationPackageReferences |
A list of Application Packages that the Batch service will deploy to the Compute Node before running the command line. |
|
authenticationTokenSettings |
The settings for an authentication token that the Task can use to perform Batch service operations. |
|
commandLine |
|
The command line of the Job Manager Task. |
constraints |
Constraints that apply to the Job Manager Task. |
|
containerSettings |
The settings for the container under which the Job Manager Task runs. |
|
displayName |
|
The display name of the Job Manager Task. |
environmentSettings |
A list of environment variable settings for the Job Manager Task. |
|
id |
|
A string that uniquely identifies the Job Manager Task within the Job. |
killJobOnCompletion |
|
Whether completion of the Job Manager Task signifies completion of the entire Job. |
outputFiles |
A list of files that the Batch service will upload from the Compute Node after running the command line. |
|
requiredSlots |
|
The number of scheduling slots that the Task requires to run. |
resourceFiles |
A list of files that the Batch service will download to the Compute Node before running the command line. |
|
runExclusive |
|
Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. |
userIdentity |
The user identity under which the Job Manager Task runs. |
JobNetworkConfiguration
The network configuration for the Job.
Name | Type | Description |
---|---|---|
subnetId |
|
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. This will only work with a VirtualMachineConfiguration Pool. |
JobPreparationTask
A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.
Name | Type | Description |
---|---|---|
commandLine |
|
The command line of the Job Preparation Task. |
constraints |
Constraints that apply to the Job Preparation Task. |
|
containerSettings |
The settings for the container under which the Job Preparation Task runs. |
|
environmentSettings |
A list of environment variable settings for the Job Preparation Task. |
|
id |
|
A string that uniquely identifies the Job Preparation Task within the Job. |
rerunOnNodeRebootAfterSuccess |
|
Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. |
resourceFiles |
A list of files that the Batch service will download to the Compute Node before running the command line. |
|
userIdentity |
The user identity under which the Job Preparation Task runs. |
|
waitForSuccess |
|
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. |
JobReleaseTask
A Job Release Task to run on Job completion on any Compute Node where the Job has run.
Name | Type | Description |
---|---|---|
commandLine |
|
The command line of the Job Release Task. |
containerSettings |
The settings for the container under which the Job Release Task runs. |
|
environmentSettings |
A list of environment variable settings for the Job Release Task. |
|
id |
|
A string that uniquely identifies the Job Release Task within the Job. |
maxWallClockTime |
|
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). |
resourceFiles |
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. |
|
retentionTime |
|
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. |
userIdentity |
The user identity under which the Job Release Task runs. |
JobSchedulePatchParameter
The set of changes to be made to a Job Schedule.
Name | Type | Description |
---|---|---|
jobSpecification |
The details of the Jobs to be created on this schedule. |
|
metadata |
A list of name-value pairs associated with the Job Schedule as metadata. |
|
schedule |
The schedule according to which Jobs will be created. |
JobSpecification
Specifies details of the Jobs to be created on a schedule.
Name | Type | Description |
---|---|---|
commonEnvironmentSettings |
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). |
|
constraints |
The execution constraints for Jobs created under this schedule. |
|
displayName |
|
The display name for Jobs created under this schedule. |
jobManagerTask |
The details of a Job Manager Task to be launched when a Job is started under this schedule. |
|
jobPreparationTask |
The Job Preparation Task for Jobs created under this schedule. |
|
jobReleaseTask |
The Job Release Task for Jobs created under this schedule. |
|
metadata |
A list of name-value pairs associated with each Job created under this schedule as metadata. |
|
networkConfiguration |
The network configuration for the Job. |
|
onAllTasksComplete |
The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. |
|
onTaskFailure |
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. |
|
poolInfo |
The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. |
|
priority |
|
The priority of Jobs created under this schedule. |
usesTaskDependencies |
|
Whether Tasks in the Job can define dependencies on each other. The default is false. |
LinuxUserConfiguration
Properties used to create a user Account on a Linux Compute Node.
Name | Type | Description |
---|---|---|
gid |
|
The group ID for the user Account. |
sshPrivateKey |
|
The SSH private key for the user Account. |
uid |
|
The user ID of the user Account. |
LoginMode
The login mode for the user
Name | Type | Description |
---|---|---|
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. |
MetadataItem
A name-value pair associated with a Batch service resource.
Name | Type | Description |
---|---|---|
name |
|
The name of the metadata item. |
value |
|
The value of the metadata item. |
MountConfiguration
The file system to mount on each node.
Name | Type | Description |
---|---|---|
azureBlobFileSystemConfiguration |
The Azure Storage Container to mount using blob FUSE on each node. |
|
azureFileShareConfiguration |
The Azure File Share to mount on each node. |
|
cifsMountConfiguration |
The CIFS/SMB file system to mount on each node. |
|
nfsMountConfiguration |
The NFS file system to mount on each node. |
NetworkConfiguration
The network configuration for a Pool.
Name | Type | Description |
---|---|---|
dynamicVNetAssignmentScope |
The scope of dynamic vnet assignment. |
|
endpointConfiguration |
The configuration for endpoints on Compute Nodes in the Batch Pool. |
|
publicIPAddressConfiguration |
The Public IPAddress configuration for Compute Nodes in the Batch Pool. |
|
subnetId |
|
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}. |
NetworkSecurityGroupRule
A network security group rule to apply to an inbound endpoint.
Name | Type | Description |
---|---|---|
access |
The action that should be taken for a specified IP address, subnet range or tag. |
|
priority |
|
The priority for this rule. |
sourceAddressPrefix |
|
The source address prefix or tag to match for the rule. |
sourcePortRanges |
|
The source port ranges to match for the rule. |
NetworkSecurityGroupRuleAccess
The action that should be taken for a specified IP address, subnet range or tag.
Name | Type | Description |
---|---|---|
allow |
|
Allow access. |
deny |
|
Deny access. |
NFSMountConfiguration
Information used to connect to an NFS file system.
Name | Type | Description |
---|---|---|
mountOptions |
|
Additional command line options to pass to the mount command. |
relativeMountPath |
|
The relative path on the compute node where the file system will be mounted |
source |
|
The URI of the file system to mount. |
OnAllTasksComplete
The action the Batch service should take when all Tasks in the Job are in the completed state.
Name | Type | Description |
---|---|---|
noaction |
|
Do nothing. The Job remains active unless terminated or disabled by some other means. |
terminatejob |
|
Terminate the Job. The Job's terminateReason is set to 'AllTasksComplete'. |
OnTaskFailure
The action the Batch service should take when any Task in the Job fails.
Name | Type | Description |
---|---|---|
noaction |
|
Do nothing. The Job remains active unless terminated or disabled by some other means. |
performexitoptionsjobaction |
|
Take the action associated with the Task exit condition in the Task's exitConditions collection. (This may still result in no action being taken, if that is what the Task specifies.) |
OutputFile
A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process.
Name | Type | Description |
---|---|---|
destination |
The destination for the output file(s). |
|
filePattern |
|
A pattern indicating which file(s) to upload. |
uploadOptions |
Additional options for the upload operation, including under what conditions to perform the upload. |
OutputFileBlobContainerDestination
Specifies a file upload destination within an Azure blob storage container.
Name | Type | Description |
---|---|---|
containerUrl |
|
The URL of the container within Azure Blob Storage to which to upload the file(s). |
path |
|
The destination blob or virtual directory within the Azure Storage container. |
OutputFileDestination
The destination to which a file should be uploaded.
Name | Type | Description |
---|---|---|
container |
A location in Azure blob storage to which files are uploaded. |
OutputFileUploadCondition
The conditions under which a Task output file or set of files should be uploaded.
Name | Type | Description |
---|---|---|
taskcompletion |
|
Upload the file(s) after the Task process exits, no matter what the exit code was. |
taskfailure |
|
Upload the file(s) only after the Task process exits with a nonzero exit code. |
tasksuccess |
|
Upload the file(s) only after the Task process exits with an exit code of 0. |
OutputFileUploadOptions
Details about an output file upload operation, including under what conditions to perform the upload.
Name | Type | Description |
---|---|---|
uploadCondition |
The conditions under which the Task output file or set of files should be uploaded. |
PoolEndpointConfiguration
The endpoint configuration for a Pool.
Name | Type | Description |
---|---|---|
inboundNATPools |
A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. |
PoolInformation
Specifies how a Job should be assigned to a Pool.
Name | Type | Description |
---|---|---|
autoPoolSpecification |
Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. |
|
poolId |
|
The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. |
PoolLifetimeOption
The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools.
Name | Type | Description |
---|---|---|
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. |
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. |
PoolSpecification
Specification for creating a new Pool.
Name | Type | Description |
---|---|---|
applicationLicenses |
|
The list of application licenses the Batch service will make available on each Compute Node in the Pool. |
applicationPackageReferences |
The list of Packages to be installed on each Compute Node in the Pool. |
|
autoScaleEvaluationInterval |
|
The time interval at which to automatically adjust the Pool size according to the autoscale formula. |
autoScaleFormula |
|
The formula for the desired number of Compute Nodes in the Pool. |
certificateReferences |
A list of Certificates to be installed on each Compute Node in the Pool. |
|
cloudServiceConfiguration |
The cloud service configuration for the Pool. |
|
displayName |
|
The display name for the Pool. |
enableAutoScale |
|
Whether the Pool size should automatically adjust over time. |
enableInterNodeCommunication |
|
Whether the Pool permits direct communication between Compute Nodes. |
metadata |
A list of name-value pairs associated with the Pool as metadata. |
|
mountConfiguration |
A list of file systems to mount on each node in the pool. |
|
networkConfiguration |
The network configuration for the Pool. |
|
resizeTimeout |
|
The timeout for allocation of Compute Nodes to the Pool. |
startTask |
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. |
|
targetDedicatedNodes |
|
The desired number of dedicated Compute Nodes in the Pool. |
targetLowPriorityNodes |
|
The desired number of low-priority Compute Nodes in the Pool. |
taskSchedulingPolicy |
How Tasks are distributed across Compute Nodes in a Pool. |
|
taskSlotsPerNode |
|
The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. |
userAccounts |
The list of user Accounts to be created on each Compute Node in the Pool. |
|
virtualMachineConfiguration |
The virtual machine configuration for the Pool. |
|
vmSize |
|
The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. |
PublicIPAddressConfiguration
The public IP Address configuration of the networking configuration of a Pool.
Name | Type | Description |
---|---|---|
ipAddressIds |
|
The list of public IPs which the Batch service will use when provisioning Compute Nodes. |
provision |
The provisioning type for Public IP Addresses for the Pool. |
ResourceFile
A single file or multiple files to be downloaded to a Compute Node.
Name | Type | Description |
---|---|---|
autoStorageContainerName |
|
The storage container name in the auto storage Account. |
blobPrefix |
|
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. |
fileMode |
|
The file permission mode attribute in octal format. |
filePath |
|
The location on the Compute Node to which to download the file(s), relative to the Task's working directory. |
httpUrl |
|
The URL of the file to download. |
storageContainerUrl |
|
The URL of the blob container within Azure Blob Storage. |
Schedule
The schedule according to which Jobs will be created
Name | Type | Description |
---|---|---|
doNotRunAfter |
|
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. |
doNotRunUntil |
|
The earliest time at which any Job may be created under this Job Schedule. |
recurrenceInterval |
|
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. |
startWindow |
|
The time interval, starting from the time at which the schedule indicates a Job should be created, within which a Job must be created. |
StartTask
A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged.
Name | Type | Description |
---|---|---|
commandLine |
|
The command line of the StartTask. |
containerSettings |
The settings for the container under which the StartTask runs. |
|
environmentSettings |
A list of environment variable settings for the StartTask. |
|
maxTaskRetryCount |
|
The maximum number of times the Task may be retried. |
resourceFiles |
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. |
|
userIdentity |
The user identity under which the StartTask runs. |
|
waitForSuccess |
|
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. |
StorageAccountType
The storage Account type for use in creating data disks.
Name | Type | Description |
---|---|---|
premium_lrs |
|
The data disk should use premium locally redundant storage. |
standard_lrs |
|
The data disk should use standard locally redundant storage. |
TaskConstraints
Execution constraints to apply to a Task.
Name | Type | Description |
---|---|---|
maxTaskRetryCount |
|
The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. |
maxWallClockTime |
|
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. |
retentionTime |
|
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. |
TaskContainerSettings
The container settings for a Task.
Name | Type | Description |
---|---|---|
containerRunOptions |
|
Additional options to the container create command. |
imageName |
|
The Image to use to create the container in which the Task will run. |
registry |
The private registry which contains the container Image. |
|
workingDirectory |
The location of the container Task working directory. |
TaskSchedulingPolicy
Specifies how Tasks should be distributed across Compute Nodes.
Name | Type | Description |
---|---|---|
nodeFillType |
How Tasks are distributed across Compute Nodes in a Pool. |
UserAccount
Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.
Name | Type | Description |
---|---|---|
elevationLevel |
The elevation level of the user Account. |
|
linuxUserConfiguration |
The Linux-specific user configuration for the user Account. |
|
name |
|
The name of the user Account. |
password |
|
The password for the user Account. |
windowsUserConfiguration |
The Windows-specific user configuration for the user Account. |
UserIdentity
The definition of the user identity under which the Task is run.
Name | Type | Description |
---|---|---|
autoUser |
The auto user under which the Task is run. |
|
username |
|
The name of the user identity under which the Task is run. |
VirtualMachineConfiguration
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.
Name | Type | Description |
---|---|---|
containerConfiguration |
The container configuration for the Pool. |
|
dataDisks |
|
The configuration for data disks attached to the Compute Nodes in the Pool. |
diskEncryptionConfiguration |
The disk encryption configuration for the pool. |
|
imageReference |
A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. |
|
licenseType |
|
The type of on-premises license to be used when deploying the operating system. Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client. |
nodeAgentSKUId |
|
The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. |
windowsConfiguration |
Windows operating system settings on the virtual machine. |
WindowsConfiguration
Windows operating system settings to apply to the virtual machine.
Name | Type | Description |
---|---|---|
enableAutomaticUpdates |
|
Whether automatic updates are enabled on the virtual machine. |
WindowsUserConfiguration
Properties used to create a user Account on a Windows Compute Node.
Name | Type | Description |
---|---|---|
loginMode |
The login mode for the user |