# 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.
NewApplicationClient creates an instance of the ApplicationClient client.
NewApplicationClientWithBaseURI creates an instance of the ApplicationClient client.
NewCertificateClient creates an instance of the CertificateClient client.
NewCertificateClientWithBaseURI creates an instance of the CertificateClient client.
NewComputeNodeClient creates an instance of the ComputeNodeClient client.
NewComputeNodeClientWithBaseURI creates an instance of the ComputeNodeClient client.
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.
NewPoolClient creates an instance of the PoolClient client.
NewPoolClientWithBaseURI creates an instance of the PoolClient client.
NewTaskClient creates an instance of the TaskClient client.
NewTaskClientWithBaseURI creates an instance of the TaskClient client.
NewWithBaseURI creates an instance of the BaseClient client.
PossibleAllocationStateValues returns an array of possible values for the AllocationState 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.
PossibleDisableComputeNodeSchedulingOptionValues returns an array of possible values for the DisableComputeNodeSchedulingOption const type.
PossibleDisableJobOptionValues returns an array of possible values for the DisableJobOption 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.
PossibleOSTypeValues returns an array of possible values for the OSType 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.
PossibleSchedulingErrorCategoryValues returns an array of possible values for the SchedulingErrorCategory 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.
PossibleTaskAddStatusValues returns an array of possible values for the TaskAddStatus 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 ...
Cer ...
CertificateStoreLocationCurrentuser ...
CertificateStoreLocationLocalmachine ...
CertificateStoreLocationUnmapped ...
CertificateVisibilityRemoteuser ...
CertificateVisibilityStarttask ...
CertificateVisibilityTask ...
CertificateVisibilityUnmapped ...
ComputeNodeFillTypePack ...
ComputeNodeFillTypeSpread ...
ComputeNodeFillTypeUnmapped ...
ComputeNodeRebootOptionRequeue ...
ComputeNodeRebootOptionRetaineddata ...
ComputeNodeRebootOptionTaskcompletion ...
ComputeNodeRebootOptionTerminate ...
ComputeNodeReimageOptionRequeue ...
ComputeNodeReimageOptionRetaineddata ...
ComputeNodeReimageOptionTaskcompletion ...
ComputeNodeReimageOptionTerminate ...
Creating ...
DefaultBaseURI is the default URI used for the service Batch.
Deletefailed ...
Deleting ...
DisableComputeNodeSchedulingOptionRequeue ...
DisableComputeNodeSchedulingOptionTaskcompletion ...
DisableComputeNodeSchedulingOptionTerminate ...
Disabled ...
DisableJobOptionRequeue ...
DisableJobOptionTerminate ...
DisableJobOptionWait ...
Enabled ...
Idle ...
JobPreparationTaskStateCompleted ...
JobPreparationTaskStateRunning ...
JobReleaseTaskStateCompleted ...
JobReleaseTaskStateRunning ...
JobScheduleStateActive ...
JobScheduleStateCompleted ...
JobScheduleStateDeleting ...
JobScheduleStateDisabled ...
JobScheduleStateTerminating ...
JobStateActive ...
JobStateCompleted ...
JobStateDeleting ...
JobStateDisabled ...
JobStateDisabling ...
JobStateEnabling ...
JobStateTerminating ...
Leavingpool ...
Offline ...
OSTypeLinux ...
OSTypeUnmapped ...
OSTypeWindows ...
Pfx ...
PoolLifetimeOptionJob ...
PoolLifetimeOptionJobschedule ...
PoolLifetimeOptionUnmapped ...
PoolStateActive ...
PoolStateDeleting ...
PoolStateUpgrading ...
Rebooting ...
Reimaging ...
Requeue ...
Resizing ...
Retaineddata ...
Running ...
SchedulingErrorCategoryServererror ...
SchedulingErrorCategoryUnmapped ...
SchedulingErrorCategoryUsererror ...
Starting ...
Starttaskfailed ...
StartTaskStateCompleted ...
StartTaskStateRunning ...
Steady ...
Stopping ...
TaskAddStatusClienterror ...
TaskAddStatusServererror ...
TaskAddStatusSuccess ...
TaskAddStatusUnmapped ...
Taskcompletion ...
TaskStateActive ...
TaskStateCompleted ...
TaskStatePreparing ...
TaskStateRunning ...
Terminate ...
Unknown ...
Unmapped ...
Unusable ...
Waitingforstarttask ...
# Structs
AccountClient is the a client for issuing REST requests to the Azure Batch service.
AccountListNodeAgentSkusResult response to an AccountOperation.ListNodeAgentSkus request.
AccountListNodeAgentSkusResultIterator provides access to a complete listing of NodeAgentSku values.
AccountListNodeAgentSkusResultPage contains a page of NodeAgentSku values.
AffinityInformation a locality hint that can be used by the Batch service to select a compute node on which to start a task.
ApplicationClient is the a client for issuing REST requests to the Azure Batch service.
ApplicationListResult response to a ApplicationOperations.List request.
ApplicationListResultIterator provides access to a complete listing of ApplicationSummary values.
ApplicationListResultPage contains a page of ApplicationSummary values.
ApplicationPackageReference a reference to an application package to be installed on compute nodes in a pool.
ApplicationSummary contains information about an application in an Azure Batch account.
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.
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 a certificate that can be installed on compute nodes and can be used to authenticate operations on the machine.
CertificateClient is the a client for issuing REST requests to the Azure Batch service.
CertificateListResult response to a CertificateOperation.List request.
CertificateListResultIterator provides access to a complete listing of Certificate values.
CertificateListResultPage contains a page of Certificate values.
CertificateReference a reference to a certificate to be installed on compute nodes in a pool.
CloudJob an Azure Batch job.
CloudJobListPreparationAndReleaseTaskStatusResult response to a CloudJobOperations.ListPreparationAndReleaseTaskStatus request.
CloudJobListPreparationAndReleaseTaskStatusResultIterator provides access to a complete listing of JobPreparationAndReleaseTaskExecutionInformation values.
CloudJobListPreparationAndReleaseTaskStatusResultPage contains a page of JobPreparationAndReleaseTaskExecutionInformation values.
CloudJobListResult response to a CloudJobOperation.List or ListFromJobSchedule request.
CloudJobListResultIterator provides access to a complete listing of CloudJob values.
CloudJobListResultPage contains a page of CloudJob values.
CloudJobSchedule a job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.
CloudJobScheduleListResult response to a CloudJobScheduleOperation.List request.
CloudJobScheduleListResultIterator provides access to a complete listing of CloudJobSchedule values.
CloudJobScheduleListResultPage contains a page of CloudJobSchedule values.
CloudPool a pool in the Azure Batch service.
CloudPoolListResult response to a CloudPoolOperations.List request.
CloudPoolListResultIterator provides access to a complete listing of CloudPool values.
CloudPoolListResultPage contains a page of CloudPool values.
CloudServiceConfiguration the configuration for nodes in a pool based on the Azure Cloud Services platform.
CloudTask an Azure Batch task.
CloudTaskListResult response to a CloudTaskOperations.List request.
CloudTaskListResultIterator provides access to a complete listing of CloudTask values.
CloudTaskListResultPage contains a page of CloudTask values.
CloudTaskListSubtasksResult response to a CloudTaskOperations.ListSubtasks request.
ComputeNode a compute node in the Batch service.
ComputeNodeClient is the a client for issuing REST requests to the Azure Batch service.
ComputeNodeError an error encountered by a compute node.
ComputeNodeGetRemoteLoginSettingsResult response to a ComputeNodeOperation.GetRemoteLoginSettings request.
ComputeNodeInformation information about the compute node on which a task ran.
ComputeNodeListResult response to a ComputeNodeOperation.List request.
ComputeNodeListResultIterator provides access to a complete listing of ComputeNode values.
ComputeNodeListResultPage contains a page of ComputeNode values.
ComputeNodeUser an user account on a compute node.
DeleteCertificateError an error encountered by the Batch service when deleting a certificate.
EnvironmentSetting an environment variable to be set on a task process.
Error an error response received from the Azure Batch service.
ErrorDetail an item of additional information included in an Azure Batch error response.
ErrorMessage an error message received in an Azure Batch error response.
FileClient is the a client for issuing REST requests to the Azure Batch service.
FileProperties the properties of a file on a compute node.
ImageReference a reference to an Azure Virtual Machines Marketplace image.
JobAddParameter an Azure Batch job to add.
JobClient is the a client for issuing REST requests to the Azure Batch service.
JobConstraints specifies the execution constraints for jobs created on a schedule.
JobDisableParameter parameters for a CloudJobOperations.Disable request.
JobExecutionInformation contains information about the execution of a job in the Azure Batch service.
JobManagerTask specifies details of a Job Manager task.
JobPatchParameter parameters for a CloudJobOperations.Patch request.
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.
JobScheduleAddParameter a job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.
JobScheduleClient is the a client for issuing REST requests to the Azure Batch service.
JobScheduleExecutionInformation specifies how tasks should be run in a job associated with a job schedule.
JobSchedulePatchParameter parameters for a CloudJobScheduleOperations.Patch request.
JobScheduleStatistics resource usage statistics for a job schedule.
JobScheduleUpdateParameter parameters for a CloudJobScheduleOperations.Update request.
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.
JobTerminateParameter parameters for a CloudJobOperations.Terminate request.
JobUpdateParameter parameters for a CloudJobOperations.Update request.
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.
NodeAgentSku a node agent SKU supported by the Batch service.
NodeDisableSchedulingParameter parameters for a ComputeNodeOperations.DisableScheduling request.
NodeFile information about a file or directory on a compute node.
NodeFileListResult response to a FileOperation.ListFromComputeNode or FileOperation.ListFromTask request.
NodeFileListResultIterator provides access to a complete listing of NodeFile values.
NodeFileListResultPage contains a page of NodeFile values.
NodeRebootParameter parameters for a ComputeNodeOperations.Reboot request.
NodeReimageParameter parameters for a ComputeNodeOperations.Reimage request.
NodeRemoveParameter parameters for a ComputeNodeOperations.Remove request.
NodeUpdateUserParameter parameters for a ComputeNodeOperations.UpdateUser request.
PoolAddParameter a pool in the Azure Batch service to add.
PoolClient is the a client for issuing REST requests to the Azure Batch service.
PoolEnableAutoScaleParameter parameters for a CloudPoolOperations.EnableAutoScale request.
PoolEvaluateAutoScaleParameter parameters for a CloudJobOperations.EvaluateAutoScale request.
PoolInformation specifies how a job should be assigned to a pool.
PoolListPoolUsageMetricsResult response to an AccountOperation.ListPoolUsageMetrics request.
PoolListPoolUsageMetricsResultIterator provides access to a complete listing of PoolUsageMetrics values.
PoolListPoolUsageMetricsResultPage contains a page of PoolUsageMetrics values.
PoolPatchParameter parameters for a CloudPoolOperations.Patch request.
PoolResizeParameter parameters for a CloudPoolOperations.Resize request.
PoolSpecification specification for creating a new pool.
PoolStatistics contains utilization and resource usage statistics for the lifetime of a pool.
PoolUpdatePropertiesParameter parameters for a CloudPoolOperations.UpdateProperties request.
PoolUpgradeOSParameter parameters for a CloudPoolOperations.UpgradeOS request.
PoolUsageMetrics usage metrics for a pool across an aggregation interval.
ReadCloser ...
RecentJob information about the most recent job to run under the job schedule.
ResizeError an error that occurred when resizing a pool.
ResourceFile a file to be downloaded from Azure blob storage 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.
TaskAddCollectionParameter a collection of Azure Batch tasks to add.
TaskAddCollectionResult response to a TaskOperations.AddCollection request.
TaskAddParameter an Azure Batch task to add.
TaskAddResult result for a single task added as part of an add task collection operation.
TaskClient is the a client for issuing REST requests to the Azure Batch service.
TaskConstraints constraints to apply to the Job Manager task.
TaskDependencies specifies any dependencies of a task.
TaskExecutionInformation information about the execution of a task.
TaskIDRange a range of task ids that a task can depend on.
TaskInformation information about a task running on a compute node.
TaskSchedulingError information about an error when scheduling a task.
TaskSchedulingPolicy specifies how tasks should be distributed across compute nodes.
TaskStatistics resource usage statistics for a task.
TaskUpdateParameter parameters for a CloudTaskOperations.Update request.
UsageStatistics statistics related to pool usage information.
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.
# Type aliases
AllocationState enumerates the values for allocation state.
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.
DisableComputeNodeSchedulingOption enumerates the values for disable compute node scheduling option.
DisableJobOption enumerates the values for disable job option.
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.
OSType enumerates the values for os type.
PoolLifetimeOption enumerates the values for pool lifetime option.
PoolState enumerates the values for pool state.
SchedulingErrorCategory enumerates the values for scheduling error category.
SchedulingState enumerates the values for scheduling state.
StartTaskState enumerates the values for start task state.
TaskAddStatus enumerates the values for task add status.
TaskState enumerates the values for task state.