@azure/batch package
Classes
| Account |
Class representing a Account. |
| Application |
Class representing a Application. |
| BatchServiceClient | |
| BatchServiceClientContext | |
| BatchSharedKeyCredentials |
Creates a new BatchSharedKeyCredentials object. |
| CertificateOperations |
Class representing a CertificateOperations. |
| ComputeNodeOperations |
Class representing a ComputeNodeOperations. |
| File |
Class representing a File. |
| Job |
Class representing a Job. |
| JobSchedule |
Class representing a JobSchedule. |
| Pool |
Class representing a Pool. |
| Task |
Class representing a Task. |
Interfaces
| AccountListPoolNodeCountsHeaders |
Defines headers for ListPoolNodeCounts operation. |
| AccountListPoolNodeCountsNextOptionalParams |
Optional Parameters. |
| AccountListPoolNodeCountsNextOptions |
Additional parameters for listPoolNodeCountsNext operation. |
| AccountListPoolNodeCountsOptionalParams |
Optional Parameters. |
| AccountListPoolNodeCountsOptions |
Additional parameters for listPoolNodeCounts operation. |
| AccountListSupportedImagesHeaders |
Defines headers for ListSupportedImages operation. |
| AccountListSupportedImagesNextOptionalParams |
Optional Parameters. |
| AccountListSupportedImagesNextOptions |
Additional parameters for listSupportedImagesNext operation. |
| AccountListSupportedImagesOptionalParams |
Optional Parameters. |
| AccountListSupportedImagesOptions |
Additional parameters for listSupportedImages operation. |
| AccountListSupportedImagesResult | |
| AffinityInformation |
An interface representing AffinityInformation. |
| ApplicationGetHeaders |
Defines headers for Get operation. |
| ApplicationGetOptionalParams |
Optional Parameters. |
| ApplicationGetOptions |
Additional parameters for get operation. |
| ApplicationListHeaders |
Defines headers for List operation. |
| ApplicationListNextOptionalParams |
Optional Parameters. |
| ApplicationListNextOptions |
Additional parameters for listNext operation. |
| ApplicationListOptionalParams |
Optional Parameters. |
| ApplicationListOptions |
Additional parameters for list operation. |
| ApplicationListResult | |
| ApplicationPackageReference |
An interface representing ApplicationPackageReference. |
| ApplicationSummary |
An interface representing ApplicationSummary. |
| AuthenticationTokenSettings |
An interface representing AuthenticationTokenSettings. |
| AutoPoolSpecification |
An interface representing AutoPoolSpecification. |
| AutoScaleRun |
An interface representing AutoScaleRun. |
| AutoScaleRunError |
An interface representing AutoScaleRunError. |
| AutoUserSpecification |
An interface representing AutoUserSpecification. |
| AzureBlobFileSystemConfiguration |
An interface representing AzureBlobFileSystemConfiguration. |
| AzureFileShareConfiguration |
An interface representing AzureFileShareConfiguration. |
| BaseResource | |
| BatchError |
An interface representing BatchError. |
| BatchErrorDetail |
An interface representing BatchErrorDetail. |
| Certificate |
A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine. |
| CertificateAddHeaders |
Defines headers for Add operation. |
| CertificateAddOptionalParams |
Optional Parameters. |
| CertificateAddOptions |
Additional parameters for add operation. |
| CertificateAddParameter |
An interface representing CertificateAddParameter. |
| CertificateCancelDeletionHeaders |
Defines headers for CancelDeletion operation. |
| CertificateCancelDeletionOptionalParams |
Optional Parameters. |
| CertificateCancelDeletionOptions |
Additional parameters for cancelDeletion operation. |
| CertificateDeleteHeaders |
Defines headers for Delete operation. |
| CertificateDeleteMethodOptionalParams |
Optional Parameters. |
| CertificateDeleteMethodOptions |
Additional parameters for deleteMethod operation. |
| CertificateGetHeaders |
Defines headers for Get operation. |
| CertificateGetOptionalParams |
Optional Parameters. |
| CertificateGetOptions |
Additional parameters for get operation. |
| CertificateListHeaders |
Defines headers for List operation. |
| CertificateListNextOptionalParams |
Optional Parameters. |
| CertificateListNextOptions |
Additional parameters for listNext operation. |
| CertificateListOptionalParams |
Optional Parameters. |
| CertificateListOptions |
Additional parameters for list operation. |
| CertificateListResult | |
| CertificateReference |
An interface representing CertificateReference. |
| CIFSMountConfiguration |
An interface representing CIFSMountConfiguration. |
| CloudError | |
| CloudJob |
An interface representing CloudJob. |
| CloudJobListPreparationAndReleaseTaskStatusResult | |
| CloudJobListResult | |
| CloudJobSchedule |
An interface representing CloudJobSchedule. |
| CloudJobScheduleListResult | |
| CloudPool |
An interface representing CloudPool. |
| CloudPoolListResult | |
| CloudServiceConfiguration |
An interface representing CloudServiceConfiguration. |
| CloudTask |
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. |
| CloudTaskListResult | |
| CloudTaskListSubtasksResult |
An interface representing CloudTaskListSubtasksResult. |
| ComputeNode |
An interface representing ComputeNode. |
| ComputeNodeAddUserHeaders |
Defines headers for AddUser operation. |
| ComputeNodeAddUserOptionalParams |
Optional Parameters. |
| ComputeNodeAddUserOptions |
Additional parameters for addUser operation. |
| ComputeNodeDeleteUserHeaders |
Defines headers for DeleteUser operation. |
| ComputeNodeDeleteUserOptionalParams |
Optional Parameters. |
| ComputeNodeDeleteUserOptions |
Additional parameters for deleteUser operation. |
| ComputeNodeDisableSchedulingHeaders |
Defines headers for DisableScheduling operation. |
| ComputeNodeDisableSchedulingOptionalParams |
Optional Parameters. |
| ComputeNodeDisableSchedulingOptions |
Additional parameters for disableScheduling operation. |
| ComputeNodeEnableSchedulingHeaders |
Defines headers for EnableScheduling operation. |
| ComputeNodeEnableSchedulingOptionalParams |
Optional Parameters. |
| ComputeNodeEnableSchedulingOptions |
Additional parameters for enableScheduling operation. |
| ComputeNodeEndpointConfiguration |
An interface representing ComputeNodeEndpointConfiguration. |
| ComputeNodeError |
An interface representing ComputeNodeError. |
| ComputeNodeGetHeaders |
Defines headers for Get operation. |
| ComputeNodeGetOptionalParams |
Optional Parameters. |
| ComputeNodeGetOptions |
Additional parameters for get operation. |
| ComputeNodeGetRemoteDesktopHeaders |
Defines headers for GetRemoteDesktop operation. |
| ComputeNodeGetRemoteDesktopOptionalParams |
Optional Parameters. |
| ComputeNodeGetRemoteDesktopOptions |
Additional parameters for getRemoteDesktop operation. |
| ComputeNodeGetRemoteLoginSettingsHeaders |
Defines headers for GetRemoteLoginSettings operation. |
| ComputeNodeGetRemoteLoginSettingsOptionalParams |
Optional Parameters. |
| ComputeNodeGetRemoteLoginSettingsOptions |
Additional parameters for getRemoteLoginSettings operation. |
| ComputeNodeGetRemoteLoginSettingsResult |
An interface representing ComputeNodeGetRemoteLoginSettingsResult. |
| ComputeNodeInformation |
An interface representing ComputeNodeInformation. |
| ComputeNodeListHeaders |
Defines headers for List operation. |
| ComputeNodeListNextOptionalParams |
Optional Parameters. |
| ComputeNodeListNextOptions |
Additional parameters for listNext operation. |
| ComputeNodeListOptionalParams |
Optional Parameters. |
| ComputeNodeListOptions |
Additional parameters for list operation. |
| ComputeNodeListResult | |
| ComputeNodeRebootHeaders |
Defines headers for Reboot operation. |
| ComputeNodeRebootOptionalParams |
Optional Parameters. |
| ComputeNodeRebootOptions |
Additional parameters for reboot operation. |
| ComputeNodeReimageHeaders |
Defines headers for Reimage operation. |
| ComputeNodeReimageOptionalParams |
Optional Parameters. |
| ComputeNodeReimageOptions |
Additional parameters for reimage operation. |
| ComputeNodeUpdateUserHeaders |
Defines headers for UpdateUser operation. |
| ComputeNodeUpdateUserOptionalParams |
Optional Parameters. |
| ComputeNodeUpdateUserOptions |
Additional parameters for updateUser operation. |
| ComputeNodeUploadBatchServiceLogsHeaders |
Defines headers for UploadBatchServiceLogs operation. |
| ComputeNodeUploadBatchServiceLogsOptionalParams |
Optional Parameters. |
| ComputeNodeUploadBatchServiceLogsOptions |
Additional parameters for uploadBatchServiceLogs operation. |
| ComputeNodeUser |
An interface representing ComputeNodeUser. |
| ContainerConfiguration |
An interface representing ContainerConfiguration. |
| ContainerRegistry |
An interface representing ContainerRegistry. |
| DataDisk |
An interface representing DataDisk. |
| DeleteCertificateError |
An interface representing DeleteCertificateError. |
| DiskEncryptionConfiguration |
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Shared Image Gallery Image. |
| EnvironmentSetting |
An interface representing EnvironmentSetting. |
| ErrorMessage |
An interface representing ErrorMessage. |
| ExitCodeMapping |
An interface representing ExitCodeMapping. |
| ExitCodeRangeMapping |
An interface representing ExitCodeRangeMapping. |
| ExitConditions |
An interface representing ExitConditions. |
| ExitOptions |
An interface representing ExitOptions. |
| FileDeleteFromComputeNodeHeaders |
Defines headers for DeleteFromComputeNode operation. |
| FileDeleteFromComputeNodeOptionalParams |
Optional Parameters. |
| FileDeleteFromComputeNodeOptions |
Additional parameters for deleteFromComputeNode operation. |
| FileDeleteFromTaskHeaders |
Defines headers for DeleteFromTask operation. |
| FileDeleteFromTaskOptionalParams |
Optional Parameters. |
| FileDeleteFromTaskOptions |
Additional parameters for deleteFromTask operation. |
| FileGetFromComputeNodeHeaders |
Defines headers for GetFromComputeNode operation. |
| FileGetFromComputeNodeOptionalParams |
Optional Parameters. |
| FileGetFromComputeNodeOptions |
Additional parameters for getFromComputeNode operation. |
| FileGetFromTaskHeaders |
Defines headers for GetFromTask operation. |
| FileGetFromTaskOptionalParams |
Optional Parameters. |
| FileGetFromTaskOptions |
Additional parameters for getFromTask operation. |
| FileGetPropertiesFromComputeNodeHeaders |
Defines headers for GetPropertiesFromComputeNode operation. |
| FileGetPropertiesFromComputeNodeOptionalParams |
Optional Parameters. |
| FileGetPropertiesFromComputeNodeOptions |
Additional parameters for getPropertiesFromComputeNode operation. |
| FileGetPropertiesFromTaskHeaders |
Defines headers for GetPropertiesFromTask operation. |
| FileGetPropertiesFromTaskOptionalParams |
Optional Parameters. |
| FileGetPropertiesFromTaskOptions |
Additional parameters for getPropertiesFromTask operation. |
| FileListFromComputeNodeHeaders |
Defines headers for ListFromComputeNode operation. |
| FileListFromComputeNodeNextOptionalParams |
Optional Parameters. |
| FileListFromComputeNodeNextOptions |
Additional parameters for listFromComputeNodeNext operation. |
| FileListFromComputeNodeOptionalParams |
Optional Parameters. |
| FileListFromComputeNodeOptions |
Additional parameters for listFromComputeNode operation. |
| FileListFromTaskHeaders |
Defines headers for ListFromTask operation. |
| FileListFromTaskNextOptionalParams |
Optional Parameters. |
| FileListFromTaskNextOptions |
Additional parameters for listFromTaskNext operation. |
| FileListFromTaskOptionalParams |
Optional Parameters. |
| FileListFromTaskOptions |
Additional parameters for listFromTask operation. |
| FileProperties |
An interface representing FileProperties. |
| ImageInformation |
An interface representing ImageInformation. |
| ImageReference |
An interface representing ImageReference. |
| InboundEndpoint |
An interface representing InboundEndpoint. |
| InboundNATPool |
An interface representing InboundNATPool. |
| JobAddHeaders |
Defines headers for Add operation. |
| JobAddOptionalParams |
Optional Parameters. |
| JobAddOptions |
Additional parameters for add operation. |
| JobAddParameter |
An interface representing JobAddParameter. |
| JobConstraints |
An interface representing JobConstraints. |
| JobDeleteHeaders |
Defines headers for Delete operation. |
| JobDeleteMethodOptionalParams |
Optional Parameters. |
| JobDeleteMethodOptions |
Additional parameters for deleteMethod operation. |
| JobDisableHeaders |
Defines headers for Disable operation. |
| JobDisableOptionalParams |
Optional Parameters. |
| JobDisableOptions |
Additional parameters for disable operation. |
| JobDisableParameter |
An interface representing JobDisableParameter. |
| JobEnableHeaders |
Defines headers for Enable operation. |
| JobEnableOptionalParams |
Optional Parameters. |
| JobEnableOptions |
Additional parameters for enable operation. |
| JobExecutionInformation |
An interface representing JobExecutionInformation. |
| JobGetAllLifetimeStatisticsHeaders |
Defines headers for GetAllLifetimeStatistics operation. |
| JobGetAllLifetimeStatisticsOptionalParams |
Optional Parameters. |
| JobGetAllLifetimeStatisticsOptions |
Additional parameters for getAllLifetimeStatistics operation. |
| JobGetHeaders |
Defines headers for Get operation. |
| JobGetOptionalParams |
Optional Parameters. |
| JobGetOptions |
Additional parameters for get operation. |
| JobGetTaskCountsHeaders |
Defines headers for GetTaskCounts operation. |
| JobGetTaskCountsOptionalParams |
Optional Parameters. |
| JobGetTaskCountsOptions |
Additional parameters for getTaskCounts operation. |
| JobListFromJobScheduleHeaders |
Defines headers for ListFromJobSchedule operation. |
| JobListFromJobScheduleNextOptionalParams |
Optional Parameters. |
| JobListFromJobScheduleNextOptions |
Additional parameters for listFromJobScheduleNext operation. |
| JobListFromJobScheduleOptionalParams |
Optional Parameters. |
| JobListFromJobScheduleOptions |
Additional parameters for listFromJobSchedule operation. |
| JobListHeaders |
Defines headers for List operation. |
| JobListNextOptionalParams |
Optional Parameters. |
| JobListNextOptions |
Additional parameters for listNext operation. |
| JobListOptionalParams |
Optional Parameters. |
| JobListOptions |
Additional parameters for list operation. |
| JobListPreparationAndReleaseTaskStatusHeaders |
Defines headers for ListPreparationAndReleaseTaskStatus operation. |
| JobListPreparationAndReleaseTaskStatusNextOptionalParams |
Optional Parameters. |
| JobListPreparationAndReleaseTaskStatusNextOptions |
Additional parameters for listPreparationAndReleaseTaskStatusNext operation. |
| JobListPreparationAndReleaseTaskStatusOptionalParams |
Optional Parameters. |
| JobListPreparationAndReleaseTaskStatusOptions |
Additional parameters for listPreparationAndReleaseTaskStatus operation. |
| JobManagerTask |
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. |
| JobNetworkConfiguration |
An interface representing JobNetworkConfiguration. |
| JobPatchHeaders |
Defines headers for Patch operation. |
| JobPatchOptionalParams |
Optional Parameters. |
| JobPatchOptions |
Additional parameters for patch operation. |
| JobPatchParameter |
An interface representing JobPatchParameter. |
| JobPreparationAndReleaseTaskExecutionInformation |
An interface representing JobPreparationAndReleaseTaskExecutionInformation. |
| JobPreparationTask |
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. |
| JobPreparationTaskExecutionInformation |
An interface representing JobPreparationTaskExecutionInformation. |
| 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 |
An interface representing JobReleaseTaskExecutionInformation. |
| JobScheduleAddHeaders |
Defines headers for Add operation. |
| JobScheduleAddOptionalParams |
Optional Parameters. |
| JobScheduleAddOptions |
Additional parameters for add operation. |
| JobScheduleAddParameter |
An interface representing JobScheduleAddParameter. |
| JobScheduleDeleteHeaders |
Defines headers for Delete operation. |
| JobScheduleDeleteMethodOptionalParams |
Optional Parameters. |
| JobScheduleDeleteMethodOptions |
Additional parameters for deleteMethod operation. |
| JobScheduleDisableHeaders |
Defines headers for Disable operation. |
| JobScheduleDisableOptionalParams |
Optional Parameters. |
| JobScheduleDisableOptions |
Additional parameters for disable operation. |
| JobScheduleEnableHeaders |
Defines headers for Enable operation. |
| JobScheduleEnableOptionalParams |
Optional Parameters. |
| JobScheduleEnableOptions |
Additional parameters for enable operation. |
| JobScheduleExecutionInformation |
An interface representing JobScheduleExecutionInformation. |
| JobScheduleExistsHeaders |
Defines headers for Exists operation. |
| JobScheduleExistsOptionalParams |
Optional Parameters. |
| JobScheduleExistsOptions |
Additional parameters for exists operation. |
| JobScheduleGetHeaders |
Defines headers for Get operation. |
| JobScheduleGetOptionalParams |
Optional Parameters. |
| JobScheduleGetOptions |
Additional parameters for get operation. |
| JobScheduleListHeaders |
Defines headers for List operation. |
| JobScheduleListNextOptionalParams |
Optional Parameters. |
| JobScheduleListNextOptions |
Additional parameters for listNext operation. |
| JobScheduleListOptionalParams |
Optional Parameters. |
| JobScheduleListOptions |
Additional parameters for list operation. |
| JobSchedulePatchHeaders |
Defines headers for Patch operation. |
| JobSchedulePatchOptionalParams |
Optional Parameters. |
| JobSchedulePatchOptions |
Additional parameters for patch operation. |
| JobSchedulePatchParameter |
An interface representing JobSchedulePatchParameter. |
| JobScheduleStatistics |
An interface representing JobScheduleStatistics. |
| JobScheduleTerminateHeaders |
Defines headers for Terminate operation. |
| JobScheduleTerminateOptionalParams |
Optional Parameters. |
| JobScheduleTerminateOptions |
Additional parameters for terminate operation. |
| JobScheduleUpdateHeaders |
Defines headers for Update operation. |
| JobScheduleUpdateOptionalParams |
Optional Parameters. |
| JobScheduleUpdateOptions |
Additional parameters for update operation. |
| JobScheduleUpdateParameter |
An interface representing JobScheduleUpdateParameter. |
| JobSchedulingError |
An interface representing JobSchedulingError. |
| JobSpecification |
An interface representing JobSpecification. |
| JobStatistics |
An interface representing JobStatistics. |
| JobTerminateHeaders |
Defines headers for Terminate operation. |
| JobTerminateOptionalParams |
Optional Parameters. |
| JobTerminateOptions |
Additional parameters for terminate operation. |
| JobTerminateParameter |
An interface representing JobTerminateParameter. |
| JobUpdateHeaders |
Defines headers for Update operation. |
| JobUpdateOptionalParams |
Optional Parameters. |
| JobUpdateOptions |
Additional parameters for update operation. |
| JobUpdateParameter |
An interface representing JobUpdateParameter. |
| LinuxUserConfiguration |
An interface representing LinuxUserConfiguration. |
| MetadataItem |
The Batch service does not assign any meaning to this metadata; it is solely for the use of user code. |
| MountConfiguration |
An interface representing MountConfiguration. |
| 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 |
An interface representing NameValuePair. |
| NetworkConfiguration |
The network configuration for a Pool. |
| NetworkSecurityGroupRule |
An interface representing NetworkSecurityGroupRule. |
| NFSMountConfiguration |
An interface representing NFSMountConfiguration. |
| NodeAgentInformation |
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. |
| NodeCounts |
An interface representing NodeCounts. |
| NodeDisableSchedulingParameter |
An interface representing NodeDisableSchedulingParameter. |
| NodeFile |
An interface representing NodeFile. |
| NodeFileListResult | |
| NodeRebootParameter |
An interface representing NodeRebootParameter. |
| NodeReimageParameter |
An interface representing NodeReimageParameter. |
| NodeRemoveParameter |
An interface representing NodeRemoveParameter. |
| NodeUpdateUserParameter |
An interface representing NodeUpdateUserParameter. |
| 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 |
An interface representing OutputFileBlobContainerDestination. |
| OutputFileDestination |
An interface representing OutputFileDestination. |
| OutputFileUploadOptions |
An interface representing OutputFileUploadOptions. |
| PoolAddHeaders |
Defines headers for Add operation. |
| PoolAddOptionalParams |
Optional Parameters. |
| PoolAddOptions |
Additional parameters for add operation. |
| PoolAddParameter |
An interface representing PoolAddParameter. |
| PoolDeleteHeaders |
Defines headers for Delete operation. |
| PoolDeleteMethodOptionalParams |
Optional Parameters. |
| PoolDeleteMethodOptions |
Additional parameters for deleteMethod operation. |
| PoolDisableAutoScaleHeaders |
Defines headers for DisableAutoScale operation. |
| PoolDisableAutoScaleOptionalParams |
Optional Parameters. |
| PoolDisableAutoScaleOptions |
Additional parameters for disableAutoScale operation. |
| PoolEnableAutoScaleHeaders |
Defines headers for EnableAutoScale operation. |
| PoolEnableAutoScaleOptionalParams |
Optional Parameters. |
| PoolEnableAutoScaleOptions |
Additional parameters for enableAutoScale operation. |
| PoolEnableAutoScaleParameter |
An interface representing PoolEnableAutoScaleParameter. |
| PoolEndpointConfiguration |
An interface representing PoolEndpointConfiguration. |
| PoolEvaluateAutoScaleHeaders |
Defines headers for EvaluateAutoScale operation. |
| PoolEvaluateAutoScaleOptionalParams |
Optional Parameters. |
| PoolEvaluateAutoScaleOptions |
Additional parameters for evaluateAutoScale operation. |
| PoolEvaluateAutoScaleParameter |
An interface representing PoolEvaluateAutoScaleParameter. |
| PoolExistsHeaders |
Defines headers for Exists operation. |
| PoolExistsOptionalParams |
Optional Parameters. |
| PoolExistsOptions |
Additional parameters for exists operation. |
| PoolGetAllLifetimeStatisticsHeaders |
Defines headers for GetAllLifetimeStatistics operation. |
| PoolGetAllLifetimeStatisticsOptionalParams |
Optional Parameters. |
| PoolGetAllLifetimeStatisticsOptions |
Additional parameters for getAllLifetimeStatistics operation. |
| PoolGetHeaders |
Defines headers for Get operation. |
| PoolGetOptionalParams |
Optional Parameters. |
| PoolGetOptions |
Additional parameters for get operation. |
| PoolInformation |
An interface representing PoolInformation. |
| PoolListHeaders |
Defines headers for List operation. |
| PoolListNextOptionalParams |
Optional Parameters. |
| PoolListNextOptions |
Additional parameters for listNext operation. |
| PoolListOptionalParams |
Optional Parameters. |
| PoolListOptions |
Additional parameters for list operation. |
| PoolListUsageMetricsHeaders |
Defines headers for ListUsageMetrics operation. |
| PoolListUsageMetricsNextOptionalParams |
Optional Parameters. |
| PoolListUsageMetricsNextOptions |
Additional parameters for listUsageMetricsNext operation. |
| PoolListUsageMetricsOptionalParams |
Optional Parameters. |
| PoolListUsageMetricsOptions |
Additional parameters for listUsageMetrics operation. |
| PoolListUsageMetricsResult | |
| PoolNodeCounts |
An interface representing PoolNodeCounts. |
| PoolNodeCountsListResult | |
| PoolPatchHeaders |
Defines headers for Patch operation. |
| PoolPatchOptionalParams |
Optional Parameters. |
| PoolPatchOptions |
Additional parameters for patch operation. |
| PoolPatchParameter |
An interface representing PoolPatchParameter. |
| PoolRemoveNodesHeaders |
Defines headers for RemoveNodes operation. |
| PoolRemoveNodesOptionalParams |
Optional Parameters. |
| PoolRemoveNodesOptions |
Additional parameters for removeNodes operation. |
| PoolResizeHeaders |
Defines headers for Resize operation. |
| PoolResizeOptionalParams |
Optional Parameters. |
| PoolResizeOptions |
Additional parameters for resize operation. |
| PoolResizeParameter |
An interface representing PoolResizeParameter. |
| PoolSpecification |
An interface representing PoolSpecification. |
| PoolStatistics |
An interface representing PoolStatistics. |
| PoolStopResizeHeaders |
Defines headers for StopResize operation. |
| PoolStopResizeOptionalParams |
Optional Parameters. |
| PoolStopResizeOptions |
Additional parameters for stopResize operation. |
| PoolUpdatePropertiesHeaders |
Defines headers for UpdateProperties operation. |
| PoolUpdatePropertiesOptionalParams |
Optional Parameters. |
| PoolUpdatePropertiesOptions |
Additional parameters for updateProperties operation. |
| PoolUpdatePropertiesParameter |
An interface representing PoolUpdatePropertiesParameter. |
| PoolUsageMetrics |
An interface representing PoolUsageMetrics. |
| PublicIPAddressConfiguration |
The public IP Address configuration of the networking configuration of a Pool. |
| RecentJob |
An interface representing RecentJob. |
| ResizeError |
An interface representing ResizeError. |
| ResourceFile |
An interface representing ResourceFile. |
| ResourceStatistics |
An interface representing ResourceStatistics. |
| Schedule |
An interface representing Schedule. |
| StartTask |
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. |
| StartTaskInformation |
An interface representing StartTaskInformation. |
| SubtaskInformation |
An interface representing SubtaskInformation. |
| TaskAddCollectionHeaders |
Defines headers for AddCollection operation. |
| TaskAddCollectionOptionalParams |
Optional Parameters. |
| TaskAddCollectionOptions |
Additional parameters for addCollection operation. |
| TaskAddCollectionParameter |
An interface representing TaskAddCollectionParameter. |
| TaskAddCollectionResult |
An interface representing TaskAddCollectionResult. |
| TaskAddHeaders |
Defines headers for Add operation. |
| TaskAddOptionalParams |
Optional Parameters. |
| TaskAddOptions |
Additional parameters for add operation. |
| TaskAddParameter |
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. |
| TaskAddResult |
An interface representing TaskAddResult. |
| TaskConstraints |
An interface representing TaskConstraints. |
| TaskContainerExecutionInformation |
An interface representing TaskContainerExecutionInformation. |
| TaskContainerSettings |
An interface representing TaskContainerSettings. |
| TaskCounts |
An interface representing TaskCounts. |
| TaskCountsResult |
An interface representing TaskCountsResult. |
| TaskDeleteHeaders |
Defines headers for Delete operation. |
| TaskDeleteMethodOptionalParams |
Optional Parameters. |
| TaskDeleteMethodOptions |
Additional parameters for deleteMethod operation. |
| TaskDependencies |
An interface representing TaskDependencies. |
| TaskExecutionInformation |
An interface representing TaskExecutionInformation. |
| TaskFailureInformation |
An interface representing TaskFailureInformation. |
| TaskGetHeaders |
Defines headers for Get operation. |
| TaskGetOptionalParams |
Optional Parameters. |
| TaskGetOptions |
Additional parameters for get operation. |
| TaskIdRange |
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'. |
| TaskInformation |
An interface representing TaskInformation. |
| TaskListHeaders |
Defines headers for List operation. |
| TaskListNextOptionalParams |
Optional Parameters. |
| TaskListNextOptions |
Additional parameters for listNext operation. |
| TaskListOptionalParams |
Optional Parameters. |
| TaskListOptions |
Additional parameters for list operation. |
| TaskListSubtasksHeaders |
Defines headers for ListSubtasks operation. |
| TaskListSubtasksOptionalParams |
Optional Parameters. |
| TaskListSubtasksOptions |
Additional parameters for listSubtasks operation. |
| TaskReactivateHeaders |
Defines headers for Reactivate operation. |
| TaskReactivateOptionalParams |
Optional Parameters. |
| TaskReactivateOptions |
Additional parameters for reactivate operation. |
| TaskSchedulingPolicy |
An interface representing TaskSchedulingPolicy. |
| TaskSlotCounts |
An interface representing TaskSlotCounts. |
| TaskStatistics |
An interface representing TaskStatistics. |
| TaskTerminateHeaders |
Defines headers for Terminate operation. |
| TaskTerminateOptionalParams |
Optional Parameters. |
| TaskTerminateOptions |
Additional parameters for terminate operation. |
| TaskUpdateHeaders |
Defines headers for Update operation. |
| TaskUpdateOptionalParams |
Optional Parameters. |
| TaskUpdateOptions |
Additional parameters for update operation. |
| TaskUpdateParameter |
An interface representing TaskUpdateParameter. |
| UploadBatchServiceLogsConfiguration |
An interface representing UploadBatchServiceLogsConfiguration. |
| UploadBatchServiceLogsResult |
An interface representing UploadBatchServiceLogsResult. |
| UsageStatistics |
An interface representing UsageStatistics. |
| UserAccount |
An interface representing UserAccount. |
| UserIdentity |
Specify either the userName or autoUser property, but not both. |
| VirtualMachineConfiguration |
An interface representing VirtualMachineConfiguration. |
| WindowsConfiguration |
An interface representing WindowsConfiguration. |
| WindowsUserConfiguration |
An interface representing WindowsUserConfiguration. |
Type Aliases
| AccessScope |
Defines values for AccessScope. Possible values include: 'job' |
| AccountListPoolNodeCountsResponse |
Contains response data for the listPoolNodeCounts operation. |
| AccountListSupportedImagesResponse |
Contains response data for the listSupportedImages operation. |
| AllocationState |
Defines values for AllocationState. Possible values include: 'steady', 'resizing', 'stopping' |
| ApplicationGetResponse |
Contains response data for the get operation. |
| ApplicationListResponse |
Contains response data for the list operation. |
| AutoUserScope |
Defines values for AutoUserScope. Possible values include: 'task', 'pool' |
| CachingType |
Defines values for CachingType. Possible values include: 'none', 'readOnly', 'readWrite' |
| CertificateAddResponse |
Contains response data for the add operation. |
| CertificateCancelDeletionResponse |
Contains response data for the cancelDeletion operation. |
| CertificateDeleteResponse |
Contains response data for the deleteMethod operation. |
| CertificateFormat |
Defines values for CertificateFormat. Possible values include: 'pfx', 'cer' |
| CertificateGetResponse |
Contains response data for the get operation. |
| CertificateListResponse |
Contains response data for the list operation. |
| CertificateState |
Defines values for CertificateState. Possible values include: 'active', 'deleting', 'deleteFailed' |
| CertificateStoreLocation |
Defines values for CertificateStoreLocation. Possible values include: 'currentUser', 'localMachine' |
| CertificateVisibility |
Defines values for CertificateVisibility. Possible values include: 'startTask', 'task', 'remoteUser' |
| ComputeNodeAddUserResponse |
Contains response data for the addUser operation. |
| ComputeNodeDeallocationOption |
Defines values for ComputeNodeDeallocationOption. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' |
| ComputeNodeDeleteUserResponse |
Contains response data for the deleteUser operation. |
| ComputeNodeDisableSchedulingResponse |
Contains response data for the disableScheduling operation. |
| ComputeNodeEnableSchedulingResponse |
Contains response data for the enableScheduling operation. |
| ComputeNodeFillType |
Defines values for ComputeNodeFillType. Possible values include: 'spread', 'pack' |
| ComputeNodeGetRemoteDesktopResponse |
Contains response data for the getRemoteDesktop operation. |
| ComputeNodeGetRemoteLoginSettingsResponse |
Contains response data for the getRemoteLoginSettings operation. |
| ComputeNodeGetResponse |
Contains response data for the get operation. |
| ComputeNodeListResponse |
Contains response data for the list operation. |
| ComputeNodeRebootOption |
Defines values for ComputeNodeRebootOption. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' |
| ComputeNodeRebootResponse |
Contains response data for the reboot operation. |
| ComputeNodeReimageOption |
Defines values for ComputeNodeReimageOption. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' |
| ComputeNodeReimageResponse |
Contains response data for the reimage operation. |
| ComputeNodeState |
Defines values for ComputeNodeState. Possible values include: 'idle', 'rebooting', 'reimaging', 'running', 'unusable', 'creating', 'starting', 'waitingForStartTask', 'startTaskFailed', 'unknown', 'leavingPool', 'offline', 'preempted' |
| ComputeNodeUpdateUserResponse |
Contains response data for the updateUser operation. |
| ComputeNodeUploadBatchServiceLogsResponse |
Contains response data for the uploadBatchServiceLogs operation. |
| ContainerWorkingDirectory |
Defines values for ContainerWorkingDirectory. Possible values include: 'taskWorkingDirectory', 'containerImageDefault' |
| DependencyAction |
Defines values for DependencyAction. Possible values include: 'satisfy', 'block' |
| DisableComputeNodeSchedulingOption |
Defines values for DisableComputeNodeSchedulingOption. Possible values include: 'requeue', 'terminate', 'taskCompletion' |
| DisableJobOption |
Defines values for DisableJobOption. Possible values include: 'requeue', 'terminate', 'wait' |
| DiskEncryptionTarget |
Defines values for DiskEncryptionTarget. Possible values include: 'OsDisk', 'TemporaryDisk' |
| DynamicVNetAssignmentScope |
Defines values for DynamicVNetAssignmentScope. Possible values include: 'none', 'job' |
| ElevationLevel |
Defines values for ElevationLevel. Possible values include: 'nonAdmin', 'admin' |
| ErrorCategory |
Defines values for ErrorCategory. Possible values include: 'userError', 'serverError' |
| FileDeleteFromComputeNodeResponse |
Contains response data for the deleteFromComputeNode operation. |
| FileDeleteFromTaskResponse |
Contains response data for the deleteFromTask operation. |
| FileGetFromComputeNodeResponse |
Contains response data for the getFromComputeNode operation. |
| FileGetFromTaskResponse |
Contains response data for the getFromTask operation. |
| FileGetPropertiesFromComputeNodeResponse |
Contains response data for the getPropertiesFromComputeNode operation. |
| FileGetPropertiesFromTaskResponse |
Contains response data for the getPropertiesFromTask operation. |
| FileListFromComputeNodeResponse |
Contains response data for the listFromComputeNode operation. |
| FileListFromTaskResponse |
Contains response data for the listFromTask operation. |
| InboundEndpointProtocol |
Defines values for InboundEndpointProtocol. Possible values include: 'tcp', 'udp' |
| IPAddressProvisioningType |
Defines values for IPAddressProvisioningType. Possible values include: 'batchManaged', 'userManaged', 'noPublicIPAddresses' |
| JobAction |
Defines values for JobAction. Possible values include: 'none', 'disable', 'terminate' |
| JobAddResponse |
Contains response data for the add operation. |
| JobDeleteResponse |
Contains response data for the deleteMethod operation. |
| JobDisableResponse |
Contains response data for the disable operation. |
| JobEnableResponse |
Contains response data for the enable operation. |
| JobGetAllLifetimeStatisticsResponse |
Contains response data for the getAllLifetimeStatistics operation. |
| JobGetResponse |
Contains response data for the get operation. |
| JobGetTaskCountsResponse |
Contains response data for the getTaskCounts operation. |
| JobListFromJobScheduleResponse |
Contains response data for the listFromJobSchedule operation. |
| JobListPreparationAndReleaseTaskStatusResponse |
Contains response data for the listPreparationAndReleaseTaskStatus operation. |
| JobListResponse |
Contains response data for the list operation. |
| JobPatchResponse |
Contains response data for the patch operation. |
| JobPreparationTaskState |
Defines values for JobPreparationTaskState. Possible values include: 'running', 'completed' |
| JobReleaseTaskState |
Defines values for JobReleaseTaskState. Possible values include: 'running', 'completed' |
| JobScheduleAddResponse |
Contains response data for the add operation. |
| JobScheduleDeleteResponse |
Contains response data for the deleteMethod operation. |
| JobScheduleDisableResponse |
Contains response data for the disable operation. |
| JobScheduleEnableResponse |
Contains response data for the enable operation. |
| JobScheduleExistsResponse |
Contains response data for the exists operation. |
| JobScheduleGetResponse |
Contains response data for the get operation. |
| JobScheduleListResponse |
Contains response data for the list operation. |
| JobSchedulePatchResponse |
Contains response data for the patch operation. |
| JobScheduleState |
Defines values for JobScheduleState. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting' |
| JobScheduleTerminateResponse |
Contains response data for the terminate operation. |
| JobScheduleUpdateResponse |
Contains response data for the update operation. |
| JobState |
Defines values for JobState. Possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting' |
| JobTerminateResponse |
Contains response data for the terminate operation. |
| JobUpdateResponse |
Contains response data for the update operation. |
| LoginMode |
Defines values for LoginMode. Possible values include: 'batch', 'interactive' |
| NetworkSecurityGroupRuleAccess |
Defines values for NetworkSecurityGroupRuleAccess. Possible values include: 'allow', 'deny' |
| OnAllTasksComplete |
Defines values for OnAllTasksComplete. Possible values include: 'noAction', 'terminateJob' |
| OnTaskFailure |
Defines values for OnTaskFailure. Possible values include: 'noAction', 'performExitOptionsJobAction' |
| OSType |
Defines values for OSType. Possible values include: 'linux', 'windows' |
| OutputFileUploadCondition |
Defines values for OutputFileUploadCondition. Possible values include: 'taskSuccess', 'taskFailure', 'taskCompletion' |
| PoolAddResponse |
Contains response data for the add operation. |
| PoolDeleteResponse |
Contains response data for the deleteMethod operation. |
| PoolDisableAutoScaleResponse |
Contains response data for the disableAutoScale operation. |
| PoolEnableAutoScaleResponse |
Contains response data for the enableAutoScale operation. |
| PoolEvaluateAutoScaleResponse |
Contains response data for the evaluateAutoScale operation. |
| PoolExistsResponse |
Contains response data for the exists operation. |
| PoolGetAllLifetimeStatisticsResponse |
Contains response data for the getAllLifetimeStatistics operation. |
| PoolGetResponse |
Contains response data for the get operation. |
| PoolLifetimeOption |
Defines values for PoolLifetimeOption. Possible values include: 'jobSchedule', 'job' |
| PoolListResponse |
Contains response data for the list operation. |
| PoolListUsageMetricsResponse |
Contains response data for the listUsageMetrics operation. |
| PoolPatchResponse |
Contains response data for the patch operation. |
| PoolRemoveNodesResponse |
Contains response data for the removeNodes operation. |
| PoolResizeResponse |
Contains response data for the resize operation. |
| PoolState |
Defines values for PoolState. Possible values include: 'active', 'deleting' |
| PoolStopResizeResponse |
Contains response data for the stopResize operation. |
| PoolUpdatePropertiesResponse |
Contains response data for the updateProperties operation. |
| SchedulingState |
Defines values for SchedulingState. Possible values include: 'enabled', 'disabled' |
| StartTaskState |
Defines values for StartTaskState. Possible values include: 'running', 'completed' |
| StorageAccountType |
Defines values for StorageAccountType. Possible values include: 'StandardLRS', 'PremiumLRS' |
| SubtaskState |
Defines values for SubtaskState. Possible values include: 'preparing', 'running', 'completed' |
| TaskAddCollectionResponse |
Contains response data for the addCollection operation. |
| TaskAddResponse |
Contains response data for the add operation. |
| TaskAddStatus |
Defines values for TaskAddStatus. Possible values include: 'success', 'clientError', 'serverError' |
| TaskDeleteResponse |
Contains response data for the deleteMethod operation. |
| TaskExecutionResult |
Defines values for TaskExecutionResult. Possible values include: 'success', 'failure' |
| TaskGetResponse |
Contains response data for the get operation. |
| TaskListResponse |
Contains response data for the list operation. |
| TaskListSubtasksResponse |
Contains response data for the listSubtasks operation. |
| TaskReactivateResponse |
Contains response data for the reactivate operation. |
| TaskState |
Defines values for TaskState. Possible values include: 'active', 'preparing', 'running', 'completed' |
| TaskTerminateResponse |
Contains response data for the terminate operation. |
| TaskUpdateResponse |
Contains response data for the update operation. |
| VerificationType |
Defines values for VerificationType. Possible values include: 'verified', 'unverified' |