com.microsoft.azure.batch.protocol.models

Defines headers for ListNodeAgentSkus operation.

Additional parameters for listNodeAgentSkusNext operation.

Additional parameters for listNodeAgentSkus operation.

Defines headers for ListPoolNodeCounts operation.

Additional parameters for listPoolNodeCountsNext operation.

Additional parameters for listPoolNodeCounts operation.

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

Defines headers for Get operation.

Additional parameters for get operation.

Defines headers for List operation.

Additional parameters for listNext operation.

Additional parameters for list operation.

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

Contains information about an application in an Azure Batch account.

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

Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool when the job is submitted.

The results and errors from an execution of a pool autoscale formula.

An error that occurred when executing or evaluating a pool autoscale formula.

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

An error response received from the Azure Batch service.

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

Exception thrown for an invalid response with BatchError information.

A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine.

Defines headers for Add operation.

Additional parameters for add operation.

A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine.

Defines headers for CancelDeletion operation.

Additional parameters for cancelDeletion operation.

Defines headers for Delete operation.

Additional parameters for delete operation.

Defines headers for Get operation.

Additional parameters for get operation.

Defines headers for List operation.

Additional parameters for listNext operation.

Additional parameters for list operation.

A reference to a certificate to be installed on compute nodes in a pool.

An Azure Batch job.

A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

A pool in the Azure Batch service.

The configuration for nodes in a pool based on the Azure Cloud Services platform.

An Azure Batch task. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute 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.

The result of listing the subtasks of a task.

A compute node in the Batch service.

Defines headers for AddUser operation.

Additional parameters for addUser operation.

Defines headers for DeleteUser operation.

Additional parameters for deleteUser operation.

Defines headers for DisableScheduling operation.

Additional parameters for disableScheduling operation.

Defines headers for EnableScheduling operation.

Additional parameters for enableScheduling operation.

The endpoint configuration for the compute node.

An error encountered by a compute node.

Defines headers for Get operation.

Additional parameters for get operation.

Defines headers for GetRemoteDesktop operation.

Additional parameters for getRemoteDesktop operation.

Defines headers for GetRemoteLoginSettings operation.

Additional parameters for getRemoteLoginSettings operation.

The remote login settings for a compute node.

Information about the compute node on which a task ran.

Defines headers for List operation.

Additional parameters for listNext operation.

Additional parameters for list operation.

Defines headers for Reboot operation.

Additional parameters for reboot operation.

Defines headers for Reimage operation.

Additional parameters for reimage operation.

Defines headers for UpdateUser operation.

Additional parameters for updateUser operation.

Defines headers for UploadBatchServiceLogs operation.

Additional parameters for uploadBatchServiceLogs operation.

A user account for RDP or SSH access on a compute node.

The configuration for container-enabled pools.

A private container registry.

Settings which will be used by the data disks associated to compute nodes in the pool.

An error encountered by the Batch service when deleting a certificate.

An environment variable to be set on a task process.

An error message received in an Azure Batch error response.

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

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

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

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

Defines headers for DeleteFromComputeNode operation.

Additional parameters for deleteFromComputeNode operation.

Defines headers for DeleteFromTask operation.

Additional parameters for deleteFromTask operation.

Defines headers for GetFromComputeNode operation.

Additional parameters for getFromComputeNode operation.

Defines headers for GetFromTask operation.

Additional parameters for getFromTask operation.

Defines headers for GetPropertiesFromComputeNode operation.

Additional parameters for getPropertiesFromComputeNode operation.

Defines headers for GetPropertiesFromTask operation.

Additional parameters for getPropertiesFromTask operation.

Defines headers for ListFromComputeNode operation.

Additional parameters for listFromComputeNodeNext operation.

Additional parameters for listFromComputeNode operation.

Defines headers for ListFromTask operation.

Additional parameters for listFromTaskNext operation.

Additional parameters for listFromTask operation.

The properties of a file on a compute node.

A reference to an Azure Virtual Machines Marketplace image or a custom Azure Virtual Machine image. To get the list of all Azure Marketplace image references verified by Azure Batch, see the 'List node agent SKUs' operation.

An inbound endpoint on a compute node.

A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.

Defines headers for Add operation.

Additional parameters for add operation.

An Azure Batch job to add.

The execution constraints for a job.

Defines headers for Delete operation.

Additional parameters for delete operation.

Defines headers for Disable operation.

Additional parameters for disable operation.

Options when disabling a job.

Defines headers for Enable operation.

Additional parameters for enable operation.

Contains information about the execution of a job in the Azure Batch service.

Defines headers for GetAllLifetimeStatistics operation.

Additional parameters for getAllLifetimeStatistics operation.

Defines headers for Get operation.

Additional parameters for get operation.

Defines headers for GetTaskCounts operation.

Additional parameters for getTaskCounts operation.

Defines headers for ListFromJobSchedule operation.

Additional parameters for listFromJobScheduleNext operation.

Additional parameters for listFromJobSchedule operation.

Defines headers for List operation.

Additional parameters for listNext operation.

Additional parameters for list operation.

Defines headers for ListPreparationAndReleaseTaskStatus operation.

Additional parameters for listPreparationAndReleaseTaskStatusNext operation.

Additional parameters for listPreparationAndReleaseTaskStatus operation.

Specifies details of a Job Manager task. The Job Manager task is automatically started when the job is created. The Batch service tries to schedule the Job Manager task before any other tasks in the job. When shrinking a pool, the Batch service tries to preserve compute nodes where Job Manager tasks are running for as long as possible (that is, nodes running 'normal' tasks are removed before nodes running Job Manager tasks). When a Job Manager task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle nodes available, the system may terminate one of the running tasks in the pool and return it to the queue in order to make room for the Job Manager task to restart. Note that a Job Manager task in one job does not have priority over tasks in other jobs. Across jobs, only job level priorities are observed. For example, if a Job Manager in a priority 0 job needs to be restarted, it will not displace tasks of a priority 1 job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute 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.

The network configuration for the job.

Defines headers for Patch operation.

Additional parameters for patch operation.

The set of changes to be made to a job.

The status of the Job Preparation and Job Release tasks on a compute node.

A Job Preparation task to run before any tasks of the job on any given compute node. You can use Job Preparation to prepare a compute node to run tasks for the job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the tasks in the job. The Job Preparation task can download these common resource files to the shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR), or starting a local service on the compute node so that all tasks of that job can communicate with it. If the Job Preparation task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run tasks of this job on the compute node. The node remains ineligible to run tasks of this job until it is reimaged. The node remains active and can be used for other jobs. The Job Preparation task can run multiple times on the same compute node. Therefore, you should write the Job Preparation task to handle re-execution. If the compute node is rebooted, the Job Preparation task is run again on the node before scheduling any other task of the job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not previously complete. If the compute node is reimaged, the Job Preparation task is run again before scheduling any task of the job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute 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.

Contains information about the execution of a Job Preparation task on a compute node.

A Job Release task to run on job completion on any compute node where the job has run. The Job Release task runs when the job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the job is still active, the job's maximum wall clock time constraint is reached, and the job is still active, or the job's Job Manager task completed, and the job is configured to terminate when the Job Manager completes. The Job Release task runs on each compute node where tasks of the job have run and the Job Preparation task ran and completed. If you reimage a compute node after it has run the Job Preparation task, and the job ends without any further tasks of the job running on that compute node (and hence the Job Preparation task does not re-run), then the Job Release task does not run on that node. If a compute node reboots while the Job Release task is still running, the Job Release task runs again when the compute node starts up. The job is not marked as complete until all Job Release tasks have completed. The Job Release task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the maxTasksPerNode limit specified on the pool.

Contains information about the execution of a Job Release task on a compute node.

Defines headers for Add operation.

Additional parameters for add operation.

A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

Defines headers for Delete operation.

Additional parameters for delete operation.

Defines headers for Disable operation.

Additional parameters for disable operation.

Defines headers for Enable operation.

Additional parameters for enable operation.

Contains information about jobs that have been and will be run under a job schedule.

Defines headers for Exists operation.

Additional parameters for exists operation.

Defines headers for Get operation.

Additional parameters for get operation.

Defines headers for List operation.

Additional parameters for listNext operation.

Additional parameters for list operation.

Defines headers for Patch operation.

Additional parameters for patch operation.

The set of changes to be made to a job schedule.

Resource usage statistics for a job schedule.

Defines headers for Terminate operation.

Additional parameters for terminate operation.

Defines headers for Update operation.

Additional parameters for update operation.

The set of changes to be made to a job schedule.

An error encountered by the Batch service when scheduling a job.

Specifies details of the jobs to be created on a schedule.

Resource usage statistics for a job.

Defines headers for Terminate operation.

Additional parameters for terminate operation.

Options when terminating a job.

Defines headers for Update operation.

Additional parameters for update operation.

The set of changes to be made to a job.

Properties used to create a user account on a Linux node.

A name-value pair associated with a Batch service resource. The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.

Settings which specify how to run a multi-instance task. Multi-instance tasks are commonly used to support MPI tasks.

Represents a name-value pair.

The network configuration for a pool.

A network security group rule to apply to an inbound endpoint.

Information about the node agent. The Batch node agent is a program that runs on each node in the pool and provides Batch capability on the compute node.

A node agent SKU supported by the Batch service. The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems.

The number of nodes in each node state.

Options for disabling scheduling on a compute node.

Information about a file or directory on a compute node.

Options for rebooting a compute node.

Options for reimaging a compute node.

Options for removing compute nodes from a pool.

The set of changes to be made to a user account on a node.

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

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

The destination to which a file should be uploaded.

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

An instance of this class defines a page of Azure resources and a link to get the next page of resources, if any.

Defines headers for Add operation.

Additional parameters for add operation.

A pool in the Azure Batch service to add.

Defines headers for Delete operation.

Additional parameters for delete operation.

Defines headers for DisableAutoScale operation.

Additional parameters for disableAutoScale operation.

Defines headers for EnableAutoScale operation.

Additional parameters for enableAutoScale operation.

Options for enabling automatic scaling on a pool.

The endpoint configuration for a pool.

Defines headers for EvaluateAutoScale operation.

Additional parameters for evaluateAutoScale operation.

Options for evaluating an automatic scaling formula on a pool.

Defines headers for Exists operation.

Additional parameters for exists operation.

Defines headers for GetAllLifetimeStatistics operation.

Additional parameters for getAllLifetimeStatistics operation.

Defines headers for Get operation.

Additional parameters for get operation.

Specifies how a job should be assigned to a pool.

Defines headers for List operation.

Additional parameters for listNext operation.

Additional parameters for list operation.

Defines headers for ListUsageMetrics operation.

Additional parameters for listUsageMetricsNext operation.

Additional parameters for listUsageMetrics operation.

The number of nodes in each state for a pool.

Defines headers for Patch operation.

Additional parameters for patch operation.

The set of changes to be made to a pool.

Defines headers for RemoveNodes operation.

Additional parameters for removeNodes operation.

Defines headers for Resize operation.

Additional parameters for resize operation.

Options for changing the size of a pool.

Specification for creating a new pool.

Contains utilization and resource usage statistics for the lifetime of a pool.

Defines headers for StopResize operation.

Additional parameters for stopResize operation.

Defines headers for UpdateProperties operation.

Additional parameters for updateProperties operation.

The set of changes to be made to a pool.

Usage metrics for a pool across an aggregation interval.

Information about the most recent job to run under the job schedule.

An error that occurred when resizing a pool.

A single file or multiple files to be downloaded to a compute node.

Statistics related to resource consumption by compute nodes in a pool.

The schedule according to which jobs will be created.

A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute 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.

Information about a start task running on a compute node.

Information about an Azure Batch subtask.

Defines headers for AddCollection operation.

Additional parameters for addCollection operation.

A collection of Azure Batch tasks to add.

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

Defines headers for Add operation.

Additional parameters for add operation.

An Azure Batch task to add. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute 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.

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

Execution constraints to apply to a task.

Contains information about the container which a task is executing.

The container settings for a task.

The task counts for a job.

Defines headers for Delete operation.

Additional parameters for delete operation.

Specifies any dependencies of a task. Any task that is explicitly specified or within a dependency range must complete before the dependant task will be scheduled.

Information about the execution of a task.

Information about a task failure.

Defines headers for Get operation.

Additional parameters for get operation.

A range of task IDs that a task can depend on. All tasks with IDs in the range must complete successfully before the dependent task can be scheduled. The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents tasks '9', '10', '11' and '12'.

Information about a task running on a compute node.

Defines headers for List operation.

Additional parameters for listNext operation.

Additional parameters for list operation.

Defines headers for ListSubtasks operation.

Additional parameters for listSubtasks operation.

Defines headers for Reactivate operation.

Additional parameters for reactivate operation.

Specifies how tasks should be distributed across compute nodes.

Resource usage statistics for a task.

Defines headers for Terminate operation.

Additional parameters for terminate operation.

Defines headers for Update operation.

Additional parameters for update operation.

The set of changes to be made to a task.

The Azure Batch service log files upload configuration for a compute node.

The result of uploading Batch service log files from a specific compute node.

Statistics related to pool usage information.

Properties used to create a user used to execute tasks on an Azure Batch node.

The definition of the user identity under which the task is run. Specify either the userName or autoUser property, but not both.

The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

Windows operating system settings to apply to the virtual machine.

Properties used to create a user account on a Windows node.

Defines values for AccessScope.

Defines values for AllocationState.

Defines values for AutoUserScope.

Defines values for CachingType.

Defines values for CertificateFormat.

Defines values for CertificateState.

Defines values for CertificateStoreLocation.

Defines values for CertificateVisibility.

Defines values for ComputeNodeDeallocationOption.

Defines values for ComputeNodeFillType.

Defines values for ComputeNodeRebootOption.

Defines values for ComputeNodeReimageOption.

Defines values for ComputeNodeState.

Defines values for DependencyAction.

Defines values for DisableComputeNodeSchedulingOption.

Defines values for DisableJobOption.

Defines values for DynamicVNetAssignmentScope.

Defines values for ElevationLevel.

Defines values for ErrorCategory.

Defines values for InboundEndpointProtocol.

Defines values for JobAction.

Defines values for JobPreparationTaskState.

Defines values for JobReleaseTaskState.

Defines values for JobScheduleState.

Defines values for JobState.

Defines values for LoginMode.

Defines values for NetworkSecurityGroupRuleAccess.

Defines values for OnAllTasksComplete.

Defines values for OnTaskFailure.

Defines values for OSType.

Defines values for OutputFileUploadCondition.

Defines values for PoolLifetimeOption.

Defines values for PoolState.

Defines values for SchedulingState.

Defines values for StartTaskState.

Defines values for StorageAccountType.

Defines values for SubtaskState.

Defines values for TaskAddStatus.

Defines values for TaskExecutionResult.

Defines values for TaskState.