models Package
Classes
| AccountListPoolNodeCountsOptions |
Additional parameters for list_pool_node_counts operation. |
| AccountListSupportedImagesOptions |
Additional parameters for list_supported_images operation. |
| AffinityInformation |
A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task. All required parameters must be populated in order to send to Azure. |
| ApplicationGetOptions |
Additional parameters for get operation. |
| ApplicationListOptions |
Additional parameters for list operation. |
| ApplicationPackageReference |
A reference to an Package to be deployed to Compute Nodes. All required parameters must be populated in order to send to Azure. |
| ApplicationSummary |
Contains information about an application in an Azure Batch Account. All required parameters must be populated in order to send to Azure. |
| ApplicationSummaryPaged |
A paging container for iterating over a list of ApplicationSummary object |
| AuthenticationTokenSettings |
The settings for an authentication token that the Task can use to perform Batch service operations. |
| AutoPoolSpecification |
Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. All required parameters must be populated in order to send to Azure. |
| AutoScaleRun |
The results and errors from an execution of a Pool autoscale formula. All required parameters must be populated in order to send to Azure. |
| AutoScaleRunError |
An error that occurred when executing or evaluating a Pool autoscale formula. |
| AutoUserSpecification |
Specifies the parameters for the auto user that runs a Task on the Batch service. |
| AutomaticOSUpgradePolicy |
The configuration parameters used for performing automatic OS upgrade. |
| AzureBlobFileSystemConfiguration |
Information used to connect to an Azure Storage Container using Blobfuse. All required parameters must be populated in order to send to Azure. |
| AzureFileShareConfiguration |
Information used to connect to an Azure Fileshare. All required parameters must be populated in order to send to Azure. |
| BatchError |
An error response received from the Azure Batch service. |
| BatchErrorDetail |
An item of additional information included in an Azure Batch error response. |
| BatchErrorException |
Server responsed with exception of type: 'BatchError'. |
| BatchPoolIdentity |
The identity of the Batch pool, if configured. The identity of the Batch pool, if configured. All required parameters must be populated in order to send to Azure. |
| CIFSMountConfiguration |
Information used to connect to a CIFS file system. All required parameters must be populated in order to send to Azure. |
| Certificate |
A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine. |
| CertificateAddOptions |
Additional parameters for add operation. |
| CertificateAddParameter |
A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine. All required parameters must be populated in order to send to Azure. |
| CertificateCancelDeletionOptions |
Additional parameters for cancel_deletion operation. |
| CertificateDeleteOptions |
Additional parameters for delete operation. |
| CertificateGetOptions |
Additional parameters for get operation. |
| CertificateListOptions |
Additional parameters for list operation. |
| CertificatePaged |
A paging container for iterating over a list of Certificate object |
| CertificateReference |
A reference to a Certificate to be installed on Compute Nodes in a Pool. Warning: This object is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead. All required parameters must be populated in order to send to Azure. |
| CloudJob |
An Azure Batch Job. |
| CloudJobPaged |
A paging container for iterating over a list of CloudJob object |
| CloudJobSchedule |
A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job. |
| CloudJobSchedulePaged |
A paging container for iterating over a list of CloudJobSchedule object |
| CloudPool |
A Pool in the Azure Batch service. Variables are only populated by the server, and will be ignored when sending a request. |
| CloudPoolPaged |
A paging container for iterating over a list of CloudPool object |
| CloudServiceConfiguration |
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform. All required parameters must be populated in order to send to Azure. |
| CloudTask |
An Azure Batch Task. 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. |
| CloudTaskListSubtasksResult |
The result of listing the subtasks of a Task. |
| CloudTaskPaged |
A paging container for iterating over a list of CloudTask object |
| ComputeNode |
A Compute Node in the Batch service. |
| ComputeNodeAddUserOptions |
Additional parameters for add_user operation. |
| ComputeNodeDeleteUserOptions |
Additional parameters for delete_user operation. |
| ComputeNodeDisableSchedulingOptions |
Additional parameters for disable_scheduling operation. |
| ComputeNodeEnableSchedulingOptions |
Additional parameters for enable_scheduling operation. |
| ComputeNodeEndpointConfiguration |
The endpoint configuration for the Compute Node. All required parameters must be populated in order to send to Azure. |
| ComputeNodeError |
An error encountered by a Compute Node. |
| ComputeNodeExtensionGetOptions |
Additional parameters for get operation. |
| ComputeNodeExtensionListOptions |
Additional parameters for list operation. |
| ComputeNodeGetOptions |
Additional parameters for get operation. |
| ComputeNodeGetRemoteDesktopOptions |
Additional parameters for get_remote_desktop operation. |
| ComputeNodeGetRemoteLoginSettingsOptions |
Additional parameters for get_remote_login_settings operation. |
| ComputeNodeGetRemoteLoginSettingsResult |
The remote login settings for a Compute Node. All required parameters must be populated in order to send to Azure. |
| ComputeNodeIdentityReference |
The reference to a user assigned identity associated with the Batch pool which a compute node will use. |
| ComputeNodeInformation |
Information about the Compute Node on which a Task ran. |
| ComputeNodeListOptions |
Additional parameters for list operation. |
| ComputeNodePaged |
A paging container for iterating over a list of ComputeNode object |
| ComputeNodeRebootOptions |
Additional parameters for reboot operation. |
| ComputeNodeReimageOptions |
Additional parameters for reimage operation. |
| ComputeNodeUpdateUserOptions |
Additional parameters for update_user operation. |
| ComputeNodeUploadBatchServiceLogsOptions |
Additional parameters for upload_batch_service_logs operation. |
| ComputeNodeUser |
A user Account for RDP or SSH access on a Compute Node. All required parameters must be populated in order to send to Azure. |
| ContainerConfiguration |
The configuration for container-enabled Pools. All required parameters must be populated in order to send to Azure. |
| ContainerRegistry |
A private container registry. |
| 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. All required parameters must be populated in order to send to Azure. |
| DeleteCertificateError |
An error encountered by the Batch service when deleting a Certificate. |
| DiffDiskSettings |
Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). |
| DiskEncryptionConfiguration |
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Azure Compute Gallery Image. |
| EnvironmentSetting |
An environment variable to be set on a Task process. All required parameters must be populated in order to send to Azure. |
| ErrorMessage |
An error message received in an Azure Batch error response. |
| ExitCodeMapping |
How the Batch service should respond if a Task exits with a particular exit code. All required parameters must be populated in order to send to Azure. |
| ExitCodeRangeMapping |
A range of exit codes and how the Batch service should respond to exit codes within that range. All required parameters must be populated in order to send to Azure. |
| ExitConditions |
Specifies how the Batch service should respond when the Task completes. |
| ExitOptions |
Specifies how the Batch service responds to a particular exit condition. |
| FileDeleteFromComputeNodeOptions |
Additional parameters for delete_from_compute_node operation. |
| FileDeleteFromTaskOptions |
Additional parameters for delete_from_task operation. |
| FileGetFromComputeNodeOptions |
Additional parameters for get_from_compute_node operation. |
| FileGetFromTaskOptions |
Additional parameters for get_from_task operation. |
| FileGetPropertiesFromComputeNodeOptions |
Additional parameters for get_properties_from_compute_node operation. |
| FileGetPropertiesFromTaskOptions |
Additional parameters for get_properties_from_task operation. |
| FileListFromComputeNodeOptions |
Additional parameters for list_from_compute_node operation. |
| FileListFromTaskOptions |
Additional parameters for list_from_task operation. |
| FileProperties |
The properties of a file on a Compute Node. All required parameters must be populated in order to send to Azure. |
| HttpHeader |
An HTTP header name-value pair. All required parameters must be populated in order to send to Azure. |
| ImageInformation |
A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image. All required parameters must be populated in order to send to Azure. |
| ImageInformationPaged |
A paging container for iterating over a list of ImageInformation object |
| ImageReference |
A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation. Variables are only populated by the server, and will be ignored when sending a request. |
| InboundEndpoint |
An inbound endpoint on a Compute Node. All required parameters must be populated in order to send to Azure. |
| InboundNATPool |
A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally. All required parameters must be populated in order to send to Azure. |
| InstanceViewStatus |
The instance view status. |
| JobAddOptions |
Additional parameters for add operation. |
| JobAddParameter |
An Azure Batch Job to add. All required parameters must be populated in order to send to Azure. |
| JobConstraints |
The execution constraints for a Job. |
| JobDeleteOptions |
Additional parameters for delete operation. |
| JobDisableOptions |
Additional parameters for disable operation. |
| JobDisableParameter |
Options when disabling a Job. All required parameters must be populated in order to send to Azure. |
| JobEnableOptions |
Additional parameters for enable operation. |
| JobExecutionInformation |
Contains information about the execution of a Job in the Azure Batch service. All required parameters must be populated in order to send to Azure. |
| JobGetOptions |
Additional parameters for get operation. |
| JobGetTaskCountsOptions |
Additional parameters for get_task_counts operation. |
| JobListFromJobScheduleOptions |
Additional parameters for list_from_job_schedule operation. |
| JobListOptions |
Additional parameters for list operation. |
| JobListPreparationAndReleaseTaskStatusOptions |
Additional parameters for list_preparation_and_release_task_status operation. |
| JobManagerTask |
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 Nodes where Job Manager Tasks are running for as long as possible (that is, Compute Nodes running 'normal' Tasks are removed before Compute 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 Compute 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 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. All required parameters must be populated in order to send to Azure. |
| JobNetworkConfiguration |
The network configuration for the Job. All required parameters must be populated in order to send to Azure. |
| JobPatchOptions |
Additional parameters for patch operation. |
| JobPatchParameter |
The set of changes to be made to a Job. |
| JobPreparationAndReleaseTaskExecutionInformation |
The status of the Job Preparation and Job Release Tasks on a Compute Node. |
| JobPreparationAndReleaseTaskExecutionInformationPaged |
A paging container for iterating over a list of JobPreparationAndReleaseTaskExecutionInformation object |
| JobPreparationTask |
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 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 Node. (AZ_BATCH_NODE_ROOT_DIRshared), or starting a local service on the 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 Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute 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 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 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. All required parameters must be populated in order to send to Azure. |
| JobPreparationTaskExecutionInformation |
Contains information about the execution of a Job Preparation Task on a Compute Node. All required parameters must be populated in order to send to Azure. |
| JobReleaseTask |
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 Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a 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 taskSlotsPerNode limit specified on the Pool. All required parameters must be populated in order to send to Azure. |
| JobReleaseTaskExecutionInformation |
Contains information about the execution of a Job Release Task on a Compute Node. All required parameters must be populated in order to send to Azure. |
| JobScheduleAddOptions |
Additional parameters for add operation. |
| JobScheduleAddParameter |
A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job. All required parameters must be populated in order to send to Azure. |
| JobScheduleDeleteOptions |
Additional parameters for delete operation. |
| JobScheduleDisableOptions |
Additional parameters for disable operation. |
| JobScheduleEnableOptions |
Additional parameters for enable operation. |
| JobScheduleExecutionInformation |
Contains information about Jobs that have been and will be run under a Job Schedule. |
| JobScheduleExistsOptions |
Additional parameters for exists operation. |
| JobScheduleGetOptions |
Additional parameters for get operation. |
| JobScheduleListOptions |
Additional parameters for list operation. |
| JobSchedulePatchOptions |
Additional parameters for patch operation. |
| JobSchedulePatchParameter |
The set of changes to be made to a Job Schedule. |
| JobScheduleStatistics |
Resource usage statistics for a Job Schedule. All required parameters must be populated in order to send to Azure. |
| JobScheduleTerminateOptions |
Additional parameters for terminate operation. |
| JobScheduleUpdateOptions |
Additional parameters for update operation. |
| JobScheduleUpdateParameter |
The set of changes to be made to a Job Schedule. All required parameters must be populated in order to send to Azure. |
| JobSchedulingError |
An error encountered by the Batch service when scheduling a Job. All required parameters must be populated in order to send to Azure. |
| JobSpecification |
Specifies details of the Jobs to be created on a schedule. All required parameters must be populated in order to send to Azure. |
| JobStatistics |
Resource usage statistics for a Job. All required parameters must be populated in order to send to Azure. |
| JobTerminateOptions |
Additional parameters for terminate operation. |
| JobTerminateParameter |
Options when terminating a Job. |
| JobUpdateOptions |
Additional parameters for update operation. |
| JobUpdateParameter |
The set of changes to be made to a Job. All required parameters must be populated in order to send to Azure. |
| LinuxUserConfiguration |
Properties used to create a user Account on a Linux Compute Node. |
| ManagedDisk |
ManagedDisk. |
| MetadataItem |
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. All required parameters must be populated in order to send to Azure. |
| MountConfiguration |
The file system to mount on each node. |
| MultiInstanceSettings |
Settings which specify how to run a multi-instance Task. Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit. All required parameters must be populated in order to send to Azure. |
| NFSMountConfiguration |
Information used to connect to an NFS file system. All required parameters must be populated in order to send to Azure. |
| NameValuePair |
Represents a name-value pair. |
| NetworkConfiguration |
The network configuration for a Pool. |
| NetworkSecurityGroupRule |
A network security group rule to apply to an inbound endpoint. All required parameters must be populated in order to send to Azure. |
| NodeAgentInformation |
Information about the Compute Node agent. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node. All required parameters must be populated in order to send to Azure. |
| NodeCounts |
The number of Compute Nodes in each Compute Node state. All required parameters must be populated in order to send to Azure. |
| NodeDisableSchedulingParameter |
Options for disabling scheduling on a Compute Node. |
| NodeFile |
Information about a file or directory on a Compute Node. |
| NodeFilePaged |
A paging container for iterating over a list of NodeFile object |
| NodePlacementConfiguration |
Node placement configuration for a pool. For regional placement, nodes in the pool will be allocated in the same region. For zonal placement, nodes in the pool will be spread across different zones with best effort balancing. |
| NodeRebootParameter |
Options for rebooting a Compute Node. |
| NodeReimageParameter |
Options for reimaging a Compute Node. |
| NodeRemoveParameter |
Options for removing Compute Nodes from a Pool. All required parameters must be populated in order to send to Azure. |
| NodeUpdateUserParameter |
The set of changes to be made to a user Account on a Compute Node. |
| NodeVMExtension |
The configuration for virtual machine extension instance view. |
| NodeVMExtensionPaged |
A paging container for iterating over a list of NodeVMExtension object |
| OSDisk |
Settings for the operating system disk of the compute node (VM). |
| 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. On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure. All required parameters must be populated in order to send to Azure. |
| OutputFileBlobContainerDestination |
Specifies a file upload destination within an Azure blob storage container. All required parameters must be populated in order to send to Azure. |
| OutputFileDestination |
The destination to which a file should be uploaded. |
| OutputFileUploadOptions |
Details about an output file upload operation, including under what conditions to perform the upload. All required parameters must be populated in order to send to Azure. |
| PoolAddOptions |
Additional parameters for add operation. |
| PoolAddParameter |
A Pool in the Azure Batch service to add. All required parameters must be populated in order to send to Azure. |
| PoolDeleteOptions |
Additional parameters for delete operation. |
| PoolDisableAutoScaleOptions |
Additional parameters for disable_auto_scale operation. |
| PoolEnableAutoScaleOptions |
Additional parameters for enable_auto_scale operation. |
| PoolEnableAutoScaleParameter |
Options for enabling automatic scaling on a Pool. |
| PoolEndpointConfiguration |
The endpoint configuration for a Pool. All required parameters must be populated in order to send to Azure. |
| PoolEvaluateAutoScaleOptions |
Additional parameters for evaluate_auto_scale operation. |
| PoolEvaluateAutoScaleParameter |
Options for evaluating an automatic scaling formula on a Pool. All required parameters must be populated in order to send to Azure. |
| PoolExistsOptions |
Additional parameters for exists operation. |
| PoolGetOptions |
Additional parameters for get operation. |
| PoolInformation |
Specifies how a Job should be assigned to a Pool. |
| PoolListOptions |
Additional parameters for list operation. |
| PoolListUsageMetricsOptions |
Additional parameters for list_usage_metrics operation. |
| PoolNodeCounts |
The number of Compute Nodes in each state for a Pool. All required parameters must be populated in order to send to Azure. |
| PoolNodeCountsPaged |
A paging container for iterating over a list of PoolNodeCounts object |
| PoolPatchOptions |
Additional parameters for patch operation. |
| PoolPatchParameter |
The set of changes to be made to a Pool. |
| PoolRemoveNodesOptions |
Additional parameters for remove_nodes operation. |
| PoolResizeOptions |
Additional parameters for resize operation. |
| PoolResizeParameter |
Options for changing the size of a Pool. |
| PoolSpecification |
Specification for creating a new Pool. All required parameters must be populated in order to send to Azure. |
| PoolStatistics |
Contains utilization and resource usage statistics for the lifetime of a Pool. All required parameters must be populated in order to send to Azure. |
| PoolStopResizeOptions |
Additional parameters for stop_resize operation. |
| PoolUpdatePropertiesOptions |
Additional parameters for update_properties operation. |
| PoolUpdatePropertiesParameter |
The set of changes to be made to a Pool. All required parameters must be populated in order to send to Azure. |
| PoolUsageMetrics |
Usage metrics for a Pool across an aggregation interval. All required parameters must be populated in order to send to Azure. |
| PoolUsageMetricsPaged |
A paging container for iterating over a list of PoolUsageMetrics object |
| PublicIPAddressConfiguration |
The public IP Address configuration of the networking configuration of a Pool. |
| RecentJob |
Information about the most recent Job to run under the Job Schedule. |
| ResizeError |
An error that occurred when resizing a Pool. |
| ResourceFile |
A single file or multiple files to be downloaded to a Compute Node. |
| ResourceStatistics |
Statistics related to resource consumption by Compute Nodes in a Pool. All required parameters must be populated in order to send to Azure. |
| RollingUpgradePolicy |
The configuration parameters used while performing a rolling upgrade. |
| Schedule |
The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. |
| SecurityProfile |
Specifies the security profile settings for the virtual machine or virtual machine scale set. |
| ServiceArtifactReference |
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. All required parameters must be populated in order to send to Azure. |
| 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. 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. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask. All required parameters must be populated in order to send to Azure. |
| StartTaskInformation |
Information about a StartTask running on a Compute Node. All required parameters must be populated in order to send to Azure. |
| SubtaskInformation |
Information about an Azure Batch subtask. |
| TaskAddCollectionOptions |
Additional parameters for add_collection operation. |
| TaskAddCollectionParameter |
A collection of Azure Batch Tasks to add. All required parameters must be populated in order to send to Azure. |
| TaskAddCollectionResult |
The result of adding a collection of Tasks to a Job. |
| TaskAddOptions |
Additional parameters for add operation. |
| TaskAddParameter |
An Azure Batch Task to add. 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. All required parameters must be populated in order to send to Azure. |
| TaskAddResult |
Result for a single Task added as part of an add Task collection operation. All required parameters must be populated in order to send to Azure. |
| TaskConstraints |
Execution constraints to apply to a Task. |
| TaskContainerExecutionInformation |
Contains information about the container which a Task is executing. |
| TaskContainerSettings |
The container settings for a Task. All required parameters must be populated in order to send to Azure. |
| TaskCounts |
The Task counts for a Job. All required parameters must be populated in order to send to Azure. |
| TaskCountsResult |
The Task and TaskSlot counts for a Job. All required parameters must be populated in order to send to Azure. |
| TaskDeleteOptions |
Additional parameters for delete operation. |
| TaskDependencies |
Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be scheduled. |
| TaskExecutionInformation |
Information about the execution of a Task. All required parameters must be populated in order to send to Azure. |
| TaskFailureInformation |
Information about a Task failure. All required parameters must be populated in order to send to Azure. |
| TaskGetOptions |
Additional parameters for get operation. |
| TaskIdRange |
A range of Task IDs that a Task can depend on. All Tasks with IDs in the range must complete successfully before the dependent Task can be scheduled. 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'. All required parameters must be populated in order to send to Azure. |
| TaskInformation |
Information about a Task running on a Compute Node. All required parameters must be populated in order to send to Azure. |
| TaskListOptions |
Additional parameters for list operation. |
| TaskListSubtasksOptions |
Additional parameters for list_subtasks operation. |
| TaskReactivateOptions |
Additional parameters for reactivate operation. |
| TaskSchedulingPolicy |
Specifies how Tasks should be distributed across Compute Nodes. All required parameters must be populated in order to send to Azure. |
| TaskSlotCounts |
The TaskSlot counts for a Job. All required parameters must be populated in order to send to Azure. |
| TaskStatistics |
Resource usage statistics for a Task. All required parameters must be populated in order to send to Azure. |
| TaskTerminateOptions |
Additional parameters for terminate operation. |
| TaskUpdateOptions |
Additional parameters for update operation. |
| TaskUpdateParameter |
The set of changes to be made to a Task. |
| UefiSettings |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. |
| UpgradePolicy |
Describes an upgrade policy - automatic, manual, or rolling. All required parameters must be populated in order to send to Azure. |
| UploadBatchServiceLogsConfiguration |
The Azure Batch service log files upload configuration for a Compute Node. All required parameters must be populated in order to send to Azure. |
| UploadBatchServiceLogsResult |
The result of uploading Batch service log files from a specific Compute Node. All required parameters must be populated in order to send to Azure. |
| UsageStatistics |
Statistics related to Pool usage information. All required parameters must be populated in order to send to Azure. |
| UserAccount |
Properties used to create a user used to execute Tasks on an Azure Batch Compute Node. All required parameters must be populated in order to send to Azure. |
| UserAssignedIdentity |
The user assigned Identity. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| UserIdentity |
The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both. |
| VMExtension |
The configuration for virtual machine extensions. All required parameters must be populated in order to send to Azure. |
| VMExtensionInstanceView |
The vm extension instance view. |
| VirtualMachineConfiguration |
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure. All required parameters must be populated in order to send to Azure. |
| VirtualMachineInfo |
Info about the current state of the virtual machine. |
| WindowsConfiguration |
Windows operating system settings to apply to the virtual machine. |
| WindowsUserConfiguration |
Properties used to create a user Account on a Windows Compute Node. |
Enums
Azure SDK for Python