# Packages
No description provided by the author
# Functions
New creates an instance of the BaseClient client.
NewAccountClient creates an instance of the AccountClient client.
NewAccountClientWithBaseURI creates an instance of the AccountClient client.
Creates a new instance of the AccountListNodeAgentSkusResultIterator type.
Creates a new instance of the AccountListNodeAgentSkusResultPage type.
NewApplicationClient creates an instance of the ApplicationClient client.
NewApplicationClientWithBaseURI creates an instance of the ApplicationClient client.
Creates a new instance of the ApplicationListResultIterator type.
Creates a new instance of the ApplicationListResultPage type.
NewCertificateClient creates an instance of the CertificateClient client.
NewCertificateClientWithBaseURI creates an instance of the CertificateClient client.
Creates a new instance of the CertificateListResultIterator type.
Creates a new instance of the CertificateListResultPage type.
Creates a new instance of the CloudJobListPreparationAndReleaseTaskStatusResultIterator type.
Creates a new instance of the CloudJobListPreparationAndReleaseTaskStatusResultPage type.
Creates a new instance of the CloudJobListResultIterator type.
Creates a new instance of the CloudJobListResultPage type.
Creates a new instance of the CloudJobScheduleListResultIterator type.
Creates a new instance of the CloudJobScheduleListResultPage type.
Creates a new instance of the CloudPoolListResultIterator type.
Creates a new instance of the CloudPoolListResultPage type.
Creates a new instance of the CloudTaskListResultIterator type.
Creates a new instance of the CloudTaskListResultPage type.
NewComputeNodeClient creates an instance of the ComputeNodeClient client.
NewComputeNodeClientWithBaseURI creates an instance of the ComputeNodeClient client.
Creates a new instance of the ComputeNodeListResultIterator type.
Creates a new instance of the ComputeNodeListResultPage type.
NewFileClient creates an instance of the FileClient client.
NewFileClientWithBaseURI creates an instance of the FileClient client.
NewJobClient creates an instance of the JobClient client.
NewJobClientWithBaseURI creates an instance of the JobClient client.
NewJobScheduleClient creates an instance of the JobScheduleClient client.
NewJobScheduleClientWithBaseURI creates an instance of the JobScheduleClient client.
Creates a new instance of the NodeFileListResultIterator type.
Creates a new instance of the NodeFileListResultPage type.
NewPoolClient creates an instance of the PoolClient client.
NewPoolClientWithBaseURI creates an instance of the PoolClient client.
Creates a new instance of the PoolListUsageMetricsResultIterator type.
Creates a new instance of the PoolListUsageMetricsResultPage type.
Creates a new instance of the PoolNodeCountsListResultIterator type.
Creates a new instance of the PoolNodeCountsListResultPage type.
NewTaskClient creates an instance of the TaskClient client.
NewTaskClientWithBaseURI creates an instance of the TaskClient client.
NewWithBaseURI creates an instance of the BaseClient client.
PossibleAccessScopeValues returns an array of possible values for the AccessScope const type.
PossibleAllocationStateValues returns an array of possible values for the AllocationState const type.
PossibleAutoUserScopeValues returns an array of possible values for the AutoUserScope const type.
PossibleCachingTypeValues returns an array of possible values for the CachingType const type.
PossibleCertificateFormatValues returns an array of possible values for the CertificateFormat const type.
PossibleCertificateStateValues returns an array of possible values for the CertificateState const type.
PossibleCertificateStoreLocationValues returns an array of possible values for the CertificateStoreLocation const type.
PossibleCertificateVisibilityValues returns an array of possible values for the CertificateVisibility const type.
PossibleComputeNodeDeallocationOptionValues returns an array of possible values for the ComputeNodeDeallocationOption const type.
PossibleComputeNodeFillTypeValues returns an array of possible values for the ComputeNodeFillType const type.
PossibleComputeNodeRebootOptionValues returns an array of possible values for the ComputeNodeRebootOption const type.
PossibleComputeNodeReimageOptionValues returns an array of possible values for the ComputeNodeReimageOption const type.
PossibleComputeNodeStateValues returns an array of possible values for the ComputeNodeState const type.
PossibleDependencyActionValues returns an array of possible values for the DependencyAction const type.
PossibleDisableComputeNodeSchedulingOptionValues returns an array of possible values for the DisableComputeNodeSchedulingOption const type.
PossibleDisableJobOptionValues returns an array of possible values for the DisableJobOption const type.
PossibleElevationLevelValues returns an array of possible values for the ElevationLevel const type.
PossibleErrorCategoryValues returns an array of possible values for the ErrorCategory const type.
PossibleInboundEndpointProtocolValues returns an array of possible values for the InboundEndpointProtocol const type.
PossibleJobActionValues returns an array of possible values for the JobAction const type.
PossibleJobPreparationTaskStateValues returns an array of possible values for the JobPreparationTaskState const type.
PossibleJobReleaseTaskStateValues returns an array of possible values for the JobReleaseTaskState const type.
PossibleJobScheduleStateValues returns an array of possible values for the JobScheduleState const type.
PossibleJobStateValues returns an array of possible values for the JobState const type.
PossibleNetworkSecurityGroupRuleAccessValues returns an array of possible values for the NetworkSecurityGroupRuleAccess const type.
PossibleOnAllTasksCompleteValues returns an array of possible values for the OnAllTasksComplete const type.
PossibleOnTaskFailureValues returns an array of possible values for the OnTaskFailure const type.
PossibleOSTypeValues returns an array of possible values for the OSType const type.
PossibleOutputFileUploadConditionValues returns an array of possible values for the OutputFileUploadCondition const type.
PossiblePoolLifetimeOptionValues returns an array of possible values for the PoolLifetimeOption const type.
PossiblePoolStateValues returns an array of possible values for the PoolState const type.
PossibleSchedulingStateValues returns an array of possible values for the SchedulingState const type.
PossibleStartTaskStateValues returns an array of possible values for the StartTaskState const type.
PossibleStorageAccountTypeValues returns an array of possible values for the StorageAccountType const type.
PossibleSubtaskStateValues returns an array of possible values for the SubtaskState const type.
PossibleTaskAddStatusValues returns an array of possible values for the TaskAddStatus const type.
PossibleTaskCountValidationStatusValues returns an array of possible values for the TaskCountValidationStatus const type.
PossibleTaskExecutionResultValues returns an array of possible values for the TaskExecutionResult const type.
PossibleTaskStateValues returns an array of possible values for the TaskState const type.
UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
# Constants
Active The certificate is available for use in pools.
Admin The user is a user with elevated access and operates with full Administrator permissions.
Allow Allow access.
Block Block the task's dependencies.
Cer The certificate is a base64-encoded X.509 certificate.
CertificateVisibilityRemoteUser The certificate should be visible to the user accounts under which users remotely access the node.
CertificateVisibilityStartTask The certificate should be visible to the user account under which the start task is run.
CertificateVisibilityTask The certificate should be visible to the user accounts under which job tasks are run.
ComputeNodeRebootOptionRequeue Terminate running task processes and requeue the tasks.
ComputeNodeRebootOptionRetainedData Allow currently running tasks to complete, then wait for all task data retention periods to expire.
ComputeNodeRebootOptionTaskCompletion Allow currently running tasks to complete.
ComputeNodeRebootOptionTerminate Terminate running tasks.
ComputeNodeReimageOptionRequeue Terminate running task processes and requeue the tasks.
ComputeNodeReimageOptionRetainedData Allow currently running tasks to complete, then wait for all task data retention periods to expire.
ComputeNodeReimageOptionTaskCompletion Allow currently running tasks to complete.
ComputeNodeReimageOptionTerminate Terminate running tasks.
Creating The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool.
CurrentUser Certificates should be installed to the CurrentUser certificate store.
DefaultBaseURI is the default URI used for the service Batch.
DeleteFailed The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes.
Deleting The user has requested that the certificate be deleted, but the delete operation has not yet completed.
Deny Deny access.
DisableComputeNodeSchedulingOptionRequeue Terminate running task processes and requeue the tasks.
DisableComputeNodeSchedulingOptionTaskCompletion Allow currently running tasks to complete.
DisableComputeNodeSchedulingOptionTerminate Terminate running tasks.
Disabled No new tasks will be scheduled on the node.
DisableJobOptionRequeue Terminate running tasks and requeue them.
DisableJobOptionTerminate Terminate running tasks.
DisableJobOptionWait Allow currently running tasks to complete.
Enabled Tasks can be scheduled on the node.
Failure There was an error during processing of the task.
Idle The node is not currently running a task.
Job Grants access to perform all operations on the job containing the task.
JobActionDisable Disable the job.
JobActionNone Take no action.
JobActionTerminate Terminate the job.
JobPreparationTaskStateCompleted The task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures).
JobPreparationTaskStateRunning The task is currently running (including retrying).
JobReleaseTaskStateCompleted The task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures).
JobReleaseTaskStateRunning The task is currently running (including retrying).
JobScheduleStateActive The job schedule is active and will create jobs as per its schedule.
JobScheduleStateCompleted The schedule has terminated, either by reaching its end time or by the user terminating it explicitly.
JobScheduleStateDeleting The user has requested that the schedule be deleted, but the delete operation is still in progress.
JobScheduleStateDisabled The user has disabled the schedule.
JobScheduleStateTerminating The schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress.
JobStateActive The job is available to have tasks scheduled.
JobStateCompleted All tasks have terminated, and the system will not accept any more tasks or any further changes to the job.
JobStateDeleting A user has requested that the job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running tasks).
JobStateDisabled A user has disabled the job.
JobStateDisabling A user has requested that the job be disabled, but the disable operation is still in progress (for example, waiting for tasks to terminate).
JobStateEnabling A user has requested that the job be enabled, but the enable operation is still in progress.
JobStateTerminating The job is about to complete, either because a Job Manager task has completed or because the user has terminated the job, but the terminate operation is still in progress (for example, because Job Release tasks are running).
LeavingPool The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down.
Linux The Linux operating system.
LocalMachine Certificates should be installed to the LocalMachine certificate store.
NoAction Do nothing.
NonAdmin The user is a standard user without elevated access.
None The caching mode for the disk is not enabled.
Offline The node is not currently running a task, and scheduling of new tasks to the node is disabled.
OnTaskFailureNoAction Do nothing.
OnTaskFailurePerformExitOptionsJobAction Take the action associated with the task exit condition in the task's exitConditions collection.
OutputFileUploadConditionTaskCompletion Upload the file(s) after the task process exits, no matter what the exit code was.
OutputFileUploadConditionTaskFailure Upload the file(s) only after the task process exits with a nonzero exit code.
OutputFileUploadConditionTaskSuccess Upload the file(s) only after the task process exits with an exit code of 0.
Pack As many tasks as possible (maxTasksPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool.
Pfx The certificate is a PFX (PKCS#12) formatted certificate or certificate chain.
Pool Specifies that the task runs as the common auto user account which is created on every node in a pool.
PoolLifetimeOptionJob The pool exists for the lifetime of the job to which it is dedicated.
PoolLifetimeOptionJobSchedule The pool exists for the lifetime of the job schedule.
PoolStateActive The pool is available to run tasks subject to the availability of compute nodes.
PoolStateDeleting The user has requested that the pool be deleted, but the delete operation has not yet completed.
PoolStateUpgrading The user has requested that the operating system of the pool's nodes be upgraded, but the upgrade operation has not yet completed (that is, some nodes in the pool have not yet been upgraded).
Preempted The low-priority node has been preempted.
PremiumLRS The data disk should use premium locally redundant storage.
ReadOnly The caching mode for the disk is read only.
ReadWrite The caching mode for the disk is read and write.
Rebooting The node is rebooting.
Reimaging The node is reimaging.
Requeue Terminate running task processes and requeue the tasks.
Resizing The pool is resizing; that is, compute nodes are being added to or removed from the pool.
RetainedData Allow currently running tasks to complete, then wait for all task data retention periods to expire.
Running The node is running one or more tasks (other than a start task).
Satisfy Satisfy the task's dependencies.
ServerError The error is due to an internal server issue.
Spread Tasks should be assigned evenly across all nodes in the pool.
StandardLRS The data disk should use standard locally redundant storage.
Starting The Batch service is starting on the underlying virtual machine.
StartTaskFailed The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set.
StartTaskStateCompleted The start task has exited with exit code 0, or the start task has failed and the retry limit has reached, or the start task process did not run due to task preparation errors (such as resource file download failures).
StartTaskStateRunning The start task is currently running.
Steady The pool is not resizing.
Stopping The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed.
SubtaskStateCompleted The task is no longer eligible to run, usually because the task has finished successfully, or the task has finished unsuccessfully and has exhausted its retry limit.
SubtaskStatePreparing The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node.
SubtaskStateRunning The task is running on a compute node.
Success The task ran successfully.
Task Specifies that the service should create a new user for the task.
TaskAddStatusClientError The task failed to add due to a client error and should not be retried without modifying the request as appropriate.
TaskAddStatusServerError Task failed to add due to a server error and can be retried without modification.
TaskAddStatusSuccess The task was added successfully.
TaskCompletion Allow currently running tasks to complete.
TaskStateActive The task is queued and able to run, but is not currently assigned to a compute node.
TaskStateCompleted The task is no longer eligible to run, usually because the task has finished successfully, or the task has finished unsuccessfully and has exhausted its retry limit.
TaskStatePreparing The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node.
TaskStateRunning The task is running on a compute node.
TCP Use TCP for the endpoint.
Terminate Terminate running tasks.
TerminateJob Terminate the job.
UDP Use UDP for the endpoint.
Unknown The Batch service has lost contact with the node, and does not know its true state.
Unusable The node cannot be used for task execution due to errors.
Unvalidated The Batch service has not been able to check state counts against the task states as reported in the List Tasks API.
UserError The error is due to a user issue, such as misconfiguration.
Validated The Batch service has validated the state counts against the task states as reported in the List Tasks API.
WaitingForStartTask The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed.
Windows The Windows operating system.
# Structs
AccountClient is the a client for issuing REST requests to the Azure Batch service.
AccountListNodeAgentSkusResult ...
AccountListNodeAgentSkusResultIterator provides access to a complete listing of NodeAgentSku values.
AccountListNodeAgentSkusResultPage contains a page of NodeAgentSku values.
AffinityInformation ...
ApplicationClient is the a client for issuing REST requests to the Azure Batch service.
ApplicationListResult ...
ApplicationListResultIterator provides access to a complete listing of ApplicationSummary values.
ApplicationListResultPage contains a page of ApplicationSummary values.
ApplicationPackageReference ...
ApplicationSummary ...
AuthenticationTokenSettings ...
AutoPoolSpecification ...
AutoScaleRun ...
AutoScaleRunError ...
AutoUserSpecification ...
BaseClient is the base client for Batch.
Certificate a certificate that can be installed on compute nodes and can be used to authenticate operations on the machine.
CertificateAddParameter ...
CertificateClient is the a client for issuing REST requests to the Azure Batch service.
CertificateListResult ...
CertificateListResultIterator provides access to a complete listing of Certificate values.
CertificateListResultPage contains a page of Certificate values.
CertificateReference ...
CloudJob ...
CloudJobListPreparationAndReleaseTaskStatusResult ...
CloudJobListPreparationAndReleaseTaskStatusResultIterator provides access to a complete listing of JobPreparationAndReleaseTaskExecutionInformation values.
CloudJobListPreparationAndReleaseTaskStatusResultPage contains a page of JobPreparationAndReleaseTaskExecutionInformation values.
CloudJobListResult ...
CloudJobListResultIterator provides access to a complete listing of CloudJob values.
CloudJobListResultPage contains a page of CloudJob values.
CloudJobSchedule ...
CloudJobScheduleListResult ...
CloudJobScheduleListResultIterator provides access to a complete listing of CloudJobSchedule values.
CloudJobScheduleListResultPage contains a page of CloudJobSchedule values.
CloudPool ...
CloudPoolListResult ...
CloudPoolListResultIterator provides access to a complete listing of CloudPool values.
CloudPoolListResultPage contains a page of CloudPool values.
CloudServiceConfiguration ...
CloudTask batch will retry tasks when a recovery operation is triggered on a compute node.
CloudTaskListResult ...
CloudTaskListResultIterator provides access to a complete listing of CloudTask values.
CloudTaskListResultPage contains a page of CloudTask values.
CloudTaskListSubtasksResult ...
ComputeNode ...
ComputeNodeClient is the a client for issuing REST requests to the Azure Batch service.
ComputeNodeEndpointConfiguration ...
ComputeNodeError ...
ComputeNodeGetRemoteLoginSettingsResult ...
ComputeNodeInformation ...
ComputeNodeListResult ...
ComputeNodeListResultIterator provides access to a complete listing of ComputeNode values.
ComputeNodeListResultPage contains a page of ComputeNode values.
ComputeNodeUser ...
ContainerConfiguration ...
ContainerRegistry ...
DataDisk ...
DeleteCertificateError ...
EnvironmentSetting ...
Error ...
ErrorDetail ...
ErrorMessage ...
ExitCodeMapping ...
ExitCodeRangeMapping ...
ExitConditions ...
ExitOptions ...
FileClient is the a client for issuing REST requests to the Azure Batch service.
FileProperties ...
ImageReference ...
InboundEndpoint ...
InboundNATPool ...
JobAddParameter ...
JobClient is the a client for issuing REST requests to the Azure Batch service.
JobConstraints ...
JobDisableParameter ...
JobExecutionInformation ...
JobManagerTask the Job Manager task is automatically started when the job is created.
JobPatchParameter ...
JobPreparationAndReleaseTaskExecutionInformation ...
JobPreparationTask you can use Job Preparation to prepare a compute node to run tasks for the job.
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.
JobReleaseTaskExecutionInformation ...
JobScheduleAddParameter ...
JobScheduleClient is the a client for issuing REST requests to the Azure Batch service.
JobScheduleExecutionInformation ...
JobSchedulePatchParameter ...
JobScheduleStatistics ...
JobScheduleUpdateParameter ...
JobSchedulingError ...
JobSpecification ...
JobStatistics ...
JobTerminateParameter ...
JobUpdateParameter ...
LinuxUserConfiguration ...
MetadataItem the Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
MultiInstanceSettings multi-instance tasks are commonly used to support MPI tasks.
NameValuePair ...
NetworkConfiguration the network configuration for a pool.
NetworkSecurityGroupRule ...
NodeAgentSku the Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service.
NodeCounts ...
NodeDisableSchedulingParameter ...
NodeFile ...
NodeFileListResult ...
NodeFileListResultIterator provides access to a complete listing of NodeFile values.
NodeFileListResultPage contains a page of NodeFile values.
NodeRebootParameter ...
NodeReimageParameter ...
NodeRemoveParameter ...
NodeUpdateUserParameter ...
OSDisk ...
OutputFile ...
OutputFileBlobContainerDestination ...
OutputFileDestination ...
OutputFileUploadOptions ...
PoolAddParameter ...
PoolClient is the a client for issuing REST requests to the Azure Batch service.
PoolEnableAutoScaleParameter ...
PoolEndpointConfiguration ...
PoolEvaluateAutoScaleParameter ...
PoolInformation ...
PoolListUsageMetricsResult ...
PoolListUsageMetricsResultIterator provides access to a complete listing of PoolUsageMetrics values.
PoolListUsageMetricsResultPage contains a page of PoolUsageMetrics values.
PoolNodeCounts ...
PoolNodeCountsListResult ...
PoolNodeCountsListResultIterator provides access to a complete listing of PoolNodeCounts values.
PoolNodeCountsListResultPage contains a page of PoolNodeCounts values.
PoolPatchParameter ...
PoolResizeParameter ...
PoolSpecification ...
PoolStatistics ...
PoolUpdatePropertiesParameter ...
PoolUpgradeOSParameter ...
PoolUsageMetrics ...
ReadCloser ...
RecentJob ...
ResizeError ...
ResourceFile ...
ResourceStatistics ...
Schedule ...
StartTask batch will retry tasks when a recovery operation is triggered on a compute node.
StartTaskInformation ...
SubtaskInformation ...
TaskAddCollectionParameter ...
TaskAddCollectionResult ...
TaskAddParameter batch will retry tasks when a recovery operation is triggered on a compute node.
TaskAddResult ...
TaskClient is the a client for issuing REST requests to the Azure Batch service.
TaskConstraints ...
TaskContainerExecutionInformation ...
TaskContainerSettings ...
TaskCounts ...
TaskDependencies ...
TaskExecutionInformation ...
TaskFailureInformation ...
TaskIDRange the start and end of the range are inclusive.
TaskInformation ...
TaskSchedulingPolicy ...
TaskStatistics ...
TaskUpdateParameter ...
UploadBatchServiceLogsConfiguration ...
UploadBatchServiceLogsResult ...
UsageStatistics ...
UserAccount ...
UserIdentity specify either the userName or autoUser property, but not both.
VirtualMachineConfiguration ...
WindowsConfiguration ...
# Type aliases
AccessScope enumerates the values for access scope.
AllocationState enumerates the values for allocation state.
AutoUserScope enumerates the values for auto user scope.
CachingType enumerates the values for caching type.
CertificateFormat enumerates the values for certificate format.
CertificateState enumerates the values for certificate state.
CertificateStoreLocation enumerates the values for certificate store location.
CertificateVisibility enumerates the values for certificate visibility.
ComputeNodeDeallocationOption enumerates the values for compute node deallocation option.
ComputeNodeFillType enumerates the values for compute node fill type.
ComputeNodeRebootOption enumerates the values for compute node reboot option.
ComputeNodeReimageOption enumerates the values for compute node reimage option.
ComputeNodeState enumerates the values for compute node state.
DependencyAction enumerates the values for dependency action.
DisableComputeNodeSchedulingOption enumerates the values for disable compute node scheduling option.
DisableJobOption enumerates the values for disable job option.
ElevationLevel enumerates the values for elevation level.
ErrorCategory enumerates the values for error category.
InboundEndpointProtocol enumerates the values for inbound endpoint protocol.
JobAction enumerates the values for job action.
JobPreparationTaskState enumerates the values for job preparation task state.
JobReleaseTaskState enumerates the values for job release task state.
JobScheduleState enumerates the values for job schedule state.
JobState enumerates the values for job state.
NetworkSecurityGroupRuleAccess enumerates the values for network security group rule access.
OnAllTasksComplete enumerates the values for on all tasks complete.
OnTaskFailure enumerates the values for on task failure.
OSType enumerates the values for os type.
OutputFileUploadCondition enumerates the values for output file upload condition.
PoolLifetimeOption enumerates the values for pool lifetime option.
PoolState enumerates the values for pool state.
SchedulingState enumerates the values for scheduling state.
StartTaskState enumerates the values for start task state.
StorageAccountType enumerates the values for storage account type.
SubtaskState enumerates the values for subtask state.
TaskAddStatus enumerates the values for task add status.
TaskCountValidationStatus enumerates the values for task count validation status.
TaskExecutionResult enumerates the values for task execution result.
TaskState enumerates the values for task state.