diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/BatchService.json index 407b2cc11d5b..000a8b1047c1 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/BatchService.json @@ -10391,7 +10391,17 @@ ], "x-ms-enum": { "name": "OSType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "linux", + "description": "The Linux operating system." + }, + { + "value": "windows", + "description": "The Windows operating system." + } + ] } } }, @@ -10410,7 +10420,13 @@ ], "x-ms-enum": { "name": "AccessScope", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "job", + "description": "Grants access to perform all operations on the job containing the task." + } + ] } }, "title": "The Batch resources to which the token grants access.", @@ -10773,7 +10789,17 @@ ], "x-ms-enum": { "name": "CertificateFormat", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "pfx", + "description": "The certificate is a PFX (PKCS#12) formatted certificate or certificate chain." + }, + { + "value": "cer", + "description": "The certificate is a base64-encoded X.509 certificate." + } + ] } }, "password": { @@ -11043,7 +11069,7 @@ "jobAction": { "type": "string", "title": "An action to take on the job containing the task, if the task completes with the given exit condition and the job's onTaskFailed property is 'performExitOptionsJobAction'.", - "description": "Values are:\n\n none - Take no action.\n disable - Disable the job. This is equivalent to calling the disable job API, with a disableTasks value of requeue.\n terminate - Terminate the job. The terminateReason in the job's executionInfo is set to \"TaskFailed\". The default is none for exit code 0 and terminate for all other exit conditions.\n\n If the job's onTaskFailed property is noAction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noaction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "none", "disable", @@ -11051,20 +11077,44 @@ ], "x-ms-enum": { "name": "JobAction", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "Take no action." + }, + { + "value": "disable", + "description": "Disable the job. This is equivalent to calling the disable job API, with a disableTasks value of requeue." + }, + { + "value": "terminate", + "description": "Terminate the job. The terminateReason in the job's executionInfo is set to \"TaskFailed\"." + } + ] } }, "dependencyAction": { "type": "string", "title": "An action that the Batch service performs on tasks that depend on this task.", - "description": "Values are:\n\n satisfy - Satisfy the task's dependencies.\n block - Block the task's dependencies.\n\n The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an erro and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "satisfy", "block" ], "x-ms-enum": { "name": "DependencyAction", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "satisfy", + "description": "Satisfy the task's dependencies." + }, + { + "value": "block", + "description": "Block the task's dependencies." + } + ] } } }, @@ -11075,14 +11125,24 @@ "scope": { "type": "string", "title": "The scope for the auto user", - "description": "Values are:\n\n pool - specifies that the task runs as the common auto user account which is created on every node in a pool.\n task - specifies that the service should create a new user for the task.\n The default value is task.", + "description": "The default value is task.", "enum": [ "task", "pool" ], "x-ms-enum": { "name": "AutoUserScope", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "task", + "description": "Specifies that the service should create a new user for the task." + }, + { + "value": "pool", + "description": "Specifies that the task runs as the common auto user account which is created on every node in a pool." + } + ] } }, "elevationLevel": { @@ -11379,14 +11439,24 @@ "properties": { "nodeFillType": { "type": "string", - "title": "How tasks are distributed across compute nodes in a pool. Values are:\n\n 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.\n spread - Tasks should be assigned evenly across all nodes in the pool.", + "title": "How tasks are distributed across compute nodes in a pool.", "enum": [ "spread", "pack" ], "x-ms-enum": { "name": "ComputeNodeFillType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "spread", + "description": "Tasks should be assigned evenly across all nodes in the pool." + }, + { + "value": "pack", + "description": "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." + } + ] } } }, @@ -11453,14 +11523,26 @@ "storeLocation": { "type": "string", "title": "The location of the certificate store on the compute node into which to install the certificate.", - "description": "The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.", + "description": "The default value is currentuser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.", "enum": [ - "currentUser", - "localMachine" + "currentuser", + "localmachine" ], "x-ms-enum": { "name": "CertificateStoreLocation", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "currentuser", + "description": "Certificates should be installed to the CurrentUser certificate store.", + "name": "currentUser" + }, + { + "value": "localmachine", + "description": "Certificates should be installed to the LocalMachine certificate store.", + "name": "localMachine" + } + ] } }, "storeName": { @@ -11474,17 +11556,33 @@ "type": "string", "x-nullable": false, "enum": [ - "startTask", + "starttask", "task", - "remoteUser" + "remoteuser" ], "x-ms-enum": { "name": "CertificateVisibility", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "starttask", + "description": "The certificate should be visible to the user account under which the start task is run.", + "name": "startTask" + }, + { + "value": "task", + "description": "The certificate should be visibile to the user accounts under which job tasks are run." + }, + { + "value": "remoteuser", + "description": "The certificate should be visibile to the user accounts under which users remotely access the node.", + "name": "remoteUser" + } + ] } }, "title": "Which user accounts on the compute node should have access to the private data of the certificate.", - "description": "Values are:\n\n starttask - The user account under which the start task is run.\n task - The accounts under which job tasks are run.\n remoteuser - The accounts under which users remotely access the node.\n\n You can specify more than one visibility in this collection. The default is all accounts." + "description": "You can specify more than one visibility in this collection. The default is all accounts." } }, "required": [ "thumbprint", "thumbprintAlgorithm" ], @@ -11636,14 +11734,24 @@ "poolLifetimeOption": { "type": "string", "title": "The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools.", - "description": "When the pool lifetime is jobSchedule the pool exists for the lifetime of the job schedule. The Batch Service creates the pool when it creates the first job on the schedule. You may apply this option only to job schedules, not to jobs. When the pool lifetime is job the pool exists for the lifetime of the job to which it is dedicated. The Batch service creates the pool when it creates the job. If the 'job' option is applied to a job schedule, the Batch service creates a new auto pool for every job created on the schedule.", "enum": [ - "jobSchedule", + "jobschedule", "job" ], "x-ms-enum": { "name": "PoolLifetimeOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "jobschedule", + "description": "The pool exists for the lifetime of the job schedule. The Batch Service creates the pool when it creates the first job on the schedule. You may apply this option only to job schedules, not to jobs.", + "name": "jobSchedule" + }, + { + "value": "job", + "description": "The pool exists for the lifetime of the job to which it is dedicated. The Batch service creates the pool when it creates the job. If the 'job' option is applied to a job schedule, the Batch service creates a new auto pool for every job created on the schedule." + } + ] } }, "keepAlive": { @@ -11693,12 +11801,12 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in a job created under this schedule are in the completed state.", - "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noAction and update the job properties to set onAllTasksComplete to terminateJob once you have finished adding tasks. The default is noAction.", + "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction.", "$ref": "#/definitions/OnAllTasksComplete" }, "onTaskFailure": { "title": "The action the Batch service should take when any task fails in a job created under this schedule. A task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error.", - "description": "The default is noAction.", + "description": "The default is noaction.", "$ref": "#/definitions/OnTaskFailure" }, "constraints": { @@ -12033,7 +12141,7 @@ "terminateReason": { "type": "string", "title": "A string describing the reason the job ended.", - "description": "This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminateJob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminateJob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation." + "description": "This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation." } }, "required": [ "startTime" ], @@ -12132,12 +12240,12 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "noAction - do nothing. The job remains active unless terminated or disabled by some other means. terminateJob - terminate the job. The job's terminateReason is set to 'AllTasksComplete'. The default is noAction.", + "description": "The default is noaction.", "$ref": "#/definitions/OnAllTasksComplete" }, "onTaskFailure": { "title": "The action the Batch service should take when any task in the job fails.", - "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. noAction - do nothing. performExitOptionsJobAction - take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noAction.", + "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction.", "$ref": "#/definitions/OnTaskFailure" }, "metadata": { @@ -12210,12 +12318,12 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noAction and update the job properties to set onAllTasksComplete to terminateJob once you have finished adding tasks. Permitted values are: noAction - do nothing. The job remains active unless terminated or disabled by some other means. terminateJob - terminate the job. The job's terminateReason is set to 'AllTasksComplete'. The default is noAction.", + "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction.", "$ref": "#/definitions/OnAllTasksComplete" }, "onTaskFailure": { "title": "The action the Batch service should take when any task in the job fails.", - "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. noAction - do nothing. performExitOptionsJobAction - take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noAction.", + "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction.", "$ref": "#/definitions/OnTaskFailure" }, "metadata": { @@ -12311,14 +12419,23 @@ "state": { "type": "string", "title": "The current state of the Job Preparation task on the compute node.", - "description": "Values are:\n\n running - the task is currently running (including retrying).\n completed - 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).", "enum": [ "running", "completed" ], "x-ms-enum": { "name": "JobPreparationTaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "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)." + } + ] } }, "taskRootDirectory": { @@ -12383,14 +12500,23 @@ "state": { "type": "string", "title": "The current state of the Job Release task on the compute node.", - "description": "Values are:\n\n running - the task is currently running (including retrying).\n completed - the task has exited, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures).", "enum": [ "running", "completed" ], "x-ms-enum": { "name": "JobReleaseTaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "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)." + } + ] } }, "taskRootDirectory": { @@ -12498,14 +12624,23 @@ "validationStatus": { "type": "string", "title": "Whether the task counts have been validated.", - "description": "If the validationStatus is unvalidated, then the Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks.", "enum": [ "validated", "unvalidated" ], "x-ms-enum": { "name": "TaskCountValidationStatus", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "validated", + "description": "The Batch service has validated the state counts against the task states as reported in the List Tasks API." + }, + { + "value": "unvalidated", + "description": "The Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks." + } + ] } } }, @@ -12628,7 +12763,7 @@ "properties": { "caching": { "title": "The type of caching to enable for the OS disk.", - "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", + "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", "$ref": "#/definitions/CachingType" } }, @@ -12655,7 +12790,7 @@ "caching": { "$ref": "#/definitions/CachingType", "title": "The type of caching to be enabled for the data disks.", - "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." }, "diskSizeGB": { "type": "integer", @@ -12664,7 +12799,7 @@ }, "storageAccountType": { "title": "The storage account type to be used for the data disk.", - "description": "If omitted, the default is \"Standard_LRS\". Values are:\n\n Standard_LRS - The data disk should use standard locally redundant storage.\n Premium_LRS - The data disk should use premium locally redundant storage.", + "description": "If omitted, the default is \"standard_lrs\".", "$ref": "#/definitions/StorageAccountType" } }, @@ -12678,26 +12813,54 @@ "type": "string", "title": "The storage account type for use in creating data disks.", "enum": [ - "Standard_LRS", - "Premium_LRS" + "standard_lrs", + "premium_lrs" ], "x-ms-enum": { "name": "StorageAccountType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "standard_lrs", + "description": "The data disk should use standard locally redundant storage.", + "name": "StandardLRS" + }, + { + "value": "premium_lrs", + "description": "The data disk should use premium locally redundant storage.", + "name": "PremiumLRS" + } + ] } }, "CachingType": { "type": "string", "title": "The type of caching to enable for the disk.", - "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", + "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", "enum": [ "none", - "readOnly", - "readWrite" + "readonly", + "readwrite" ], "x-ms-enum": { "name": "CachingType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "The caching mode for the disk is not enabled." + }, + { + "value": "readonly", + "description": "The caching mode for the disk is read only.", + "name": "readOnly" + }, + { + "value": "readwrite", + "description": "The caching mode for the disk is read and write.", + "name": "readWrite" + } + ] } }, "VirtualMachineConfiguration": { @@ -12726,7 +12889,7 @@ "$ref": "#/definitions/DataDisk" }, "title": "The configuration for data disks attached to the comptue nodes in the pool.", - "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated." + "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the node is removed from the pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine." }, "licenseType": { "type": "string", @@ -12767,13 +12930,18 @@ "type": { "type": "string", "title": "The container technology to be used.", - "description": "Values are:\n\n docker - Docker will be used to launch the containers.", "enum": [ "docker" ], "x-ms-enum": { "name": "ContainerType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "docker", + "description": "Docker will be used to launch the containers." + } + ] } }, "containerImageNames": { @@ -12850,7 +13018,6 @@ "state": { "type": "string", "title": "The current state of the pool.", - "description": "Values are:\n\n active - The pool is available to run tasks subject to the availability of compute nodes.\n deleting - The user has requested that the pool be deleted, but the delete operation has not yet completed.\n upgrading - 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). While upgrading, the pool may be able to run tasks (with reduced capacity) but this is not guaranteed.", "enum": [ "active", "deleting", @@ -12858,7 +13025,21 @@ ], "x-ms-enum": { "name": "PoolState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The pool is available to run tasks subject to the availability of compute nodes." + }, + { + "value": "deleting", + "description": "The user has requested that the pool be deleted, but the delete operation has not yet completed." + }, + { + "value": "upgrading", + "description": "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). While upgrading, the pool may be able to run tasks (with reduced capacity) but this is not guaranteed." + } + ] } }, "stateTransitionTime": { @@ -12869,7 +13050,6 @@ "allocationState": { "type": "string", "title": "Whether the pool is resizing.", - "description": "Values are:\n\n steady - The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of dedicated nodes.\n resizing - The pool is resizing; that is, compute nodes are being added to or removed from the pool.\n stopping - The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed.", "enum": [ "steady", "resizing", @@ -12877,7 +13057,21 @@ ], "x-ms-enum": { "name": "AllocationState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "steady", + "description": "The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes." + }, + { + "value": "resizing", + "description": "The pool is resizing; that is, compute nodes are being added to or removed from the pool." + }, + { + "value": "stopping", + "description": "The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." + } + ] } }, "allocationStateTransitionTime": { @@ -13655,13 +13849,31 @@ "status": { "type": "string", "title": "The status of the add task request.", - "description": "Values are:\n\n success - Task was added successfully.\n clienterror - Task failed to add due to a client error and should not be retried without modifying the request as appropriate.\n servererror - Task failed to add due to a server error and can be retried without modification.", "enum": [ "success", - "clientError", - "serverError" + "clienterror", + "servererror" ], - "x-ms-enum": { "name": "TaskAddStatus" } + "x-ms-enum": { + "name": "TaskAddStatus", + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The task was added successfully." + }, + { + "value": "clienterror", + "description": "The task failed to add due to a client error and should not be retried without modifying the request as appropriate.", + "name": "clientError" + }, + { + "value": "servererror", + "description": "Task failed to add due to a server error and can be retried without modification.", + "name": "serverError" + } + ] + } }, "taskId": { "type": "string", @@ -13831,14 +14043,23 @@ "state": { "type": "string", "title": "The state of the start task on the compute node.", - "description": "Values are:\n\n running - The start task is currently running.\n completed - 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).", "enum": [ "running", "completed" ], "x-ms-enum": { "name": "StartTaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The start task is currently running." + }, + { + "value": "completed", + "description": "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)." + } + ] } }, "startTime": { @@ -13924,7 +14145,7 @@ "state": { "type": "string", "title": "The current state of the compute node.", - "description": "Values are:\n\n idle - The node is not currently running a task.\n rebooting - The node is rebooting.\n reimaging - The node is reimaging.\n running - The node is running one or more tasks (other than a start task).\n unusable - The node cannot be used for task execution due to errors.\n creating - The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool.\n starting - the Batch service is starting on the underlying virtual machine.\n waitingforstarttask - The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed.\n starttaskfailed - The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set. The node is not usable for running tasks.\n unknown - The Batch service has lost contact with the node, and does not know its true state.\n leavingpool - The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down.\n offline - The node is not currently running a task, and scheduling of new tasks to the node is disabled.\n preempted - The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", "enum": [ "idle", "rebooting", @@ -13933,29 +14154,95 @@ "unusable", "creating", "starting", - "waitingForStartTask", - "startTaskFailed", + "waitingforstarttask", + "starttaskfailed", "unknown", - "leavingPool", + "leavingpool", "offline", "preempted" ], "x-ms-enum": { "name": "ComputeNodeState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "idle", + "description": "The node is not currently running a task." + }, + { + "value": "rebooting", + "description": "The node is rebooting." + }, + { + "value": "reimaging", + "description": "The node is reimaging." + }, + { + "value": "running", + "description": "The node is running one or more tasks (other than a start task)." + }, + { + "value": "unusable", + "description": "The node cannot be used for task execution due to errors." + }, + { + "value": "creating", + "description": "The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool." + }, + { + "value": "starting", + "description": "The Batch service is starting on the underlying virtual machine." + }, + { + "value": "waitingforstarttask", + "description": "The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed.", + "name": "waitingForStartTask" + }, + { + "value": "starttaskfailed", + "description": "The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set. The node is not usable for running tasks.", + "name": "startTaskFailed" + }, + { + "value": "unknown", + "description": "The Batch service has lost contact with the node, and does not know its true state." + }, + { + "value": "leavingpool", + "description": "The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down.", + "name": "leavingPool" + }, + { + "value": "offline", + "description": "The node is not currently running a task, and scheduling of new tasks to the node is disabled." + }, + { + "value": "preempted", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available." + } + ] } }, "schedulingState": { "type": "string", "title": "Whether the compute node is available for task scheduling.", - "description": "Values are:\n\n enabled - Tasks can be scheduled on the node.\n disabled - No new tasks will be scheduled on the node. Tasks already running on the node may still run to completion. All nodes start with scheduling enabled.", "enum": [ "enabled", "disabled" ], "x-ms-enum": { "name": "SchedulingState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "enabled", + "description": "Tasks can be scheduled on the node." + }, + { + "value": "disabled", + "description": "No new tasks will be scheduled on the node. Tasks already running on the node may still run to completion. All nodes start with scheduling enabled." + } + ] } }, "stateTransitionTime": { @@ -14068,16 +14355,8 @@ "description": "The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400." }, "protocol": { - "type": "string", - "title": "The protocol of the endpoint.", - "enum": [ - "tcp", - "udp" - ], - "x-ms-enum": { - "name": "InboundEndpointProtocol", - "modelAsString": false - } + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint." }, "backendPort": { "type": "integer", @@ -14089,13 +14368,13 @@ "type": "integer", "format": "int32", "title": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", - "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." }, "frontendPortRangeEnd": { "type": "integer", "format": "int32", "title": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", - "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." }, "networkSecurityGroupRules": { "type": "array", @@ -14126,7 +14405,17 @@ ], "x-ms-enum": { "name": "NetworkSecurityGroupRuleAccess", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "allow", + "description": "Allow access." + }, + { + "value": "deny", + "description": "Deny access." + } + ] } }, "sourceAddressPrefix": { @@ -14158,16 +14447,8 @@ "title": "The name of the endpoint." }, "protocol": { - "type": "string", - "title": "The protocol of the endpoint.", - "enum": [ - "tcp", - "udp" - ], - "x-ms-enum": { - "name": "InboundEndpointProtocol", - "modelAsString": false - } + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint." }, "publicIPAddress": { "type": "string", @@ -14305,7 +14586,6 @@ "disableTasks": { "type": "string", "title": "What to do with active tasks associated with the job.", - "description": "Values are:\n\n requeue - Terminate running tasks and requeue them. The tasks will run again when the job is enabled.\n terminate - Terminate running tasks. The tasks will not run again.\n wait - Allow currently running tasks to complete.", "enum": [ "requeue", "terminate", @@ -14313,7 +14593,21 @@ ], "x-ms-enum": { "name": "DisableJobOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running tasks and requeue them. The tasks will run again when the job is enabled." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again." + }, + { + "value": "wait", + "description": "Allow currently running tasks to complete." + } + ] } } }, @@ -14339,7 +14633,7 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "If omitted, the completion behavior is left unchanged. You may not change the value from terminateJob to noAction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "$ref": "#/definitions/OnAllTasksComplete" }, "constraints": { @@ -14391,7 +14685,7 @@ }, "onAllTasksComplete": { "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "If omitted, the completion behavior is set to noAction. If the current value is terminateJob, this is an error because a job's completion behavior may not be changed from terminateJob to noAction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob.", + "description": "If omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a job's completion behavior may not be changed from terminatejob to noaction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob.", "$ref": "#/definitions/OnAllTasksComplete" } }, @@ -14566,16 +14860,36 @@ "nodeRebootOption": { "type": "string", "title": "When to reboot the compute node and what to do with currently running tasks.", - "description": "Values are:\n\n requeue - Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Restart the node as soon as tasks have been terminated.\n terminate - Terminate running tasks. The tasks will not run again. Restart the node as soon as tasks have been terminated.\n taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Restart the node when all tasks have completed.\n retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Restart the node when all task retention periods have expired.\n\n The default value is requeue.", + "description": "The default value is requeue.", "enum": [ "requeue", "terminate", - "taskCompletion", - "retainedData" + "taskcompletion", + "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeRebootOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Restart the node as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Restart the node as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Restart the node when all tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Restart the node when all task retention periods have expired.", + "name": "retainedData" + } + ] } } }, @@ -14586,16 +14900,36 @@ "nodeReimageOption": { "type": "string", "title": "When to reimage the compute node and what to do with currently running tasks.", - "description": "Values are:\n\n requeue - Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Reimage the node as soon as tasks have been terminated.\n terminate - Terminate running tasks. The tasks will not run again. Reimage the node as soon as tasks have been terminated.\n taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Reimage the node when all tasks have completed.\n retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Reimage the node when all task retention periods have expired.\n\n The default value is requeue.", + "description": "The default value is requeue.", "enum": [ "requeue", "terminate", - "taskCompletion", - "retainedData" + "taskcompletion", + "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeReimageOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Reimage the node as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Reimage the node as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Reimage the node when all tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Reimage the node when all task retention periods have expired.", + "name": "retainedData" + } + ] } } }, @@ -14606,15 +14940,30 @@ "nodeDisableSchedulingOption": { "type": "string", "title": "What to do with currently running tasks when disabling task scheduling on the compute node.", - "description": "Values are:\n\n requeue - Terminate running task processes and requeue the tasks. The tasks may run again on other compute nodes, or when task scheduling is re-enabled on this node. Enter offline state as soon as tasks have been terminated.\n terminate - Terminate running tasks. The tasks will not run again. Enter offline state as soon as tasks have been terminated.\n taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Enter offline state when all tasks have completed.\n\n The default value is requeue.", + "description": "The default value is requeue.", "enum": [ "requeue", "terminate", - "taskCompletion" + "taskcompletion" ], "x-ms-enum": { "name": "DisableComputeNodeSchedulingOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks may run again on other compute nodes, or when task scheduling is re-enabled on this node. Enter offline state as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Enter offline state when all tasks have completed.", + "name": "taskCompletion" + } + ] } } }, @@ -14693,7 +15042,7 @@ "properties": { "uploadCondition": { "title": "The conditions under which the task output file or set of files should be uploaded.", - "description": "The default is taskCompletion.", + "description": "The default is taskcompletion.", "$ref": "#/definitions/OutputFileUploadCondition" } }, @@ -14749,34 +15098,57 @@ "CertificateState": { "type": "string", "title": "The state of the certificate.", - "description": "Values are:\n\n active - The certificate is available for use in pools.\n deleting - The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools.\n 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. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete.", "enum": [ "active", "deleting", - "deleteFailed" + "deletefailed" ], "x-ms-enum": { "name": "CertificateState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The certificate is available for use in pools." + }, + { + "value": "deleting", + "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools." + }, + { + "value": "deletefailed", + "description": "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. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete.", + "name": "deleteFailed" + } + ] } }, "ElevationLevel": { "type": "string", "title": "The elevation level of the user.", - "description": "Values are:\n\n nonAdmin - The user is a standard user without elevated access.\n admin - The user is a user with elevated access and operates with full Administrator permissions.", "enum": [ - "nonAdmin", + "nonadmin", "admin" ], "x-ms-enum": { "name": "ElevationLevel", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "nonadmin", + "description": "The user is a standard user without elevated access.", + "name": "nonAdmin" + }, + { + "value": "admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] } }, "JobScheduleState": { "type": "string", "title": "The state of the job schedule.", - "description": "Values are:\n\n active - The job schedule is active and will create jobs as per its schedule.\n disabled - The user has disabled the schedule. The scheduler will not initiate any new jobs will on this schedule, but any existing active job will continue to run.\n terminating - The schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new jobs for this schedule, nor is any existing job active.\n completed - The schedule has terminated, either by reaching its end time or by the user terminating it explicitly.\n deleting - The user has requested that the schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new jobs for this schedule, and will delete any existing jobs and tasks under the schedule, including any active job. The schedule will be deleted when all jobs and tasks under the schedule have been deleted.", "enum": [ "active", "completed", @@ -14786,13 +15158,34 @@ ], "x-ms-enum": { "name": "JobScheduleState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The job schedule is active and will create jobs as per its schedule." + }, + { + "value": "completed", + "description": "The schedule has terminated, either by reaching its end time or by the user terminating it explicitly." + }, + { + "value": "disabled", + "description": "The user has disabled the schedule. The scheduler will not initiate any new jobs will on this schedule, but any existing active job will continue to run." + }, + { + "value": "terminating", + "description": "The schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new jobs for this schedule, nor is any existing job active." + }, + { + "value": "deleting", + "description": "The user has requested that the schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new jobs for this schedule, and will delete any existing jobs and tasks under the schedule, including any active job. The schedule will be deleted when all jobs and tasks under the schedule have been deleted." + } + ] } }, "JobState": { "type": "string", "title": "The state of the job.", - "description": "Values are:\n\n active - the job is available to have tasks scheduled.\n disabling - a user has requested that the job be disabled, but the disable operation is still in progress (for example, waiting for tasks to terminate).\n disabled - a user has disabled the job. No tasks are running, and no new tasks will be scheduled.\n enabling - a user has requested that the job be enabled, but the enable operation is still in progress.\n terminating - 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).\n completed - all tasks have terminated, and the system will not accept any more tasks or any further changes to the job.\n deleting - 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).", "enum": [ "active", "disabling", @@ -14804,51 +15197,115 @@ ], "x-ms-enum": { "name": "JobState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The job is available to have tasks scheduled." + }, + { + "value": "disabling", + "description": "A user has requested that the job be disabled, but the disable operation is still in progress (for example, waiting for tasks to terminate)." + }, + { + "value": "disabled", + "description": "A user has disabled the job. No tasks are running, and no new tasks will be scheduled." + }, + { + "value": "enabling", + "description": "A user has requested that the job be enabled, but the enable operation is still in progress." + }, + { + "value": "terminating", + "description": "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)." + }, + { + "value": "completed", + "description": "All tasks have terminated, and the system will not accept any more tasks or any further changes to the job." + }, + { + "value": "deleting", + "description": "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)." + } + ] } }, "OnAllTasksComplete": { "type": "string", "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "Values are:\n\n noAction - do nothing. The job remains active unless terminated or disabled by some other means.\n terminateJob - terminate the job. The job's terminateReason is set to 'AllTasksComplete'.", "enum": [ - "noAction", - "terminateJob" + "noaction", + "terminatejob" ], "x-ms-enum": { "name": "OnAllTasksComplete", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "terminatejob", + "description": "Terminate the job. The job's terminateReason is set to 'AllTasksComplete'.", + "name": "terminateJob" + } + ] } }, "OnTaskFailure": { "type": "string", "title": "The action the Batch service should take when any task in the job fails.", - "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. Values are:\n\n noAction - do nothing.\n performExitOptionsJobAction - take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.)\n\n The default is noAction.", + "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction.", "enum": [ - "noAction", - "performExitOptionsJobAction" + "noaction", + "performexitoptionsjobaction" ], "x-ms-enum": { "name": "OnTaskFailure", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "performexitoptionsjobaction", + "description": "Take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.)", + "name": "performExitOptionsJobAction" + } + ] } }, "ErrorCategory": { "type": "string", "title": "The category of the error.", "enum": [ - "userError", - "serverError" + "usererror", + "servererror" ], "x-ms-enum": { "name": "ErrorCategory", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "usererror", + "description": "The error is due to a user issue, such as misconfiguration.", + "name": "userError" + }, + { + "value": "servererror", + "description": "The error is due to an internal server issue.", + "name": "serverError" + } + ] } }, "TaskState": { "type": "string", "title": "The state of the task.", - "description": "Values are:\n\n active - The task is queued and able to run, but is not currently assigned to a compute node. A task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run.\n preparing - The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will return to active and will be eligible to be assigned to a different node.\n running - The task is running on a compute node. This includes task-level preparation such as downloading resource files or deploying application packages specified on the task - it does not necessarily mean that the task command line has started executing.\n completed - 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. A task is also marked as completed if an error occurred launching the task, or when the task has been terminated.", "enum": [ "active", "preparing", @@ -14857,13 +15314,30 @@ ], "x-ms-enum": { "name": "TaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The task is queued and able to run, but is not currently assigned to a compute node. A task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run." + }, + { + "value": "preparing", + "description": "The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will return to active and will be eligible to be assigned to a different node." + }, + { + "value": "running", + "description": "The task is running on a compute node. This includes task-level preparation such as downloading resource files or deploying application packages specified on the task - it does not necessarily mean that the task command line has started executing." + }, + { + "value": "completed", + "description": "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. A task is also marked as completed if an error occurred launching the task, or when the task has been terminated." + } + ] } }, "SubtaskState": { "type": "string", "title": "The state of the subtask.", - "description": "Values are:\n\n preparing - The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will be eligible to be assigned to a different node.\n running - The subtask is running on a compute node.\n completed - The subtask is no longer eligible to run, usually because the subtask has finished successfully, or the subtask has finished unsuccessfully and has exhausted its retry limit. A subtask is also marked as completed if an error occurred launching the subtask, or when the task has been terminated.", "enum": [ "preparing", "running", @@ -14871,49 +15345,134 @@ ], "x-ms-enum": { "name": "SubtaskState", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "preparing", + "description": "The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will return to active and will be eligible to be assigned to a different node." + }, + { + "value": "running", + "description": "The task is running on a compute node. This includes task-level preparation such as downloading resource files or deploying application packages specified on the task - it does not necessarily mean that the task command line has started executing." + }, + { + "value": "completed", + "description": "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. A task is also marked as completed if an error occurred launching the task, or when the task has been terminated." + } + ] } }, "ComputeNodeDeallocationOption": { "type": "string", "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", - "description": "Values are:\n\n requeue - Terminate running tasks and requeue them. The tasks will run again when the job is enabled. Remove nodes as soon as tasks have been terminated.\n terminate - Terminate running tasks. The tasks will not run again. Remove nodes as soon as tasks have been terminated.\n taskcompletion - Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed.\n retaineddata - Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired.\n\n The default value is requeue.", + "description": "The default value is requeue.", "enum": [ "requeue", "terminate", - "taskCompletion", - "retainedData" + "taskcompletion", + "retaineddata" ], "x-ms-enum": { "name": "ComputeNodeDeallocationOption", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired.", + "name": "retainedData" + } + ] } }, "OutputFileUploadCondition": { "type": "string", "title": "The conditions under which a task output file or set of files should be uploaded.", - "description": "Values are:\n\n taskSuccess - Upload the file(s) only after the task process exits with an exit code of 0.\n taskFailure - Upload the file(s) only after the task process exits with a nonzero exit code.\n taskCompletion - Upload the file(s) after the task process exits, no matter what the exit code was.", "enum": [ - "taskSuccess", - "taskFailure", - "taskCompletion" + "tasksuccess", + "taskfailure", + "taskcompletion" ], "x-ms-enum": { "name": "OutputFileUploadCondition", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "tasksuccess", + "description": "Upload the file(s) only after the task process exits with an exit code of 0.", + "name": "taskSuccess" + }, + { + "value": "taskfailure", + "description": "Upload the file(s) only after the task process exits with a nonzero exit code.", + "name": "taskFailure" + }, + { + "value": "taskcompletion", + "description": "Upload the file(s) after the task process exits, no matter what the exit code was.", + "name": "taskCompletion" + } + ] } }, "TaskExecutionResult": { "type": "string", "title": "The result of task execution.", - "description": "Values are:\n\n success - The task ran successfully.\n failure - There was an error during processing of the task. The failure may have occurred before the task process was launched, while the task process was executing, or after the task process exited.", "enum": [ "success", "failure" ], "x-ms-enum": { "name": "TaskExecutionResult", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The task ran successfully.", + "name": "success" + }, + { + "value": "failure", + "description": "There was an error during processing of the task. The failure may have occurred before the task process was launched, while the task process was executing, or after the task process exited.", + "name": "failure" + } + ] + } + }, + "InboundEndpointProtocol": { + "type": "string", + "title": "The protocol of the endpoint.", + "enum": [ + "tcp", + "udp" + ], + "x-ms-enum": { + "name": "InboundEndpointProtocol", + "modelAsString": false, + "values": [ + { + "value": "tcp", + "description": "Use TCP for the endpoint.", + "name": "tcp" + }, + { + "value": "udp", + "description": "Use UDP for the endpoint.", + "name": "udp" + } + ] } } }, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateGet.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateGet.json index b8c00a4958dd..67568b3c318d 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateGet.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateGet.json @@ -12,7 +12,7 @@ "thumbprint": "0123456789abcdef0123456789abcdef01234567", "thumbprintAlgorithm": "sha1", "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", - "state": "deleteFailed", + "state": "deletefailed", "stateTransitionTime": "2014-07-31T21:12:58.236Z", "previousState": "deleting", "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateList.json index c49d999f6d94..fbd427639159 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/CertificateList.json @@ -12,7 +12,7 @@ "thumbprint": "0123456789abcdef0123456789abcdef01234567", "thumbprintAlgorithm": "sha1", "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", - "state": "deleteFailed", + "state": "deletefailed", "stateTransitionTime": "2014-07-31T21:12:58.236Z", "previousState": "deleting", "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobAdd_Complex.json index 24f1be80ddbd..770bdd8c2ece 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobAdd_Complex.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobAdd_Complex.json @@ -89,7 +89,7 @@ { "thumbprint": "0123456789abcdef0123456789abcdef01234567", "thumbprintAlgorithm": "sha1", - "storeLocation": "localMachine", + "storeLocation": "localmachine", "storeName": "Root", "visibility": [ "task" diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobGet.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobGet.json index 1a5397235d37..9a1504f6c9f0 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobGet.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobGet.json @@ -32,8 +32,8 @@ "poolId": "poolId", "terminateReason": "UserTerminate" }, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction" + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" } } } diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobList.json index 0cd145b3334d..3d418a5dbb5b 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobList.json @@ -31,8 +31,8 @@ "startTime": "2016-11-19T00:05:25.3309105Z", "poolId": "poolId" }, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction" + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" } ] } diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleAdd_Complex.json index cff2e7b5220e..5963c206ac88 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleAdd_Complex.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleAdd_Complex.json @@ -45,7 +45,7 @@ "userIdentity": { "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "runExclusive": true @@ -53,7 +53,7 @@ "poolInfo": { "autoPoolSpecification": { "autoPoolIdPrefix": "mypool", - "poolLifetimeOption": "jobSchedule", + "poolLifetimeOption": "jobschedule", "pool": { "vmSize": "small", "cloudServiceConfiguration": { @@ -96,7 +96,7 @@ { "thumbprint": "0123456789abcdef0123456789abcdef01234567", "thumbprintAlgorithm": "sha1", - "storeLocation": "localMachine", + "storeLocation": "localmachine", "storeName": "Root", "visibility": [ "task" diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleGet.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleGet.json index d58611df767a..990d879d4d20 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleGet.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleGet.json @@ -20,8 +20,8 @@ "jobSpecification": { "priority": 0, "usesTaskDependencies": false, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction", + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", "constraints": { "maxWallClockTime": "P10675199DT2H48M5.4775807S", "maxTaskRetryCount": 0 diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleList.json index 4b343e94048e..807886be4ef1 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/JobScheduleList.json @@ -21,8 +21,8 @@ "jobSpecification": { "priority": 0, "usesTaskDependencies": false, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction", + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", "constraints": { "maxWallClockTime": "P10675199DT2H48M5.4775807S", "maxTaskRetryCount": 0 @@ -52,8 +52,8 @@ "jobSpecification": { "priority": 0, "usesTaskDependencies": false, - "onAllTasksComplete": "noAction", - "onTaskFailure": "noAction", + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", "constraints": { "maxWallClockTime": "P10675199DT2H48M5.4775807S", "maxTaskRetryCount": 0 diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeGet_Basic.json index 36bd026a388d..9f77641967f7 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeGet_Basic.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeGet_Basic.json @@ -28,7 +28,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeList.json index 96ede9afe506..a6d8d4cd4013 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/NodeList.json @@ -29,7 +29,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, @@ -63,7 +63,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, @@ -97,7 +97,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolGet_Basic.json index 64f6ffc16dc1..8a97f2c53081 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolGet_Basic.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolGet_Basic.json @@ -30,7 +30,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolList_Basic.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolList_Basic.json index ab40e3523dd8..abf1070bba6f 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolList_Basic.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/PoolList_Basic.json @@ -31,7 +31,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "maxTaskRetryCount": 0, diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ContainerSettings.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ContainerSettings.json index 43d7fea5afa1..a0c773ea8e26 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ContainerSettings.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ContainerSettings.json @@ -14,7 +14,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } } } diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ExitConditions.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ExitConditions.json index b36767f0538e..e8f13b7be097 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ExitConditions.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskAdd_ExitConditions.json @@ -21,7 +21,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } } } diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskGet.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskGet.json index 1b64cf66d686..02fecd7ae8a4 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskGet.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskGet.json @@ -20,7 +20,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "multiInstanceSettings": { diff --git a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskList.json b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskList.json index 832a0cb4d9b4..7aadb36bd7b8 100644 --- a/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskList.json +++ b/specification/batch/data-plane/Microsoft.Batch/2017-09-01.6.0/examples/TaskList.json @@ -21,7 +21,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "constraints": { @@ -46,7 +46,7 @@ "userIdentity":{ "autoUser": { "scope": "task", - "elevationLevel": "nonAdmin" + "elevationLevel": "nonadmin" } }, "constraints": {