Azure.Compute.Batch Namespace

Classes

AddTaskCollectionTerminatedException	An exception thrown when a task collection is terminated due to a non-retryable failure.
AffinityInfo	A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task.
AuthenticationTokenSettings	The settings for an authentication token that the Task can use to perform Batch service operations.
AutomaticOsUpgradePolicy	The configuration parameters used for performing automatic OS upgrade.
AutoScaleRun	The results and errors from an execution of a Pool autoscale formula.
AutoScaleRunError	An error that occurred when executing or evaluating a Pool autoscale formula.
AutoUserSpecification	Specifies the options for the auto user that runs an Azure Batch Task.
AzureBlobFileSystemConfiguration	Information used to connect to an Azure Storage Container using Blobfuse.
AzureFileShareConfiguration	Information used to connect to an Azure Fileshare.
BatchApplication	Contains information about an application in an Azure Batch Account.
BatchApplicationPackageReference	A reference to an Package to be deployed to Compute Nodes.
BatchAutoPoolSpecification	Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.
BatchCertificate	A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine.
BatchCertificateReference	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.
BatchClient	The Batch service client.
BatchClientException	An exception thrown by the Batch client.
BatchClientOptions	Client options for BatchClient.
BatchError	An error response received from the Azure Batch service.
BatchErrorCodeStrings	Contains string constants for error codes returned by the Batch service.
BatchErrorDetail	An item of additional information included in an Azure Batch error response.
BatchErrorMessage	An error message received in an Azure Batch error response.
BatchFileProperties	Collection of header values that describe Batch File properties
BatchJob	An Azure Batch Job.
BatchJobConstraints	The execution constraints for a Job.
BatchJobCreateContent	Parameters for creating an Azure Batch Job.
BatchJobDisableContent	Parameters for disabling an Azure Batch Job.
BatchJobExecutionInfo	Contains information about the execution of a Job in the Azure Batch service.
BatchJobManagerTask	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.
BatchJobNetworkConfiguration	The network configuration for the Job.
BatchJobPreparationAndReleaseTaskStatus	The status of the Job Preparation and Job Release Tasks on a Compute Node.
BatchJobPreparationTask	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_DIR\shared), 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.
BatchJobPreparationTaskExecutionInfo	Contains information about the execution of a Job Preparation Task on a Compute Node.
BatchJobReleaseTask	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.
BatchJobReleaseTaskExecutionInfo	Contains information about the execution of a Job Release Task on a Compute Node.
BatchJobSchedule	A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.
BatchJobScheduleConfiguration	The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.
BatchJobScheduleCreateContent	Parameters for creating an Azure Batch Job Schedule.
BatchJobScheduleExecutionInfo	Contains information about Jobs that have been and will be run under a Job Schedule.
BatchJobScheduleStatistics	Resource usage statistics for a Job Schedule.
BatchJobScheduleUpdateContent	Parameters for updating an Azure Batch Job Schedule.
BatchJobSchedulingError	An error encountered by the Batch service when scheduling a Job.
BatchJobSpecification	Specifies details of the Jobs to be created on a schedule.
BatchJobStatistics	Resource usage statistics for a Job.
BatchJobTerminateContent	Parameters for terminating an Azure Batch Job.
BatchJobUpdateContent	Parameters for updating an Azure Batch Job.
BatchNode	A Compute Node in the Batch service.
BatchNodeAgentInfo	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.
BatchNodeCounts	The number of Compute Nodes in each Compute Node state.
BatchNodeDeallocateContent	Options for deallocating a Compute Node.
BatchNodeDisableSchedulingContent	Parameters for disabling scheduling on an Azure Batch Compute Node.
BatchNodeEndpointConfiguration	The endpoint configuration for the Compute Node.
BatchNodeError	An error encountered by a Compute Node.
BatchNodeFile	Information about a file or directory on a Compute Node.
BatchNodeIdentityReference	The reference to a user assigned identity associated with the Batch pool which a compute node will use.
BatchNodeInfo	Information about the Compute Node on which a Task ran.
BatchNodePlacementConfiguration	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.
BatchNodeRebootContent	Parameters for rebooting an Azure Batch Compute Node.
BatchNodeReimageContent	Parameters for reimaging an Azure Batch Compute Node.
BatchNodeRemoteLoginSettings	The remote login settings for a Compute Node.
BatchNodeRemoveContent	Parameters for removing nodes from an Azure Batch Pool.
BatchNodeUserCreateContent	Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node.
BatchNodeUserUpdateContent	Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node.
BatchNodeVMExtension	The configuration for virtual machine extension instance view.
BatchPool	A Pool in the Azure Batch service.
BatchPoolCreateContent	Parameters for creating an Azure Batch Pool.
BatchPoolEnableAutoScaleContent	Parameters for enabling automatic scaling on an Azure Batch Pool.
BatchPoolEndpointConfiguration	The endpoint configuration for a Pool.
BatchPoolEvaluateAutoScaleContent	Parameters for evaluating an automatic scaling formula on an Azure Batch Pool.
BatchPoolIdentity	The identity of the Batch pool, if configured.
BatchPoolInfo	Specifies how a Job should be assigned to a Pool.
BatchPoolNodeCounts	The number of Compute Nodes in each state for a Pool.
BatchPoolReplaceContent	Parameters for replacing properties on an Azure Batch Pool.
BatchPoolResizeContent	Parameters for changing the size of an Azure Batch Pool.
BatchPoolResourceStatistics	Statistics related to resource consumption by Compute Nodes in a Pool.
BatchPoolSpecification	Specification for creating a new Pool.
BatchPoolStatistics	Contains utilization and resource usage statistics for the lifetime of a Pool.
BatchPoolUpdateContent	Parameters for updating an Azure Batch Pool.
BatchPoolUsageMetrics	Usage metrics for a Pool across an aggregation interval.
BatchPoolUsageStatistics	Statistics related to Pool usage information.
BatchStartTask	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.
BatchStartTaskInfo	Information about a StartTask running on a Compute Node.
BatchSubtask	Information about an Azure Batch subtask.
BatchSupportedImage	A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image.
BatchTask	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.
BatchTaskAddCollectionResult	The result of adding a collection of Tasks to a Job.
BatchTaskAddResult	Result for a single Task added as part of an add Task collection operation.
BatchTaskConstraints	Execution constraints to apply to a Task.
BatchTaskContainerExecutionInfo	Contains information about the container which a Task is executing.
BatchTaskContainerSettings	The container settings for a Task.
BatchTaskCounts	The Task counts for a Job.
BatchTaskCountsResult	The Task and TaskSlot counts for a Job.
BatchTaskCreateContent	Parameters for creating an Azure Batch Task.
BatchTaskDependencies	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.
BatchTaskExecutionInfo	Information about the execution of a Task.
BatchTaskFailureInfo	Information about a Task failure.
BatchTaskGroup	A collection of Azure Batch Tasks to add.
BatchTaskIdRange	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'.
BatchTaskInfo	Information about a Task running on a Compute Node.
BatchTaskSchedulingPolicy	Specifies how Tasks should be distributed across Compute Nodes.
BatchTaskSlotCounts	The TaskSlot counts for a Job.
BatchTaskStatistics	Resource usage statistics for a Task.
CifsMountConfiguration	Information used to connect to a CIFS file system.
ComputeBatchModelFactory	Model factory for models.
ContainerConfiguration	The configuration for container-enabled Pools.
ContainerHostBatchBindMountEntry	The entry of path and mount mode you want to mount into task container.
ContainerRegistryReference	A private container registry.
CreateTaskResult	Represents the result of adding a task to a Batch job.
CreateTasksOptions	Stores options that configure the operation of methods on Batch client parallel operations.
CreateTasksResult	The result of creating a list of tasks using the CreateTasks operation.
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.
DefaultCreateTaskResultHandler	The default implementation of ICreateTaskResultHandler for adding tasks to a Batch job.
DeleteBatchCertificateError	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.
ExitCodeMapping	How the Batch service should respond if a Task exits with a particular exit code.
ExitCodeRangeMapping	A range of exit codes and how the Batch service should respond to exit codes within that range.
ExitConditions	Specifies how the Batch service should respond when the Task completes.
ExitOptions	Specifies how the Batch service responds to a particular exit condition.
FileProperties	The properties of a file on a Compute Node.
GetCertificateResponse	The GetCertificateResponse.
HttpHeader	An HTTP header name-value pair.
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.
InboundEndpoint	An inbound endpoint on a Compute Node.
InboundNatPool	A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.
InstanceViewStatus	The instance view status.
LinuxUserConfiguration	Properties used to create a user Account on a Linux Compute Node.
ManagedDisk	The managed disk parameters.
MetadataItem	The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
MountConfiguration	The file system to mount on each node.
MultiInstanceSettings	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.
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.
NfsMountConfiguration	Information used to connect to an NFS file system.
OSDisk	Settings for the operating system disk of the compute node (VM).
OutputFile	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.
OutputFileBlobContainerDestination	Specifies a file upload destination within an Azure blob storage container.
OutputFileDestination	The destination to which a file should be uploaded.
OutputFileUploadConfig	Options for an output file upload operation, including under what conditions to perform the upload.
ParallelOperationsException	An exception raised when one or more operations in a parallel set of operations fails. The InnerExceptions collection contains the exceptions for each of the failed operations.
PublicIpAddressConfiguration	The public IP Address configuration of the networking configuration of a Pool.
RecentBatchJob	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.
RollingUpgradePolicy	The configuration parameters used while performing a rolling upgrade.
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.
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.
UploadBatchServiceLogsContent	The Azure Batch service log files upload parameters for a Compute Node.
UploadBatchServiceLogsResult	The result of uploading Batch service log files from a specific Compute Node.
UserAccount	Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.
UserAssignedIdentity	The user assigned Identity.
UserIdentity	The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both.
VirtualMachineConfiguration	The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.
VirtualMachineInfo	Info about the current state of the virtual machine.
VMDiskSecurityProfile	Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and required when using Confidential VMs.
VMExtension	The configuration for virtual machine extensions.
VMExtensionInstanceView	The vm extension instance view.
WindowsConfiguration	Windows operating system settings to apply to the virtual machine.
WindowsUserConfiguration	Properties used to create a user Account on a Windows Compute Node.

Structs

AccessScope	AccessScope enums.
AllocationState	AllocationState enums.
AutoUserScope	AutoUserScope enums.
BatchCertificateFormat	BatchCertificateFormat enums.
BatchCertificateState	BatchCertificateState enums.
BatchCertificateStoreLocation	BatchCertificateStoreLocation enums.
BatchCertificateVisibility	BatchCertificateVisibility enums.
BatchJobAction	BatchJobAction enums.
BatchJobPreparationTaskState	BatchJobPreparationTaskState enums.
BatchJobReleaseTaskState	BatchJobReleaseTaskState enums.
BatchJobScheduleState	BatchJobScheduleState enums.
BatchJobState	BatchJobState enums.
BatchNodeCommunicationMode	BatchNodeCommunicationMode enums.
BatchNodeDeallocateOption	BatchNodeDeallocateOption enums.
BatchNodeDeallocationOption	BatchNodeDeallocationOption enums.
BatchNodeDisableSchedulingOption	BatchNodeDisableSchedulingOption enums.
BatchNodeFillType	BatchNodeFillType enums.
BatchNodePlacementPolicyType	BatchNodePlacementPolicyType enums.
BatchNodeRebootOption	BatchNodeRebootOption enums.
BatchNodeReimageOption	BatchNodeReimageOption enums.
BatchNodeState	BatchNodeState enums.
BatchPoolIdentityType	BatchPoolIdentityType enums.
BatchPoolLifetimeOption	BatchPoolLifetimeOption enums.
BatchPoolState	BatchPoolState enums.
BatchStartTaskState	BatchStartTaskState enums.
BatchSubtaskState	BatchSubtaskState enums.
BatchTaskAddStatus	BatchTaskAddStatus enums.
BatchTaskExecutionResult	BatchTaskExecutionResult enums.
BatchTaskState	BatchTaskState enums.
CachingType	CachingType enums.
ContainerHostDataPath	The paths which will be mounted to container task's container.
ContainerType	ContainerType enums.
ContainerWorkingDirectory	ContainerWorkingDirectory enums.
DependencyAction	DependencyAction enums.
DiffDiskPlacement	Specifies the ephemeral disk placement for operating system disk for all compute nodes (VMs) in the pool. This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.
DisableBatchJobOption	DisableBatchJobOption enums.
DiskEncryptionTarget	DiskEncryptionTarget enums.
DynamicVNetAssignmentScope	DynamicVNetAssignmentScope enums.
ElevationLevel	ElevationLevel enums.
ErrorCategory	ErrorCategory enums.
ImageVerificationType	ImageVerificationType enums.
InboundEndpointProtocol	InboundEndpointProtocol enums.
IpAddressProvisioningType	IPAddressProvisioningType enums.
LoginMode	LoginMode enums.
NetworkSecurityGroupRuleAccess	NetworkSecurityGroupRuleAccess enums.
OnAllBatchTasksComplete	The action the Batch service should take when all Tasks in the Job are in the completed state.
OnBatchTaskFailure	OnTaskFailure enums.
OSType	OSType enums.
OutputFileUploadCondition	OutputFileUploadCondition enums.
SchedulingState	SchedulingState enums.
SecurityEncryptionTypes	SecurityEncryptionTypes enums.
SecurityTypes	Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
StatusLevelTypes	Level code.
StorageAccountType	StorageAccountType enums.
UpgradeMode	UpgradeMode enums.

Interfaces

ICreateTaskResultHandler

you can use to specify under what conditions an operation to add multiple tasks to a job should retry, mark as successful, failure, or terminate.

Enums

BatchClientOptions.ServiceVersion	The version of the service to use.
CreateTaskResultStatus	Used by Azure.Compute.Batch.TasksWorkflowManager to classify an CreateTaskResult as successful or requiring a retry.