Microsoft.Azure.Batch
Namespace
Contains classes and interfaces that support creating and using Batch resources.
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. |
| 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 |
| 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. |
| 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. |
| 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. |
| CloudServiceConfiguration |
The configuration for compute nodes in a pool based on the Azure Cloud Services platform. |
| 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. |
| ComputeNodeInformation |
The compute node information class. |
| ComputeNodeUser |
A user account for remote access to a compute node. |
| Constants |
Contains constants for interacting with the Azure Batch service. |
| 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. |
| 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. |
| ImageReference |
A reference to an Azure Virtual Machines Marketplace image. To retrieve a list of images supported by the Batch service, see ListNodeAgentSkus(DetailLevel, IEnumerable<BatchClientBehavior>) and VerifiedImageReferences. |
| 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. |
| 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. |
| 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 JobPreparationTask on a compute node. |
| JobReleaseTask |
A Job Release task to run on job completion on any compute node where the job has run. |
| JobReleaseTaskExecutionInformation |
Details about the execution of a JobReleaseTask 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. |
| 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. |
| MultiInstanceSettings |
Settings which specify how to run a multi-instance task. Multi-instance tasks are commonly used to support MPI tasks. 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. |
| NodeAgentSku |
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. |
| NodeFile |
Exposes methods and properties to access files from Nodes or Tasks. |
| 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 |
A reference to an OS disk image. |
| 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. |
| PoolEndpointConfiguration |
The endpoint configuration for a pool. |
| PoolInformation |
Specifies how a job should be assigned to a pool. |
| 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. |
| 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. |
| Schedule |
A schedule. |
| 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. |
| TaskCounts |
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. |
| TaskSchedulingError |
Information about an error when scheduling a task. |
| TaskSchedulingPolicy |
A scheduling policy for a compute node. |
| TaskStateMonitor |
Provides utilities to help monitor CloudTask states. |
| TaskStatistics |
Resource usage statistics for the task. |
| 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. |
| 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. |
| WindowsConfiguration |
Windows operating system settings to apply to the virtual machine. |
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.
|
| IPagedEnumerator<T> |
An enumerator which exposes an asynchronous mechanism for iteration.
|
| 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. |
Remarks
None.