Package com.microsoft.azure.batch.protocol.models
This package contains the models classes for BatchServiceClient.
A client for issuing REST requests to the Azure Batch service.
-
Class Summary Class Description AccountListPoolNodeCountsHeaders Defines headers for ListPoolNodeCounts operation.AccountListPoolNodeCountsNextOptions Additional parameters for listPoolNodeCountsNext operation.AccountListPoolNodeCountsOptions Additional parameters for listPoolNodeCounts operation.AccountListSupportedImagesHeaders Defines headers for ListSupportedImages operation.AccountListSupportedImagesNextOptions Additional parameters for listSupportedImagesNext operation.AccountListSupportedImagesOptions Additional parameters for listSupportedImages operation.AffinityInformation A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task.ApplicationGetHeaders Defines headers for Get operation.ApplicationGetOptions Additional parameters for get operation.ApplicationListHeaders Defines headers for List operation.ApplicationListNextOptions Additional parameters for listNext operation.ApplicationListOptions Additional parameters for list operation.ApplicationPackageReference A reference to an 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'.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 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.BatchError An error response received from the Azure Batch service.BatchErrorDetail An item of additional information included in an Azure Batch error response.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.CertificateAddOptions Additional parameters for add operation.CertificateAddParameter A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine.CertificateCancelDeletionHeaders Defines headers for CancelDeletion operation.CertificateCancelDeletionOptions Additional parameters for cancelDeletion operation.CertificateDeleteHeaders Defines headers for Delete operation.CertificateDeleteOptions Additional parameters for delete operation.CertificateGetHeaders Defines headers for Get operation.CertificateGetOptions Additional parameters for get operation.CertificateListHeaders Defines headers for List operation.CertificateListNextOptions Additional parameters for listNext operation.CertificateListOptions Additional parameters for list operation.CertificateReference A reference to a Certificate to be installed on Compute Nodes in a Pool.CIFSMountConfiguration Information used to connect to a CIFS file system.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.CloudTaskListSubtasksResult The result of listing the subtasks of a Task.ComputeNode A Compute Node in the Batch service.ComputeNodeAddUserHeaders Defines headers for AddUser operation.ComputeNodeAddUserOptions Additional parameters for addUser operation.ComputeNodeDeleteUserHeaders Defines headers for DeleteUser operation.ComputeNodeDeleteUserOptions Additional parameters for deleteUser operation.ComputeNodeDisableSchedulingHeaders Defines headers for DisableScheduling operation.ComputeNodeDisableSchedulingOptions Additional parameters for disableScheduling operation.ComputeNodeEnableSchedulingHeaders Defines headers for EnableScheduling operation.ComputeNodeEnableSchedulingOptions Additional parameters for enableScheduling operation.ComputeNodeEndpointConfiguration The endpoint configuration for the Compute Node.ComputeNodeError An error encountered by a Compute Node.ComputeNodeGetHeaders Defines headers for Get operation.ComputeNodeGetOptions Additional parameters for get operation.ComputeNodeGetRemoteDesktopHeaders Defines headers for GetRemoteDesktop operation.ComputeNodeGetRemoteDesktopOptions Additional parameters for getRemoteDesktop operation.ComputeNodeGetRemoteLoginSettingsHeaders Defines headers for GetRemoteLoginSettings operation.ComputeNodeGetRemoteLoginSettingsOptions Additional parameters for getRemoteLoginSettings operation.ComputeNodeGetRemoteLoginSettingsResult The remote login settings for a Compute Node.ComputeNodeInformation Information about the Compute Node on which a Task ran.ComputeNodeListHeaders Defines headers for List operation.ComputeNodeListNextOptions Additional parameters for listNext operation.ComputeNodeListOptions Additional parameters for list operation.ComputeNodeRebootHeaders Defines headers for Reboot operation.ComputeNodeRebootOptions Additional parameters for reboot operation.ComputeNodeReimageHeaders Defines headers for Reimage operation.ComputeNodeReimageOptions Additional parameters for reimage operation.ComputeNodeUpdateUserHeaders Defines headers for UpdateUser operation.ComputeNodeUpdateUserOptions Additional parameters for updateUser operation.ComputeNodeUploadBatchServiceLogsHeaders Defines headers for UploadBatchServiceLogs operation.ComputeNodeUploadBatchServiceLogsOptions Additional parameters for uploadBatchServiceLogs operation.ComputeNodeUser A user Account for RDP or SSH access on a Compute Node.ContainerConfiguration The configuration for container-enabled Pools.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.DiskEncryptionConfiguration The disk encryption configuration applied on compute nodes in the pool.EnvironmentSetting An environment variable to be set on a Task process.ErrorMessage An error message received in an Azure Batch error response.ExitCodeMapping How the Batch service should respond if a Task exits with a particular exit code.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.FileDeleteFromComputeNodeHeaders Defines headers for DeleteFromComputeNode operation.FileDeleteFromComputeNodeOptions Additional parameters for deleteFromComputeNode operation.FileDeleteFromTaskHeaders Defines headers for DeleteFromTask operation.FileDeleteFromTaskOptions Additional parameters for deleteFromTask operation.FileGetFromComputeNodeHeaders Defines headers for GetFromComputeNode operation.FileGetFromComputeNodeOptions Additional parameters for getFromComputeNode operation.FileGetFromTaskHeaders Defines headers for GetFromTask operation.FileGetFromTaskOptions Additional parameters for getFromTask operation.FileGetPropertiesFromComputeNodeHeaders Defines headers for GetPropertiesFromComputeNode operation.FileGetPropertiesFromComputeNodeOptions Additional parameters for getPropertiesFromComputeNode operation.FileGetPropertiesFromTaskHeaders Defines headers for GetPropertiesFromTask operation.FileGetPropertiesFromTaskOptions Additional parameters for getPropertiesFromTask operation.FileListFromComputeNodeHeaders Defines headers for ListFromComputeNode operation.FileListFromComputeNodeNextOptions Additional parameters for listFromComputeNodeNext operation.FileListFromComputeNodeOptions Additional parameters for listFromComputeNode operation.FileListFromTaskHeaders Defines headers for ListFromTask operation.FileListFromTaskNextOptions Additional parameters for listFromTaskNext operation.FileListFromTaskOptions Additional parameters for listFromTask operation.FileProperties The properties of a file on a Compute Node.ImageInformation A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image.ImageReference A reference to an Azure Virtual Machines Marketplace Image or a custom Azure Virtual Machine Image.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.JobAddHeaders Defines headers for Add operation.JobAddOptions Additional parameters for add operation.JobAddParameter An Azure Batch Job to add.JobConstraints The execution constraints for a Job.JobDeleteHeaders Defines headers for Delete operation.JobDeleteOptions Additional parameters for delete operation.JobDisableHeaders Defines headers for Disable operation.JobDisableOptions Additional parameters for disable operation.JobDisableParameter Options when disabling a Job.JobEnableHeaders Defines headers for Enable operation.JobEnableOptions Additional parameters for enable operation.JobExecutionInformation Contains information about the execution of a Job in the Azure Batch service.JobGetAllLifetimeStatisticsHeaders Defines headers for GetAllLifetimeStatistics operation.JobGetAllLifetimeStatisticsOptions Additional parameters for getAllLifetimeStatistics operation.JobGetHeaders Defines headers for Get operation.JobGetOptions Additional parameters for get operation.JobGetTaskCountsHeaders Defines headers for GetTaskCounts operation.JobGetTaskCountsOptions Additional parameters for getTaskCounts operation.JobListFromJobScheduleHeaders Defines headers for ListFromJobSchedule operation.JobListFromJobScheduleNextOptions Additional parameters for listFromJobScheduleNext operation.JobListFromJobScheduleOptions Additional parameters for listFromJobSchedule operation.JobListHeaders Defines headers for List operation.JobListNextOptions Additional parameters for listNext operation.JobListOptions Additional parameters for list operation.JobListPreparationAndReleaseTaskStatusHeaders Defines headers for ListPreparationAndReleaseTaskStatus operation.JobListPreparationAndReleaseTaskStatusNextOptions Additional parameters for listPreparationAndReleaseTaskStatusNext operation.JobListPreparationAndReleaseTaskStatusOptions Additional parameters for listPreparationAndReleaseTaskStatus operation.JobManagerTask Specifies details of a Job Manager Task.JobNetworkConfiguration The network configuration for the Job.JobPatchHeaders Defines headers for Patch operation.JobPatchOptions Additional parameters for patch operation.JobPatchParameter The set of changes to be made to a Job.JobPreparationAndReleaseTaskExecutionInformation The status of the Job Preparation and Job Release Tasks on a Compute Node.JobPreparationTask A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.JobPreparationTaskExecutionInformation Contains information about the execution of a Job Preparation Task on a Compute Node.JobReleaseTask A Job Release Task to run on Job completion on any Compute Node where the Job has run.JobReleaseTaskExecutionInformation Contains information about the execution of a Job Release Task on a Compute Node.JobScheduleAddHeaders Defines headers for Add operation.JobScheduleAddOptions Additional parameters for add operation.JobScheduleAddParameter A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.JobScheduleDeleteHeaders Defines headers for Delete operation.JobScheduleDeleteOptions Additional parameters for delete operation.JobScheduleDisableHeaders Defines headers for Disable operation.JobScheduleDisableOptions Additional parameters for disable operation.JobScheduleEnableHeaders Defines headers for Enable operation.JobScheduleEnableOptions Additional parameters for enable operation.JobScheduleExecutionInformation Contains information about Jobs that have been and will be run under a Job Schedule.JobScheduleExistsHeaders Defines headers for Exists operation.JobScheduleExistsOptions Additional parameters for exists operation.JobScheduleGetHeaders Defines headers for Get operation.JobScheduleGetOptions Additional parameters for get operation.JobScheduleListHeaders Defines headers for List operation.JobScheduleListNextOptions Additional parameters for listNext operation.JobScheduleListOptions Additional parameters for list operation.JobSchedulePatchHeaders Defines headers for Patch operation.JobSchedulePatchOptions Additional parameters for patch operation.JobSchedulePatchParameter The set of changes to be made to a Job Schedule.JobScheduleStatistics Resource usage statistics for a Job Schedule.JobScheduleTerminateHeaders Defines headers for Terminate operation.JobScheduleTerminateOptions Additional parameters for terminate operation.JobScheduleUpdateHeaders Defines headers for Update operation.JobScheduleUpdateOptions Additional parameters for update operation.JobScheduleUpdateParameter The set of changes to be made to a Job Schedule.JobSchedulingError An error encountered by the Batch service when scheduling a Job.JobSpecification Specifies details of the Jobs to be created on a schedule.JobStatistics Resource usage statistics for a Job.JobTerminateHeaders Defines headers for Terminate operation.JobTerminateOptions Additional parameters for terminate operation.JobTerminateParameter Options when terminating a Job.JobUpdateHeaders Defines headers for Update operation.JobUpdateOptions Additional parameters for update operation.JobUpdateParameter The set of changes to be made to a Job.LinuxUserConfiguration Properties used to create a user Account on a Linux Compute Node.MetadataItem A name-value pair associated with a Batch service resource.MountConfiguration The file system to mount on each node.MultiInstanceSettings Settings which specify how to run a multi-instance Task.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 Compute Node agent.NodeCounts The number of Compute Nodes in each Compute Node state.NodeDisableSchedulingParameter Options for disabling scheduling on a Compute Node.NodeFile Information about a file or directory on a Compute Node.NodeRebootParameter Options for rebooting a Compute Node.NodeReimageParameter Options for reimaging a Compute Node.NodeRemoveParameter Options for removing Compute Nodes from a Pool.NodeUpdateUserParameter The set of changes to be made to a user Account on a Compute Node.OutputFile A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process.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.PageImpl<T> An instance of this class defines a page of Azure resources and a link to get the next page of resources, if any.PoolAddHeaders Defines headers for Add operation.PoolAddOptions Additional parameters for add operation.PoolAddParameter A Pool in the Azure Batch service to add.PoolDeleteHeaders Defines headers for Delete operation.PoolDeleteOptions Additional parameters for delete operation.PoolDisableAutoScaleHeaders Defines headers for DisableAutoScale operation.PoolDisableAutoScaleOptions Additional parameters for disableAutoScale operation.PoolEnableAutoScaleHeaders Defines headers for EnableAutoScale operation.PoolEnableAutoScaleOptions Additional parameters for enableAutoScale operation.PoolEnableAutoScaleParameter Options for enabling automatic scaling on a Pool.PoolEndpointConfiguration The endpoint configuration for a Pool.PoolEvaluateAutoScaleHeaders Defines headers for EvaluateAutoScale operation.PoolEvaluateAutoScaleOptions Additional parameters for evaluateAutoScale operation.PoolEvaluateAutoScaleParameter Options for evaluating an automatic scaling formula on a Pool.PoolExistsHeaders Defines headers for Exists operation.PoolExistsOptions Additional parameters for exists operation.PoolGetAllLifetimeStatisticsHeaders Defines headers for GetAllLifetimeStatistics operation.PoolGetAllLifetimeStatisticsOptions Additional parameters for getAllLifetimeStatistics operation.PoolGetHeaders Defines headers for Get operation.PoolGetOptions Additional parameters for get operation.PoolInformation Specifies how a Job should be assigned to a Pool.PoolListHeaders Defines headers for List operation.PoolListNextOptions Additional parameters for listNext operation.PoolListOptions Additional parameters for list operation.PoolListUsageMetricsHeaders Defines headers for ListUsageMetrics operation.PoolListUsageMetricsNextOptions Additional parameters for listUsageMetricsNext operation.PoolListUsageMetricsOptions Additional parameters for listUsageMetrics operation.PoolNodeCounts The number of Compute Nodes in each state for a Pool.PoolPatchHeaders Defines headers for Patch operation.PoolPatchOptions Additional parameters for patch operation.PoolPatchParameter The set of changes to be made to a Pool.PoolRemoveNodesHeaders Defines headers for RemoveNodes operation.PoolRemoveNodesOptions Additional parameters for removeNodes operation.PoolResizeHeaders Defines headers for Resize operation.PoolResizeOptions Additional parameters for resize operation.PoolResizeParameter Options for changing the size of a Pool.PoolSpecification Specification for creating a new Pool.PoolStatistics Contains utilization and resource usage statistics for the lifetime of a Pool.PoolStopResizeHeaders Defines headers for StopResize operation.PoolStopResizeOptions Additional parameters for stopResize operation.PoolUpdatePropertiesHeaders Defines headers for UpdateProperties operation.PoolUpdatePropertiesOptions Additional parameters for updateProperties operation.PoolUpdatePropertiesParameter The set of changes to be made to a Pool.PoolUsageMetrics Usage metrics for a Pool across an aggregation interval.PublicIPAddressConfiguration The public IP Address configuration of the networking configuration of a Pool.RecentJob Information about the most recent Job to run under the Job Schedule.ResizeError An error that occurred when resizing a Pool.ResourceFile A single file or multiple files to be downloaded to a Compute Node.ResourceStatistics Statistics related to resource consumption by Compute Nodes in a Pool.Schedule The schedule according to which Jobs will be created.StartTask A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged.StartTaskInformation Information about a StartTask running on a Compute Node.SubtaskInformation Information about an Azure Batch subtask.TaskAddCollectionHeaders Defines headers for AddCollection operation.TaskAddCollectionOptions Additional parameters for addCollection operation.TaskAddCollectionParameter A collection of Azure Batch Tasks to add.TaskAddCollectionResult The result of adding a collection of Tasks to a Job.TaskAddHeaders Defines headers for Add operation.TaskAddOptions Additional parameters for add operation.TaskAddParameter An Azure Batch Task to add.TaskAddResult Result for a single Task added as part of an add Task collection operation.TaskConstraints Execution constraints to apply to a Task.TaskContainerExecutionInformation Contains information about the container which a Task is executing.TaskContainerSettings The container settings for a Task.TaskCounts The Task counts for a Job.TaskDeleteHeaders Defines headers for Delete operation.TaskDeleteOptions Additional parameters for delete operation.TaskDependencies Specifies any dependencies of a Task.TaskExecutionInformation Information about the execution of a Task.TaskFailureInformation Information about a Task failure.TaskGetHeaders Defines headers for Get operation.TaskGetOptions Additional parameters for get operation.TaskIdRange A range of Task IDs that a Task can depend on.TaskInformation Information about a Task running on a Compute Node.TaskListHeaders Defines headers for List operation.TaskListNextOptions Additional parameters for listNext operation.TaskListOptions Additional parameters for list operation.TaskListSubtasksHeaders Defines headers for ListSubtasks operation.TaskListSubtasksOptions Additional parameters for listSubtasks operation.TaskReactivateHeaders Defines headers for Reactivate operation.TaskReactivateOptions Additional parameters for reactivate operation.TaskSchedulingPolicy Specifies how Tasks should be distributed across Compute Nodes.TaskStatistics Resource usage statistics for a Task.TaskTerminateHeaders Defines headers for Terminate operation.TaskTerminateOptions Additional parameters for terminate operation.TaskUpdateHeaders Defines headers for Update operation.TaskUpdateOptions Additional parameters for update operation.TaskUpdateParameter The set of changes to be made to a Task.UploadBatchServiceLogsConfiguration The Azure Batch service log files upload configuration for a Compute Node.UploadBatchServiceLogsResult The result of uploading Batch service log files from a specific Compute Node.UsageStatistics Statistics related to Pool usage information.UserAccount Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.UserIdentity The definition of the user identity under which the Task is run.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.WindowsUserConfiguration Properties used to create a user Account on a Windows Compute Node. -
Enum Summary Enum Description AccessScope Defines values for AccessScope.AllocationState Defines values for AllocationState.AutoUserScope Defines values for AutoUserScope.CachingType Defines values for CachingType.CertificateFormat Defines values for CertificateFormat.CertificateState Defines values for CertificateState.CertificateStoreLocation Defines values for CertificateStoreLocation.CertificateVisibility Defines values for CertificateVisibility.ComputeNodeDeallocationOption Defines values for ComputeNodeDeallocationOption.ComputeNodeFillType Defines values for ComputeNodeFillType.ComputeNodeRebootOption Defines values for ComputeNodeRebootOption.ComputeNodeReimageOption Defines values for ComputeNodeReimageOption.ComputeNodeState Defines values for ComputeNodeState.ContainerWorkingDirectory Defines values for ContainerWorkingDirectory.DependencyAction Defines values for DependencyAction.DisableComputeNodeSchedulingOption Defines values for DisableComputeNodeSchedulingOption.DisableJobOption Defines values for DisableJobOption.DiskEncryptionTarget Defines values for DiskEncryptionTarget.DynamicVNetAssignmentScope Defines values for DynamicVNetAssignmentScope.ElevationLevel Defines values for ElevationLevel.ErrorCategory Defines values for ErrorCategory.InboundEndpointProtocol Defines values for InboundEndpointProtocol.IPAddressProvisioningType Defines values for IPAddressProvisioningType.JobAction Defines values for JobAction.JobPreparationTaskState Defines values for JobPreparationTaskState.JobReleaseTaskState Defines values for JobReleaseTaskState.JobScheduleState Defines values for JobScheduleState.JobState Defines values for JobState.LoginMode Defines values for LoginMode.NetworkSecurityGroupRuleAccess Defines values for NetworkSecurityGroupRuleAccess.OnAllTasksComplete Defines values for OnAllTasksComplete.OnTaskFailure Defines values for OnTaskFailure.OSType Defines values for OSType.OutputFileUploadCondition Defines values for OutputFileUploadCondition.PoolLifetimeOption Defines values for PoolLifetimeOption.PoolState Defines values for PoolState.SchedulingState Defines values for SchedulingState.StartTaskState Defines values for StartTaskState.StorageAccountType Defines values for StorageAccountType.SubtaskState Defines values for SubtaskState.TaskAddStatus Defines values for TaskAddStatus.TaskExecutionResult Defines values for TaskExecutionResult.TaskState Defines values for TaskState.VerificationType Defines values for VerificationType. -
Exception Summary Exception Description BatchErrorException Exception thrown for an invalid response with BatchError information.