Microsoft.Azure.Batch Namespace

Classes

AddTaskCollectionResultHandler	A BatchClientBehavior which you can use to specify under what conditions an operation to add multiple tasks to a job should retry, terminate or be considered successful.
AddTaskCollectionTerminatedException	The exception that is thrown when the AddTaskCollection operation is terminated.
AddTaskResult	Result for a single task added as part of a collection of tasks.
AffinityInformation	A locality hint that can be used by the Batch service to select a compute node on which to start a new task.
ApplicationOperations	Performs application-related operations on an Azure Batch account.
ApplicationPackageReference	A reference to an application package to be deployed to compute nodes.
ApplicationSummary	Contains information about an application in an Azure Batch account.
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.
AutoPoolSpecification	Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool, run all the tasks for the job on it, and by default delete the pool once the job has completed.
AutoScaleRun	The results and errors from an evaluation or execution of a pool autoscale formula.
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
AzureBlobFileSystemConfiguration	Information used to connect to an Azure Storage Container using Blobfuse.
AzureFileShareConfiguration	Information used to connect to an Azure Fileshare.
AzureStorageAuthenticationKey
BatchClient	A client for an Azure Batch account, used to access the Batch service.
BatchClientBehavior	Derived classes modify operational behaviors of a Azure Batch Service client. Derived classes can be called out of order and simultaneously by several threads. Implementations should be threadsafe.
BatchClientException	An exception thrown by the Batch client.
BatchClientParallelOptions	Stores options that configure the operation of methods on Batch client parallel operations.
BatchError	An error received from the Azure Batch service.
BatchErrorDetail	An item of additional information included in a BatchError.
BatchErrorMessages	A strongly-typed resource class, for looking up localized strings, etc.
BatchPoolIdentity	The identity of the Batch pool, if configured.
BatchRequestTimeout	Class which provides easy access to the Timeout property and the Timeout property.
Certificate	A certificate that can be installed on compute nodes and can be used to authenticate operations on a node.
CertificateOperations	Performs certificate-related operations on an Azure Batch account.
CertificateReference	Represents a certificate object of the Azure Batch service.
CifsMountConfiguration	Information used to connect to a CIFS file system.
ClientRequestIdProvider	Interceptor which contains a function used to generate a client request id to set as ClientRequestId. If there are multiple instances of this then the last set wins.
CloudJob	An Azure Batch job.
CloudJobSchedule	A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.
CloudPool	A pool in the Azure Batch service.
CloudTask	An Azure Batch task. A task is a piece of work that is associated with a job and runs on a compute node.
ComputeNode	Summarizes the state of a compute node.
ComputeNodeEndpointConfiguration	The endpoint configuration for the compute node.
ComputeNodeError	An error encountered by an Azure Batch compute node.
ComputeNodeIdentityReference	The reference to a user assigned identity associated with the Batch pool which a compute node will use.
ComputeNodeInformation	The compute node information class.
ComputeNodeUser	A user for a specific Azure Batch compute node.
Constants	Contains constants for interacting with the Azure Batch service.
ContainerConfiguration	The configuration for container-enabled pools.
ContainerHostBatchBindMountEntry	The entry of path and mount mode you want to mount into task container.
ContainerRegistry	A private container registry.
DataDisk	Settings which will be used by the data disks associated to compute nodes in the pool.
DeleteCertificateError	An error encountered by the Batch service when deleting a certificate.
DetailLevel	Controls the amount of detail requested from the Azure Batch service when listing or retrieving resources.
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, such as a job task, start task, job manager task, or job preparation or release task.
ErrorMessage	An error message received in an Azure Batch error response.
ExitCodeMapping	A process exit code and how the Batch service should respond if a task exits with that exit code.
ExitCodeRangeMapping	A range of exit codes and how the Batch service should respond if a task exits with an exit code within that range.
ExitConditions	How the Batch service should respond when a task completes.
ExitOptions	How the Batch service should respond to a particular exit condition.
FileProperties	The properties of a file on a compute node.
GetFileRequestByteRange	The byte range to retrieve in a file download operation.
HttpHeader	An HTTP header name-value pair
ImageInformation	A reference to an Azure Virtual Machines Marketplace Image and additional information about the Image.
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.
JobConstraints	Specifies the execution constraints for a job.
JobExecutionInformation	Information about the execution of an Azure Batch job.
JobManagerTask	Represents an Azure Batch JobManager task.
JobNetworkConfiguration	The network configuration for a job.
JobOperations	Performs operations on Azure Batch jobs.
JobPreparationAndReleaseTaskExecutionInformation	The status of the Job Preparation task and Job Release task on a compute node.
JobPreparationTask	A Job Preparation task to run before any tasks of the job on any given compute node.
JobPreparationTaskExecutionInformation	Details about the execution of a Job Preparation task on a compute node.
JobReleaseTask	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.
JobReleaseTaskExecutionInformation	Details about the execution of a Job Release task on a compute node.
JobScheduleExecutionInformation	The execution information for a job schedule.
JobScheduleOperations	Performs operations on Azure Batch job schedules.
JobScheduleStatistics	Resource usage statistics for a CloudJobSchedule.
JobSchedulingError	An error encountered by the Batch service when scheduling a job.
JobSpecification	The JobSpecification of a CloudJobSchedule.
JobStatistics	Resource usage statistics for the job.
LinuxUserConfiguration	Properties used to create a user account on a Linux node.
ManagedDisk	The managed disk object.
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.
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. For more information see https://azure.microsoft.com/documentation/articles/batch-mpi/.
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.
NodeAgentInformation	Information about the node agent
NodeCounts	The number of nodes in each node state.
NodeFile	Exposes methods and properties to access files from Nodes or Tasks.
NodePlacementConfiguration	Node placement configuration for a pool.
NodeVMExtension	The configuration for virtual machine extension instance view.
ODATADetailLevel	Controls the amount of detail requested from the Azure Batch service when listing or retrieving resources, using OData query clauses.
ODATAMonitorControl	Contains control settings used for optimal retrieval of state data via OData predicates.
OSDisk	Settings for the operating system disk of the compute node (VM).
OutputFile	A specification for uploading files from an Azure Batch node to another location after the Batch service has finished executing the task process.
OutputFileBlobContainerDestination	Specifies a file upload destination within an Azure blob storage container.
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.
PagedEnumerableExtensions	Provides a set of static (Shared in Visual Basic) methods for working with sequences that implement IPagedEnumerable<T>.
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.
PoolEndpointConfiguration	The endpoint configuration for a pool.
PoolInformation	Specifies how a job should be assigned to a pool.
PoolNodeCounts	A pool in the Azure Batch service.
PoolOperations	Performs pool-related operations on an Azure Batch account.
PoolSpecification	The specification for a pool.
PoolStatistics	Contains utilization and resource usage statistics for the lifetime of a pool.
PoolUsageMetrics	The usage metrics for a single pool in a certain time range.
PublicIPAddressConfiguration	Details about an output file upload operation, including under what conditions to perform the upload.
RecentJob	Information about the most recent job under a job schedule.
RemoteLoginSettings	Gets the settings required for remote login to a compute node.
ResizeError	An error that occurred when resizing a pool.
ResourceFile	A file to be downloaded to a compute node from Azure Blob Storage, such as task executables and task input data files.
ResourceStatistics	The resource statistics data for the pool.
RetryPolicyProvider	A RequestInterceptor that sets the RetryPolicy.
RollingUpgradePolicy	The configuration parameters used while performing a rolling upgrade.
Schedule	A schedule.
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.
StartTask	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.
StartTaskInformation	Specifies the detailed runtime information of the start task, including current state, error details, exit code, start time, end time, etc.
SubtaskInformation	Information about an Azure Batch subtask.
SynchronousMethodExceptionBehavior	A BatchClientBehavior which specifies how exceptions should be thrown from synchronous methods.
TaskConstraints	Defines the constraints on a particular Azure Batch task.
TaskContainerExecutionInformation	Contains information about the container which a task is executing.
TaskContainerSettings	The container settings for a task.
TaskCounts	The task counts for a job.
TaskCountsResult	The task counts for a job.
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	Task execution information.
TaskFailureInformation	Information about a task failure.
TaskIdRange	A range of task ids that a CloudTask depends on. All tasks with ids in the range must complete successfully before the dependent task can be scheduled.
TaskInformation	The compute node's task info class.
TaskSchedulingPolicy	A scheduling policy for a compute node.
TaskSlotCounts	The number of TaskSlots required by Tasks per state.
TaskStateMonitor	Provides utilities to help monitor CloudTask states.
TaskStatistics	Resource usage statistics for the 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.
UploadBatchServiceLogsResult	The result of uploading batch service log files from a specific compute node.
UsageStatistics	Statistics related to pool usage data.
UserAccount	A user account to create on an Azure Batch node. Tasks may be configured to execute in the security context of the user account.
UserAssignedIdentity	The reference to a user assigned identity associated with the Batch pool which a compute node will use.
UserIdentity	The definition of the user identity under which the task is run.
Utilities	Tools and utilities for the Azure Batch Service.
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 node.

Interfaces

IFileStagingArtifact	Contains information about a file staging process. File staging is typically performed for a CloudTask (see FilesToStage).
IInheritedBehaviors	Methods and properties that are inherited from the instantiating parent object.
IPagedEnumerable<T>	Exposes enumerators for a paged collection. These enumerators support simple iteration over a paged collection of a specified type. Paged collections are backed by one or more calls to the Batch Service. Each of these calls can return a variable sized page of data which is then consumed by the enumerator.
IPagedEnumerator<T>	An enumerator which exposes an asynchronous mechanism for iteration. Enumerator instances are not threadsafe. Each enumerator fetches the collection from the server. As a consequence, each enumerator can see different data (collection size, contents, etc.). Care should be taken to avoid multiple retrievals of the data from the server via casual use of foreach/ForeachAsync and other collection operations.
IRefreshable	Provides a mechanism for refreshing a resource.

Enums

AddTaskResultStatus	Used by AddTaskCollectionResultHandler to classify an AddTaskResult as successful or requiring a retry.
ComputeNodeUserCommitSemantics	Informs the Commit() call that the state transfer between the client and server is either a create-user or update-user operation.