1 package batch 2 3 // Copyright (c) Microsoft Corporation. All rights reserved. 4 // Licensed under the MIT License. See License.txt in the project root for license information. 5 // 6 // Code generated by Microsoft (R) AutoRest Code Generator. 7 // Changes may cause incorrect behavior and will be lost if the code is regenerated. 8 9 // AccessScope enumerates the values for access scope. 10 type AccessScope string 11 12 const ( 13 // Job Grants access to perform all operations on the Job containing the Task. 14 Job AccessScope = "job" 15 ) 16 17 // PossibleAccessScopeValues returns an array of possible values for the AccessScope const type. 18 func PossibleAccessScopeValues() []AccessScope { 19 return []AccessScope{Job} 20 } 21 22 // AllocationState enumerates the values for allocation state. 23 type AllocationState string 24 25 const ( 26 // Resizing The Pool is resizing; that is, Compute Nodes are being added to or removed from the Pool. 27 Resizing AllocationState = "resizing" 28 // Steady The Pool is not resizing. There are no changes to the number of Compute Nodes in the Pool in 29 // progress. A Pool enters this state when it is created and when no operations are being performed on the 30 // Pool to change the number of Compute Nodes. 31 Steady AllocationState = "steady" 32 // Stopping The Pool was resizing, but the user has requested that the resize be stopped, but the stop 33 // request has not yet been completed. 34 Stopping AllocationState = "stopping" 35 ) 36 37 // PossibleAllocationStateValues returns an array of possible values for the AllocationState const type. 38 func PossibleAllocationStateValues() []AllocationState { 39 return []AllocationState{Resizing, Steady, Stopping} 40 } 41 42 // AutoUserScope enumerates the values for auto user scope. 43 type AutoUserScope string 44 45 const ( 46 // Pool Specifies that the Task runs as the common auto user Account which is created on every Compute Node 47 // in a Pool. 48 Pool AutoUserScope = "pool" 49 // Task Specifies that the service should create a new user for the Task. 50 Task AutoUserScope = "task" 51 ) 52 53 // PossibleAutoUserScopeValues returns an array of possible values for the AutoUserScope const type. 54 func PossibleAutoUserScopeValues() []AutoUserScope { 55 return []AutoUserScope{Pool, Task} 56 } 57 58 // CachingType enumerates the values for caching type. 59 type CachingType string 60 61 const ( 62 // None The caching mode for the disk is not enabled. 63 None CachingType = "none" 64 // ReadOnly The caching mode for the disk is read only. 65 ReadOnly CachingType = "readonly" 66 // ReadWrite The caching mode for the disk is read and write. 67 ReadWrite CachingType = "readwrite" 68 ) 69 70 // PossibleCachingTypeValues returns an array of possible values for the CachingType const type. 71 func PossibleCachingTypeValues() []CachingType { 72 return []CachingType{None, ReadOnly, ReadWrite} 73 } 74 75 // CertificateFormat enumerates the values for certificate format. 76 type CertificateFormat string 77 78 const ( 79 // Cer The Certificate is a base64-encoded X.509 Certificate. 80 Cer CertificateFormat = "cer" 81 // Pfx The Certificate is a PFX (PKCS#12) formatted Certificate or Certificate chain. 82 Pfx CertificateFormat = "pfx" 83 ) 84 85 // PossibleCertificateFormatValues returns an array of possible values for the CertificateFormat const type. 86 func PossibleCertificateFormatValues() []CertificateFormat { 87 return []CertificateFormat{Cer, Pfx} 88 } 89 90 // CertificateState enumerates the values for certificate state. 91 type CertificateState string 92 93 const ( 94 // Active The Certificate is available for use in Pools. 95 Active CertificateState = "active" 96 // DeleteFailed The user requested that the Certificate be deleted, but there are Pools that still have 97 // references to the Certificate, or it is still installed on one or more Nodes. (The latter can occur if 98 // the Certificate has been removed from the Pool, but the Compute Node has not yet restarted. Compute 99 // Nodes refresh their Certificates only when they restart.) You may use the cancel Certificate delete 100 // operation to cancel the delete, or the delete Certificate operation to retry the delete. 101 DeleteFailed CertificateState = "deletefailed" 102 // Deleting The user has requested that the Certificate be deleted, but the delete operation has not yet 103 // completed. You may not reference the Certificate when creating or updating Pools. 104 Deleting CertificateState = "deleting" 105 ) 106 107 // PossibleCertificateStateValues returns an array of possible values for the CertificateState const type. 108 func PossibleCertificateStateValues() []CertificateState { 109 return []CertificateState{Active, DeleteFailed, Deleting} 110 } 111 112 // CertificateStoreLocation enumerates the values for certificate store location. 113 type CertificateStoreLocation string 114 115 const ( 116 // CurrentUser Certificates should be installed to the CurrentUser Certificate store. 117 CurrentUser CertificateStoreLocation = "currentuser" 118 // LocalMachine Certificates should be installed to the LocalMachine Certificate store. 119 LocalMachine CertificateStoreLocation = "localmachine" 120 ) 121 122 // PossibleCertificateStoreLocationValues returns an array of possible values for the CertificateStoreLocation const type. 123 func PossibleCertificateStoreLocationValues() []CertificateStoreLocation { 124 return []CertificateStoreLocation{CurrentUser, LocalMachine} 125 } 126 127 // CertificateVisibility enumerates the values for certificate visibility. 128 type CertificateVisibility string 129 130 const ( 131 // CertificateVisibilityRemoteUser The Certificate should be visible to the user accounts under which users 132 // remotely access the Compute Node. 133 CertificateVisibilityRemoteUser CertificateVisibility = "remoteuser" 134 // CertificateVisibilityStartTask The Certificate should be visible to the user account under which the 135 // StartTask is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this 136 // certificate will be visible to the Task as well. 137 CertificateVisibilityStartTask CertificateVisibility = "starttask" 138 // CertificateVisibilityTask The Certificate should be visible to the user accounts under which Job Tasks 139 // are run. 140 CertificateVisibilityTask CertificateVisibility = "task" 141 ) 142 143 // PossibleCertificateVisibilityValues returns an array of possible values for the CertificateVisibility const type. 144 func PossibleCertificateVisibilityValues() []CertificateVisibility { 145 return []CertificateVisibility{CertificateVisibilityRemoteUser, CertificateVisibilityStartTask, CertificateVisibilityTask} 146 } 147 148 // ComputeNodeDeallocationOption enumerates the values for compute node deallocation option. 149 type ComputeNodeDeallocationOption string 150 151 const ( 152 // Requeue Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute 153 // Node is available. Remove Compute Nodes as soon as Tasks have been terminated. 154 Requeue ComputeNodeDeallocationOption = "requeue" 155 // RetainedData Allow currently running Tasks to complete, then wait for all Task data retention periods to 156 // expire. Schedule no new Tasks while waiting. Remove Compute Nodes when all Task retention periods have 157 // expired. 158 RetainedData ComputeNodeDeallocationOption = "retaineddata" 159 // TaskCompletion Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Remove 160 // Compute Nodes when all Tasks have completed. 161 TaskCompletion ComputeNodeDeallocationOption = "taskcompletion" 162 // Terminate Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they 163 // were terminated, and will not run again. Remove Compute Nodes as soon as Tasks have been terminated. 164 Terminate ComputeNodeDeallocationOption = "terminate" 165 ) 166 167 // PossibleComputeNodeDeallocationOptionValues returns an array of possible values for the ComputeNodeDeallocationOption const type. 168 func PossibleComputeNodeDeallocationOptionValues() []ComputeNodeDeallocationOption { 169 return []ComputeNodeDeallocationOption{Requeue, RetainedData, TaskCompletion, Terminate} 170 } 171 172 // ComputeNodeFillType enumerates the values for compute node fill type. 173 type ComputeNodeFillType string 174 175 const ( 176 // Pack As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool 177 // before any Tasks are assigned to the next Compute Node in the Pool. 178 Pack ComputeNodeFillType = "pack" 179 // Spread Tasks should be assigned evenly across all Compute Nodes in the Pool. 180 Spread ComputeNodeFillType = "spread" 181 ) 182 183 // PossibleComputeNodeFillTypeValues returns an array of possible values for the ComputeNodeFillType const type. 184 func PossibleComputeNodeFillTypeValues() []ComputeNodeFillType { 185 return []ComputeNodeFillType{Pack, Spread} 186 } 187 188 // ComputeNodeRebootOption enumerates the values for compute node reboot option. 189 type ComputeNodeRebootOption string 190 191 const ( 192 // ComputeNodeRebootOptionRequeue Terminate running Task processes and requeue the Tasks. The Tasks will 193 // run again when a Compute Node is available. Restart the Compute Node as soon as Tasks have been 194 // terminated. 195 ComputeNodeRebootOptionRequeue ComputeNodeRebootOption = "requeue" 196 // ComputeNodeRebootOptionRetainedData Allow currently running Tasks to complete, then wait for all Task 197 // data retention periods to expire. Schedule no new Tasks while waiting. Restart the Compute Node when all 198 // Task retention periods have expired. 199 ComputeNodeRebootOptionRetainedData ComputeNodeRebootOption = "retaineddata" 200 // ComputeNodeRebootOptionTaskCompletion Allow currently running Tasks to complete. Schedule no new Tasks 201 // while waiting. Restart the Compute Node when all Tasks have completed. 202 ComputeNodeRebootOptionTaskCompletion ComputeNodeRebootOption = "taskcompletion" 203 // ComputeNodeRebootOptionTerminate Terminate running Tasks. The Tasks will be completed with failureInfo 204 // indicating that they were terminated, and will not run again. Restart the Compute Node as soon as Tasks 205 // have been terminated. 206 ComputeNodeRebootOptionTerminate ComputeNodeRebootOption = "terminate" 207 ) 208 209 // PossibleComputeNodeRebootOptionValues returns an array of possible values for the ComputeNodeRebootOption const type. 210 func PossibleComputeNodeRebootOptionValues() []ComputeNodeRebootOption { 211 return []ComputeNodeRebootOption{ComputeNodeRebootOptionRequeue, ComputeNodeRebootOptionRetainedData, ComputeNodeRebootOptionTaskCompletion, ComputeNodeRebootOptionTerminate} 212 } 213 214 // ComputeNodeReimageOption enumerates the values for compute node reimage option. 215 type ComputeNodeReimageOption string 216 217 const ( 218 // ComputeNodeReimageOptionRequeue Terminate running Task processes and requeue the Tasks. The Tasks will 219 // run again when a Compute Node is available. Reimage the Compute Node as soon as Tasks have been 220 // terminated. 221 ComputeNodeReimageOptionRequeue ComputeNodeReimageOption = "requeue" 222 // ComputeNodeReimageOptionRetainedData Allow currently running Tasks to complete, then wait for all Task 223 // data retention periods to expire. Schedule no new Tasks while waiting. Reimage the Compute Node when all 224 // Task retention periods have expired. 225 ComputeNodeReimageOptionRetainedData ComputeNodeReimageOption = "retaineddata" 226 // ComputeNodeReimageOptionTaskCompletion Allow currently running Tasks to complete. Schedule no new Tasks 227 // while waiting. Reimage the Compute Node when all Tasks have completed. 228 ComputeNodeReimageOptionTaskCompletion ComputeNodeReimageOption = "taskcompletion" 229 // ComputeNodeReimageOptionTerminate Terminate running Tasks. The Tasks will be completed with failureInfo 230 // indicating that they were terminated, and will not run again. Reimage the Compute Node as soon as Tasks 231 // have been terminated. 232 ComputeNodeReimageOptionTerminate ComputeNodeReimageOption = "terminate" 233 ) 234 235 // PossibleComputeNodeReimageOptionValues returns an array of possible values for the ComputeNodeReimageOption const type. 236 func PossibleComputeNodeReimageOptionValues() []ComputeNodeReimageOption { 237 return []ComputeNodeReimageOption{ComputeNodeReimageOptionRequeue, ComputeNodeReimageOptionRetainedData, ComputeNodeReimageOptionTaskCompletion, ComputeNodeReimageOptionTerminate} 238 } 239 240 // ComputeNodeState enumerates the values for compute node state. 241 type ComputeNodeState string 242 243 const ( 244 // Creating The Batch service has obtained the underlying virtual machine from Azure Compute, but it has 245 // not yet started to join the Pool. 246 Creating ComputeNodeState = "creating" 247 // Idle The Compute Node is not currently running a Task. 248 Idle ComputeNodeState = "idle" 249 // LeavingPool The Compute Node is leaving the Pool, either because the user explicitly removed it or 250 // because the Pool is resizing or autoscaling down. 251 LeavingPool ComputeNodeState = "leavingpool" 252 // Offline The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute 253 // Node is disabled. 254 Offline ComputeNodeState = "offline" 255 // Preempted The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node 256 // when it was preempted will be rescheduled when another Compute Node becomes available. 257 Preempted ComputeNodeState = "preempted" 258 // Rebooting The Compute Node is rebooting. 259 Rebooting ComputeNodeState = "rebooting" 260 // Reimaging The Compute Node is reimaging. 261 Reimaging ComputeNodeState = "reimaging" 262 // Running The Compute Node is running one or more Tasks (other than a StartTask). 263 Running ComputeNodeState = "running" 264 // Starting The Batch service is starting on the underlying virtual machine. 265 Starting ComputeNodeState = "starting" 266 // StartTaskFailed The StartTask has failed on the Compute Node (and exhausted all retries), and 267 // waitForSuccess is set. The Compute Node is not usable for running Tasks. 268 StartTaskFailed ComputeNodeState = "starttaskfailed" 269 // Unknown The Batch service has lost contact with the Compute Node, and does not know its true state. 270 Unknown ComputeNodeState = "unknown" 271 // Unusable The Compute Node cannot be used for Task execution due to errors. 272 Unusable ComputeNodeState = "unusable" 273 // WaitingForStartTask The StartTask has started running on the Compute Node, but waitForSuccess is set and 274 // the StartTask has not yet completed. 275 WaitingForStartTask ComputeNodeState = "waitingforstarttask" 276 ) 277 278 // PossibleComputeNodeStateValues returns an array of possible values for the ComputeNodeState const type. 279 func PossibleComputeNodeStateValues() []ComputeNodeState { 280 return []ComputeNodeState{Creating, Idle, LeavingPool, Offline, Preempted, Rebooting, Reimaging, Running, Starting, StartTaskFailed, Unknown, Unusable, WaitingForStartTask} 281 } 282 283 // ContainerWorkingDirectory enumerates the values for container working directory. 284 type ContainerWorkingDirectory string 285 286 const ( 287 // ContainerImageDefault Use the working directory defined in the container Image. Beware that this 288 // directory will not contain the Resource Files downloaded by Batch. 289 ContainerImageDefault ContainerWorkingDirectory = "containerImageDefault" 290 // TaskWorkingDirectory Use the standard Batch service Task working directory, which will contain the Task 291 // Resource Files populated by Batch. 292 TaskWorkingDirectory ContainerWorkingDirectory = "taskWorkingDirectory" 293 ) 294 295 // PossibleContainerWorkingDirectoryValues returns an array of possible values for the ContainerWorkingDirectory const type. 296 func PossibleContainerWorkingDirectoryValues() []ContainerWorkingDirectory { 297 return []ContainerWorkingDirectory{ContainerImageDefault, TaskWorkingDirectory} 298 } 299 300 // DependencyAction enumerates the values for dependency action. 301 type DependencyAction string 302 303 const ( 304 // Block Blocks tasks waiting on this task, preventing them from being scheduled. 305 Block DependencyAction = "block" 306 // Satisfy Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be 307 // scheduled to run. 308 Satisfy DependencyAction = "satisfy" 309 ) 310 311 // PossibleDependencyActionValues returns an array of possible values for the DependencyAction const type. 312 func PossibleDependencyActionValues() []DependencyAction { 313 return []DependencyAction{Block, Satisfy} 314 } 315 316 // DisableComputeNodeSchedulingOption enumerates the values for disable compute node scheduling option. 317 type DisableComputeNodeSchedulingOption string 318 319 const ( 320 // DisableComputeNodeSchedulingOptionRequeue Terminate running Task processes and requeue the Tasks. The 321 // Tasks may run again on other Compute Nodes, or when Task scheduling is re-enabled on this Compute Node. 322 // Enter offline state as soon as Tasks have been terminated. 323 DisableComputeNodeSchedulingOptionRequeue DisableComputeNodeSchedulingOption = "requeue" 324 // DisableComputeNodeSchedulingOptionTaskCompletion Allow currently running Tasks to complete. Schedule no 325 // new Tasks while waiting. Enter offline state when all Tasks have completed. 326 DisableComputeNodeSchedulingOptionTaskCompletion DisableComputeNodeSchedulingOption = "taskcompletion" 327 // DisableComputeNodeSchedulingOptionTerminate Terminate running Tasks. The Tasks will be completed with 328 // failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as 329 // Tasks have been terminated. 330 DisableComputeNodeSchedulingOptionTerminate DisableComputeNodeSchedulingOption = "terminate" 331 ) 332 333 // PossibleDisableComputeNodeSchedulingOptionValues returns an array of possible values for the DisableComputeNodeSchedulingOption const type. 334 func PossibleDisableComputeNodeSchedulingOptionValues() []DisableComputeNodeSchedulingOption { 335 return []DisableComputeNodeSchedulingOption{DisableComputeNodeSchedulingOptionRequeue, DisableComputeNodeSchedulingOptionTaskCompletion, DisableComputeNodeSchedulingOptionTerminate} 336 } 337 338 // DisableJobOption enumerates the values for disable job option. 339 type DisableJobOption string 340 341 const ( 342 // DisableJobOptionRequeue Terminate running Tasks and requeue them. The Tasks will run again when the Job 343 // is enabled. 344 DisableJobOptionRequeue DisableJobOption = "requeue" 345 // DisableJobOptionTerminate Terminate running Tasks. The Tasks will be completed with failureInfo 346 // indicating that they were terminated, and will not run again. 347 DisableJobOptionTerminate DisableJobOption = "terminate" 348 // DisableJobOptionWait Allow currently running Tasks to complete. 349 DisableJobOptionWait DisableJobOption = "wait" 350 ) 351 352 // PossibleDisableJobOptionValues returns an array of possible values for the DisableJobOption const type. 353 func PossibleDisableJobOptionValues() []DisableJobOption { 354 return []DisableJobOption{DisableJobOptionRequeue, DisableJobOptionTerminate, DisableJobOptionWait} 355 } 356 357 // DiskEncryptionTarget enumerates the values for disk encryption target. 358 type DiskEncryptionTarget string 359 360 const ( 361 // OsDisk The temporary disk on the compute node is encrypted. On Linux this encryption applies to other 362 // partitions (such as those on mounted data disks) when encryption occurs at boot time. 363 OsDisk DiskEncryptionTarget = "osdisk" 364 // TemporaryDisk The temporary disk on the compute node is encrypted. On Linux this encryption applies to 365 // other partitions (such as those on mounted data disks) when encryption occurs at boot time. 366 TemporaryDisk DiskEncryptionTarget = "temporarydisk" 367 ) 368 369 // PossibleDiskEncryptionTargetValues returns an array of possible values for the DiskEncryptionTarget const type. 370 func PossibleDiskEncryptionTargetValues() []DiskEncryptionTarget { 371 return []DiskEncryptionTarget{OsDisk, TemporaryDisk} 372 } 373 374 // DynamicVNetAssignmentScope enumerates the values for dynamic v net assignment scope. 375 type DynamicVNetAssignmentScope string 376 377 const ( 378 // DynamicVNetAssignmentScopeJob Dynamic VNet assignment is done per-job. 379 DynamicVNetAssignmentScopeJob DynamicVNetAssignmentScope = "job" 380 // DynamicVNetAssignmentScopeNone No dynamic VNet assignment is enabled. 381 DynamicVNetAssignmentScopeNone DynamicVNetAssignmentScope = "none" 382 ) 383 384 // PossibleDynamicVNetAssignmentScopeValues returns an array of possible values for the DynamicVNetAssignmentScope const type. 385 func PossibleDynamicVNetAssignmentScopeValues() []DynamicVNetAssignmentScope { 386 return []DynamicVNetAssignmentScope{DynamicVNetAssignmentScopeJob, DynamicVNetAssignmentScopeNone} 387 } 388 389 // ElevationLevel enumerates the values for elevation level. 390 type ElevationLevel string 391 392 const ( 393 // Admin The user is a user with elevated access and operates with full Administrator permissions. 394 Admin ElevationLevel = "admin" 395 // NonAdmin The user is a standard user without elevated access. 396 NonAdmin ElevationLevel = "nonadmin" 397 ) 398 399 // PossibleElevationLevelValues returns an array of possible values for the ElevationLevel const type. 400 func PossibleElevationLevelValues() []ElevationLevel { 401 return []ElevationLevel{Admin, NonAdmin} 402 } 403 404 // ErrorCategory enumerates the values for error category. 405 type ErrorCategory string 406 407 const ( 408 // ServerError The error is due to an internal server issue. 409 ServerError ErrorCategory = "servererror" 410 // UserError The error is due to a user issue, such as misconfiguration. 411 UserError ErrorCategory = "usererror" 412 ) 413 414 // PossibleErrorCategoryValues returns an array of possible values for the ErrorCategory const type. 415 func PossibleErrorCategoryValues() []ErrorCategory { 416 return []ErrorCategory{ServerError, UserError} 417 } 418 419 // InboundEndpointProtocol enumerates the values for inbound endpoint protocol. 420 type InboundEndpointProtocol string 421 422 const ( 423 // TCP Use TCP for the endpoint. 424 TCP InboundEndpointProtocol = "tcp" 425 // UDP Use UDP for the endpoint. 426 UDP InboundEndpointProtocol = "udp" 427 ) 428 429 // PossibleInboundEndpointProtocolValues returns an array of possible values for the InboundEndpointProtocol const type. 430 func PossibleInboundEndpointProtocolValues() []InboundEndpointProtocol { 431 return []InboundEndpointProtocol{TCP, UDP} 432 } 433 434 // IPAddressProvisioningType enumerates the values for ip address provisioning type. 435 type IPAddressProvisioningType string 436 437 const ( 438 // BatchManaged A public IP will be created and managed by Batch. There may be multiple public IPs 439 // depending on the size of the Pool. 440 BatchManaged IPAddressProvisioningType = "batchmanaged" 441 // NoPublicIPAddresses No public IP Address will be created. 442 NoPublicIPAddresses IPAddressProvisioningType = "nopublicipaddresses" 443 // UserManaged Public IPs are provided by the user and will be used to provision the Compute Nodes. 444 UserManaged IPAddressProvisioningType = "usermanaged" 445 ) 446 447 // PossibleIPAddressProvisioningTypeValues returns an array of possible values for the IPAddressProvisioningType const type. 448 func PossibleIPAddressProvisioningTypeValues() []IPAddressProvisioningType { 449 return []IPAddressProvisioningType{BatchManaged, NoPublicIPAddresses, UserManaged} 450 } 451 452 // JobAction enumerates the values for job action. 453 type JobAction string 454 455 const ( 456 // JobActionDisable Disable the Job. This is equivalent to calling the disable Job API, with a disableTasks 457 // value of requeue. 458 JobActionDisable JobAction = "disable" 459 // JobActionNone Take no action. 460 JobActionNone JobAction = "none" 461 // JobActionTerminate Terminate the Job. The terminateReason in the Job's executionInfo is set to 462 // "TaskFailed". 463 JobActionTerminate JobAction = "terminate" 464 ) 465 466 // PossibleJobActionValues returns an array of possible values for the JobAction const type. 467 func PossibleJobActionValues() []JobAction { 468 return []JobAction{JobActionDisable, JobActionNone, JobActionTerminate} 469 } 470 471 // JobPreparationTaskState enumerates the values for job preparation task state. 472 type JobPreparationTaskState string 473 474 const ( 475 // JobPreparationTaskStateCompleted The Task has exited with exit code 0, or the Task has exhausted its 476 // retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as 477 // resource file download failures). 478 JobPreparationTaskStateCompleted JobPreparationTaskState = "completed" 479 // JobPreparationTaskStateRunning The Task is currently running (including retrying). 480 JobPreparationTaskStateRunning JobPreparationTaskState = "running" 481 ) 482 483 // PossibleJobPreparationTaskStateValues returns an array of possible values for the JobPreparationTaskState const type. 484 func PossibleJobPreparationTaskStateValues() []JobPreparationTaskState { 485 return []JobPreparationTaskState{JobPreparationTaskStateCompleted, JobPreparationTaskStateRunning} 486 } 487 488 // JobReleaseTaskState enumerates the values for job release task state. 489 type JobReleaseTaskState string 490 491 const ( 492 // JobReleaseTaskStateCompleted The Task has exited with exit code 0, or the Task has exhausted its retry 493 // limit, or the Batch service was unable to start the Task due to Task preparation errors (such as 494 // resource file download failures). 495 JobReleaseTaskStateCompleted JobReleaseTaskState = "completed" 496 // JobReleaseTaskStateRunning The Task is currently running (including retrying). 497 JobReleaseTaskStateRunning JobReleaseTaskState = "running" 498 ) 499 500 // PossibleJobReleaseTaskStateValues returns an array of possible values for the JobReleaseTaskState const type. 501 func PossibleJobReleaseTaskStateValues() []JobReleaseTaskState { 502 return []JobReleaseTaskState{JobReleaseTaskStateCompleted, JobReleaseTaskStateRunning} 503 } 504 505 // JobScheduleState enumerates the values for job schedule state. 506 type JobScheduleState string 507 508 const ( 509 // JobScheduleStateActive The Job Schedule is active and will create Jobs as per its schedule. 510 JobScheduleStateActive JobScheduleState = "active" 511 // JobScheduleStateCompleted The Job Schedule has terminated, either by reaching its end time or by the 512 // user terminating it explicitly. 513 JobScheduleStateCompleted JobScheduleState = "completed" 514 // JobScheduleStateDeleting The user has requested that the Job Schedule be deleted, but the delete 515 // operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and 516 // will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job 517 // Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted. 518 JobScheduleStateDeleting JobScheduleState = "deleting" 519 // JobScheduleStateDisabled The user has disabled the Job Schedule. The scheduler will not initiate any new 520 // Jobs will on this schedule, but any existing active Job will continue to run. 521 JobScheduleStateDisabled JobScheduleState = "disabled" 522 // JobScheduleStateTerminating The Job Schedule has no more work to do, or has been explicitly terminated 523 // by the user, but the termination operation is still in progress. The scheduler will not initiate any new 524 // Jobs for this Job Schedule, nor is any existing Job active. 525 JobScheduleStateTerminating JobScheduleState = "terminating" 526 ) 527 528 // PossibleJobScheduleStateValues returns an array of possible values for the JobScheduleState const type. 529 func PossibleJobScheduleStateValues() []JobScheduleState { 530 return []JobScheduleState{JobScheduleStateActive, JobScheduleStateCompleted, JobScheduleStateDeleting, JobScheduleStateDisabled, JobScheduleStateTerminating} 531 } 532 533 // JobState enumerates the values for job state. 534 type JobState string 535 536 const ( 537 // JobStateActive The Job is available to have Tasks scheduled. 538 JobStateActive JobState = "active" 539 // JobStateCompleted All Tasks have terminated, and the system will not accept any more Tasks or any 540 // further changes to the Job. 541 JobStateCompleted JobState = "completed" 542 // JobStateDeleting A user has requested that the Job be deleted, but the delete operation is still in 543 // progress (for example, because the system is still terminating running Tasks). 544 JobStateDeleting JobState = "deleting" 545 // JobStateDisabled A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. 546 JobStateDisabled JobState = "disabled" 547 // JobStateDisabling A user has requested that the Job be disabled, but the disable operation is still in 548 // progress (for example, waiting for Tasks to terminate). 549 JobStateDisabling JobState = "disabling" 550 // JobStateEnabling A user has requested that the Job be enabled, but the enable operation is still in 551 // progress. 552 JobStateEnabling JobState = "enabling" 553 // JobStateTerminating The Job is about to complete, either because a Job Manager Task has completed or 554 // because the user has terminated the Job, but the terminate operation is still in progress (for example, 555 // because Job Release Tasks are running). 556 JobStateTerminating JobState = "terminating" 557 ) 558 559 // PossibleJobStateValues returns an array of possible values for the JobState const type. 560 func PossibleJobStateValues() []JobState { 561 return []JobState{JobStateActive, JobStateCompleted, JobStateDeleting, JobStateDisabled, JobStateDisabling, JobStateEnabling, JobStateTerminating} 562 } 563 564 // LoginMode enumerates the values for login mode. 565 type LoginMode string 566 567 const ( 568 // Batch The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running 569 // parallel processes. 570 Batch LoginMode = "batch" 571 // Interactive The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows 572 // VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows 573 // VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed 574 // by the Task command line is configured to always require administrative privilege or to always require 575 // maximum privilege. 576 Interactive LoginMode = "interactive" 577 ) 578 579 // PossibleLoginModeValues returns an array of possible values for the LoginMode const type. 580 func PossibleLoginModeValues() []LoginMode { 581 return []LoginMode{Batch, Interactive} 582 } 583 584 // NetworkSecurityGroupRuleAccess enumerates the values for network security group rule access. 585 type NetworkSecurityGroupRuleAccess string 586 587 const ( 588 // Allow Allow access. 589 Allow NetworkSecurityGroupRuleAccess = "allow" 590 // Deny Deny access. 591 Deny NetworkSecurityGroupRuleAccess = "deny" 592 ) 593 594 // PossibleNetworkSecurityGroupRuleAccessValues returns an array of possible values for the NetworkSecurityGroupRuleAccess const type. 595 func PossibleNetworkSecurityGroupRuleAccessValues() []NetworkSecurityGroupRuleAccess { 596 return []NetworkSecurityGroupRuleAccess{Allow, Deny} 597 } 598 599 // OnAllTasksComplete enumerates the values for on all tasks complete. 600 type OnAllTasksComplete string 601 602 const ( 603 // NoAction Do nothing. The Job remains active unless terminated or disabled by some other means. 604 NoAction OnAllTasksComplete = "noaction" 605 // TerminateJob Terminate the Job. The Job's terminateReason is set to 'AllTasksComplete'. 606 TerminateJob OnAllTasksComplete = "terminatejob" 607 ) 608 609 // PossibleOnAllTasksCompleteValues returns an array of possible values for the OnAllTasksComplete const type. 610 func PossibleOnAllTasksCompleteValues() []OnAllTasksComplete { 611 return []OnAllTasksComplete{NoAction, TerminateJob} 612 } 613 614 // OnTaskFailure enumerates the values for on task failure. 615 type OnTaskFailure string 616 617 const ( 618 // OnTaskFailureNoAction Do nothing. The Job remains active unless terminated or disabled by some other 619 // means. 620 OnTaskFailureNoAction OnTaskFailure = "noaction" 621 // OnTaskFailurePerformExitOptionsJobAction Take the action associated with the Task exit condition in the 622 // Task's exitConditions collection. (This may still result in no action being taken, if that is what the 623 // Task specifies.) 624 OnTaskFailurePerformExitOptionsJobAction OnTaskFailure = "performexitoptionsjobaction" 625 ) 626 627 // PossibleOnTaskFailureValues returns an array of possible values for the OnTaskFailure const type. 628 func PossibleOnTaskFailureValues() []OnTaskFailure { 629 return []OnTaskFailure{OnTaskFailureNoAction, OnTaskFailurePerformExitOptionsJobAction} 630 } 631 632 // OSType enumerates the values for os type. 633 type OSType string 634 635 const ( 636 // Linux The Linux operating system. 637 Linux OSType = "linux" 638 // Windows The Windows operating system. 639 Windows OSType = "windows" 640 ) 641 642 // PossibleOSTypeValues returns an array of possible values for the OSType const type. 643 func PossibleOSTypeValues() []OSType { 644 return []OSType{Linux, Windows} 645 } 646 647 // OutputFileUploadCondition enumerates the values for output file upload condition. 648 type OutputFileUploadCondition string 649 650 const ( 651 // OutputFileUploadConditionTaskCompletion Upload the file(s) after the Task process exits, no matter what 652 // the exit code was. 653 OutputFileUploadConditionTaskCompletion OutputFileUploadCondition = "taskcompletion" 654 // OutputFileUploadConditionTaskFailure Upload the file(s) only after the Task process exits with a nonzero 655 // exit code. 656 OutputFileUploadConditionTaskFailure OutputFileUploadCondition = "taskfailure" 657 // OutputFileUploadConditionTaskSuccess Upload the file(s) only after the Task process exits with an exit 658 // code of 0. 659 OutputFileUploadConditionTaskSuccess OutputFileUploadCondition = "tasksuccess" 660 ) 661 662 // PossibleOutputFileUploadConditionValues returns an array of possible values for the OutputFileUploadCondition const type. 663 func PossibleOutputFileUploadConditionValues() []OutputFileUploadCondition { 664 return []OutputFileUploadCondition{OutputFileUploadConditionTaskCompletion, OutputFileUploadConditionTaskFailure, OutputFileUploadConditionTaskSuccess} 665 } 666 667 // PoolLifetimeOption enumerates the values for pool lifetime option. 668 type PoolLifetimeOption string 669 670 const ( 671 // PoolLifetimeOptionJob The Pool exists for the lifetime of the Job to which it is dedicated. The Batch 672 // service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the 673 // Batch service creates a new auto Pool for every Job created on the schedule. 674 PoolLifetimeOptionJob PoolLifetimeOption = "job" 675 // PoolLifetimeOptionJobSchedule The Pool exists for the lifetime of the Job Schedule. The Batch Service 676 // creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job 677 // Schedules, not to Jobs. 678 PoolLifetimeOptionJobSchedule PoolLifetimeOption = "jobschedule" 679 ) 680 681 // PossiblePoolLifetimeOptionValues returns an array of possible values for the PoolLifetimeOption const type. 682 func PossiblePoolLifetimeOptionValues() []PoolLifetimeOption { 683 return []PoolLifetimeOption{PoolLifetimeOptionJob, PoolLifetimeOptionJobSchedule} 684 } 685 686 // PoolState enumerates the values for pool state. 687 type PoolState string 688 689 const ( 690 // PoolStateActive The Pool is available to run Tasks subject to the availability of Compute Nodes. 691 PoolStateActive PoolState = "active" 692 // PoolStateDeleting The user has requested that the Pool be deleted, but the delete operation has not yet 693 // completed. 694 PoolStateDeleting PoolState = "deleting" 695 ) 696 697 // PossiblePoolStateValues returns an array of possible values for the PoolState const type. 698 func PossiblePoolStateValues() []PoolState { 699 return []PoolState{PoolStateActive, PoolStateDeleting} 700 } 701 702 // SchedulingState enumerates the values for scheduling state. 703 type SchedulingState string 704 705 const ( 706 // Disabled No new Tasks will be scheduled on the Compute Node. Tasks already running on the Compute Node 707 // may still run to completion. All Compute Nodes start with scheduling enabled. 708 Disabled SchedulingState = "disabled" 709 // Enabled Tasks can be scheduled on the Compute Node. 710 Enabled SchedulingState = "enabled" 711 ) 712 713 // PossibleSchedulingStateValues returns an array of possible values for the SchedulingState const type. 714 func PossibleSchedulingStateValues() []SchedulingState { 715 return []SchedulingState{Disabled, Enabled} 716 } 717 718 // StartTaskState enumerates the values for start task state. 719 type StartTaskState string 720 721 const ( 722 // StartTaskStateCompleted The StartTask has exited with exit code 0, or the StartTask has failed and the 723 // retry limit has reached, or the StartTask process did not run due to Task preparation errors (such as 724 // resource file download failures). 725 StartTaskStateCompleted StartTaskState = "completed" 726 // StartTaskStateRunning The StartTask is currently running. 727 StartTaskStateRunning StartTaskState = "running" 728 ) 729 730 // PossibleStartTaskStateValues returns an array of possible values for the StartTaskState const type. 731 func PossibleStartTaskStateValues() []StartTaskState { 732 return []StartTaskState{StartTaskStateCompleted, StartTaskStateRunning} 733 } 734 735 // StorageAccountType enumerates the values for storage account type. 736 type StorageAccountType string 737 738 const ( 739 // PremiumLRS The data disk should use premium locally redundant storage. 740 PremiumLRS StorageAccountType = "premium_lrs" 741 // StandardLRS The data disk should use standard locally redundant storage. 742 StandardLRS StorageAccountType = "standard_lrs" 743 ) 744 745 // PossibleStorageAccountTypeValues returns an array of possible values for the StorageAccountType const type. 746 func PossibleStorageAccountTypeValues() []StorageAccountType { 747 return []StorageAccountType{PremiumLRS, StandardLRS} 748 } 749 750 // SubtaskState enumerates the values for subtask state. 751 type SubtaskState string 752 753 const ( 754 // SubtaskStateCompleted The Task is no longer eligible to run, usually because the Task has finished 755 // successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also 756 // marked as completed if an error occurred launching the Task, or when the Task has been terminated. 757 SubtaskStateCompleted SubtaskState = "completed" 758 // SubtaskStatePreparing The Task has been assigned to a Compute Node, but is waiting for a required Job 759 // Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will 760 // move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible 761 // to be assigned to a different Compute Node. 762 SubtaskStatePreparing SubtaskState = "preparing" 763 // SubtaskStateRunning The Task is running on a Compute Node. This includes task-level preparation such as 764 // downloading resource files or deploying Packages specified on the Task - it does not necessarily mean 765 // that the Task command line has started executing. 766 SubtaskStateRunning SubtaskState = "running" 767 ) 768 769 // PossibleSubtaskStateValues returns an array of possible values for the SubtaskState const type. 770 func PossibleSubtaskStateValues() []SubtaskState { 771 return []SubtaskState{SubtaskStateCompleted, SubtaskStatePreparing, SubtaskStateRunning} 772 } 773 774 // TaskAddStatus enumerates the values for task add status. 775 type TaskAddStatus string 776 777 const ( 778 // TaskAddStatusClientError The Task failed to add due to a client error and should not be retried without 779 // modifying the request as appropriate. 780 TaskAddStatusClientError TaskAddStatus = "clienterror" 781 // TaskAddStatusServerError Task failed to add due to a server error and can be retried without 782 // modification. 783 TaskAddStatusServerError TaskAddStatus = "servererror" 784 // TaskAddStatusSuccess The Task was added successfully. 785 TaskAddStatusSuccess TaskAddStatus = "success" 786 ) 787 788 // PossibleTaskAddStatusValues returns an array of possible values for the TaskAddStatus const type. 789 func PossibleTaskAddStatusValues() []TaskAddStatus { 790 return []TaskAddStatus{TaskAddStatusClientError, TaskAddStatusServerError, TaskAddStatusSuccess} 791 } 792 793 // TaskExecutionResult enumerates the values for task execution result. 794 type TaskExecutionResult string 795 796 const ( 797 // Failure There was an error during processing of the Task. The failure may have occurred before the Task 798 // process was launched, while the Task process was executing, or after the Task process exited. 799 Failure TaskExecutionResult = "failure" 800 // Success The Task ran successfully. 801 Success TaskExecutionResult = "success" 802 ) 803 804 // PossibleTaskExecutionResultValues returns an array of possible values for the TaskExecutionResult const type. 805 func PossibleTaskExecutionResultValues() []TaskExecutionResult { 806 return []TaskExecutionResult{Failure, Success} 807 } 808 809 // TaskState enumerates the values for task state. 810 type TaskState string 811 812 const ( 813 // TaskStateActive The Task is queued and able to run, but is not currently assigned to a Compute Node. A 814 // Task enters this state when it is created, when it is enabled after being disabled, or when it is 815 // awaiting a retry after a failed run. 816 TaskStateActive TaskState = "active" 817 // TaskStateCompleted The Task is no longer eligible to run, usually because the Task has finished 818 // successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also 819 // marked as completed if an error occurred launching the Task, or when the Task has been terminated. 820 TaskStateCompleted TaskState = "completed" 821 // TaskStatePreparing The Task has been assigned to a Compute Node, but is waiting for a required Job 822 // Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will 823 // move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible 824 // to be assigned to a different Compute Node. 825 TaskStatePreparing TaskState = "preparing" 826 // TaskStateRunning The Task is running on a Compute Node. This includes task-level preparation such as 827 // downloading resource files or deploying Packages specified on the Task - it does not necessarily mean 828 // that the Task command line has started executing. 829 TaskStateRunning TaskState = "running" 830 ) 831 832 // PossibleTaskStateValues returns an array of possible values for the TaskState const type. 833 func PossibleTaskStateValues() []TaskState { 834 return []TaskState{TaskStateActive, TaskStateCompleted, TaskStatePreparing, TaskStateRunning} 835 } 836 837 // VerificationType enumerates the values for verification type. 838 type VerificationType string 839 840 const ( 841 // Unverified The associated Compute Node agent SKU should have binary compatibility with the Image, but 842 // specific functionality has not been verified. 843 Unverified VerificationType = "unverified" 844 // Verified The Image is guaranteed to be compatible with the associated Compute Node agent SKU and all 845 // Batch features have been confirmed to work as expected. 846 Verified VerificationType = "verified" 847 ) 848 849 // PossibleVerificationTypeValues returns an array of possible values for the VerificationType const type. 850 func PossibleVerificationTypeValues() []VerificationType { 851 return []VerificationType{Unverified, Verified} 852 } 853