Microsoft.Azure.Batch.Protocol.Models Namespace

Classes

AccountListNodeAgentSkusHeaders

Defines headers for ListNodeAgentSkus operation.

AccountListNodeAgentSkusNextOptions

Additional parameters for ListNodeAgentSkusNext operation.

AccountListNodeAgentSkusOptions

Additional parameters for ListNodeAgentSkus operation.

AccountListPoolNodeCountsHeaders

Defines headers for ListPoolNodeCounts operation.

AccountListPoolNodeCountsNextOptions

Additional parameters for ListPoolNodeCountsNext operation.

AccountListPoolNodeCountsOptions

Additional parameters for ListPoolNodeCounts 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 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 when the job is submitted.

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.

BatchError

An error response received from the Azure Batch service.

BatchErrorDetail

An item of additional information included in an Azure Batch error response.

BatchErrorException

Exception thrown for an invalid response with BatchError information.

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.

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 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.

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.

ImageReference

A reference to an Azure Virtual Machines Marketplace image or a custom Azure Virtual Machine image. To get the list of all Azure Marketplace image references verified by Azure Batch, see the 'List node agent SKUs' 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.

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 node.

MetadataItem

A name-value pair associated with a Batch service resource.

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.

NodeAgentInformation

Information about the node agent.

NodeAgentSku

A node agent SKU supported by the Batch service.

NodeCounts

The number of nodes in each 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 node.

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.

Page<T>

Defines a page in Azure responses.

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 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.

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 compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.

StartTaskInformation

Information about a start task 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. Any task that is explicitly specified or within a dependency range must complete before the dependant task will be scheduled.

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. All tasks with IDs in the range must complete successfully before the dependent task can be scheduled.

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 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 node.

Interfaces

IODataExpand

Represents an options object supporting the OData $expand parameter.

IODataFilter

Represents an options object supporting the OData $filter parameter.

IODataSelect

Represents an options object supporting the OData $select parameter.

IOptions

Optional arguments applicable to all service requests.

ITimeoutOptions

Optional arguments for service requests which support timeouts.

Enums

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.

DependencyAction

Defines values for DependencyAction.

DisableComputeNodeSchedulingOption

Defines values for DisableComputeNodeSchedulingOption.

DisableJobOption

Defines values for DisableJobOption.

DynamicVNetAssignmentScope

Defines values for DynamicVNetAssignmentScope.

ElevationLevel

Defines values for ElevationLevel.

ErrorCategory

Defines values for ErrorCategory.

InboundEndpointProtocol

Defines values for InboundEndpointProtocol.

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.