diff --git a/lib/services/batch/lib/models/accountListNodeAgentSkusNextOptions.js b/lib/services/batch/lib/models/accountListNodeAgentSkusNextOptions.js index 51fa533a4d..4a5806dd39 100644 --- a/lib/services/batch/lib/models/accountListNodeAgentSkusNextOptions.js +++ b/lib/services/batch/lib/models/accountListNodeAgentSkusNextOptions.js @@ -17,14 +17,14 @@ class AccountListNodeAgentSkusNextOptions { /** * Create a AccountListNodeAgentSkusNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/accountListNodeAgentSkusOptions.js b/lib/services/batch/lib/models/accountListNodeAgentSkusOptions.js index b44ada4f83..718803121d 100644 --- a/lib/services/batch/lib/models/accountListNodeAgentSkusOptions.js +++ b/lib/services/batch/lib/models/accountListNodeAgentSkusOptions.js @@ -17,23 +17,23 @@ class AccountListNodeAgentSkusOptions { /** * Create a AccountListNodeAgentSkusOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 results will be returned. Default value: 1000 - * . - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 results will be returned. Default value: + * 1000 . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/accountListNodeAgentSkusResult.js b/lib/services/batch/lib/models/accountListNodeAgentSkusResult.js index 4ceb5e27c4..e12abaa634 100644 --- a/lib/services/batch/lib/models/accountListNodeAgentSkusResult.js +++ b/lib/services/batch/lib/models/accountListNodeAgentSkusResult.js @@ -16,7 +16,7 @@ class AccountListNodeAgentSkusResult extends Array { /** * Create a AccountListNodeAgentSkusResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/accountListPoolNodeCountsNextOptions.js b/lib/services/batch/lib/models/accountListPoolNodeCountsNextOptions.js index eb1235963f..07a87f6cde 100644 --- a/lib/services/batch/lib/models/accountListPoolNodeCountsNextOptions.js +++ b/lib/services/batch/lib/models/accountListPoolNodeCountsNextOptions.js @@ -17,14 +17,14 @@ class AccountListPoolNodeCountsNextOptions { /** * Create a AccountListPoolNodeCountsNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/accountListPoolNodeCountsOptions.js b/lib/services/batch/lib/models/accountListPoolNodeCountsOptions.js index 4218d720d9..3343388be4 100644 --- a/lib/services/batch/lib/models/accountListPoolNodeCountsOptions.js +++ b/lib/services/batch/lib/models/accountListPoolNodeCountsOptions.js @@ -17,22 +17,22 @@ class AccountListPoolNodeCountsOptions { /** * Create a AccountListPoolNodeCountsOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch. - * @member {number} [maxResults] The maximum number of items to return in the - * response. Default value: 10 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [maxResults] The maximum number of items to return in + * the response. Default value: 10 . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/affinityInformation.js b/lib/services/batch/lib/models/affinityInformation.js index a8e35b9993..5824935447 100644 --- a/lib/services/batch/lib/models/affinityInformation.js +++ b/lib/services/batch/lib/models/affinityInformation.js @@ -18,8 +18,8 @@ class AffinityInformation { /** * Create a AffinityInformation. - * @member {string} affinityId An opaque string representing the location of - * a compute node or a task that has run previously. You can pass the + * @property {string} affinityId An opaque string representing the location + * of a compute node or a task that has run previously. You can pass the * affinityId of a compute node to indicate that this task needs to run on * that compute node. Note that this is just a soft affinity. If the target * node is busy or unavailable at the time the task is scheduled, then the diff --git a/lib/services/batch/lib/models/applicationGetOptions.js b/lib/services/batch/lib/models/applicationGetOptions.js index 547320700d..75c6101d55 100644 --- a/lib/services/batch/lib/models/applicationGetOptions.js +++ b/lib/services/batch/lib/models/applicationGetOptions.js @@ -17,17 +17,17 @@ class ApplicationGetOptions { /** * Create a ApplicationGetOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/applicationListNextOptions.js b/lib/services/batch/lib/models/applicationListNextOptions.js index 8586e4d4a7..36a56d5697 100644 --- a/lib/services/batch/lib/models/applicationListNextOptions.js +++ b/lib/services/batch/lib/models/applicationListNextOptions.js @@ -17,14 +17,14 @@ class ApplicationListNextOptions { /** * Create a ApplicationListNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/applicationListOptions.js b/lib/services/batch/lib/models/applicationListOptions.js index aa8b410ba8..f98a4248eb 100644 --- a/lib/services/batch/lib/models/applicationListOptions.js +++ b/lib/services/batch/lib/models/applicationListOptions.js @@ -17,20 +17,20 @@ class ApplicationListOptions { /** * Create a ApplicationListOptions. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 applications can be returned. Default value: - * 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 applications can be returned. Default + * value: 1000 . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/applicationListResult.js b/lib/services/batch/lib/models/applicationListResult.js index c37062d546..cdca36fd35 100644 --- a/lib/services/batch/lib/models/applicationListResult.js +++ b/lib/services/batch/lib/models/applicationListResult.js @@ -16,7 +16,7 @@ class ApplicationListResult extends Array { /** * Create a ApplicationListResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/applicationPackageReference.js b/lib/services/batch/lib/models/applicationPackageReference.js index 18c11c8218..0b1ae1179d 100644 --- a/lib/services/batch/lib/models/applicationPackageReference.js +++ b/lib/services/batch/lib/models/applicationPackageReference.js @@ -18,8 +18,8 @@ class ApplicationPackageReference { /** * Create a ApplicationPackageReference. - * @member {string} applicationId The ID of the application to deploy. - * @member {string} [version] The version of the application to deploy. If + * @property {string} applicationId The ID of the application to deploy. + * @property {string} [version] The version of the application to deploy. If * omitted, the default version is deployed. If this is omitted on a pool, * and no default version is specified for this application, the request * fails with the error code InvalidApplicationPackageReferences and HTTP diff --git a/lib/services/batch/lib/models/applicationSummary.js b/lib/services/batch/lib/models/applicationSummary.js index c6f5010c95..e50b29f729 100644 --- a/lib/services/batch/lib/models/applicationSummary.js +++ b/lib/services/batch/lib/models/applicationSummary.js @@ -18,10 +18,10 @@ class ApplicationSummary { /** * Create a ApplicationSummary. - * @member {string} id A string that uniquely identifies the application + * @property {string} id A string that uniquely identifies the application * within the account. - * @member {string} displayName The display name for the application. - * @member {array} versions The list of available versions of the + * @property {string} displayName The display name for the application. + * @property {array} versions The list of available versions of the * application. */ constructor() { diff --git a/lib/services/batch/lib/models/authenticationTokenSettings.js b/lib/services/batch/lib/models/authenticationTokenSettings.js index 6e1c88b4f4..a8569668b7 100644 --- a/lib/services/batch/lib/models/authenticationTokenSettings.js +++ b/lib/services/batch/lib/models/authenticationTokenSettings.js @@ -18,7 +18,7 @@ class AuthenticationTokenSettings { /** * Create a AuthenticationTokenSettings. - * @member {array} [access] The Batch resources to which the token grants + * @property {array} [access] The Batch resources to which the token grants * access. The authentication token grants access to a limited set of Batch * service operations. Currently the only supported value for the access * property is 'job', which grants access to all operations related to the diff --git a/lib/services/batch/lib/models/autoPoolSpecification.js b/lib/services/batch/lib/models/autoPoolSpecification.js index 3d1cb939d9..b58eff8353 100644 --- a/lib/services/batch/lib/models/autoPoolSpecification.js +++ b/lib/services/batch/lib/models/autoPoolSpecification.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Specifies characteristics for a temporary 'auto pool'. The Batch * service will create this auto pool when the job is submitted. @@ -20,29 +18,29 @@ const models = require('./index'); class AutoPoolSpecification { /** * Create a AutoPoolSpecification. - * @member {string} [autoPoolIdPrefix] A prefix to be added to the unique + * @property {string} [autoPoolIdPrefix] A prefix to be added to the unique * identifier when a pool is automatically created. The Batch service assigns * each auto pool a unique identifier on creation. To distinguish between * pools created for different purposes, you can specify this element to add * a prefix to the ID that is assigned. The prefix can be up to 20 characters * long. - * @member {string} poolLifetimeOption The minimum lifetime of created auto + * @property {string} poolLifetimeOption The minimum lifetime of created auto * pools, and how multiple jobs on a schedule are assigned to pools. Possible * values include: 'jobSchedule', 'job' - * @member {boolean} [keepAlive] Whether to keep an auto pool alive after its - * lifetime expires. If false, the Batch service deletes the pool once its - * lifetime (as determined by the poolLifetimeOption setting) expires; that - * is, when the job or job schedule completes. If true, the Batch service - * does not delete the pool automatically. It is up to the user to delete - * auto pools created with this option. - * @member {object} [pool] The pool specification for the auto pool. - * @member {string} [pool.displayName] The display name need not be unique + * @property {boolean} [keepAlive] Whether to keep an auto pool alive after + * its lifetime expires. If false, the Batch service deletes the pool once + * its lifetime (as determined by the poolLifetimeOption setting) expires; + * that is, when the job or job schedule completes. If true, the Batch + * service does not delete the pool automatically. It is up to the user to + * delete auto pools created with this option. + * @property {object} [pool] The pool specification for the auto pool. + * @property {string} [pool.displayName] The display name need not be unique * and can contain any Unicode characters up to a maximum length of 1024. - * @member {string} [pool.vmSize] For information about available sizes of + * @property {string} [pool.vmSize] For information about available sizes of * virtual machines in pools, see Choose a VM size for compute nodes in an * Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} [pool.cloudServiceConfiguration] This property must be + * @property {object} [pool.cloudServiceConfiguration] This property must be * specified if the pool needs to be created with Azure PaaS VMs. This * property and virtualMachineConfiguration are mutually exclusive and one of * the properties must be specified. If neither is specified then the Batch @@ -50,41 +48,42 @@ class AutoPoolSpecification { * HTTP status code is 400 (Bad Request). This property cannot be specified * if the Batch account was created with its poolAllocationMode property set * to 'UserSubscription'. - * @member {string} [pool.cloudServiceConfiguration.osFamily] Possible values - * are: + * @property {string} [pool.cloudServiceConfiguration.osFamily] Possible + * values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. * 3 - OS Family 3, equivalent to Windows Server 2012. * 4 - OS Family 4, equivalent to Windows Server 2012 R2. * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [pool.cloudServiceConfiguration.osVersion] The default + * @property {string} [pool.cloudServiceConfiguration.osVersion] The default * value is * which specifies the latest operating system version for the * specified OS family. - * @member {object} [pool.virtualMachineConfiguration] This property must be - * specified if the pool needs to be created with Azure IaaS VMs. This + * @property {object} [pool.virtualMachineConfiguration] This property must + * be specified if the pool needs to be created with Azure IaaS VMs. This * property and cloudServiceConfiguration are mutually exclusive and one of * the properties must be specified. If neither is specified then the Batch * service returns an error; if you are calling the REST API directly, the * HTTP status code is 400 (Bad Request). - * @member {object} [pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {object} [pool.virtualMachineConfiguration.imageReference] + * @property {string} * [pool.virtualMachineConfiguration.imageReference.publisher] For example, * Canonical or MicrosoftWindowsServer. - * @member {string} [pool.virtualMachineConfiguration.imageReference.offer] + * @property {string} [pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} [pool.virtualMachineConfiguration.imageReference.sku] For - * example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} [pool.virtualMachineConfiguration.imageReference.sku] + * For example, 14.04.0-LTS or 2012-R2-Datacenter. + * @property {string} + * [pool.virtualMachineConfiguration.imageReference.version] A value of + * 'latest' can be specified to select the latest version of an image. If + * omitted, the default is 'latest'. + * @property {string} * [pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} [pool.virtualMachineConfiguration.nodeAgentSKUId] The + * @property {string} [pool.virtualMachineConfiguration.nodeAgentSKUId] The * Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch * service. There are different implementations of the node agent, known as @@ -92,86 +91,88 @@ class AutoPoolSpecification { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} [pool.virtualMachineConfiguration.windowsConfiguration] + * @property {object} [pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} [pool.virtualMachineConfiguration.dataDisks] 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 + * @property {array} [pool.virtualMachineConfiguration.dataDisks] 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. - * @member {string} [pool.virtualMachineConfiguration.licenseType] This only - * applies to images that contain the Windows operating system, and should - * only be used when you hold valid on-premises licenses for the nodes which - * will be deployed. If omitted, no on-premises licensing discount is + * @property {string} [pool.virtualMachineConfiguration.licenseType] This + * only applies to images that contain the Windows operating system, and + * should only be used when you hold valid on-premises licenses for the nodes + * which will be deployed. If omitted, no on-premises licensing discount is * applied. Values are: * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks - * to run in containers. All regular tasks and job manager tasks run on this - * pool must specify the containerSettings property, and all other tasks may - * specify it. - * @member {array} + * @property {object} + * [pool.virtualMachineConfiguration.containerConfiguration] If specified, + * setup is performed on each node in the pool to allow tasks to run in + * containers. All regular tasks and job manager tasks run on this pool must + * specify the containerSettings property, and all other tasks may specify + * it. + * @property {array} * [pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} [pool.maxTasksPerNode] The default value is 1. The + * @property {number} [pool.maxTasksPerNode] The default value is 1. The * maximum value of this setting depends on the size of the compute nodes in * the pool (the vmSize setting). - * @member {object} [pool.taskSchedulingPolicy] - * @member {string} [pool.taskSchedulingPolicy.nodeFillType] Possible values - * include: 'spread', 'pack' - * @member {moment.duration} [pool.resizeTimeout] This timeout applies only + * @property {object} [pool.taskSchedulingPolicy] + * @property {string} [pool.taskSchedulingPolicy.nodeFillType] Possible + * values include: 'spread', 'pack' + * @property {moment.duration} [pool.resizeTimeout] This timeout applies only * to manual scaling; it has no effect when enableAutoScale is set to true. * The default value is 15 minutes. The minimum value is 5 minutes. If you * specify a value less than 5 minutes, the Batch service rejects the request * with an error; if you are calling the REST API directly, the HTTP status * code is 400 (Bad Request). - * @member {number} [pool.targetDedicatedNodes] This property must not be + * @property {number} [pool.targetDedicatedNodes] This property must not be * specified if enableAutoScale is set to true. If enableAutoScale is set to * false, then you must set either targetDedicatedNodes, * targetLowPriorityNodes, or both. - * @member {number} [pool.targetLowPriorityNodes] This property must not be + * @property {number} [pool.targetLowPriorityNodes] This property must not be * specified if enableAutoScale is set to true. If enableAutoScale is set to * false, then you must set either targetDedicatedNodes, * targetLowPriorityNodes, or both. - * @member {boolean} [pool.enableAutoScale] If false, at least one of + * @property {boolean} [pool.enableAutoScale] If false, at least one of * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, * the autoScaleFormula element is required. The pool automatically resizes * according to the formula. The default value is false. - * @member {string} [pool.autoScaleFormula] This property must not be + * @property {string} [pool.autoScaleFormula] This property must not be * specified if enableAutoScale is set to false. It is required if * enableAutoScale is set to true. The formula is checked for validity before * the pool is created. If the formula is not valid, the Batch service * rejects the request with detailed error information. - * @member {moment.duration} [pool.autoScaleEvaluationInterval] The default + * @property {moment.duration} [pool.autoScaleEvaluationInterval] The default * value is 15 minutes. The minimum and maximum value are 5 minutes and 168 * hours respectively. If you specify a value less than 5 minutes or greater * than 168 hours, the Batch service rejects the request with an invalid * property value error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {boolean} [pool.enableInterNodeCommunication] Enabling inter-node - * communication limits the maximum size of the pool due to deployment - * restrictions on the nodes of the pool. This may result in the pool not - * reaching its desired size. The default value is false. - * @member {object} [pool.networkConfiguration] - * @member {string} [pool.networkConfiguration.subnetId] This is of the form + * @property {boolean} [pool.enableInterNodeCommunication] Enabling + * inter-node communication limits the maximum size of the pool due to + * deployment restrictions on the nodes of the pool. This may result in the + * pool not reaching its desired size. The default value is false. + * @property {object} [pool.networkConfiguration] + * @property {string} [pool.networkConfiguration.subnetId] This is of the + * form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the * Azure Batch account. The specified subnet should have enough free IP @@ -183,18 +184,18 @@ class AutoPoolSpecification { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [pool.networkConfiguration.dynamicVNetAssignmentScope] + * @property {string} [pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} [pool.networkConfiguration.endpointConfiguration] Pool + * @property {object} [pool.networkConfiguration.endpointConfiguration] Pool * endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [pool.networkConfiguration.endpointConfiguration.inboundNATPools] The * maximum number of inbound NAT pools per Batch pool is 5. If the maximum * number of inbound NAT pools is exceeded the request fails with HTTP status * code 400. - * @member {object} [pool.startTask] - * @member {string} [pool.startTask.commandLine] The command line does not + * @property {object} [pool.startTask] + * @property {string} [pool.startTask.commandLine] The command line does not * run under a shell, and therefore cannot take advantage of shell features * such as environment variable expansion. If you want to take advantage of * such features, you should invoke the shell in the command line, for @@ -203,41 +204,42 @@ class AutoPoolSpecification { * path (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [pool.startTask.containerSettings] When this is + * @property {object} [pool.startTask.containerSettings] When this is * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR * (the root of Azure Batch directories on the node) are mapped into the * container, all task environment variables are mapped into the container, * and the task command line is executed in the container. - * @member {string} [pool.startTask.containerSettings.containerRunOptions] + * @property {string} [pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [pool.startTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a + * @property {string} [pool.startTask.containerSettings.imageName] This is + * the full image reference, as would be specified to "docker pull". If no + * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [pool.startTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} + * @property {object} [pool.startTask.containerSettings.registry] This + * setting can be omitted if was already provided at pool creation. + * @property {string} * [pool.startTask.containerSettings.registry.registryServer] If omitted, the * default is "docker.io". - * @member {string} [pool.startTask.containerSettings.registry.userName] - * @member {string} [pool.startTask.containerSettings.registry.password] - * @member {array} [pool.startTask.resourceFiles] Files listed under this + * @property {string} [pool.startTask.containerSettings.registry.userName] + * @property {string} [pool.startTask.containerSettings.registry.password] + * @property {array} [pool.startTask.resourceFiles] Files listed under this * element are located in the task's working directory. - * @member {array} [pool.startTask.environmentSettings] - * @member {object} [pool.startTask.userIdentity] If omitted, the task runs + * @property {array} [pool.startTask.environmentSettings] + * @property {object} [pool.startTask.userIdentity] If omitted, the task runs * as a non-administrative user unique to the task. - * @member {string} [pool.startTask.userIdentity.userName] The userName and + * @property {string} [pool.startTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [pool.startTask.userIdentity.autoUser] The userName and + * @property {object} [pool.startTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [pool.startTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [pool.startTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [pool.startTask.maxTaskRetryCount] The Batch service + * @property {string} [pool.startTask.userIdentity.autoUser.scope] The + * default value is task. Possible values include: 'task', 'pool' + * @property {string} [pool.startTask.userIdentity.autoUser.elevationLevel] + * The default value is nonAdmin. Possible values include: 'nonAdmin', + * 'admin' + * @property {number} [pool.startTask.maxTaskRetryCount] The Batch service * retries a task if its exit code is nonzero. Note that this value * specifically controls the number of retries. The Batch service will try * the task once, and may then retry up to this limit. For example, if the @@ -245,7 +247,7 @@ class AutoPoolSpecification { * try and 3 retries). If the maximum retry count is 0, the Batch service * does not retry the task. If the maximum retry count is -1, the Batch * service retries the task without limit. - * @member {boolean} [pool.startTask.waitForSuccess] If true and the start + * @property {boolean} [pool.startTask.waitForSuccess] If true and the start * task fails on a compute node, the Batch service retries the start task up * to its maximum retry count (maxTaskRetryCount). If the task has still not * completed successfully after all retries, then the Batch service marks the @@ -255,7 +257,7 @@ class AutoPoolSpecification { * other tasks can start executing on the compute node while the start task * is still running; and even if the start task fails, new tasks will * continue to be scheduled on the node. The default is false. - * @member {array} [pool.certificateReferences] For Windows compute nodes, + * @property {array} [pool.certificateReferences] For Windows compute nodes, * the Batch service installs the certificates to the specified certificate * store and location. For Linux compute nodes, the certificates are stored * in a directory inside the task working directory and an environment @@ -263,15 +265,15 @@ class AutoPoolSpecification { * 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. - * @member {array} [pool.applicationPackageReferences] - * @member {array} [pool.applicationLicenses] The list of application + * @property {array} [pool.applicationPackageReferences] + * @property {array} [pool.applicationLicenses] The list of application * licenses must be a subset of available Batch service application licenses. * If a license is requested which is not supported, pool creation will fail. * The permitted licenses available on the pool are 'maya', 'vray', '3dsmax', * 'arnold'. An additional charge applies for each application license added * to the pool. - * @member {array} [pool.userAccounts] - * @member {array} [pool.metadata] The Batch service does not assign any + * @property {array} [pool.userAccounts] + * @property {array} [pool.metadata] The Batch service does not assign any * meaning to metadata; it is solely for the use of user code. */ constructor() { diff --git a/lib/services/batch/lib/models/autoScaleRun.js b/lib/services/batch/lib/models/autoScaleRun.js index f633d5ec83..e6ebe0cb2f 100644 --- a/lib/services/batch/lib/models/autoScaleRun.js +++ b/lib/services/batch/lib/models/autoScaleRun.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The results and errors from an execution of a pool autoscale * formula. @@ -20,16 +18,16 @@ const models = require('./index'); class AutoScaleRun { /** * Create a AutoScaleRun. - * @member {date} timestamp The time at which the autoscale formula was last - * evaluated. - * @member {string} [results] The final values of all variables used in the + * @property {date} timestamp The time at which the autoscale formula was + * last evaluated. + * @property {string} [results] The final values of all variables used in the * evaluation of the autoscale formula. Each variable value is returned in * the form $variable=value, and variables are separated by semicolons. - * @member {object} [error] Details of the error encountered evaluating the + * @property {object} [error] Details of the error encountered evaluating the * autoscale formula on the pool, if the evaluation was unsuccessful. - * @member {string} [error.code] - * @member {string} [error.message] - * @member {array} [error.values] + * @property {string} [error.code] + * @property {string} [error.message] + * @property {array} [error.values] */ constructor() { } diff --git a/lib/services/batch/lib/models/autoScaleRunError.js b/lib/services/batch/lib/models/autoScaleRunError.js index 1e05bc61e8..37515faa7b 100644 --- a/lib/services/batch/lib/models/autoScaleRunError.js +++ b/lib/services/batch/lib/models/autoScaleRunError.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An error that occurred when executing or evaluating a pool * autoscale formula. @@ -20,12 +18,12 @@ const models = require('./index'); class AutoScaleRunError { /** * Create a AutoScaleRunError. - * @member {string} [code] An identifier for the autoscale error. Codes are + * @property {string} [code] An identifier for the autoscale error. Codes are * invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the autoscale error, + * @property {string} [message] A message describing the autoscale error, * intended to be suitable for display in a user interface. - * @member {array} [values] A list of additional error details related to the - * autoscale error. + * @property {array} [values] A list of additional error details related to + * the autoscale error. */ constructor() { } diff --git a/lib/services/batch/lib/models/autoUserSpecification.js b/lib/services/batch/lib/models/autoUserSpecification.js index 72ffd4cf97..00a73fa772 100644 --- a/lib/services/batch/lib/models/autoUserSpecification.js +++ b/lib/services/batch/lib/models/autoUserSpecification.js @@ -18,9 +18,9 @@ class AutoUserSpecification { /** * Create a AutoUserSpecification. - * @member {string} [scope] The scope for the auto user. The default value is - * task. Possible values include: 'task', 'pool' - * @member {string} [elevationLevel] The elevation level of the auto user. + * @property {string} [scope] The scope for the auto user. The default value + * is task. Possible values include: 'task', 'pool' + * @property {string} [elevationLevel] The elevation level of the auto user. * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' */ diff --git a/lib/services/batch/lib/models/batchError.js b/lib/services/batch/lib/models/batchError.js index d6cf927bdd..c26fe66787 100644 --- a/lib/services/batch/lib/models/batchError.js +++ b/lib/services/batch/lib/models/batchError.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An error response received from the Azure Batch service. * @@ -19,13 +17,13 @@ const models = require('./index'); class BatchError { /** * Create a BatchError. - * @member {string} [code] An identifier for the error. Codes are invariant + * @property {string} [code] An identifier for the error. Codes are invariant * and are intended to be consumed programmatically. - * @member {object} [message] A message describing the error, intended to be - * suitable for display in a user interface. - * @member {string} [message.lang] - * @member {string} [message.value] - * @member {array} [values] A collection of key-value pairs containing + * @property {object} [message] A message describing the error, intended to + * be suitable for display in a user interface. + * @property {string} [message.lang] + * @property {string} [message.value] + * @property {array} [values] A collection of key-value pairs containing * additional details about the error. */ constructor() { diff --git a/lib/services/batch/lib/models/batchErrorDetail.js b/lib/services/batch/lib/models/batchErrorDetail.js index 5049e0b4d7..119e8055ed 100644 --- a/lib/services/batch/lib/models/batchErrorDetail.js +++ b/lib/services/batch/lib/models/batchErrorDetail.js @@ -18,9 +18,9 @@ class BatchErrorDetail { /** * Create a BatchErrorDetail. - * @member {string} [key] An identifier specifying the meaning of the Value + * @property {string} [key] An identifier specifying the meaning of the Value * property. - * @member {string} [value] The additional information included with the + * @property {string} [value] The additional information included with the * error response. */ constructor() { diff --git a/lib/services/batch/lib/models/certificate.js b/lib/services/batch/lib/models/certificate.js index 3603174353..6d35b4b1de 100644 --- a/lib/services/batch/lib/models/certificate.js +++ b/lib/services/batch/lib/models/certificate.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * A certificate that can be installed on compute nodes and can be used to * authenticate operations on the machine. @@ -20,32 +18,32 @@ const models = require('./index'); class Certificate { /** * Create a Certificate. - * @member {string} [thumbprint] The X.509 thumbprint of the certificate. + * @property {string} [thumbprint] The X.509 thumbprint of the certificate. * This is a sequence of up to 40 hex digits. - * @member {string} [thumbprintAlgorithm] The algorithm used to derive the + * @property {string} [thumbprintAlgorithm] The algorithm used to derive the * thumbprint. - * @member {string} [url] The URL of the certificate. - * @member {string} [state] The current state of the certificate. Possible + * @property {string} [url] The URL of the certificate. + * @property {string} [state] The current state of the certificate. Possible * values include: 'active', 'deleting', 'deleteFailed' - * @member {date} [stateTransitionTime] The time at which the certificate + * @property {date} [stateTransitionTime] The time at which the certificate * entered its current state. - * @member {string} [previousState] The previous state of the certificate. + * @property {string} [previousState] The previous state of the certificate. * This property is not set if the certificate is in its initial active * state. Possible values include: 'active', 'deleting', 'deleteFailed' - * @member {date} [previousStateTransitionTime] The time at which the + * @property {date} [previousStateTransitionTime] The time at which the * certificate entered its previous state. This property is not set if the * certificate is in its initial Active state. - * @member {string} [publicData] The public part of the certificate as a + * @property {string} [publicData] The public part of the certificate as a * base-64 encoded .cer file. - * @member {object} [deleteCertificateError] The error that occurred on the + * @property {object} [deleteCertificateError] The error that occurred on the * last attempt to delete this certificate. This property is set only if the * certificate is in the DeleteFailed state. - * @member {string} [deleteCertificateError.code] - * @member {string} [deleteCertificateError.message] - * @member {array} [deleteCertificateError.values] This list includes details - * such as the active pools and nodes referencing this certificate. However, - * if a large number of resources reference the certificate, the list - * contains only about the first hundred. + * @property {string} [deleteCertificateError.code] + * @property {string} [deleteCertificateError.message] + * @property {array} [deleteCertificateError.values] This list includes + * details such as the active pools and nodes referencing this certificate. + * However, if a large number of resources reference the certificate, the + * list contains only about the first hundred. */ constructor() { } diff --git a/lib/services/batch/lib/models/certificateAddOptions.js b/lib/services/batch/lib/models/certificateAddOptions.js index 32f473428f..8c3bad52b4 100644 --- a/lib/services/batch/lib/models/certificateAddOptions.js +++ b/lib/services/batch/lib/models/certificateAddOptions.js @@ -17,17 +17,17 @@ class CertificateAddOptions { /** * Create a CertificateAddOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/certificateAddParameter.js b/lib/services/batch/lib/models/certificateAddParameter.js index 5cba8cc33a..453a8718bb 100644 --- a/lib/services/batch/lib/models/certificateAddParameter.js +++ b/lib/services/batch/lib/models/certificateAddParameter.js @@ -18,16 +18,16 @@ class CertificateAddParameter { /** * Create a CertificateAddParameter. - * @member {string} thumbprint The X.509 thumbprint of the certificate. This - * is a sequence of up to 40 hex digits (it may include spaces but these are - * removed). - * @member {string} thumbprintAlgorithm The algorithm used to derive the + * @property {string} thumbprint The X.509 thumbprint of the certificate. + * This is a sequence of up to 40 hex digits (it may include spaces but these + * are removed). + * @property {string} thumbprintAlgorithm The algorithm used to derive the * thumbprint. This must be sha1. - * @member {string} data The base64-encoded contents of the certificate. The - * maximum size is 10KB. - * @member {string} [certificateFormat] The format of the certificate data. + * @property {string} data The base64-encoded contents of the certificate. + * The maximum size is 10KB. + * @property {string} [certificateFormat] The format of the certificate data. * Possible values include: 'pfx', 'cer' - * @member {string} [password] The password to access the certificate's + * @property {string} [password] The password to access the certificate's * private key. This is required if the certificate format is pfx. It should * be omitted if the certificate format is cer. */ diff --git a/lib/services/batch/lib/models/certificateCancelDeletionOptions.js b/lib/services/batch/lib/models/certificateCancelDeletionOptions.js index a49180d9f4..d4ae52a9f9 100644 --- a/lib/services/batch/lib/models/certificateCancelDeletionOptions.js +++ b/lib/services/batch/lib/models/certificateCancelDeletionOptions.js @@ -17,17 +17,17 @@ class CertificateCancelDeletionOptions { /** * Create a CertificateCancelDeletionOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/certificateDeleteMethodOptions.js b/lib/services/batch/lib/models/certificateDeleteMethodOptions.js index c02d276b20..60ee4179ef 100644 --- a/lib/services/batch/lib/models/certificateDeleteMethodOptions.js +++ b/lib/services/batch/lib/models/certificateDeleteMethodOptions.js @@ -17,17 +17,17 @@ class CertificateDeleteMethodOptions { /** * Create a CertificateDeleteMethodOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/certificateGetOptions.js b/lib/services/batch/lib/models/certificateGetOptions.js index 258d13d73c..cd97ed6f90 100644 --- a/lib/services/batch/lib/models/certificateGetOptions.js +++ b/lib/services/batch/lib/models/certificateGetOptions.js @@ -17,18 +17,18 @@ class CertificateGetOptions { /** * Create a CertificateGetOptions. - * @member {string} [select] An OData $select clause. - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/certificateListNextOptions.js b/lib/services/batch/lib/models/certificateListNextOptions.js index f9e6b6062b..f44b6d28c1 100644 --- a/lib/services/batch/lib/models/certificateListNextOptions.js +++ b/lib/services/batch/lib/models/certificateListNextOptions.js @@ -17,14 +17,14 @@ class CertificateListNextOptions { /** * Create a CertificateListNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/certificateListOptions.js b/lib/services/batch/lib/models/certificateListOptions.js index b344dd1ac4..b7beef0920 100644 --- a/lib/services/batch/lib/models/certificateListOptions.js +++ b/lib/services/batch/lib/models/certificateListOptions.js @@ -17,24 +17,24 @@ class CertificateListOptions { /** * Create a CertificateListOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates. - * @member {string} [select] An OData $select clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 certificates can be returned. Default value: - * 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 certificates can be returned. Default + * value: 1000 . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/certificateListResult.js b/lib/services/batch/lib/models/certificateListResult.js index 4eb9a31d48..b1f826297f 100644 --- a/lib/services/batch/lib/models/certificateListResult.js +++ b/lib/services/batch/lib/models/certificateListResult.js @@ -16,7 +16,7 @@ class CertificateListResult extends Array { /** * Create a CertificateListResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/certificateReference.js b/lib/services/batch/lib/models/certificateReference.js index 832367c7c9..fc0cf76d61 100644 --- a/lib/services/batch/lib/models/certificateReference.js +++ b/lib/services/batch/lib/models/certificateReference.js @@ -18,28 +18,29 @@ class CertificateReference { /** * Create a CertificateReference. - * @member {string} thumbprint The thumbprint of the certificate. - * @member {string} thumbprintAlgorithm The algorithm with which the + * @property {string} thumbprint The thumbprint of the certificate. + * @property {string} thumbprintAlgorithm The algorithm with which the * thumbprint is associated. This must be sha1. - * @member {string} [storeLocation] The location of the certificate store on - * the compute node into which to install the certificate. 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. Possible values include: 'currentUser', 'localMachine' - * @member {string} [storeName] The name of the certificate store on the + * @property {string} [storeLocation] The location of the certificate store + * on the compute node into which to install the certificate. 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. + * Possible values include: 'currentUser', 'localMachine' + * @property {string} [storeName] The name of the certificate store on the * compute node into which to install the certificate. This property is * applicable only for pools configured with Windows nodes (that is, created * with cloudServiceConfiguration, or with virtualMachineConfiguration using * a Windows image reference). Common store names include: My, Root, CA, * Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, * but any custom store name can also be used. The default value is My. - * @member {array} [visibility] Which user accounts on the compute node + * @property {array} [visibility] Which user accounts on the compute node * should have access to the private data of the certificate. You can specify * more than one visibility in this collection. The default is all accounts. */ diff --git a/lib/services/batch/lib/models/cloudJob.js b/lib/services/batch/lib/models/cloudJob.js index 8e110bbc6d..850e8b5a0e 100644 --- a/lib/services/batch/lib/models/cloudJob.js +++ b/lib/services/batch/lib/models/cloudJob.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An Azure Batch job. * @@ -19,59 +17,59 @@ const models = require('./index'); class CloudJob { /** * Create a CloudJob. - * @member {string} [id] A string that uniquely identifies the job within the - * account. The ID is case-preserving and case-insensitive (that is, you may - * not have two IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the job. - * @member {boolean} [usesTaskDependencies] Whether tasks in the job can + * @property {string} [id] A string that uniquely identifies the job within + * the account. The ID is case-preserving and case-insensitive (that is, you + * may not have two IDs within an account that differ only by case). + * @property {string} [displayName] The display name for the job. + * @property {boolean} [usesTaskDependencies] Whether tasks in the job can * define dependencies on each other. The default is false. - * @member {string} [url] The URL of the job. - * @member {string} [eTag] The ETag of the job. This is an opaque string. You - * can use it to detect whether the job has changed between requests. In + * @property {string} [url] The URL of the job. + * @property {string} [eTag] The ETag of the job. This is an opaque string. + * You can use it to detect whether the job has changed between requests. In * particular, you can be pass the ETag when updating a job to specify that * your changes should take effect only if nobody else has modified the job * in the meantime. - * @member {date} [lastModified] The last modified time of the job. This is + * @property {date} [lastModified] The last modified time of the job. This is * the last time at which the job level data, such as the job state or * priority, changed. It does not factor in task-level changes such as adding * new tasks or tasks changing state. - * @member {date} [creationTime] The creation time of the job. - * @member {string} [state] The current state of the job. Possible values + * @property {date} [creationTime] The creation time of the job. + * @property {string} [state] The current state of the job. Possible values * include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', * 'completed', 'deleting' - * @member {date} [stateTransitionTime] The time at which the job entered its - * current state. - * @member {string} [previousState] The previous state of the job. This + * @property {date} [stateTransitionTime] The time at which the job entered + * its current state. + * @property {string} [previousState] The previous state of the job. This * property is not set if the job is in its initial Active state. Possible * values include: 'active', 'disabling', 'disabled', 'enabling', * 'terminating', 'completed', 'deleting' - * @member {date} [previousStateTransitionTime] The time at which the job + * @property {date} [previousStateTransitionTime] The time at which the job * entered its previous state. This property is not set if the job is in its * initial Active state. - * @member {number} [priority] The priority of the job. Priority values can + * @property {number} [priority] The priority of the job. Priority values can * range from -1000 to 1000, with -1000 being the lowest priority and 1000 * being the highest priority. The default value is 0. - * @member {object} [constraints] The execution constraints for the job. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does + * @property {object} [constraints] The execution constraints for the job. + * @property {moment.duration} [constraints.maxWallClockTime] If the job does * not complete within the time limit, the Batch service terminates it and * any tasks that are still running. In this case, the termination reason * will be MaxWallClockTimeExpiry. If this property is not specified, there * is no time limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries. The Batch service will try * each task once, and may then retry up to this limit. For example, if the * maximum retry count is 3, Batch tries a task up to 4 times (one initial * try and 3 retries). If the maximum retry count is 0, the Batch service * does not retry tasks. If the maximum retry count is -1, the Batch service * retries tasks without limit. The default value is 0 (no retries). - * @member {object} [jobManagerTask] Details of a Job Manager task to be + * @property {object} [jobManagerTask] Details of a Job Manager task to be * launched when the job is started. - * @member {string} [jobManagerTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot + * @property {string} [jobManagerTask.id] The ID can contain any combination + * of alphanumeric characters including hyphens and underscores and cannot * contain more than 64 characters. - * @member {string} [jobManagerTask.displayName] It need not be unique and + * @property {string} [jobManagerTask.displayName] It need not be unique and * can contain any Unicode characters up to a maximum length of 1024. - * @member {string} [jobManagerTask.commandLine] The command line does not + * @property {string} [jobManagerTask.commandLine] The command line does not * run under a shell, and therefore cannot take advantage of shell features * such as environment variable expansion. If you want to take advantage of * such features, you should invoke the shell in the command line, for @@ -80,55 +78,55 @@ class CloudJob { * path (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobManagerTask.containerSettings] If the pool that will - * run this task has containerConfiguration set, this must be set as well. If - * the pool that will run this task doesn't have containerConfiguration set, - * this must not be set. When this is specified, all directories recursively - * below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on - * the node) are mapped into the container, all task environment variables - * are mapped into the container, and the task command line is executed in - * the container. - * @member {string} [jobManagerTask.containerSettings.containerRunOptions] + * @property {object} [jobManagerTask.containerSettings] If the pool that + * will run this task has containerConfiguration set, this must be set as + * well. If the pool that will run this task doesn't have + * containerConfiguration set, this must not be set. When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * Azure Batch directories on the node) are mapped into the container, all + * task environment variables are mapped into the container, and the task + * command line is executed in the container. + * @property {string} [jobManagerTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a + * @property {string} [jobManagerTask.containerSettings.imageName] This is + * the full image reference, as would be specified to "docker pull". If no + * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} + * @property {object} [jobManagerTask.containerSettings.registry] This + * setting can be omitted if was already provided at pool creation. + * @property {string} * [jobManagerTask.containerSettings.registry.registryServer] If omitted, the * default is "docker.io". - * @member {string} [jobManagerTask.containerSettings.registry.userName] - * @member {string} [jobManagerTask.containerSettings.registry.password] - * @member {array} [jobManagerTask.resourceFiles] Files listed under this + * @property {string} [jobManagerTask.containerSettings.registry.userName] + * @property {string} [jobManagerTask.containerSettings.registry.password] + * @property {array} [jobManagerTask.resourceFiles] Files listed under this * element are located in the task's working directory. There is a maximum * size for the list of resource files. When the max size is exceeded, the * request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobManagerTask.outputFiles] For multi-instance tasks, the - * files will only be uploaded from the compute node on which the primary + * @property {array} [jobManagerTask.outputFiles] For multi-instance tasks, + * the files will only be uploaded from the compute node on which the primary * task is executed. - * @member {array} [jobManagerTask.environmentSettings] - * @member {object} [jobManagerTask.constraints] - * @member {moment.duration} [jobManagerTask.constraints.maxWallClockTime] If - * this is not specified, there is no time limit on how long the task may + * @property {array} [jobManagerTask.environmentSettings] + * @property {object} [jobManagerTask.constraints] + * @property {moment.duration} [jobManagerTask.constraints.maxWallClockTime] + * If this is not specified, there is no time limit on how long the task may * run. - * @member {moment.duration} [jobManagerTask.constraints.retentionTime] The + * @property {moment.duration} [jobManagerTask.constraints.retentionTime] The * default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} [jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task + * @property {number} [jobManagerTask.constraints.maxTaskRetryCount] Note + * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task * once, and may then retry up to this limit. For example, if the maximum * retry count is 3, Batch tries the task up to 4 times (one initial try and * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobManagerTask.killJobOnCompletion] If true, when the + * @property {boolean} [jobManagerTask.killJobOnCompletion] If true, when the * Job Manager task completes, the Batch service marks the job as complete. * If any tasks are still running at this time (other than Job Release), * those tasks are terminated. If false, the completion of the Job Manager @@ -141,32 +139,33 @@ class CloudJob { * and using the Job Manager task only to create the tasks for the job (not * to monitor progress), then it is important to set killJobOnCompletion to * false. - * @member {object} [jobManagerTask.userIdentity] If omitted, the task runs + * @property {object} [jobManagerTask.userIdentity] If omitted, the task runs * as a non-administrative user unique to the task. - * @member {string} [jobManagerTask.userIdentity.userName] The userName and + * @property {string} [jobManagerTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [jobManagerTask.userIdentity.autoUser] The userName and + * @property {object} [jobManagerTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobManagerTask.runExclusive] If true, no other tasks + * @property {string} [jobManagerTask.userIdentity.autoUser.scope] The + * default value is task. Possible values include: 'task', 'pool' + * @property {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] + * The default value is nonAdmin. Possible values include: 'nonAdmin', + * 'admin' + * @property {boolean} [jobManagerTask.runExclusive] If true, no other tasks * will run on the same compute node for as long as the Job Manager is * running. If false, other tasks can run simultaneously with the Job Manager * on a compute node. The Job Manager task counts normally against the node's * concurrent task limit, so this is only relevant if the node allows * multiple concurrent tasks. The default value is true. - * @member {array} [jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the - * existing copy on the compute node is used. If a referenced application - * package cannot be installed, for example because the package has been - * deleted or because download failed, the task fails. - * @member {object} [jobManagerTask.authenticationTokenSettings] If this + * @property {array} [jobManagerTask.applicationPackageReferences] + * Application packages are downloaded and deployed to a shared directory, + * not the task working directory. Therefore, if a referenced package is + * already on the compute node, and is up to date, then it is not + * re-downloaded; the existing copy on the compute node is used. If a + * referenced application package cannot be installed, for example because + * the package has been deleted or because download failed, the task fails. + * @property {object} [jobManagerTask.authenticationTokenSettings] If this * property is set, the Batch service provides the task with an * authentication token which can be used to authenticate Batch service * operations without requiring an account access key. The token is provided @@ -174,17 +173,17 @@ class CloudJob { * that the task can carry out using the token depend on the settings. For * example, a task can request job permissions in order to add other tasks to * the job, or check the status of the job or of other tasks under the job. - * @member {array} [jobManagerTask.authenticationTokenSettings.access] The + * @property {array} [jobManagerTask.authenticationTokenSettings.access] The * authentication token grants access to a limited set of Batch service * operations. Currently the only supported value for the access property is * 'job', which grants access to all operations related to the job which * contains the task. - * @member {boolean} [jobManagerTask.allowLowPriorityNode] The default value - * is true. - * @member {object} [jobPreparationTask] The Job Preparation task. The Job + * @property {boolean} [jobManagerTask.allowLowPriorityNode] The default + * value is true. + * @property {object} [jobPreparationTask] The Job Preparation task. The Job * Preparation task is a special task run on each node before any other task * of the job. - * @member {string} [jobPreparationTask.id] The ID can contain any + * @property {string} [jobPreparationTask.id] The ID can contain any * combination of alphanumeric characters including hyphens and underscores * and cannot contain more than 64 characters. If you do not specify this * property, the Batch service assigns a default value of 'jobpreparation'. @@ -192,7 +191,7 @@ class CloudJob { * If you try to submit a task with the same id, the Batch service rejects * the request with error code TaskIdSameAsJobPreparationTask; if you are * calling the REST API directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobPreparationTask.commandLine] The command line does + * @property {string} [jobPreparationTask.commandLine] The command line does * not run under a shell, and therefore cannot take advantage of shell * features such as environment variable expansion. If you want to take * advantage of such features, you should invoke the shell in the command @@ -201,42 +200,44 @@ class CloudJob { * use a relative path (relative to the task working directory), or use the * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobPreparationTask.containerSettings] When this is + * @property {object} [jobPreparationTask.containerSettings] When this is * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR * (the root of Azure Batch directories on the node) are mapped into the * container, all task environment variables are mapped into the container, * and the task command line is executed in the container. - * @member {string} + * @property {string} * [jobPreparationTask.containerSettings.containerRunOptions] These * additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no + * @property {string} [jobPreparationTask.containerSettings.imageName] This + * is the full image reference, as would be specified to "docker pull". If no * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [jobPreparationTask.containerSettings.registry] This + * @property {object} [jobPreparationTask.containerSettings.registry] This * setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobPreparationTask.containerSettings.registry.registryServer] If omitted, * the default is "docker.io". - * @member {string} [jobPreparationTask.containerSettings.registry.userName] - * @member {string} [jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobPreparationTask.resourceFiles] Files listed under this - * element are located in the task's working directory. There is a maximum - * size for the list of resource files. When the max size is exceeded, the - * request will fail and the response error code will be + * @property {string} + * [jobPreparationTask.containerSettings.registry.userName] + * @property {string} + * [jobPreparationTask.containerSettings.registry.password] + * @property {array} [jobPreparationTask.resourceFiles] Files listed under + * this element are located in the task's working directory. There is a + * maximum size for the list of resource files. When the max size is + * exceeded, the request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobPreparationTask.environmentSettings] - * @member {object} [jobPreparationTask.constraints] - * @member {moment.duration} + * @property {array} [jobPreparationTask.environmentSettings] + * @property {object} [jobPreparationTask.constraints] + * @property {moment.duration} * [jobPreparationTask.constraints.maxWallClockTime] If this is not * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [jobPreparationTask.constraints.retentionTime] + * @property {moment.duration} [jobPreparationTask.constraints.retentionTime] * The default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note + * @property {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task * once, and may then retry up to this limit. For example, if the maximum @@ -244,10 +245,10 @@ class CloudJob { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobPreparationTask.waitForSuccess] If true and the Job - * Preparation task fails on a compute node, the Batch service retries the - * Job Preparation task up to its maximum retry count (as specified in the - * constraints element). If the task has still not completed successfully + * @property {boolean} [jobPreparationTask.waitForSuccess] If true and the + * Job Preparation task fails on a compute node, the Batch service retries + * the Job Preparation task up to its maximum retry count (as specified in + * the constraints element). If the task has still not completed successfully * after all retries, then the Batch service will not schedule tasks of the * job to the compute node. The compute node remains active and eligible to * run tasks of other jobs. If false, the Batch service will not wait for the @@ -255,38 +256,38 @@ class CloudJob { * start executing on the compute node while the Job Preparation task is * still running; and even if the Job Preparation task fails, new tasks will * continue to be scheduled on the node. The default value is true. - * @member {object} [jobPreparationTask.userIdentity] If omitted, the task + * @property {object} [jobPreparationTask.userIdentity] If omitted, the task * runs as a non-administrative user unique to the task on Windows nodes, or - * a a non-administrative user unique to the pool on Linux nodes. - * @member {string} [jobPreparationTask.userIdentity.userName] The userName + * a non-administrative user unique to the pool on Linux nodes. + * @property {string} [jobPreparationTask.userIdentity.userName] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {object} [jobPreparationTask.userIdentity.autoUser] The userName + * @property {object} [jobPreparationTask.userIdentity.autoUser] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {string} [jobPreparationTask.userIdentity.autoUser.scope] The + * @property {string} [jobPreparationTask.userIdentity.autoUser.scope] The * default value is task. Possible values include: 'task', 'pool' - * @member {string} [jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', - * 'admin' - * @member {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The + * @property {string} + * [jobPreparationTask.userIdentity.autoUser.elevationLevel] The default + * value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @property {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The * Job Preparation task is always rerun if a compute node is reimaged, or if * the Job Preparation task did not complete (e.g. because the reboot * occurred while the task was running). Therefore, you should always write a * Job Preparation task to be idempotent and to behave correctly if run * multiple times. The default value is true. - * @member {object} [jobReleaseTask] The Job Release task. The Job Release + * @property {object} [jobReleaseTask] The Job Release task. The Job Release * task is a special task run at the end of the job on each node that has run * any other task of the job. - * @member {string} [jobReleaseTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot + * @property {string} [jobReleaseTask.id] The ID can contain any combination + * of alphanumeric characters including hyphens and underscores and cannot * contain more than 64 characters. If you do not specify this property, the * Batch service assigns a default value of 'jobrelease'. No other task in * the job can have the same ID as the Job Release task. If you try to submit * a task with the same id, the Batch service rejects the request with error * code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, * the HTTP status code is 409 (Conflict). - * @member {string} [jobReleaseTask.commandLine] The command line does not + * @property {string} [jobReleaseTask.commandLine] The command line does not * run under a shell, and therefore cannot take advantage of shell features * such as environment variable expansion. If you want to take advantage of * such features, you should invoke the shell in the command line, for @@ -295,58 +296,59 @@ class CloudJob { * path (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobReleaseTask.containerSettings] When this is + * @property {object} [jobReleaseTask.containerSettings] When this is * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR * (the root of Azure Batch directories on the node) are mapped into the * container, all task environment variables are mapped into the container, * and the task command line is executed in the container. - * @member {string} [jobReleaseTask.containerSettings.containerRunOptions] + * @property {string} [jobReleaseTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a + * @property {string} [jobReleaseTask.containerSettings.imageName] This is + * the full image reference, as would be specified to "docker pull". If no + * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} + * @property {object} [jobReleaseTask.containerSettings.registry] This + * setting can be omitted if was already provided at pool creation. + * @property {string} * [jobReleaseTask.containerSettings.registry.registryServer] If omitted, the * default is "docker.io". - * @member {string} [jobReleaseTask.containerSettings.registry.userName] - * @member {string} [jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobReleaseTask.resourceFiles] Files listed under this + * @property {string} [jobReleaseTask.containerSettings.registry.userName] + * @property {string} [jobReleaseTask.containerSettings.registry.password] + * @property {array} [jobReleaseTask.resourceFiles] Files listed under this * element are located in the task's working directory. - * @member {array} [jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobReleaseTask.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the + * @property {array} [jobReleaseTask.environmentSettings] + * @property {moment.duration} [jobReleaseTask.maxWallClockTime] + * @property {moment.duration} [jobReleaseTask.retentionTime] The default is + * 7 days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {object} [jobReleaseTask.userIdentity] If omitted, the task runs + * @property {object} [jobReleaseTask.userIdentity] If omitted, the task runs * as a non-administrative user unique to the task. - * @member {string} [jobReleaseTask.userIdentity.userName] The userName and + * @property {string} [jobReleaseTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [jobReleaseTask.userIdentity.autoUser] The userName and + * @property {object} [jobReleaseTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [commonEnvironmentSettings] The list of common environment - * variable settings. These environment variables are set for all tasks in - * the job (including the Job Manager, Job Preparation and Job Release - * tasks). Individual tasks can override an environment setting specified - * here by specifying the same setting name with a different value. - * @member {object} [poolInfo] The pool settings associated with the job. - * @member {string} [poolInfo.poolId] You must ensure that the pool + * @property {string} [jobReleaseTask.userIdentity.autoUser.scope] The + * default value is task. Possible values include: 'task', 'pool' + * @property {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] + * The default value is nonAdmin. Possible values include: 'nonAdmin', + * 'admin' + * @property {array} [commonEnvironmentSettings] The list of common + * environment variable settings. These environment variables are set for all + * tasks in the job (including the Job Manager, Job Preparation and Job + * Release tasks). Individual tasks can override an environment setting + * specified here by specifying the same setting name with a different value. + * @property {object} [poolInfo] The pool settings associated with the job. + * @property {string} [poolInfo.poolId] You must ensure that the pool * referenced by this property exists. If the pool does not exist at the time * the Batch service tries to schedule a job, no tasks for the job will run * until you create a pool with that id. Note that the Batch service will not * reject the job request; it will simply not run tasks until the pool * exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation + * @property {object} [poolInfo.autoPoolSpecification] If auto pool creation * fails, the Batch service moves the job to a completed state, and the pool * creation error is set in the job's scheduling error property. The Batch * service manages the lifetime (both creation and, unless keepAlive is @@ -354,28 +356,28 @@ class CloudJob { * lifetime of the auto pool while the job is active will result in * unexpected behavior. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The + * @property {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The * Batch service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] + * @property {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the + * @property {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, + * the Batch service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The + * @property {object} [poolInfo.autoPoolSpecification.pool] + * @property {string} [poolInfo.autoPoolSpecification.pool.displayName] The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For + * @property {string} [poolInfo.autoPoolSpecification.pool.vmSize] For * information about available sizes of virtual machines in pools, see Choose * a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This * property must be specified if the pool needs to be created with Azure PaaS * VMs. This property and virtualMachineConfiguration are mutually exclusive @@ -384,7 +386,7 @@ class CloudJob { * directly, the HTTP status code is 400 (Bad Request). This property cannot * be specified if the Batch account was created with its poolAllocationMode * property set to 'UserSubscription'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] * Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -393,39 +395,39 @@ class CloudJob { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] * The default value is * which specifies the latest operating system version * for the specified OS family. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This * property must be specified if the pool needs to be created with Azure IaaS * VMs. This property and cloudServiceConfiguration are mutually exclusive * and one of the properties must be specified. If neither is specified then * the Batch service returns an error; if you are calling the REST API * directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -434,14 +436,14 @@ class CloudJob { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] * 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 @@ -453,7 +455,7 @@ class CloudJob { * 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. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] * This only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -462,71 +464,71 @@ class CloudJob { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size - * of the compute nodes in the pool (the vmSize setting). - * @member {object} + * @property {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] + * The default value is 1. The maximum value of this setting depends on the + * size of the compute nodes in the pool (the vmSize setting). + * @property {object} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] * Possible values include: 'spread', 'pack' - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies * only to manual scaling; it has no effect when enableAutoScale is set to * true. The default value is 15 minutes. The minimum value is 5 minutes. If * you specify a value less than 5 minutes, the Batch service rejects the * request with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is + * @property {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] + * If false, at least one of targetDedicateNodes and targetLowPriorityNodes + * must be specified. If true, the autoScaleFormula element is required. The + * pool automatically resizes according to the formula. The default value is * false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] + * @property {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] * This property must not be specified if enableAutoScale is set to false. It * is required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The * default value is 15 minutes. The minimum and maximum value are 5 minutes * and 168 hours respectively. If you specify a value less than 5 minutes or * greater than 168 hours, the Batch service rejects the request with an * invalid property value error; if you are calling the REST API directly, * the HTTP status code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] * Enabling inter-node communication limits the maximum size of the pool due * to deployment restrictions on the nodes of the pool. This may result in * the pool not reaching its desired size. The default value is false. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This * is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -540,20 +542,20 @@ class CloudJob { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} + * @property {object} [poolInfo.autoPoolSpecification.pool.startTask] + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.commandLine] The command * line does not run under a shell, and therefore cannot take advantage of * shell features such as environment variable expansion. If you want to take @@ -563,56 +565,56 @@ class CloudJob { * use a relative path (relative to the task working directory), or use the * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When * this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] * This is the full image reference, as would be specified to "docker pull". * If no tag is provided as part of the image name, the tag ":latest" is used * as a default. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] * This setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed * under this element are located in the task's working directory. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, * the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] * The default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The * Batch service retries a task if its exit code is nonzero. Note that this * value specifically controls the number of retries. The Batch service will @@ -621,7 +623,7 @@ class CloudJob { * initial try and 3 retries). If the maximum retry count is 0, the Batch * service does not retry the task. If the maximum retry count is -1, the * Batch service retries the task without limit. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and * the start task fails on a compute node, the Batch service retries the * start task up to its maximum retry count (maxTaskRetryCount). If the task @@ -633,7 +635,7 @@ class CloudJob { * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.certificateReferences] For Windows * compute nodes, the Batch service installs the certificates to the * specified certificate store and location. For Linux compute nodes, the @@ -643,31 +645,32 @@ class CloudJob { * '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. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch - * service application licenses. If a license is requested which is not - * supported, pool creation will fail. The permitted licenses available on - * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge - * applies for each application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch + * @property {array} + * [poolInfo.autoPoolSpecification.pool.applicationLicenses] The list of + * application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, + * pool creation will fail. The permitted licenses available on the pool are + * 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each + * application license added to the pool. + * @property {array} [poolInfo.autoPoolSpecification.pool.userAccounts] + * @property {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch * service does not assign any meaning to metadata; it is solely for the use * of user code. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in the job are in the completed state. The default is - * noaction. Possible values include: 'noAction', 'terminateJob' - * @member {string} [onTaskFailure] The action the Batch service should take - * when any task in the job fails. 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. Possible values include: 'noAction', + * @property {string} [onAllTasksComplete] The action the Batch service + * should take when all tasks in the job are in the completed state. The + * default is noaction. Possible values include: 'noAction', 'terminateJob' + * @property {string} [onTaskFailure] The action the Batch service should + * take when any task in the job fails. 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. Possible values include: 'noAction', * 'performExitOptionsJobAction' - * @member {object} [networkConfiguration] The network configuration for the - * job. - * @member {string} [networkConfiguration.subnetId] This is only supported + * @property {object} [networkConfiguration] The network configuration for + * the job. + * @property {string} [networkConfiguration.subnetId] This is only supported * for jobs running on VirtualMachineConfiguration pools. This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the @@ -675,31 +678,31 @@ class CloudJob { * addresses to accommodate the number of nodes which will run tasks from the * job. For more details, see * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {array} [metadata] A list of name-value pairs associated with the - * job as metadata. The Batch service does not assign any meaning to + * @property {array} [metadata] A list of name-value pairs associated with + * the job as metadata. The Batch service does not assign any meaning to * metadata; it is solely for the use of user code. - * @member {object} [executionInfo] The execution information for the job. - * @member {date} [executionInfo.startTime] This is the time at which the job - * was created. - * @member {date} [executionInfo.endTime] This property is set only if the + * @property {object} [executionInfo] The execution information for the job. + * @property {date} [executionInfo.startTime] This is the time at which the + * job was created. + * @property {date} [executionInfo.endTime] This property is set only if the * job is in the completed state. - * @member {string} [executionInfo.poolId] This element contains the actual + * @property {string} [executionInfo.poolId] This element contains the actual * pool where the job is assigned. When you get job details from the service, * they also contain a poolInfo element, which contains the pool * configuration data from when the job was added or updated. That poolInfo * element may also contain a poolId element. If it does, the two IDs are the * same. If it does not, it means the job ran on an auto pool, and this * property contains the ID of that auto pool. - * @member {object} [executionInfo.schedulingError] This property is not set - * if there was no error starting the job. - * @member {string} [executionInfo.schedulingError.category] Possible values - * include: 'userError', 'serverError' - * @member {string} [executionInfo.schedulingError.code] - * @member {string} [executionInfo.schedulingError.message] - * @member {array} [executionInfo.schedulingError.details] - * @member {string} [executionInfo.terminateReason] 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 + * @property {object} [executionInfo.schedulingError] This property is not + * set if there was no error starting the job. + * @property {string} [executionInfo.schedulingError.category] Possible + * values include: 'userError', 'serverError' + * @property {string} [executionInfo.schedulingError.code] + * @property {string} [executionInfo.schedulingError.message] + * @property {array} [executionInfo.schedulingError.details] + * @property {string} [executionInfo.terminateReason] 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. @@ -709,30 +712,30 @@ class CloudJob { * 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. - * @member {object} [stats] Resource usage statistics for the entire lifetime - * of the job. The statistics may not be immediately available. The Batch - * service performs periodic roll-up of statistics. The typical delay is - * about 30 minutes. - * @member {string} [stats.url] - * @member {date} [stats.startTime] - * @member {date} [stats.lastUpdateTime] - * @member {moment.duration} [stats.userCPUTime] - * @member {moment.duration} [stats.kernelCPUTime] - * @member {moment.duration} [stats.wallClockTime] The wall clock time is the - * elapsed time from when the task started running on a compute node to when - * it finished (or to the last time the statistics were updated, if the task - * had not finished by then). If a task was retried, this includes the wall - * clock time of all the task retries. - * @member {number} [stats.readIOps] - * @member {number} [stats.writeIOps] - * @member {number} [stats.readIOGiB] - * @member {number} [stats.writeIOGiB] - * @member {number} [stats.numSucceededTasks] A task completes successfully + * @property {object} [stats] Resource usage statistics for the entire + * lifetime of the job. The statistics may not be immediately available. The + * Batch service performs periodic roll-up of statistics. The typical delay + * is about 30 minutes. + * @property {string} [stats.url] + * @property {date} [stats.startTime] + * @property {date} [stats.lastUpdateTime] + * @property {moment.duration} [stats.userCPUTime] + * @property {moment.duration} [stats.kernelCPUTime] + * @property {moment.duration} [stats.wallClockTime] The wall clock time is + * the elapsed time from when the task started running on a compute node to + * when it finished (or to the last time the statistics were updated, if the + * task had not finished by then). If a task was retried, this includes the + * wall clock time of all the task retries. + * @property {number} [stats.readIOps] + * @property {number} [stats.writeIOps] + * @property {number} [stats.readIOGiB] + * @property {number} [stats.writeIOGiB] + * @property {number} [stats.numSucceededTasks] A task completes successfully * if it returns exit code 0. - * @member {number} [stats.numFailedTasks] A task fails if it exhausts its + * @property {number} [stats.numFailedTasks] A task fails if it exhausts its * maximum retry count without returning exit code 0. - * @member {number} [stats.numTaskRetries] - * @member {moment.duration} [stats.waitTime] The wait time for a task is + * @property {number} [stats.numTaskRetries] + * @property {moment.duration} [stats.waitTime] The wait time for a task is * defined as the elapsed time between the creation of the task and the start * of task execution. (If the task is retried due to failures, the wait time * is the time to the most recent task execution.) This value is only diff --git a/lib/services/batch/lib/models/cloudJobListPreparationAndReleaseTaskStatusResult.js b/lib/services/batch/lib/models/cloudJobListPreparationAndReleaseTaskStatusResult.js index c7622b60c3..8c65b93607 100644 --- a/lib/services/batch/lib/models/cloudJobListPreparationAndReleaseTaskStatusResult.js +++ b/lib/services/batch/lib/models/cloudJobListPreparationAndReleaseTaskStatusResult.js @@ -17,7 +17,7 @@ class CloudJobListPreparationAndReleaseTaskStatusResult extends Array { /** * Create a CloudJobListPreparationAndReleaseTaskStatusResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/cloudJobListResult.js b/lib/services/batch/lib/models/cloudJobListResult.js index 62f3cf2e78..17692fde86 100644 --- a/lib/services/batch/lib/models/cloudJobListResult.js +++ b/lib/services/batch/lib/models/cloudJobListResult.js @@ -16,7 +16,7 @@ class CloudJobListResult extends Array { /** * Create a CloudJobListResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/cloudJobSchedule.js b/lib/services/batch/lib/models/cloudJobSchedule.js index 0981f35625..c73c2f7dfb 100644 --- a/lib/services/batch/lib/models/cloudJobSchedule.js +++ b/lib/services/batch/lib/models/cloudJobSchedule.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A job schedule that allows recurring jobs by specifying when to run * jobs and a specification used to create each job. @@ -20,40 +18,41 @@ const models = require('./index'); class CloudJobSchedule { /** * Create a CloudJobSchedule. - * @member {string} [id] A string that uniquely identifies the schedule + * @property {string} [id] A string that uniquely identifies the schedule * within the account. - * @member {string} [displayName] The display name for the schedule. - * @member {string} [url] The URL of the job schedule. - * @member {string} [eTag] The ETag of the job schedule. This is an opaque + * @property {string} [displayName] The display name for the schedule. + * @property {string} [url] The URL of the job schedule. + * @property {string} [eTag] The ETag of the job schedule. This is an opaque * string. You can use it to detect whether the job schedule has changed * between requests. In particular, you can be pass the ETag with an Update * Job Schedule request to specify that your changes should take effect only * if nobody else has modified the schedule in the meantime. - * @member {date} [lastModified] The last modified time of the job schedule. - * This is the last time at which the schedule level data, such as the job - * specification or recurrence information, changed. It does not factor in - * job-level changes such as new jobs being created or jobs changing state. - * @member {date} [creationTime] The creation time of the job schedule. - * @member {string} [state] The current state of the job schedule. Possible + * @property {date} [lastModified] The last modified time of the job + * schedule. This is the last time at which the schedule level data, such as + * the job specification or recurrence information, changed. It does not + * factor in job-level changes such as new jobs being created or jobs + * changing state. + * @property {date} [creationTime] The creation time of the job schedule. + * @property {string} [state] The current state of the job schedule. Possible * values include: 'active', 'completed', 'disabled', 'terminating', * 'deleting' - * @member {date} [stateTransitionTime] The time at which the job schedule + * @property {date} [stateTransitionTime] The time at which the job schedule * entered the current state. - * @member {string} [previousState] The previous state of the job schedule. + * @property {string} [previousState] The previous state of the job schedule. * This property is not present if the job schedule is in its initial active * state. Possible values include: 'active', 'completed', 'disabled', * 'terminating', 'deleting' - * @member {date} [previousStateTransitionTime] The time at which the job + * @property {date} [previousStateTransitionTime] The time at which the job * schedule entered its previous state. This property is not present if the * job schedule is in its initial active state. - * @member {object} [schedule] The schedule according to which jobs will be + * @property {object} [schedule] The schedule according to which jobs will be * created. - * @member {date} [schedule.doNotRunUntil] If you do not specify a + * @property {date} [schedule.doNotRunUntil] If you do not specify a * doNotRunUntil time, the schedule becomes ready to create jobs immediately. - * @member {date} [schedule.doNotRunAfter] If you do not specify a + * @property {date} [schedule.doNotRunAfter] If you do not specify a * doNotRunAfter time, and you are creating a recurring job schedule, the job * schedule will remain active until you explicitly terminate it. - * @member {moment.duration} [schedule.startWindow] If a job is not created + * @property {moment.duration} [schedule.startWindow] If a job is not created * within the startWindow interval, then the 'opportunity' is lost; no job * will be created until the next recurrence of the schedule. If the schedule * is recurring, and the startWindow is longer than the recurrence interval, @@ -63,7 +62,7 @@ class CloudJobSchedule { * minute. If you specify a lower value, the Batch service rejects the * schedule with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {moment.duration} [schedule.recurrenceInterval] Because a job + * @property {moment.duration} [schedule.recurrenceInterval] Because a job * schedule can have at most one active job under it at any given time, if it * is time to create a new job under a job schedule, but the previous job is * still running, the Batch service will not create the new job until the @@ -79,44 +78,46 @@ class CloudJobSchedule { * minute. If you specify a lower value, the Batch service rejects the * schedule with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {object} [jobSpecification] The details of the jobs to be created - * on this schedule. - * @member {number} [jobSpecification.priority] Priority values can range + * @property {object} [jobSpecification] The details of the jobs to be + * created on this schedule. + * @property {number} [jobSpecification.priority] Priority values can range * from -1000 to 1000, with -1000 being the lowest priority and 1000 being * the highest priority. The default value is 0. This priority is used as the * default for all jobs under the job schedule. You can update a job's * priority after it has been created using by using the update job API. - * @member {string} [jobSpecification.displayName] The name need not be + * @property {string} [jobSpecification.displayName] The name need not be * unique and can contain any Unicode characters up to a maximum length of * 1024. - * @member {boolean} [jobSpecification.usesTaskDependencies] - * @member {string} [jobSpecification.onAllTasksComplete] 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 + * @property {boolean} [jobSpecification.usesTaskDependencies] + * @property {string} [jobSpecification.onAllTasksComplete] 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. Possible values include: 'noAction', * 'terminateJob' - * @member {string} [jobSpecification.onTaskFailure] The default is noaction. - * Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [jobSpecification.networkConfiguration] - * @member {string} [jobSpecification.networkConfiguration.subnetId] This is - * only supported for jobs running on VirtualMachineConfiguration pools. This - * is of the form + * @property {string} [jobSpecification.onTaskFailure] The default is + * noaction. Possible values include: 'noAction', + * 'performExitOptionsJobAction' + * @property {object} [jobSpecification.networkConfiguration] + * @property {string} [jobSpecification.networkConfiguration.subnetId] This + * is only supported for jobs running on VirtualMachineConfiguration pools. + * This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the * Azure Batch account. The specified subnet should have enough free IP * addresses to accommodate the number of nodes which will run tasks from the * job. For more details, see * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [jobSpecification.constraints] - * @member {moment.duration} [jobSpecification.constraints.maxWallClockTime] - * If the job does not complete within the time limit, the Batch service - * terminates it and any tasks that are still running. In this case, the - * termination reason will be MaxWallClockTimeExpiry. If this property is not - * specified, there is no time limit on how long the job may run. - * @member {number} [jobSpecification.constraints.maxTaskRetryCount] Note + * @property {object} [jobSpecification.constraints] + * @property {moment.duration} + * [jobSpecification.constraints.maxWallClockTime] If the job does not + * complete within the time limit, the Batch service terminates it and any + * tasks that are still running. In this case, the termination reason will be + * MaxWallClockTimeExpiry. If this property is not specified, there is no + * time limit on how long the job may run. + * @property {number} [jobSpecification.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries. The Batch * service will try each task once, and may then retry up to this limit. For * example, if the maximum retry count is 3, Batch tries a task up to 4 times @@ -124,27 +125,27 @@ class CloudJobSchedule { * Batch service does not retry tasks. If the maximum retry count is -1, the * Batch service retries tasks without limit. The default value is 0 (no * retries). - * @member {object} [jobSpecification.jobManagerTask] If the job does not + * @property {object} [jobSpecification.jobManagerTask] If the job does not * specify a Job Manager task, the user must explicitly add tasks to the job * using the Task API. If the job does specify a Job Manager task, the Batch * service creates the Job Manager task when the job is created, and will try * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobSpecification.jobManagerTask.id] The ID can contain + * @property {string} [jobSpecification.jobManagerTask.id] The ID can contain * any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. - * @member {string} [jobSpecification.jobManagerTask.displayName] It need not - * be unique and can contain any Unicode characters up to a maximum length of - * 1024. - * @member {string} [jobSpecification.jobManagerTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should - * use a relative path (relative to the task working directory), or use the - * Batch provided environment variable + * @property {string} [jobSpecification.jobManagerTask.displayName] It need + * not be unique and can contain any Unicode characters up to a maximum + * length of 1024. + * @property {string} [jobSpecification.jobManagerTask.commandLine] The + * command line does not run under a shell, and therefore cannot take + * advantage of shell features such as environment variable expansion. If you + * want to take advantage of such features, you should invoke the shell in + * the command line, for example using "cmd /c MyCommand" in Windows or + * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, + * it should use a relative path (relative to the task working directory), or + * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobManagerTask.containerSettings] If + * @property {object} [jobSpecification.jobManagerTask.containerSettings] If * the pool that will run this task has containerConfiguration set, this must * be set as well. If the pool that will run this task doesn't have * containerConfiguration set, this must not be set. When this is specified, @@ -152,45 +153,45 @@ class CloudJobSchedule { * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.imageName] This is the * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobManagerTask.containerSettings.registry] This setting * can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobManagerTask.resourceFiles] Files + * @property {array} [jobSpecification.jobManagerTask.resourceFiles] Files * listed under this element are located in the task's working directory. * There is a maximum size for the list of resource files. When the max size * is exceeded, the request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobSpecification.jobManagerTask.outputFiles] For + * @property {array} [jobSpecification.jobManagerTask.outputFiles] For * multi-instance tasks, the files will only be uploaded from the compute * node on which the primary task is executed. - * @member {array} [jobSpecification.jobManagerTask.environmentSettings] - * @member {object} [jobSpecification.jobManagerTask.constraints] - * @member {moment.duration} + * @property {array} [jobSpecification.jobManagerTask.environmentSettings] + * @property {object} [jobSpecification.jobManagerTask.constraints] + * @property {moment.duration} * [jobSpecification.jobManagerTask.constraints.maxWallClockTime] If this is * not specified, there is no time limit on how long the task may run. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.jobManagerTask.constraints.retentionTime] The default is * 7 days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {number} + * @property {number} * [jobSpecification.jobManagerTask.constraints.maxTaskRetryCount] Note that * this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task @@ -199,11 +200,11 @@ class CloudJobSchedule { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] If - * true, when the Job Manager task completes, the Batch service marks the job - * as complete. If any tasks are still running at this time (other than Job - * Release), those tasks are terminated. If false, the completion of the Job - * Manager task does not affect the job status. In this case, you should + * @property {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] + * If true, when the Job Manager task completes, the Batch service marks the + * job as complete. If any tasks are still running at this time (other than + * Job Release), those tasks are terminated. If false, the completion of the + * Job Manager task does not affect the job status. In this case, you should * either use the onAllTasksComplete attribute to terminate the job, or have * a client or user terminate the job explicitly. An example of this is if * the Job Manager creates a set of tasks but then takes no further role in @@ -212,27 +213,27 @@ class CloudJobSchedule { * and using the Job Manager task only to create the tasks for the job (not * to monitor progress), then it is important to set killJobOnCompletion to * false. - * @member {object} [jobSpecification.jobManagerTask.userIdentity] If + * @property {object} [jobSpecification.jobManagerTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobManagerTask.userIdentity.userName] + * @property {string} [jobSpecification.jobManagerTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] + * @property {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.userIdentity.autoUser.scope] The default * value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobSpecification.jobManagerTask.runExclusive] If true, - * no other tasks will run on the same compute node for as long as the Job - * Manager is running. If false, other tasks can run simultaneously with the - * Job Manager on a compute node. The Job Manager task counts normally + * @property {boolean} [jobSpecification.jobManagerTask.runExclusive] If + * true, no other tasks will run on the same compute node for as long as the + * Job Manager is running. If false, other tasks can run simultaneously with + * the Job Manager on a compute node. The Job Manager task counts normally * against the node's concurrent task limit, so this is only relevant if the * node allows multiple concurrent tasks. The default value is true. - * @member {array} + * @property {array} * [jobSpecification.jobManagerTask.applicationPackageReferences] Application * packages are downloaded and deployed to a shared directory, not the task * working directory. Therefore, if a referenced package is already on the @@ -240,7 +241,7 @@ class CloudJobSchedule { * existing copy on the compute node is used. If a referenced application * package cannot be installed, for example because the package has been * deleted or because download failed, the task fails. - * @member {object} + * @property {object} * [jobSpecification.jobManagerTask.authenticationTokenSettings] If this * property is set, the Batch service provides the task with an * authentication token which can be used to authenticate Batch service @@ -249,18 +250,19 @@ class CloudJobSchedule { * that the task can carry out using the token depend on the settings. For * example, a task can request job permissions in order to add other tasks to * the job, or check the status of the job or of other tasks under the job. - * @member {array} + * @property {array} * [jobSpecification.jobManagerTask.authenticationTokenSettings.access] The * authentication token grants access to a limited set of Batch service * operations. Currently the only supported value for the access property is * 'job', which grants access to all operations related to the job which * contains the task. - * @member {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] + * @property {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] * The default value is true. - * @member {object} [jobSpecification.jobPreparationTask] If a job has a Job - * Preparation task, the Batch service will run the Job Preparation task on a - * compute node before starting any tasks of that job on that compute node. - * @member {string} [jobSpecification.jobPreparationTask.id] The ID can + * @property {object} [jobSpecification.jobPreparationTask] If a job has a + * Job Preparation task, the Batch service will run the Job Preparation task + * on a compute node before starting any tasks of that job on that compute + * node. + * @property {string} [jobSpecification.jobPreparationTask.id] The ID can * contain any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. If you do not * specify this property, the Batch service assigns a default value of @@ -269,7 +271,7 @@ class CloudJobSchedule { * service rejects the request with error code * TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, * the HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobPreparationTask.commandLine] The + * @property {string} [jobSpecification.jobPreparationTask.commandLine] The * command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you * want to take advantage of such features, you should invoke the shell in @@ -278,48 +280,49 @@ class CloudJobSchedule { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobPreparationTask.containerSettings] + * @property {object} [jobSpecification.jobPreparationTask.containerSettings] * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.imageName] This is * the full image reference, as would be specified to "docker pull". If no * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobPreparationTask.containerSettings.registry] This * setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobPreparationTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles - * must be reduced in size. This can be achieved using .zip files, - * Application Packages, or Docker Containers. - * @member {array} [jobSpecification.jobPreparationTask.environmentSettings] - * @member {object} [jobSpecification.jobPreparationTask.constraints] - * @member {moment.duration} + * @property {array} [jobSpecification.jobPreparationTask.resourceFiles] + * Files listed under this element are located in the task's working + * directory. There is a maximum size for the list of resource files. When + * the max size is exceeded, the request will fail and the response error + * code will be RequestEntityTooLarge. If this occurs, the collection of + * ResourceFiles must be reduced in size. This can be achieved using .zip + * files, Application Packages, or Docker Containers. + * @property {array} + * [jobSpecification.jobPreparationTask.environmentSettings] + * @property {object} [jobSpecification.jobPreparationTask.constraints] + * @property {moment.duration} * [jobSpecification.jobPreparationTask.constraints.maxWallClockTime] If this * is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.jobPreparationTask.constraints.retentionTime] The * default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} + * @property {number} * [jobSpecification.jobPreparationTask.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task @@ -328,8 +331,8 @@ class CloudJobSchedule { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] If - * true and the Job Preparation task fails on a compute node, the Batch + * @property {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] + * If true and the Job Preparation task fails on a compute node, the Batch * service retries the Job Preparation task up to its maximum retry count (as * specified in the constraints element). If the task has still not completed * successfully after all retries, then the Batch service will not schedule @@ -340,40 +343,40 @@ class CloudJobSchedule { * Preparation task is still running; and even if the Job Preparation task * fails, new tasks will continue to be scheduled on the node. The default * value is true. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity] If + * @property {object} [jobSpecification.jobPreparationTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task on - * Windows nodes, or a a non-administrative user unique to the pool on Linux + * Windows nodes, or a non-administrative user unique to the pool on Linux * nodes. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.userName] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {object} + * @property {object} * [jobSpecification.jobPreparationTask.userIdentity.autoUser] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.autoUser.scope] The * default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {boolean} + * @property {boolean} * [jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] The * Job Preparation task is always rerun if a compute node is reimaged, or if * the Job Preparation task did not complete (e.g. because the reboot * occurred while the task was running). Therefore, you should always write a * Job Preparation task to be idempotent and to behave correctly if run * multiple times. The default value is true. - * @member {object} [jobSpecification.jobReleaseTask] The primary purpose of - * the Job Release task is to undo changes to compute nodes made by the Job - * Preparation task. Example activities include deleting local files, or + * @property {object} [jobSpecification.jobReleaseTask] The primary purpose + * of the Job Release task is to undo changes to compute nodes made by the + * Job Preparation task. Example activities include deleting local files, or * shutting down services that were started as part of job preparation. A Job * Release task cannot be specified without also specifying a Job Preparation * task for the job. The Batch service runs the Job Release task on the * compute nodes that have run the Job Preparation task. - * @member {string} [jobSpecification.jobReleaseTask.id] The ID can contain + * @property {string} [jobSpecification.jobReleaseTask.id] The ID can contain * any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. If you do not * specify this property, the Batch service assigns a default value of @@ -382,108 +385,109 @@ class CloudJobSchedule { * service rejects the request with error code TaskIdSameAsJobReleaseTask; if * you are calling the REST API directly, the HTTP status code is 409 * (Conflict). - * @member {string} [jobSpecification.jobReleaseTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should - * use a relative path (relative to the task working directory), or use the - * Batch provided environment variable + * @property {string} [jobSpecification.jobReleaseTask.commandLine] The + * command line does not run under a shell, and therefore cannot take + * advantage of shell features such as environment variable expansion. If you + * want to take advantage of such features, you should invoke the shell in + * the command line, for example using "cmd /c MyCommand" in Windows or + * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, + * it should use a relative path (relative to the task working directory), or + * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobReleaseTask.containerSettings] When - * this is specified, all directories recursively below the + * @property {object} [jobSpecification.jobReleaseTask.containerSettings] + * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.imageName] This is the * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobReleaseTask.containerSettings.registry] This setting * can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobReleaseTask.resourceFiles] Files + * @property {array} [jobSpecification.jobReleaseTask.resourceFiles] Files * listed under this element are located in the task's working directory. - * @member {array} [jobSpecification.jobReleaseTask.environmentSettings] - * @member {moment.duration} + * @property {array} [jobSpecification.jobReleaseTask.environmentSettings] + * @property {moment.duration} * [jobSpecification.jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobSpecification.jobReleaseTask.retentionTime] - * The default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity] If + * @property {moment.duration} + * [jobSpecification.jobReleaseTask.retentionTime] The default is 7 days, + * i.e. the task directory will be retained for 7 days unless the compute + * node is removed or the job is deleted. + * @property {object} [jobSpecification.jobReleaseTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobReleaseTask.userIdentity.userName] + * @property {string} [jobSpecification.jobReleaseTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] + * @property {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.userIdentity.autoUser.scope] The default * value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [jobSpecification.commonEnvironmentSettings] Individual + * @property {array} [jobSpecification.commonEnvironmentSettings] Individual * tasks can override an environment setting specified here by specifying the * same setting name with a different value. - * @member {object} [jobSpecification.poolInfo] - * @member {string} [jobSpecification.poolInfo.poolId] You must ensure that + * @property {object} [jobSpecification.poolInfo] + * @property {string} [jobSpecification.poolInfo.poolId] You must ensure that * the pool referenced by this property exists. If the pool does not exist at * the time the Batch service tries to schedule a job, no tasks for the job * will run until you create a pool with that id. Note that the Batch service * will not reject the job request; it will simply not run tasks until the * pool exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification] If auto - * pool creation fails, the Batch service moves the job to a completed state, - * and the pool creation error is set in the job's scheduling error property. - * The Batch service manages the lifetime (both creation and, unless - * keepAlive is specified, deletion) of the auto pool. Any user actions that - * affect the lifetime of the auto pool while the job is active will result - * in unexpected behavior. You must specify either the pool ID or the auto - * pool specification, but not both. - * @member {string} + * @property {object} [jobSpecification.poolInfo.autoPoolSpecification] If + * auto pool creation fails, the Batch service moves the job to a completed + * state, and the pool creation error is set in the job's scheduling error + * property. The Batch service manages the lifetime (both creation and, + * unless keepAlive is specified, deletion) of the auto pool. Any user + * actions that affect the lifetime of the auto pool while the job is active + * will result in unexpected behavior. You must specify either the pool ID or + * the auto pool specification, but not both. + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.autoPoolIdPrefix] The * Batch service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.poolLifetimeOption] * Possible values include: 'jobSchedule', 'job' - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.keepAlive] If false, the * Batch service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] - * @member {string} + * @property {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.displayName] The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.vmSize] For * information about available sizes of virtual machines in pools, see Choose * a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] * This property must be specified if the pool needs to be created with Azure * PaaS VMs. This property and virtualMachineConfiguration are mutually @@ -492,7 +496,7 @@ class CloudJobSchedule { * REST API directly, the HTTP status code is 400 (Bad Request). This * property cannot be specified if the Batch account was created with its * poolAllocationMode property set to 'UserSubscription'. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] * Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -501,39 +505,39 @@ class CloudJobSchedule { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] * The default value is * which specifies the latest operating system version * for the specified OS family. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] * This property must be specified if the pool needs to be created with Azure * IaaS VMs. This property and cloudServiceConfiguration are mutually * exclusive and one of the properties must be specified. If neither is * specified then the Batch service returns an error; if you are calling the * REST API directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -542,14 +546,14 @@ class CloudJobSchedule { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] * 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 @@ -561,7 +565,7 @@ class CloudJobSchedule { * 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. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] * This only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -570,74 +574,74 @@ class CloudJobSchedule { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The * default value is 1. The maximum value of this setting depends on the size * of the compute nodes in the pool (the vmSize setting). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] * Possible values include: 'spread', 'pack' - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.poolInfo.autoPoolSpecification.pool.resizeTimeout] This * timeout applies only to manual scaling; it has no effect when * enableAutoScale is set to true. The default value is 15 minutes. The * minimum value is 5 minutes. If you specify a value less than 5 minutes, * the Batch service rejects the request with an error; if you are calling * the REST API directly, the HTTP status code is 400 (Bad Request). - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] * This property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] * This property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableAutoScale] If * false, at least one of targetDedicateNodes and targetLowPriorityNodes must * be specified. If true, the autoScaleFormula element is required. The pool * automatically resizes according to the formula. The default value is * false. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleFormula] * This property must not be specified if enableAutoScale is set to false. It * is required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] * The default value is 15 minutes. The minimum and maximum value are 5 * minutes and 168 hours respectively. If you specify a value less than 5 * minutes or greater than 168 hours, the Batch service rejects the request * with an invalid property value error; if you are calling the REST API * directly, the HTTP status code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] * Enabling inter-node communication limits the maximum size of the pool due * to deployment restrictions on the nodes of the pool. This may result in * the pool not reaching its desired size. The default value is false. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] * This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -651,21 +655,21 @@ class CloudJobSchedule { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.commandLine] * The command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you @@ -675,57 +679,57 @@ class CloudJobSchedule { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings] * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] * This is the full image reference, as would be specified to "docker pull". * If no tag is provided as part of the image name, the tag ":latest" is used * as a default. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] * This setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] * Files listed under this element are located in the task's working * directory. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity] * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] * The default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] * The Batch service retries a task if its exit code is nonzero. Note that * this value specifically controls the number of retries. The Batch service @@ -734,7 +738,7 @@ class CloudJobSchedule { * initial try and 3 retries). If the maximum retry count is 0, the Batch * service does not retry the task. If the maximum retry count is -1, the * Batch service retries the task without limit. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] * If true and the start task fails on a compute node, the Batch service * retries the start task up to its maximum retry count (maxTaskRetryCount). @@ -746,7 +750,7 @@ class CloudJobSchedule { * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.certificateReferences] * For Windows compute nodes, the Batch service installs the certificates to * the specified certificate store and location. For Linux compute nodes, the @@ -756,61 +760,62 @@ class CloudJobSchedule { * '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. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationLicenses] * The list of application licenses must be a subset of available Batch * service application licenses. If a license is requested which is not * supported, pool creation will fail. The permitted licenses available on * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge * applies for each application license added to the pool. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.metadata] The Batch * service does not assign any meaning to metadata; it is solely for the use * of user code. - * @member {array} [jobSpecification.metadata] The Batch service does not + * @property {array} [jobSpecification.metadata] The Batch service does not * assign any meaning to metadata; it is solely for the use of user code. - * @member {object} [executionInfo] Information about jobs that have been and - * will be run under this schedule. - * @member {date} [executionInfo.nextRunTime] This property is meaningful + * @property {object} [executionInfo] Information about jobs that have been + * and will be run under this schedule. + * @property {date} [executionInfo.nextRunTime] This property is meaningful * only if the schedule is in the active state when the time comes around. * For example, if the schedule is disabled, no job will be created at * nextRunTime unless the job is enabled before then. - * @member {object} [executionInfo.recentJob] This property is present only + * @property {object} [executionInfo.recentJob] This property is present only * if the at least one job has run under the schedule. - * @member {string} [executionInfo.recentJob.id] - * @member {string} [executionInfo.recentJob.url] - * @member {date} [executionInfo.endTime] This property is set only if the + * @property {string} [executionInfo.recentJob.id] + * @property {string} [executionInfo.recentJob.url] + * @property {date} [executionInfo.endTime] This property is set only if the * job schedule is in the completed state. - * @member {array} [metadata] A list of name-value pairs associated with the - * schedule as metadata. The Batch service does not assign any meaning to + * @property {array} [metadata] A list of name-value pairs associated with + * the schedule as metadata. The Batch service does not assign any meaning to * metadata; it is solely for the use of user code. - * @member {object} [stats] The lifetime resource usage statistics for the + * @property {object} [stats] The lifetime resource usage statistics for the * job schedule. The statistics may not be immediately available. The Batch * service performs periodic roll-up of statistics. The typical delay is * about 30 minutes. - * @member {string} [stats.url] - * @member {date} [stats.startTime] - * @member {date} [stats.lastUpdateTime] - * @member {moment.duration} [stats.userCPUTime] - * @member {moment.duration} [stats.kernelCPUTime] - * @member {moment.duration} [stats.wallClockTime] The wall clock time is the - * elapsed time from when the task started running on a compute node to when - * it finished (or to the last time the statistics were updated, if the task - * had not finished by then). If a task was retried, this includes the wall - * clock time of all the task retries. - * @member {number} [stats.readIOps] - * @member {number} [stats.writeIOps] - * @member {number} [stats.readIOGiB] - * @member {number} [stats.writeIOGiB] - * @member {number} [stats.numSucceededTasks] - * @member {number} [stats.numFailedTasks] - * @member {number} [stats.numTaskRetries] - * @member {moment.duration} [stats.waitTime] This value is only reported in - * the account lifetime statistics; it is not included in the job statistics. + * @property {string} [stats.url] + * @property {date} [stats.startTime] + * @property {date} [stats.lastUpdateTime] + * @property {moment.duration} [stats.userCPUTime] + * @property {moment.duration} [stats.kernelCPUTime] + * @property {moment.duration} [stats.wallClockTime] The wall clock time is + * the elapsed time from when the task started running on a compute node to + * when it finished (or to the last time the statistics were updated, if the + * task had not finished by then). If a task was retried, this includes the + * wall clock time of all the task retries. + * @property {number} [stats.readIOps] + * @property {number} [stats.writeIOps] + * @property {number} [stats.readIOGiB] + * @property {number} [stats.writeIOGiB] + * @property {number} [stats.numSucceededTasks] + * @property {number} [stats.numFailedTasks] + * @property {number} [stats.numTaskRetries] + * @property {moment.duration} [stats.waitTime] This value is only reported + * in the account lifetime statistics; it is not included in the job + * statistics. */ constructor() { } diff --git a/lib/services/batch/lib/models/cloudJobScheduleListResult.js b/lib/services/batch/lib/models/cloudJobScheduleListResult.js index a8e4714989..0714338fc6 100644 --- a/lib/services/batch/lib/models/cloudJobScheduleListResult.js +++ b/lib/services/batch/lib/models/cloudJobScheduleListResult.js @@ -16,7 +16,7 @@ class CloudJobScheduleListResult extends Array { /** * Create a CloudJobScheduleListResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/cloudPool.js b/lib/services/batch/lib/models/cloudPool.js index ce0f420fa9..eca6e31f3a 100644 --- a/lib/services/batch/lib/models/cloudPool.js +++ b/lib/services/batch/lib/models/cloudPool.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A pool in the Azure Batch service. * @@ -19,73 +17,74 @@ const models = require('./index'); class CloudPool { /** * Create a CloudPool. - * @member {string} [id] A string that uniquely identifies the pool within + * @property {string} [id] A string that uniquely identifies the pool within * the account. The ID can contain any combination of alphanumeric characters * including hyphens and underscores, and cannot contain more than 64 * characters. The ID is case-preserving and case-insensitive (that is, you * may not have two IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the pool. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. - * @member {string} [url] The URL of the pool. - * @member {string} [eTag] The ETag of the pool. This is an opaque string. + * @property {string} [displayName] The display name for the pool. The + * display name need not be unique and can contain any Unicode characters up + * to a maximum length of 1024. + * @property {string} [url] The URL of the pool. + * @property {string} [eTag] The ETag of the pool. This is an opaque string. * You can use it to detect whether the pool has changed between requests. In * particular, you can be pass the ETag when updating a pool to specify that * your changes should take effect only if nobody else has modified the pool * in the meantime. - * @member {date} [lastModified] The last modified time of the pool. This is - * the last time at which the pool level data, such as the + * @property {date} [lastModified] The last modified time of the pool. This + * is the last time at which the pool level data, such as the * targetDedicatedNodes or enableAutoscale settings, changed. It does not * factor in node-level changes such as a compute node changing state. - * @member {date} [creationTime] The creation time of the pool. - * @member {string} [state] The current state of the pool. Possible values + * @property {date} [creationTime] The creation time of the pool. + * @property {string} [state] The current state of the pool. Possible values * include: 'active', 'deleting' - * @member {date} [stateTransitionTime] The time at which the pool entered + * @property {date} [stateTransitionTime] The time at which the pool entered * its current state. - * @member {string} [allocationState] Whether the pool is resizing. Possible - * values include: 'steady', 'resizing', 'stopping' - * @member {date} [allocationStateTransitionTime] The time at which the pool - * entered its current allocation state. - * @member {string} [vmSize] The size of virtual machines in the pool. All + * @property {string} [allocationState] Whether the pool is resizing. + * Possible values include: 'steady', 'resizing', 'stopping' + * @property {date} [allocationStateTransitionTime] The time at which the + * pool entered its current allocation state. + * @property {string} [vmSize] The size of virtual machines in the pool. All * virtual machines in a pool are the same size. For information about * available sizes of virtual machines in pools, see Choose a VM size for * compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} [cloudServiceConfiguration] The cloud service + * @property {object} [cloudServiceConfiguration] The cloud service * configuration for the pool. This property and virtualMachineConfiguration * are mutually exclusive and one of the properties must be specified. This * property cannot be specified if the Batch account was created with its * poolAllocationMode property set to 'UserSubscription'. - * @member {string} [cloudServiceConfiguration.osFamily] Possible values are: + * @property {string} [cloudServiceConfiguration.osFamily] Possible values + * are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. * 3 - OS Family 3, equivalent to Windows Server 2012. * 4 - OS Family 4, equivalent to Windows Server 2012 R2. * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [cloudServiceConfiguration.osVersion] The default value + * @property {string} [cloudServiceConfiguration.osVersion] The default value * is * which specifies the latest operating system version for the specified * OS family. - * @member {object} [virtualMachineConfiguration] The virtual machine + * @property {object} [virtualMachineConfiguration] The virtual machine * configuration for the pool. This property and cloudServiceConfiguration * are mutually exclusive and one of the properties must be specified. - * @member {object} [virtualMachineConfiguration.imageReference] - * @member {string} [virtualMachineConfiguration.imageReference.publisher] + * @property {object} [virtualMachineConfiguration.imageReference] + * @property {string} [virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.offer] For + * @property {string} [virtualMachineConfiguration.imageReference.offer] For * example, UbuntuServer or WindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.sku] For + * @property {string} [virtualMachineConfiguration.imageReference.sku] For * example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [virtualMachineConfiguration.imageReference.version] A + * @property {string} [virtualMachineConfiguration.imageReference.version] A * value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [virtualMachineConfiguration.imageReference.virtualMachineImageId] This * property is mutually exclusive with other ImageReference properties. The * virtual machine image must be in the same region and subscription as the * Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch + * @property {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch * node agent is a program that runs on each node in the pool, and provides * the command-and-control interface between the node and the Batch service. * There are different implementations of the node agent, known as SKUs, for @@ -93,14 +92,14 @@ class CloudPool { * matches the selected image reference. To get the list of supported node * agent SKUs along with their list of verified image references, see the * 'List supported node agent SKUs' operation. - * @member {object} [virtualMachineConfiguration.windowsConfiguration] This + * @property {object} [virtualMachineConfiguration.windowsConfiguration] This * property must not be specified if the imageReference property specifies a * Linux OS image. - * @member {boolean} + * @property {boolean} * [virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} [virtualMachineConfiguration.dataDisks] This property must - * be specified if the compute nodes in the pool need to have empty data + * @property {array} [virtualMachineConfiguration.dataDisks] 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 @@ -110,7 +109,7 @@ class CloudPool { * 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. - * @member {string} [virtualMachineConfiguration.licenseType] This only + * @property {string} [virtualMachineConfiguration.licenseType] This only * applies to images that contain the Windows operating system, and should * only be used when you hold valid on-premises licenses for the nodes which * will be deployed. If omitted, no on-premises licensing discount is @@ -118,66 +117,66 @@ class CloudPool { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [virtualMachineConfiguration.containerConfiguration] If + * @property {object} [virtualMachineConfiguration.containerConfiguration] If * specified, setup is performed on each node in the pool to allow tasks to * run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {moment.duration} [resizeTimeout] The timeout for allocation of + * @property {moment.duration} [resizeTimeout] The timeout for allocation of * compute nodes to the pool. This is the timeout for the most recent resize * operation. (The initial sizing when the pool is created counts as a * resize.) The default value is 15 minutes. - * @member {array} [resizeErrors] A list of errors encountered while + * @property {array} [resizeErrors] A list of errors encountered while * performing the last resize on the pool. This property is set only if one * or more errors occurred during the last pool resize, and only when the * pool allocationState is Steady. - * @member {number} [currentDedicatedNodes] The number of dedicated compute + * @property {number} [currentDedicatedNodes] The number of dedicated compute * nodes currently in the pool. - * @member {number} [currentLowPriorityNodes] The number of low-priority + * @property {number} [currentLowPriorityNodes] The number of low-priority * compute nodes currently in the pool. Low-priority compute nodes which have * been preempted are included in this count. - * @member {number} [targetDedicatedNodes] The desired number of dedicated + * @property {number} [targetDedicatedNodes] The desired number of dedicated * compute nodes in the pool. - * @member {number} [targetLowPriorityNodes] The desired number of + * @property {number} [targetLowPriorityNodes] The desired number of * low-priority compute nodes in the pool. - * @member {boolean} [enableAutoScale] Whether the pool size should + * @property {boolean} [enableAutoScale] Whether the pool size should * automatically adjust over time. If false, at least one of * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, * the autoScaleFormula property is required and the pool automatically * resizes according to the formula. The default value is false. - * @member {string} [autoScaleFormula] A formula for the desired number of + * @property {string} [autoScaleFormula] A formula for the desired number of * compute nodes in the pool. This property is set only if the pool * automatically scales, i.e. enableAutoScale is true. - * @member {moment.duration} [autoScaleEvaluationInterval] The time interval - * at which to automatically adjust the pool size according to the autoscale - * formula. This property is set only if the pool automatically scales, i.e. - * enableAutoScale is true. - * @member {object} [autoScaleRun] The results and errors from the last + * @property {moment.duration} [autoScaleEvaluationInterval] The time + * interval at which to automatically adjust the pool size according to the + * autoscale formula. This property is set only if the pool automatically + * scales, i.e. enableAutoScale is true. + * @property {object} [autoScaleRun] The results and errors from the last * execution of the autoscale formula. This property is set only if the pool * automatically scales, i.e. enableAutoScale is true. - * @member {date} [autoScaleRun.timestamp] - * @member {string} [autoScaleRun.results] Each variable value is returned in - * the form $variable=value, and variables are separated by semicolons. - * @member {object} [autoScaleRun.error] - * @member {string} [autoScaleRun.error.code] - * @member {string} [autoScaleRun.error.message] - * @member {array} [autoScaleRun.error.values] - * @member {boolean} [enableInterNodeCommunication] Whether the pool permits - * direct communication between nodes. This imposes restrictions on which - * nodes can be assigned to the pool. Specifying this value can reduce the - * chance of the requested number of nodes to be allocated in the pool. - * @member {object} [networkConfiguration] The network configuration for the - * pool. - * @member {string} [networkConfiguration.subnetId] This is of the form + * @property {date} [autoScaleRun.timestamp] + * @property {string} [autoScaleRun.results] Each variable value is returned + * in the form $variable=value, and variables are separated by semicolons. + * @property {object} [autoScaleRun.error] + * @property {string} [autoScaleRun.error.code] + * @property {string} [autoScaleRun.error.message] + * @property {array} [autoScaleRun.error.values] + * @property {boolean} [enableInterNodeCommunication] Whether the pool + * permits direct communication between nodes. This imposes restrictions on + * which nodes can be assigned to the pool. Specifying this value can reduce + * the chance of the requested number of nodes to be allocated in the pool. + * @property {object} [networkConfiguration] The network configuration for + * the pool. + * @property {string} [networkConfiguration.subnetId] This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the * Azure Batch account. The specified subnet should have enough free IP @@ -189,18 +188,18 @@ class CloudPool { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [networkConfiguration.dynamicVNetAssignmentScope] + * @property {string} [networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} [networkConfiguration.endpointConfiguration] Pool + * @property {object} [networkConfiguration.endpointConfiguration] Pool * endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [networkConfiguration.endpointConfiguration.inboundNATPools] The maximum * number of inbound NAT pools per Batch pool is 5. If the maximum number of * inbound NAT pools is exceeded the request fails with HTTP status code 400. - * @member {object} [startTask] A task specified to run on each compute node - * as it joins the pool. - * @member {string} [startTask.commandLine] The command line does not run + * @property {object} [startTask] A task specified to run on each compute + * node as it joins the pool. + * @property {string} [startTask.commandLine] The command line does not run * under a shell, and therefore cannot take advantage of shell features such * as environment variable expansion. If you want to take advantage of such * features, you should invoke the shell in the command line, for example @@ -209,48 +208,48 @@ class CloudPool { * (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * @property {object} [startTask.containerSettings] When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These + * @property {string} [startTask.containerSettings.containerRunOptions] These * additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is + * @property {string} [startTask.containerSettings.imageName] This is the + * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [startTask.containerSettings.registry] This setting can + * @property {object} [startTask.containerSettings.registry] This setting can * be omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a + * @property {string} [startTask.containerSettings.registry.registryServer] + * If omitted, the default is "docker.io". + * @property {string} [startTask.containerSettings.registry.userName] + * @property {string} [startTask.containerSettings.registry.password] + * @property {array} [startTask.resourceFiles] Files listed under this + * element are located in the task's working directory. + * @property {array} [startTask.environmentSettings] + * @property {object} [startTask.userIdentity] If omitted, the task runs as a * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and + * @property {string} [startTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [startTask.userIdentity.autoUser] The userName and + * @property {object} [startTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The + * @property {string} [startTask.userIdentity.autoUser.scope] The default + * value is task. Possible values include: 'task', 'pool' + * @property {string} [startTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically + * @property {number} [startTask.maxTaskRetryCount] The Batch service retries + * a task if its exit code is nonzero. Note that this value specifically * controls the number of retries. The Batch service will try the task once, * and may then retry up to this limit. For example, if the maximum retry * count is 3, Batch tries the task up to 4 times (one initial try and 3 * retries). If the maximum retry count is 0, the Batch service does not * retry the task. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task + * @property {boolean} [startTask.waitForSuccess] If true and the start task * fails on a compute node, the Batch service retries the start task up to * its maximum retry count (maxTaskRetryCount). If the task has still not * completed successfully after all retries, then the Batch service marks the @@ -260,7 +259,7 @@ class CloudPool { * other tasks can start executing on the compute node while the start task * is still running; and even if the start task fails, new tasks will * continue to be scheduled on the node. The default is false. - * @member {array} [certificateReferences] The list of certificates to be + * @property {array} [certificateReferences] The list of certificates to be * installed on each compute node in the pool. For Windows compute nodes, the * Batch service installs the certificates to the specified certificate store * and location. For Linux compute nodes, the certificates are stored in a @@ -269,48 +268,48 @@ class CloudPool { * 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. - * @member {array} [applicationPackageReferences] The list of application + * @property {array} [applicationPackageReferences] The list of application * packages to be installed on each compute node in the pool. - * @member {array} [applicationLicenses] The list of application licenses the - * Batch service will make available on each compute node in the pool. The - * list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, - * pool creation will fail. - * @member {number} [maxTasksPerNode] The maximum number of tasks that can + * @property {array} [applicationLicenses] The list of application licenses + * the Batch service will make available on each compute node in the pool. + * The list of application licenses must be a subset of available Batch + * service application licenses. If a license is requested which is not + * supported, pool creation will fail. + * @property {number} [maxTasksPerNode] The maximum number of tasks that can * run concurrently on a single compute node in the pool. - * @member {object} [taskSchedulingPolicy] How tasks are distributed across + * @property {object} [taskSchedulingPolicy] How tasks are distributed across * compute nodes in a pool. - * @member {string} [taskSchedulingPolicy.nodeFillType] Possible values + * @property {string} [taskSchedulingPolicy.nodeFillType] Possible values * include: 'spread', 'pack' - * @member {array} [userAccounts] The list of user accounts to be created on - * each node in the pool. - * @member {array} [metadata] A list of name-value pairs associated with the - * pool as metadata. - * @member {object} [stats] Utilization and resource usage statistics for the - * entire lifetime of the pool. The statistics may not be immediately + * @property {array} [userAccounts] The list of user accounts to be created + * on each node in the pool. + * @property {array} [metadata] A list of name-value pairs associated with + * the pool as metadata. + * @property {object} [stats] Utilization and resource usage statistics for + * the entire lifetime of the pool. The statistics may not be immediately * available. The Batch service performs periodic roll-up of statistics. The * typical delay is about 30 minutes. - * @member {string} [stats.url] - * @member {date} [stats.startTime] - * @member {date} [stats.lastUpdateTime] - * @member {object} [stats.usageStats] - * @member {date} [stats.usageStats.startTime] - * @member {date} [stats.usageStats.lastUpdateTime] - * @member {moment.duration} [stats.usageStats.dedicatedCoreTime] - * @member {object} [stats.resourceStats] - * @member {date} [stats.resourceStats.startTime] - * @member {date} [stats.resourceStats.lastUpdateTime] - * @member {number} [stats.resourceStats.avgCPUPercentage] - * @member {number} [stats.resourceStats.avgMemoryGiB] - * @member {number} [stats.resourceStats.peakMemoryGiB] - * @member {number} [stats.resourceStats.avgDiskGiB] - * @member {number} [stats.resourceStats.peakDiskGiB] - * @member {number} [stats.resourceStats.diskReadIOps] - * @member {number} [stats.resourceStats.diskWriteIOps] - * @member {number} [stats.resourceStats.diskReadGiB] - * @member {number} [stats.resourceStats.diskWriteGiB] - * @member {number} [stats.resourceStats.networkReadGiB] - * @member {number} [stats.resourceStats.networkWriteGiB] + * @property {string} [stats.url] + * @property {date} [stats.startTime] + * @property {date} [stats.lastUpdateTime] + * @property {object} [stats.usageStats] + * @property {date} [stats.usageStats.startTime] + * @property {date} [stats.usageStats.lastUpdateTime] + * @property {moment.duration} [stats.usageStats.dedicatedCoreTime] + * @property {object} [stats.resourceStats] + * @property {date} [stats.resourceStats.startTime] + * @property {date} [stats.resourceStats.lastUpdateTime] + * @property {number} [stats.resourceStats.avgCPUPercentage] + * @property {number} [stats.resourceStats.avgMemoryGiB] + * @property {number} [stats.resourceStats.peakMemoryGiB] + * @property {number} [stats.resourceStats.avgDiskGiB] + * @property {number} [stats.resourceStats.peakDiskGiB] + * @property {number} [stats.resourceStats.diskReadIOps] + * @property {number} [stats.resourceStats.diskWriteIOps] + * @property {number} [stats.resourceStats.diskReadGiB] + * @property {number} [stats.resourceStats.diskWriteGiB] + * @property {number} [stats.resourceStats.networkReadGiB] + * @property {number} [stats.resourceStats.networkWriteGiB] */ constructor() { } diff --git a/lib/services/batch/lib/models/cloudPoolListResult.js b/lib/services/batch/lib/models/cloudPoolListResult.js index 9e9413c972..e285c05f80 100644 --- a/lib/services/batch/lib/models/cloudPoolListResult.js +++ b/lib/services/batch/lib/models/cloudPoolListResult.js @@ -16,7 +16,7 @@ class CloudPoolListResult extends Array { /** * Create a CloudPoolListResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/cloudServiceConfiguration.js b/lib/services/batch/lib/models/cloudServiceConfiguration.js index 53e29e4f5a..b8fb73a5b0 100644 --- a/lib/services/batch/lib/models/cloudServiceConfiguration.js +++ b/lib/services/batch/lib/models/cloudServiceConfiguration.js @@ -18,17 +18,17 @@ class CloudServiceConfiguration { /** * Create a CloudServiceConfiguration. - * @member {string} osFamily The Azure Guest OS family to be installed on the - * virtual machines in the pool. Possible values are: + * @property {string} osFamily The Azure Guest OS family to be installed on + * the virtual machines in the pool. Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. * 3 - OS Family 3, equivalent to Windows Server 2012. * 4 - OS Family 4, equivalent to Windows Server 2012 R2. * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [osVersion] The Azure Guest OS version to be installed on - * the virtual machines in the pool. The default value is * which specifies - * the latest operating system version for the specified OS family. + * @property {string} [osVersion] The Azure Guest OS version to be installed + * on the virtual machines in the pool. The default value is * which + * specifies the latest operating system version for the specified OS family. */ constructor() { } diff --git a/lib/services/batch/lib/models/cloudTask.js b/lib/services/batch/lib/models/cloudTask.js index 39c05f934e..fe128682b0 100644 --- a/lib/services/batch/lib/models/cloudTask.js +++ b/lib/services/batch/lib/models/cloudTask.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An Azure Batch task. * @@ -30,89 +28,89 @@ const models = require('./index'); class CloudTask { /** * Create a CloudTask. - * @member {string} [id] A string that uniquely identifies the task within + * @property {string} [id] A string that uniquely identifies the task within * the job. The ID can contain any combination of alphanumeric characters * including hyphens and underscores, and cannot contain more than 64 * characters. - * @member {string} [displayName] A display name for the task. The display + * @property {string} [displayName] A display name for the task. The display * name need not be unique and can contain any Unicode characters up to a * maximum length of 1024. - * @member {string} [url] The URL of the task. - * @member {string} [eTag] The ETag of the task. This is an opaque string. + * @property {string} [url] The URL of the task. + * @property {string} [eTag] The ETag of the task. This is an opaque string. * You can use it to detect whether the task has changed between requests. In * particular, you can be pass the ETag when updating a task to specify that * your changes should take effect only if nobody else has modified the task * in the meantime. - * @member {date} [lastModified] The last modified time of the task. - * @member {date} [creationTime] The creation time of the task. - * @member {object} [exitConditions] How the Batch service should respond + * @property {date} [lastModified] The last modified time of the task. + * @property {date} [creationTime] The creation time of the task. + * @property {object} [exitConditions] How the Batch service should respond * when the task completes. - * @member {array} [exitConditions.exitCodes] - * @member {array} [exitConditions.exitCodeRanges] - * @member {object} [exitConditions.preProcessingError] - * @member {string} [exitConditions.preProcessingError.jobAction] 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). Possible values include: 'none', 'disable', - * 'terminate' - * @member {string} [exitConditions.preProcessingError.dependencyAction] The - * default is 'satisfy' for exit code 0, and 'block' for all other exit + * @property {array} [exitConditions.exitCodes] + * @property {array} [exitConditions.exitCodeRanges] + * @property {object} [exitConditions.preProcessingError] + * @property {string} [exitConditions.preProcessingError.jobAction] 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). Possible values + * include: 'none', 'disable', 'terminate' + * @property {string} [exitConditions.preProcessingError.dependencyAction] + * 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). * Possible values include: 'satisfy', 'block' - * @member {object} [exitConditions.fileUploadError] If the task exited with - * an exit code that was specified via exitCodes or exitCodeRanges, and then - * encountered a file upload error, then the action specified by the exit - * code takes precedence. - * @member {string} [exitConditions.fileUploadError.jobAction] 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 + * @property {object} [exitConditions.fileUploadError] If the task exited + * with an exit code that was specified via exitCodes or exitCodeRanges, and + * then encountered a file upload error, then the action specified by the + * exit code takes precedence. + * @property {string} [exitConditions.fileUploadError.jobAction] 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). Possible values include: 'none', 'disable', * 'terminate' - * @member {string} [exitConditions.fileUploadError.dependencyAction] The + * @property {string} [exitConditions.fileUploadError.dependencyAction] 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). * Possible values include: 'satisfy', 'block' - * @member {object} [exitConditions.default] This value is used if the task + * @property {object} [exitConditions.default] This value is used if the task * exits with any nonzero exit code not listed in the exitCodes or * exitCodeRanges collection, with a pre-processing error if the * preProcessingError property is not present, or with a file upload error if * the fileUploadError property is not present. If you want non-default * behavior on exit code 0, you must list it explicitly using the exitCodes * or exitCodeRanges collection. - * @member {string} [exitConditions.default.jobAction] The default is none + * @property {string} [exitConditions.default.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [exitConditions.default.dependencyAction] 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). Possible values - * include: 'satisfy', 'block' - * @member {string} [state] The current state of the task. Possible values + * @property {string} [exitConditions.default.dependencyAction] 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). Possible + * values include: 'satisfy', 'block' + * @property {string} [state] The current state of the task. Possible values * include: 'active', 'preparing', 'running', 'completed' - * @member {date} [stateTransitionTime] The time at which the task entered + * @property {date} [stateTransitionTime] The time at which the task entered * its current state. - * @member {string} [previousState] The previous state of the task. This + * @property {string} [previousState] The previous state of the task. This * property is not set if the task is in its initial Active state. Possible * values include: 'active', 'preparing', 'running', 'completed' - * @member {date} [previousStateTransitionTime] The time at which the task + * @property {date} [previousStateTransitionTime] The time at which the task * entered its previous state. This property is not set if the task is in its * initial Active state. - * @member {string} [commandLine] The command line of the task. For + * @property {string} [commandLine] The command line of the task. For * multi-instance tasks, the command line is executed as the primary task, * after the primary task and all subtasks have finished executing the * coordination command line. The command line does not run under a shell, @@ -123,8 +121,8 @@ class CloudTask { * line refers to file paths, it should use a relative path (relative to the * task working directory), or use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the task runs. If the pool that will run this task has + * @property {object} [containerSettings] The settings for the container + * under which the task runs. If the pool that will run this task has * containerConfiguration set, this must be set as well. If the pool that * will run this task doesn't have containerConfiguration set, this must not * be set. When this is specified, all directories recursively below the @@ -132,19 +130,19 @@ class CloudTask { * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image + * @property {string} [containerSettings.containerRunOptions] These + * additional options are supplied as arguments to the "docker create" + * command, in addition to those controlled by the Batch Service. + * @property {string} [containerSettings.imageName] This is the full image * reference, as would be specified to "docker pull". If no tag is provided * as part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted - * if was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, + * @property {object} [containerSettings.registry] This setting can be + * omitted if was already provided at pool creation. + * @property {string} [containerSettings.registry.registryServer] If omitted, * the default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service + * @property {string} [containerSettings.registry.userName] + * @property {string} [containerSettings.registry.password] + * @property {array} [resourceFiles] A list of files that the Batch service * will download to the compute node before running the command line. For * multi-instance tasks, the resource files will only be downloaded to the * compute node on which the primary task is executed. There is a maximum @@ -153,27 +151,27 @@ class CloudTask { * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [outputFiles] A list of files that the Batch service will - * upload from the compute node after running the command line. For + * @property {array} [outputFiles] A list of files that the Batch service + * will upload from the compute node after running the command line. For * multi-instance tasks, the files will only be uploaded from the compute * node on which the primary task is executed. - * @member {array} [environmentSettings] A list of environment variable + * @property {array} [environmentSettings] A list of environment variable * settings for the task. - * @member {object} [affinityInfo] A locality hint that can be used by the + * @property {object} [affinityInfo] A locality hint that can be used by the * Batch service to select a compute node on which to start the new task. - * @member {string} [affinityInfo.affinityId] You can pass the affinityId of - * a compute node to indicate that this task needs to run on that compute + * @property {string} [affinityInfo.affinityId] You can pass the affinityId + * of a compute node to indicate that this task needs to run on that compute * node. Note that this is just a soft affinity. If the target node is busy * or unavailable at the time the task is scheduled, then the task will be * scheduled elsewhere. - * @member {object} [constraints] The execution constraints that apply to + * @property {object} [constraints] The execution constraints that apply to * this task. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not + * @property {moment.duration} [constraints.maxWallClockTime] If this is not * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 + * @property {moment.duration} [constraints.retentionTime] The default is 7 * days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries for the task executable due to * a nonzero exit code. The Batch service will try the task once, and may * then retry up to this limit. For example, if the maximum retry count is 3, @@ -181,126 +179,126 @@ class CloudTask { * maximum retry count is 0, the Batch service does not retry the task after * the first attempt. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {object} [userIdentity] The user identity under which the task + * @property {object} [userIdentity] The user identity under which the task * runs. If omitted, the task runs as a non-administrative user unique to the * task. - * @member {string} [userIdentity.userName] The userName and autoUser + * @property {string} [userIdentity.userName] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser + * @property {object} [userIdentity.autoUser] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value - * is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {object} [executionInfo] Information about the execution of the + * @property {string} [userIdentity.autoUser.scope] The default value is + * task. Possible values include: 'task', 'pool' + * @property {string} [userIdentity.autoUser.elevationLevel] The default + * value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @property {object} [executionInfo] Information about the execution of the * task. - * @member {date} [executionInfo.startTime] 'Running' corresponds to the + * @property {date} [executionInfo.startTime] 'Running' corresponds to the * running state, so if the task specifies resource files or application * packages, then the start time reflects the time at which the task started * downloading or deploying these. If the task has been restarted or retried, * this is the most recent time at which the task started running. This * property is present only for tasks that are in the running or completed * state. - * @member {date} [executionInfo.endTime] This property is set only if the + * @property {date} [executionInfo.endTime] This property is set only if the * task is in the Completed state. - * @member {number} [executionInfo.exitCode] This property is set only if the - * task is in the completed state. In general, the exit code for a process - * reflects the specific convention implemented by the application developer - * for that process. If you use the exit code value to make decisions in your - * code, be sure that you know the exit code convention used by the - * application process. However, if the Batch service terminates the task - * (due to timeout, or user termination via the API) you may see an operating - * system-defined exit code. - * @member {object} [executionInfo.containerInfo] This property is set only + * @property {number} [executionInfo.exitCode] This property is set only if + * the task is in the completed state. In general, the exit code for a + * process reflects the specific convention implemented by the application + * developer for that process. If you use the exit code value to make + * decisions in your code, be sure that you know the exit code convention + * used by the application process. However, if the Batch service terminates + * the task (due to timeout, or user termination via the API) you may see an + * operating system-defined exit code. + * @property {object} [executionInfo.containerInfo] This property is set only * if the task runs in a container context. - * @member {string} [executionInfo.containerInfo.containerId] - * @member {string} [executionInfo.containerInfo.state] This is the state of - * the container according to the Docker service. It is equivalent to the + * @property {string} [executionInfo.containerInfo.containerId] + * @property {string} [executionInfo.containerInfo.state] This is the state + * of the container according to the Docker service. It is equivalent to the * status field returned by "docker inspect". - * @member {string} [executionInfo.containerInfo.error] This is the detailed - * error string from the Docker service, if available. It is equivalent to - * the error field returned by "docker inspect". - * @member {object} [executionInfo.failureInfo] This property is set only if - * the task is in the completed state and encountered a failure. - * @member {string} [executionInfo.failureInfo.category] Possible values + * @property {string} [executionInfo.containerInfo.error] This is the + * detailed error string from the Docker service, if available. It is + * equivalent to the error field returned by "docker inspect". + * @property {object} [executionInfo.failureInfo] This property is set only + * if the task is in the completed state and encountered a failure. + * @property {string} [executionInfo.failureInfo.category] Possible values * include: 'userError', 'serverError' - * @member {string} [executionInfo.failureInfo.code] - * @member {string} [executionInfo.failureInfo.message] - * @member {array} [executionInfo.failureInfo.details] - * @member {number} [executionInfo.retryCount] Task application failures + * @property {string} [executionInfo.failureInfo.code] + * @property {string} [executionInfo.failureInfo.message] + * @property {array} [executionInfo.failureInfo.details] + * @property {number} [executionInfo.retryCount] Task application failures * (non-zero exit code) are retried, pre-processing errors (the task could * not be run) and file upload errors are not retried. The Batch service will * retry the task up to the limit specified by the constraints. - * @member {date} [executionInfo.lastRetryTime] This element is present only - * if the task was retried (i.e. retryCount is nonzero). If present, this is - * typically the same as startTime, but may be different if the task has been - * restarted for reasons other than retry; for example, if the compute node - * was rebooted during a retry, then the startTime is updated but the - * lastRetryTime is not. - * @member {number} [executionInfo.requeueCount] When the user removes nodes - * from a pool (by resizing/shrinking the pool) or when the job is being - * disabled, the user can specify that running tasks on the nodes be requeued - * for execution. This count tracks how many times the task has been requeued - * for these reasons. - * @member {date} [executionInfo.lastRequeueTime] This property is set only + * @property {date} [executionInfo.lastRetryTime] This element is present + * only if the task was retried (i.e. retryCount is nonzero). If present, + * this is typically the same as startTime, but may be different if the task + * has been restarted for reasons other than retry; for example, if the + * compute node was rebooted during a retry, then the startTime is updated + * but the lastRetryTime is not. + * @property {number} [executionInfo.requeueCount] When the user removes + * nodes from a pool (by resizing/shrinking the pool) or when the job is + * being disabled, the user can specify that running tasks on the nodes be + * requeued for execution. This count tracks how many times the task has been + * requeued for these reasons. + * @property {date} [executionInfo.lastRequeueTime] This property is set only * if the requeueCount is nonzero. - * @member {string} [executionInfo.result] If the value is 'failed', then the - * details of the failure can be found in the failureInfo property. Possible - * values include: 'success', 'failure' - * @member {object} [nodeInfo] Information about the compute node on which + * @property {string} [executionInfo.result] If the value is 'failed', then + * the details of the failure can be found in the failureInfo property. + * Possible values include: 'success', 'failure' + * @property {object} [nodeInfo] Information about the compute node on which * the task ran. - * @member {string} [nodeInfo.affinityId] - * @member {string} [nodeInfo.nodeUrl] - * @member {string} [nodeInfo.poolId] - * @member {string} [nodeInfo.nodeId] - * @member {string} [nodeInfo.taskRootDirectory] - * @member {string} [nodeInfo.taskRootDirectoryUrl] - * @member {object} [multiInstanceSettings] An object that indicates that the - * task is a multi-instance task, and contains information about how to run - * the multi-instance task. - * @member {number} [multiInstanceSettings.numberOfInstances] If omitted, the - * default is 1. - * @member {string} [multiInstanceSettings.coordinationCommandLine] A typical - * coordination command line launches a background service and verifies that - * the service is ready to process inter-node messages. - * @member {array} [multiInstanceSettings.commonResourceFiles] The difference - * between common resource files and task resource files is that common - * resource files are downloaded for all subtasks including the primary, - * whereas task resource files are downloaded only for the primary. Also note - * that these resource files are not downloaded to the task working + * @property {string} [nodeInfo.affinityId] + * @property {string} [nodeInfo.nodeUrl] + * @property {string} [nodeInfo.poolId] + * @property {string} [nodeInfo.nodeId] + * @property {string} [nodeInfo.taskRootDirectory] + * @property {string} [nodeInfo.taskRootDirectoryUrl] + * @property {object} [multiInstanceSettings] An object that indicates that + * the task is a multi-instance task, and contains information about how to + * run the multi-instance task. + * @property {number} [multiInstanceSettings.numberOfInstances] If omitted, + * the default is 1. + * @property {string} [multiInstanceSettings.coordinationCommandLine] A + * typical coordination command line launches a background service and + * verifies that the service is ready to process inter-node messages. + * @property {array} [multiInstanceSettings.commonResourceFiles] The + * difference between common resource files and task resource files is that + * common resource files are downloaded for all subtasks including the + * primary, whereas task resource files are downloaded only for the primary. + * Also note that these resource files are not downloaded to the task working * directory, but instead are downloaded to the task root directory (one * directory above the working directory). There is a maximum size for the * list of resource files. When the max size is exceeded, the request will * fail and the response error code will be RequestEntityTooLarge. If this * occurs, the collection of ResourceFiles must be reduced in size. This can * be achieved using .zip files, Application Packages, or Docker Containers. - * @member {object} [stats] Resource usage statistics for the task. - * @member {string} [stats.url] - * @member {date} [stats.startTime] - * @member {date} [stats.lastUpdateTime] - * @member {moment.duration} [stats.userCPUTime] - * @member {moment.duration} [stats.kernelCPUTime] - * @member {moment.duration} [stats.wallClockTime] The wall clock time is the - * elapsed time from when the task started running on a compute node to when - * it finished (or to the last time the statistics were updated, if the task - * had not finished by then). If the task was retried, this includes the wall - * clock time of all the task retries. - * @member {number} [stats.readIOps] - * @member {number} [stats.writeIOps] - * @member {number} [stats.readIOGiB] - * @member {number} [stats.writeIOGiB] - * @member {moment.duration} [stats.waitTime] - * @member {object} [dependsOn] The tasks that this task depends on. This + * @property {object} [stats] Resource usage statistics for the task. + * @property {string} [stats.url] + * @property {date} [stats.startTime] + * @property {date} [stats.lastUpdateTime] + * @property {moment.duration} [stats.userCPUTime] + * @property {moment.duration} [stats.kernelCPUTime] + * @property {moment.duration} [stats.wallClockTime] The wall clock time is + * the elapsed time from when the task started running on a compute node to + * when it finished (or to the last time the statistics were updated, if the + * task had not finished by then). If the task was retried, this includes the + * wall clock time of all the task retries. + * @property {number} [stats.readIOps] + * @property {number} [stats.writeIOps] + * @property {number} [stats.readIOGiB] + * @property {number} [stats.writeIOGiB] + * @property {moment.duration} [stats.waitTime] + * @property {object} [dependsOn] The tasks that this task depends on. This * task will not be scheduled until all tasks that it depends on have * completed successfully. If any of those tasks fail and exhaust their retry * counts, this task will never be scheduled. - * @member {array} [dependsOn.taskIds] The taskIds collection is limited to + * @property {array} [dependsOn.taskIds] The taskIds collection is limited to * 64000 characters total (i.e. the combined length of all task IDs). If the * taskIds collection exceeds the maximum length, the Add Task request fails * with error code TaskDependencyListTooLong. In this case consider using * task ID ranges instead. - * @member {array} [dependsOn.taskIdRanges] - * @member {array} [applicationPackageReferences] A list of application + * @property {array} [dependsOn.taskIdRanges] + * @property {array} [applicationPackageReferences] A list of application * packages that the Batch service will deploy to the compute node before * running the command line. Application packages are downloaded and deployed * to a shared directory, not the task working directory. Therefore, if a @@ -308,7 +306,7 @@ class CloudTask { * it is not re-downloaded; the existing copy on the compute node is used. If * a referenced application package cannot be installed, for example because * the package has been deleted or because download failed, the task fails. - * @member {object} [authenticationTokenSettings] The settings for an + * @property {object} [authenticationTokenSettings] The settings for an * authentication token that the task can use to perform Batch service * operations. If this property is set, the Batch service provides the task * with an authentication token which can be used to authenticate Batch @@ -318,7 +316,7 @@ class CloudTask { * settings. For example, a task can request job permissions in order to add * other tasks to the job, or check the status of the job or of other tasks * under the job. - * @member {array} [authenticationTokenSettings.access] The authentication + * @property {array} [authenticationTokenSettings.access] The authentication * token grants access to a limited set of Batch service operations. * Currently the only supported value for the access property is 'job', which * grants access to all operations related to the job which contains the diff --git a/lib/services/batch/lib/models/cloudTaskListResult.js b/lib/services/batch/lib/models/cloudTaskListResult.js index ce9c005566..ca7bb8c0f7 100644 --- a/lib/services/batch/lib/models/cloudTaskListResult.js +++ b/lib/services/batch/lib/models/cloudTaskListResult.js @@ -16,7 +16,7 @@ class CloudTaskListResult extends Array { /** * Create a CloudTaskListResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/cloudTaskListSubtasksResult.js b/lib/services/batch/lib/models/cloudTaskListSubtasksResult.js index eff138230d..f24b36f580 100644 --- a/lib/services/batch/lib/models/cloudTaskListSubtasksResult.js +++ b/lib/services/batch/lib/models/cloudTaskListSubtasksResult.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The result of listing the subtasks of a task. * @@ -19,7 +17,7 @@ const models = require('./index'); class CloudTaskListSubtasksResult { /** * Create a CloudTaskListSubtasksResult. - * @member {array} [value] The list of subtasks. + * @property {array} [value] The list of subtasks. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNode.js b/lib/services/batch/lib/models/computeNode.js index 75e182ddf2..06638c3f1b 100644 --- a/lib/services/batch/lib/models/computeNode.js +++ b/lib/services/batch/lib/models/computeNode.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A compute node in the Batch service. * @@ -19,57 +17,58 @@ const models = require('./index'); class ComputeNode { /** * Create a ComputeNode. - * @member {string} [id] The ID of the compute node. Every node that is added - * to a pool is assigned a unique ID. Whenever a node is removed from a pool, - * all of its local files are deleted, and the ID is reclaimed and could be - * reused for new nodes. - * @member {string} [url] The URL of the compute node. - * @member {string} [state] The current state of the compute node. The + * @property {string} [id] The ID of the compute node. Every node that is + * added to a pool is assigned a unique ID. Whenever a node is removed from a + * pool, all of its local files are deleted, and the ID is reclaimed and + * could be reused for new nodes. + * @property {string} [url] The URL of the compute node. + * @property {string} [state] The current state of the compute node. 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. Possible values include: 'idle', 'rebooting', 'reimaging', * 'running', 'unusable', 'creating', 'starting', 'waitingForStartTask', * 'startTaskFailed', 'unknown', 'leavingPool', 'offline', 'preempted' - * @member {string} [schedulingState] Whether the compute node is available + * @property {string} [schedulingState] Whether the compute node is available * for task scheduling. Possible values include: 'enabled', 'disabled' - * @member {date} [stateTransitionTime] The time at which the compute node + * @property {date} [stateTransitionTime] The time at which the compute node * entered its current state. - * @member {date} [lastBootTime] The last time at which the compute node was - * started. This property may not be present if the node state is unusable. - * @member {date} [allocationTime] The time at which this compute node was + * @property {date} [lastBootTime] The last time at which the compute node + * was started. This property may not be present if the node state is + * unusable. + * @property {date} [allocationTime] The time at which this compute node was * allocated to the pool. This is the time when the node was initially * allocated and doesn't change once set. It is not updated when the node is * service healed or preempted. - * @member {string} [ipAddress] The IP address that other compute nodes can + * @property {string} [ipAddress] The IP address that other compute nodes can * use to communicate with this compute node. Every node that is added to a * pool is assigned a unique IP address. Whenever a node is removed from a * pool, all of its local files are deleted, and the IP address is reclaimed * and could be reused for new nodes. - * @member {string} [affinityId] An identifier which can be passed when + * @property {string} [affinityId] An identifier which can be passed when * adding a task to request that the task be scheduled on this node. Note * that this is just a soft affinity. If the target node is busy or * unavailable at the time the task is scheduled, then the task will be * scheduled elsewhere. - * @member {string} [vmSize] The size of the virtual machine hosting the + * @property {string} [vmSize] The size of the virtual machine hosting the * compute node. For information about available sizes of virtual machines in * pools, see Choose a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {number} [totalTasksRun] The total number of job tasks completed + * @property {number} [totalTasksRun] The total number of job tasks completed * on the compute node. This includes Job Manager tasks and normal tasks, but * not Job Preparation, Job Release or Start tasks. - * @member {number} [runningTasksCount] The total number of currently running - * job tasks on the compute node. This includes Job Manager tasks and normal - * tasks, but not Job Preparation, Job Release or Start tasks. - * @member {number} [totalTasksSucceeded] The total number of job tasks which - * completed successfully (with exitCode 0) on the compute node. This + * @property {number} [runningTasksCount] The total number of currently + * running job tasks on the compute node. This includes Job Manager tasks and + * normal tasks, but not Job Preparation, Job Release or Start tasks. + * @property {number} [totalTasksSucceeded] The total number of job tasks + * which completed successfully (with exitCode 0) on the compute node. This * includes Job Manager tasks and normal tasks, but not Job Preparation, Job * Release or Start tasks. - * @member {array} [recentTasks] A list of tasks whose state has recently + * @property {array} [recentTasks] A list of tasks whose state has recently * changed. This property is present only if at least one task has run on * this node since it was assigned to the pool. - * @member {object} [startTask] The task specified to run on the compute node - * as it joins the pool. - * @member {string} [startTask.commandLine] The command line does not run + * @property {object} [startTask] The task specified to run on the compute + * node as it joins the pool. + * @property {string} [startTask.commandLine] The command line does not run * under a shell, and therefore cannot take advantage of shell features such * as environment variable expansion. If you want to take advantage of such * features, you should invoke the shell in the command line, for example @@ -78,48 +77,48 @@ class ComputeNode { * (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * @property {object} [startTask.containerSettings] When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These + * @property {string} [startTask.containerSettings.containerRunOptions] These * additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is + * @property {string} [startTask.containerSettings.imageName] This is the + * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [startTask.containerSettings.registry] This setting can + * @property {object} [startTask.containerSettings.registry] This setting can * be omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a + * @property {string} [startTask.containerSettings.registry.registryServer] + * If omitted, the default is "docker.io". + * @property {string} [startTask.containerSettings.registry.userName] + * @property {string} [startTask.containerSettings.registry.password] + * @property {array} [startTask.resourceFiles] Files listed under this + * element are located in the task's working directory. + * @property {array} [startTask.environmentSettings] + * @property {object} [startTask.userIdentity] If omitted, the task runs as a * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and + * @property {string} [startTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [startTask.userIdentity.autoUser] The userName and + * @property {object} [startTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The + * @property {string} [startTask.userIdentity.autoUser.scope] The default + * value is task. Possible values include: 'task', 'pool' + * @property {string} [startTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically + * @property {number} [startTask.maxTaskRetryCount] The Batch service retries + * a task if its exit code is nonzero. Note that this value specifically * controls the number of retries. The Batch service will try the task once, * and may then retry up to this limit. For example, if the maximum retry * count is 3, Batch tries the task up to 4 times (one initial try and 3 * retries). If the maximum retry count is 0, the Batch service does not * retry the task. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task + * @property {boolean} [startTask.waitForSuccess] If true and the start task * fails on a compute node, the Batch service retries the start task up to * its maximum retry count (maxTaskRetryCount). If the task has still not * completed successfully after all retries, then the Batch service marks the @@ -129,77 +128,77 @@ class ComputeNode { * other tasks can start executing on the compute node while the start task * is still running; and even if the start task fails, new tasks will * continue to be scheduled on the node. The default is false. - * @member {object} [startTaskInfo] Runtime information about the execution + * @property {object} [startTaskInfo] Runtime information about the execution * of the start task on the compute node. - * @member {string} [startTaskInfo.state] Possible values include: 'running', - * 'completed' - * @member {date} [startTaskInfo.startTime] This value is reset every time + * @property {string} [startTaskInfo.state] Possible values include: + * 'running', 'completed' + * @property {date} [startTaskInfo.startTime] This value is reset every time * the task is restarted or retried (that is, this is the most recent time at * which the start task started running). - * @member {date} [startTaskInfo.endTime] This is the end time of the most + * @property {date} [startTaskInfo.endTime] This is the end time of the most * recent run of the start task, if that run has completed (even if that run * failed and a retry is pending). This element is not present if the start * task is currently running. - * @member {number} [startTaskInfo.exitCode] This property is set only if the - * start task is in the completed state. In general, the exit code for a + * @property {number} [startTaskInfo.exitCode] This property is set only if + * the start task is in the completed state. In general, the exit code for a * process reflects the specific convention implemented by the application * developer for that process. If you use the exit code value to make * decisions in your code, be sure that you know the exit code convention * used by the application process. However, if the Batch service terminates * the start task (due to timeout, or user termination via the API) you may * see an operating system-defined exit code. - * @member {object} [startTaskInfo.containerInfo] This property is set only + * @property {object} [startTaskInfo.containerInfo] This property is set only * if the task runs in a container context. - * @member {string} [startTaskInfo.containerInfo.containerId] - * @member {string} [startTaskInfo.containerInfo.state] This is the state of - * the container according to the Docker service. It is equivalent to the + * @property {string} [startTaskInfo.containerInfo.containerId] + * @property {string} [startTaskInfo.containerInfo.state] This is the state + * of the container according to the Docker service. It is equivalent to the * status field returned by "docker inspect". - * @member {string} [startTaskInfo.containerInfo.error] This is the detailed - * error string from the Docker service, if available. It is equivalent to - * the error field returned by "docker inspect". - * @member {object} [startTaskInfo.failureInfo] This property is set only if - * the task is in the completed state and encountered a failure. - * @member {string} [startTaskInfo.failureInfo.category] Possible values + * @property {string} [startTaskInfo.containerInfo.error] This is the + * detailed error string from the Docker service, if available. It is + * equivalent to the error field returned by "docker inspect". + * @property {object} [startTaskInfo.failureInfo] This property is set only + * if the task is in the completed state and encountered a failure. + * @property {string} [startTaskInfo.failureInfo.category] Possible values * include: 'userError', 'serverError' - * @member {string} [startTaskInfo.failureInfo.code] - * @member {string} [startTaskInfo.failureInfo.message] - * @member {array} [startTaskInfo.failureInfo.details] - * @member {number} [startTaskInfo.retryCount] Task application failures + * @property {string} [startTaskInfo.failureInfo.code] + * @property {string} [startTaskInfo.failureInfo.message] + * @property {array} [startTaskInfo.failureInfo.details] + * @property {number} [startTaskInfo.retryCount] Task application failures * (non-zero exit code) are retried, pre-processing errors (the task could * not be run) and file upload errors are not retried. The Batch service will * retry the task up to the limit specified by the constraints. - * @member {date} [startTaskInfo.lastRetryTime] This element is present only - * if the task was retried (i.e. retryCount is nonzero). If present, this is - * typically the same as startTime, but may be different if the task has been - * restarted for reasons other than retry; for example, if the compute node - * was rebooted during a retry, then the startTime is updated but the - * lastRetryTime is not. - * @member {string} [startTaskInfo.result] If the value is 'failed', then the - * details of the failure can be found in the failureInfo property. Possible - * values include: 'success', 'failure' - * @member {array} [certificateReferences] The list of certificates installed - * on the compute node. For Windows compute nodes, the Batch service installs - * the certificates to the specified certificate store and location. For - * Linux compute nodes, the certificates are stored in a directory inside the - * task working directory and an environment variable + * @property {date} [startTaskInfo.lastRetryTime] This element is present + * only if the task was retried (i.e. retryCount is nonzero). If present, + * this is typically the same as startTime, but may be different if the task + * has been restarted for reasons other than retry; for example, if the + * compute node was rebooted during a retry, then the startTime is updated + * but the lastRetryTime is not. + * @property {string} [startTaskInfo.result] If the value is 'failed', then + * the details of the failure can be found in the failureInfo property. + * Possible values include: 'success', 'failure' + * @property {array} [certificateReferences] The list of certificates + * installed on the compute node. For Windows compute nodes, the Batch + * service installs the certificates to the specified certificate store and + * location. 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. - * @member {array} [errors] The list of errors that are currently being + * @property {array} [errors] The list of errors that are currently being * encountered by the compute node. - * @member {boolean} [isDedicated] Whether this compute node is a dedicated + * @property {boolean} [isDedicated] Whether this compute node is a dedicated * node. If false, the node is a low-priority node. - * @member {object} [endpointConfiguration] The endpoint configuration for + * @property {object} [endpointConfiguration] The endpoint configuration for * the compute node. - * @member {array} [endpointConfiguration.inboundEndpoints] - * @member {object} [nodeAgentInfo] Information about the node agent version - * and the time the node upgraded to a new version. - * @member {string} [nodeAgentInfo.version] This version number can be + * @property {array} [endpointConfiguration.inboundEndpoints] + * @property {object} [nodeAgentInfo] Information about the node agent + * version and the time the node upgraded to a new version. + * @property {string} [nodeAgentInfo.version] This version number can be * checked against the node agent release notes located at * https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. - * @member {date} [nodeAgentInfo.lastUpdateTime] This is the most recent time - * that the node agent was updated to a new version. + * @property {date} [nodeAgentInfo.lastUpdateTime] This is the most recent + * time that the node agent was updated to a new version. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeAddUserOptions.js b/lib/services/batch/lib/models/computeNodeAddUserOptions.js index 50f65be709..04d092ae99 100644 --- a/lib/services/batch/lib/models/computeNodeAddUserOptions.js +++ b/lib/services/batch/lib/models/computeNodeAddUserOptions.js @@ -17,17 +17,17 @@ class ComputeNodeAddUserOptions { /** * Create a ComputeNodeAddUserOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeDeleteUserOptions.js b/lib/services/batch/lib/models/computeNodeDeleteUserOptions.js index 1fd52818c8..eb67500f00 100644 --- a/lib/services/batch/lib/models/computeNodeDeleteUserOptions.js +++ b/lib/services/batch/lib/models/computeNodeDeleteUserOptions.js @@ -17,17 +17,17 @@ class ComputeNodeDeleteUserOptions { /** * Create a ComputeNodeDeleteUserOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeDisableSchedulingOptions.js b/lib/services/batch/lib/models/computeNodeDisableSchedulingOptions.js index dd7c2b5149..cd3a837fbe 100644 --- a/lib/services/batch/lib/models/computeNodeDisableSchedulingOptions.js +++ b/lib/services/batch/lib/models/computeNodeDisableSchedulingOptions.js @@ -17,17 +17,17 @@ class ComputeNodeDisableSchedulingOptions { /** * Create a ComputeNodeDisableSchedulingOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeEnableSchedulingOptions.js b/lib/services/batch/lib/models/computeNodeEnableSchedulingOptions.js index 7e0e1786e3..6c953ecac3 100644 --- a/lib/services/batch/lib/models/computeNodeEnableSchedulingOptions.js +++ b/lib/services/batch/lib/models/computeNodeEnableSchedulingOptions.js @@ -17,17 +17,17 @@ class ComputeNodeEnableSchedulingOptions { /** * Create a ComputeNodeEnableSchedulingOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeEndpointConfiguration.js b/lib/services/batch/lib/models/computeNodeEndpointConfiguration.js index 9b52c9c439..635a95b6e3 100644 --- a/lib/services/batch/lib/models/computeNodeEndpointConfiguration.js +++ b/lib/services/batch/lib/models/computeNodeEndpointConfiguration.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The endpoint configuration for the compute node. * @@ -19,7 +17,7 @@ const models = require('./index'); class ComputeNodeEndpointConfiguration { /** * Create a ComputeNodeEndpointConfiguration. - * @member {array} inboundEndpoints The list of inbound endpoints that are + * @property {array} inboundEndpoints The list of inbound endpoints that are * accessible on the compute node. */ constructor() { diff --git a/lib/services/batch/lib/models/computeNodeError.js b/lib/services/batch/lib/models/computeNodeError.js index edc12b02ae..9bf86e453b 100644 --- a/lib/services/batch/lib/models/computeNodeError.js +++ b/lib/services/batch/lib/models/computeNodeError.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An error encountered by a compute node. * @@ -19,11 +17,11 @@ const models = require('./index'); class ComputeNodeError { /** * Create a ComputeNodeError. - * @member {string} [code] An identifier for the compute node error. Codes + * @property {string} [code] An identifier for the compute node error. Codes * are invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the compute node error, + * @property {string} [message] A message describing the compute node error, * intended to be suitable for display in a user interface. - * @member {array} [errorDetails] The list of additional error details + * @property {array} [errorDetails] The list of additional error details * related to the compute node error. */ constructor() { diff --git a/lib/services/batch/lib/models/computeNodeGetOptions.js b/lib/services/batch/lib/models/computeNodeGetOptions.js index 754c25cb36..3a1104477a 100644 --- a/lib/services/batch/lib/models/computeNodeGetOptions.js +++ b/lib/services/batch/lib/models/computeNodeGetOptions.js @@ -17,18 +17,18 @@ class ComputeNodeGetOptions { /** * Create a ComputeNodeGetOptions. - * @member {string} [select] An OData $select clause. - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeGetRemoteDesktopOptions.js b/lib/services/batch/lib/models/computeNodeGetRemoteDesktopOptions.js index 65cfb2f3f2..e84a8f12a0 100644 --- a/lib/services/batch/lib/models/computeNodeGetRemoteDesktopOptions.js +++ b/lib/services/batch/lib/models/computeNodeGetRemoteDesktopOptions.js @@ -17,17 +17,17 @@ class ComputeNodeGetRemoteDesktopOptions { /** * Create a ComputeNodeGetRemoteDesktopOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeGetRemoteLoginSettingsOptions.js b/lib/services/batch/lib/models/computeNodeGetRemoteLoginSettingsOptions.js index cd6515f5e4..deb091cda9 100644 --- a/lib/services/batch/lib/models/computeNodeGetRemoteLoginSettingsOptions.js +++ b/lib/services/batch/lib/models/computeNodeGetRemoteLoginSettingsOptions.js @@ -17,17 +17,17 @@ class ComputeNodeGetRemoteLoginSettingsOptions { /** * Create a ComputeNodeGetRemoteLoginSettingsOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeGetRemoteLoginSettingsResult.js b/lib/services/batch/lib/models/computeNodeGetRemoteLoginSettingsResult.js index 9aabced135..df58b9cb6a 100644 --- a/lib/services/batch/lib/models/computeNodeGetRemoteLoginSettingsResult.js +++ b/lib/services/batch/lib/models/computeNodeGetRemoteLoginSettingsResult.js @@ -17,9 +17,9 @@ class ComputeNodeGetRemoteLoginSettingsResult { /** * Create a ComputeNodeGetRemoteLoginSettingsResult. - * @member {string} remoteLoginIPAddress The IP address used for remote login - * to the compute node. - * @member {number} remoteLoginPort The port used for remote login to the + * @property {string} remoteLoginIPAddress The IP address used for remote + * login to the compute node. + * @property {number} remoteLoginPort The port used for remote login to the * compute node. */ constructor() { diff --git a/lib/services/batch/lib/models/computeNodeInformation.js b/lib/services/batch/lib/models/computeNodeInformation.js index 1e656577ef..9ba1008961 100644 --- a/lib/services/batch/lib/models/computeNodeInformation.js +++ b/lib/services/batch/lib/models/computeNodeInformation.js @@ -17,15 +17,15 @@ class ComputeNodeInformation { /** * Create a ComputeNodeInformation. - * @member {string} [affinityId] An identifier for the compute node on which - * the task ran, which can be passed when adding a task to request that the - * task be scheduled on this compute node. - * @member {string} [nodeUrl] The URL of the node on which the task ran. . - * @member {string} [poolId] The ID of the pool on which the task ran. - * @member {string} [nodeId] The ID of the node on which the task ran. - * @member {string} [taskRootDirectory] The root directory of the task on the - * compute node. - * @member {string} [taskRootDirectoryUrl] The URL to the root directory of + * @property {string} [affinityId] An identifier for the compute node on + * which the task ran, which can be passed when adding a task to request that + * the task be scheduled on this compute node. + * @property {string} [nodeUrl] The URL of the node on which the task ran. . + * @property {string} [poolId] The ID of the pool on which the task ran. + * @property {string} [nodeId] The ID of the node on which the task ran. + * @property {string} [taskRootDirectory] The root directory of the task on + * the compute node. + * @property {string} [taskRootDirectoryUrl] The URL to the root directory of * the task on the compute node. */ constructor() { diff --git a/lib/services/batch/lib/models/computeNodeListNextOptions.js b/lib/services/batch/lib/models/computeNodeListNextOptions.js index 728b6d2fa7..60a3979ae2 100644 --- a/lib/services/batch/lib/models/computeNodeListNextOptions.js +++ b/lib/services/batch/lib/models/computeNodeListNextOptions.js @@ -17,14 +17,14 @@ class ComputeNodeListNextOptions { /** * Create a ComputeNodeListNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeListOptions.js b/lib/services/batch/lib/models/computeNodeListOptions.js index 886f9bc23b..aa989158a8 100644 --- a/lib/services/batch/lib/models/computeNodeListOptions.js +++ b/lib/services/batch/lib/models/computeNodeListOptions.js @@ -17,23 +17,24 @@ class ComputeNodeListOptions { /** * Create a ComputeNodeListOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. - * @member {string} [select] An OData $select clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 nodes can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 nodes can be returned. Default value: 1000 + * . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeListResult.js b/lib/services/batch/lib/models/computeNodeListResult.js index 194f7068be..66375f2392 100644 --- a/lib/services/batch/lib/models/computeNodeListResult.js +++ b/lib/services/batch/lib/models/computeNodeListResult.js @@ -16,7 +16,7 @@ class ComputeNodeListResult extends Array { /** * Create a ComputeNodeListResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/computeNodeRebootOptions.js b/lib/services/batch/lib/models/computeNodeRebootOptions.js index 1ab5ddb763..2cd4c3c7ac 100644 --- a/lib/services/batch/lib/models/computeNodeRebootOptions.js +++ b/lib/services/batch/lib/models/computeNodeRebootOptions.js @@ -17,17 +17,17 @@ class ComputeNodeRebootOptions { /** * Create a ComputeNodeRebootOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeReimageOptions.js b/lib/services/batch/lib/models/computeNodeReimageOptions.js index cf2498028f..83f17abcbe 100644 --- a/lib/services/batch/lib/models/computeNodeReimageOptions.js +++ b/lib/services/batch/lib/models/computeNodeReimageOptions.js @@ -17,17 +17,17 @@ class ComputeNodeReimageOptions { /** * Create a ComputeNodeReimageOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeUpdateUserOptions.js b/lib/services/batch/lib/models/computeNodeUpdateUserOptions.js index 5be43b9db5..4ee42a1af6 100644 --- a/lib/services/batch/lib/models/computeNodeUpdateUserOptions.js +++ b/lib/services/batch/lib/models/computeNodeUpdateUserOptions.js @@ -17,17 +17,17 @@ class ComputeNodeUpdateUserOptions { /** * Create a ComputeNodeUpdateUserOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeUploadBatchServiceLogsOptions.js b/lib/services/batch/lib/models/computeNodeUploadBatchServiceLogsOptions.js index b84666aa52..ed3ace6d95 100644 --- a/lib/services/batch/lib/models/computeNodeUploadBatchServiceLogsOptions.js +++ b/lib/services/batch/lib/models/computeNodeUploadBatchServiceLogsOptions.js @@ -17,17 +17,17 @@ class ComputeNodeUploadBatchServiceLogsOptions { /** * Create a ComputeNodeUploadBatchServiceLogsOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/computeNodeUser.js b/lib/services/batch/lib/models/computeNodeUser.js index f7dc170d58..d98a5436e0 100644 --- a/lib/services/batch/lib/models/computeNodeUser.js +++ b/lib/services/batch/lib/models/computeNodeUser.js @@ -17,18 +17,18 @@ class ComputeNodeUser { /** * Create a ComputeNodeUser. - * @member {string} name The user name of the account. - * @member {boolean} [isAdmin] Whether the account should be an administrator - * on the compute node. The default value is false. - * @member {date} [expiryTime] The time at which the account should expire. + * @property {string} name The user name of the account. + * @property {boolean} [isAdmin] Whether the account should be an + * administrator on the compute node. The default value is false. + * @property {date} [expiryTime] The time at which the account should expire. * If omitted, the default is 1 day from the current time. For Linux compute * nodes, the expiryTime has a precision up to a day. - * @member {string} [password] The password of the account. The password is + * @property {string} [password] The password of the account. The password is * required for Windows nodes (those created with * 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' * using a Windows image reference). For Linux compute nodes, the password * can optionally be specified along with the sshPublicKey property. - * @member {string} [sshPublicKey] The SSH public key that can be used for + * @property {string} [sshPublicKey] The SSH public key that can be used for * remote login to the compute node. The public key should be compatible with * OpenSSH encoding and should be base 64 encoded. This property can be * specified only for Linux nodes. If this is specified for a Windows node, diff --git a/lib/services/batch/lib/models/containerConfiguration.js b/lib/services/batch/lib/models/containerConfiguration.js index 4e65c587dd..53e3b2806f 100644 --- a/lib/services/batch/lib/models/containerConfiguration.js +++ b/lib/services/batch/lib/models/containerConfiguration.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The configuration for container-enabled pools. * @@ -19,11 +17,11 @@ const models = require('./index'); class ContainerConfiguration { /** * Create a ContainerConfiguration. - * @member {array} [containerImageNames] The collection of container image + * @property {array} [containerImageNames] The collection of container image * names. This is the full image reference, as would be specified to "docker * pull". An image will be sourced from the default Docker registry unless * the image is fully qualified with an alternative registry. - * @member {array} [containerRegistries] Additional private registries from + * @property {array} [containerRegistries] Additional private registries from * which containers can be pulled. If any images must be downloaded from a * private registry which requires credentials, then those credentials must * be provided here. diff --git a/lib/services/batch/lib/models/containerRegistry.js b/lib/services/batch/lib/models/containerRegistry.js index 77cdf09c70..474dd98ce2 100644 --- a/lib/services/batch/lib/models/containerRegistry.js +++ b/lib/services/batch/lib/models/containerRegistry.js @@ -17,10 +17,10 @@ class ContainerRegistry { /** * Create a ContainerRegistry. - * @member {string} [registryServer] The registry URL. If omitted, the + * @property {string} [registryServer] The registry URL. If omitted, the * default is "docker.io". - * @member {string} userName The user name to log into the registry server. - * @member {string} password The password to log into the registry server. + * @property {string} userName The user name to log into the registry server. + * @property {string} password The password to log into the registry server. */ constructor() { } diff --git a/lib/services/batch/lib/models/dataDisk.js b/lib/services/batch/lib/models/dataDisk.js index 5bbb1e9de8..03efcd92d5 100644 --- a/lib/services/batch/lib/models/dataDisk.js +++ b/lib/services/batch/lib/models/dataDisk.js @@ -18,18 +18,18 @@ class DataDisk { /** * Create a DataDisk. - * @member {number} lun The logical unit number. The lun is used to uniquely - * identify each data disk. If attaching multiple disks, each should have a - * distinct lun. - * @member {string} [caching] The type of caching to be enabled for the data - * disks. The default value for caching is readwrite. For information about - * the caching options see: + * @property {number} lun The logical unit number. The lun is used to + * uniquely identify each data disk. If attaching multiple disks, each should + * have a distinct lun. + * @property {string} [caching] The type of caching to be enabled for the + * data disks. The default value for caching is readwrite. For information + * about the caching options see: * https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. * Possible values include: 'none', 'readOnly', 'readWrite' - * @member {number} diskSizeGB The initial disk size in gigabytes. - * @member {string} [storageAccountType] The storage account type to be used - * for the data disk. If omitted, the default is "standard_lrs". Possible - * values include: 'StandardLRS', 'PremiumLRS' + * @property {number} diskSizeGB The initial disk size in gigabytes. + * @property {string} [storageAccountType] The storage account type to be + * used for the data disk. If omitted, the default is "standard_lrs". + * Possible values include: 'StandardLRS', 'PremiumLRS' */ constructor() { } diff --git a/lib/services/batch/lib/models/deleteCertificateError.js b/lib/services/batch/lib/models/deleteCertificateError.js index ab3fc90fb1..f3ec87e643 100644 --- a/lib/services/batch/lib/models/deleteCertificateError.js +++ b/lib/services/batch/lib/models/deleteCertificateError.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An error encountered by the Batch service when deleting a * certificate. @@ -20,15 +18,16 @@ const models = require('./index'); class DeleteCertificateError { /** * Create a DeleteCertificateError. - * @member {string} [code] An identifier for the certificate deletion error. - * Codes are invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the certificate deletion + * @property {string} [code] An identifier for the certificate deletion + * error. Codes are invariant and are intended to be consumed + * programmatically. + * @property {string} [message] A message describing the certificate deletion * error, intended to be suitable for display in a user interface. - * @member {array} [values] A list of additional error details related to the - * certificate deletion error. This list includes details such as the active - * pools and nodes referencing this certificate. However, if a large number - * of resources reference the certificate, the list contains only about the - * first hundred. + * @property {array} [values] A list of additional error details related to + * the certificate deletion error. This list includes details such as the + * active pools and nodes referencing this certificate. However, if a large + * number of resources reference the certificate, the list contains only + * about the first hundred. */ constructor() { } diff --git a/lib/services/batch/lib/models/environmentSetting.js b/lib/services/batch/lib/models/environmentSetting.js index ec9e7842c4..c2a0647326 100644 --- a/lib/services/batch/lib/models/environmentSetting.js +++ b/lib/services/batch/lib/models/environmentSetting.js @@ -17,8 +17,8 @@ class EnvironmentSetting { /** * Create a EnvironmentSetting. - * @member {string} name The name of the environment variable. - * @member {string} [value] The value of the environment variable. + * @property {string} name The name of the environment variable. + * @property {string} [value] The value of the environment variable. */ constructor() { } diff --git a/lib/services/batch/lib/models/errorMessage.js b/lib/services/batch/lib/models/errorMessage.js index 982b23457a..adecf89091 100644 --- a/lib/services/batch/lib/models/errorMessage.js +++ b/lib/services/batch/lib/models/errorMessage.js @@ -17,8 +17,8 @@ class ErrorMessage { /** * Create a ErrorMessage. - * @member {string} [lang] The language code of the error message. - * @member {string} [value] The text of the message. + * @property {string} [lang] The language code of the error message. + * @property {string} [value] The text of the message. */ constructor() { } diff --git a/lib/services/batch/lib/models/exitCodeMapping.js b/lib/services/batch/lib/models/exitCodeMapping.js index a09d9b0257..c329d4cfb9 100644 --- a/lib/services/batch/lib/models/exitCodeMapping.js +++ b/lib/services/batch/lib/models/exitCodeMapping.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary How the Batch service should respond if a task exits with a * particular exit code. @@ -20,16 +18,16 @@ const models = require('./index'); class ExitCodeMapping { /** * Create a ExitCodeMapping. - * @member {number} code A process exit code. - * @member {object} exitOptions How the Batch service should respond if the + * @property {number} code A process exit code. + * @property {object} exitOptions How the Batch service should respond if the * task exits with this exit code. - * @member {string} [exitOptions.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [exitOptions.dependencyAction] The default is 'satisfy' + * @property {string} [exitOptions.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' + * @property {string} [exitOptions.dependencyAction] 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 diff --git a/lib/services/batch/lib/models/exitCodeRangeMapping.js b/lib/services/batch/lib/models/exitCodeRangeMapping.js index 1b6520f160..5c137b2970 100644 --- a/lib/services/batch/lib/models/exitCodeRangeMapping.js +++ b/lib/services/batch/lib/models/exitCodeRangeMapping.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A range of exit codes and how the Batch service should respond to * exit codes within that range. @@ -20,17 +18,17 @@ const models = require('./index'); class ExitCodeRangeMapping { /** * Create a ExitCodeRangeMapping. - * @member {number} start The first exit code in the range. - * @member {number} end The last exit code in the range. - * @member {object} exitOptions How the Batch service should respond if the + * @property {number} start The first exit code in the range. + * @property {number} end The last exit code in the range. + * @property {object} exitOptions How the Batch service should respond if the * task exits with an exit code in the range start to end (inclusive). - * @member {string} [exitOptions.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [exitOptions.dependencyAction] The default is 'satisfy' + * @property {string} [exitOptions.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' + * @property {string} [exitOptions.dependencyAction] 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 diff --git a/lib/services/batch/lib/models/exitConditions.js b/lib/services/batch/lib/models/exitConditions.js index db15b4a31a..4d4cd105ad 100644 --- a/lib/services/batch/lib/models/exitConditions.js +++ b/lib/services/batch/lib/models/exitConditions.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Specifies how the Batch service should respond when the task * completes. @@ -20,43 +18,43 @@ const models = require('./index'); class ExitConditions { /** * Create a ExitConditions. - * @member {array} [exitCodes] A list of individual task exit codes and how + * @property {array} [exitCodes] A list of individual task exit codes and how * the Batch service should respond to them. - * @member {array} [exitCodeRanges] A list of task exit code ranges and how + * @property {array} [exitCodeRanges] A list of task exit code ranges and how * the Batch service should respond to them. - * @member {object} [preProcessingError] How the Batch service should respond - * if the task fails to start due to an error. - * @member {string} [preProcessingError.jobAction] The default is none for + * @property {object} [preProcessingError] How the Batch service should + * respond if the task fails to start due to an error. + * @property {string} [preProcessingError.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [preProcessingError.dependencyAction] The default is + * @property {string} [preProcessingError.dependencyAction] 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). Possible values * include: 'satisfy', 'block' - * @member {object} [fileUploadError] How the Batch service should respond if - * a file upload error occurs. If the task exited with an exit code that was - * specified via exitCodes or exitCodeRanges, and then encountered a file + * @property {object} [fileUploadError] How the Batch service should respond + * if a file upload error occurs. If the task exited with an exit code that + * was specified via exitCodes or exitCodeRanges, and then encountered a file * upload error, then the action specified by the exit code takes precedence. - * @member {string} [fileUploadError.jobAction] The default is none for exit - * code 0 and terminate for all other exit conditions. If the job's + * @property {string} [fileUploadError.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [fileUploadError.dependencyAction] The default is + * @property {string} [fileUploadError.dependencyAction] 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). Possible values * include: 'satisfy', 'block' - * @member {object} [default] How the Batch service should respond if the + * @property {object} [default] How the Batch service should respond if the * task fails with an exit condition not covered by any of the other * properties. This value is used if the task exits with any nonzero exit * code not listed in the exitCodes or exitCodeRanges collection, with a @@ -64,13 +62,13 @@ class ExitConditions { * with a file upload error if the fileUploadError property is not present. * If you want non-default behavior on exit code 0, you must list it * explicitly using the exitCodes or exitCodeRanges collection. - * @member {string} [default.jobAction] The default is none for exit code 0 + * @property {string} [default.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [default.dependencyAction] The default is 'satisfy' for + * @property {string} [default.dependencyAction] 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 diff --git a/lib/services/batch/lib/models/exitOptions.js b/lib/services/batch/lib/models/exitOptions.js index 9b3bb458eb..0edfacf4fa 100644 --- a/lib/services/batch/lib/models/exitOptions.js +++ b/lib/services/batch/lib/models/exitOptions.js @@ -18,7 +18,7 @@ class ExitOptions { /** * Create a ExitOptions. - * @member {string} [jobAction] An action to take on the job containing the + * @property {string} [jobAction] 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'. The default is * none for exit code 0 and terminate for all other exit conditions. If the @@ -27,7 +27,7 @@ class ExitOptions { * value error; if you are calling the REST API directly, the HTTP status * code is 400 (Bad Request). Possible values include: 'none', 'disable', * 'terminate' - * @member {string} [dependencyAction] An action that the Batch service + * @property {string} [dependencyAction] An action that the Batch service * performs on tasks that depend on this task. 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 diff --git a/lib/services/batch/lib/models/fileDeleteFromComputeNodeOptions.js b/lib/services/batch/lib/models/fileDeleteFromComputeNodeOptions.js index faa5345454..6c376b95a2 100644 --- a/lib/services/batch/lib/models/fileDeleteFromComputeNodeOptions.js +++ b/lib/services/batch/lib/models/fileDeleteFromComputeNodeOptions.js @@ -17,17 +17,17 @@ class FileDeleteFromComputeNodeOptions { /** * Create a FileDeleteFromComputeNodeOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/fileDeleteFromTaskOptions.js b/lib/services/batch/lib/models/fileDeleteFromTaskOptions.js index 2ce0af06f9..9cbc0086bf 100644 --- a/lib/services/batch/lib/models/fileDeleteFromTaskOptions.js +++ b/lib/services/batch/lib/models/fileDeleteFromTaskOptions.js @@ -17,17 +17,17 @@ class FileDeleteFromTaskOptions { /** * Create a FileDeleteFromTaskOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/fileGetFromComputeNodeOptions.js b/lib/services/batch/lib/models/fileGetFromComputeNodeOptions.js index ea2c540205..f31041ef5d 100644 --- a/lib/services/batch/lib/models/fileGetFromComputeNodeOptions.js +++ b/lib/services/batch/lib/models/fileGetFromComputeNodeOptions.js @@ -17,24 +17,24 @@ class FileGetFromComputeNodeOptions { /** * Create a FileGetFromComputeNodeOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ocpRange] The byte range to be retrieved. The default is - * to retrieve the entire file. The format is bytes=startRange-endRange. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ocpRange] The byte range to be retrieved. The default + * is to retrieve the entire file. The format is bytes=startRange-endRange. + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/fileGetFromTaskOptions.js b/lib/services/batch/lib/models/fileGetFromTaskOptions.js index 190dbfe023..9bfe21c38a 100644 --- a/lib/services/batch/lib/models/fileGetFromTaskOptions.js +++ b/lib/services/batch/lib/models/fileGetFromTaskOptions.js @@ -17,24 +17,24 @@ class FileGetFromTaskOptions { /** * Create a FileGetFromTaskOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ocpRange] The byte range to be retrieved. The default is - * to retrieve the entire file. The format is bytes=startRange-endRange. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ocpRange] The byte range to be retrieved. The default + * is to retrieve the entire file. The format is bytes=startRange-endRange. + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/fileGetPropertiesFromComputeNodeOptions.js b/lib/services/batch/lib/models/fileGetPropertiesFromComputeNodeOptions.js index 199eb0df63..48fa29b1bc 100644 --- a/lib/services/batch/lib/models/fileGetPropertiesFromComputeNodeOptions.js +++ b/lib/services/batch/lib/models/fileGetPropertiesFromComputeNodeOptions.js @@ -17,22 +17,22 @@ class FileGetPropertiesFromComputeNodeOptions { /** * Create a FileGetPropertiesFromComputeNodeOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/fileGetPropertiesFromTaskOptions.js b/lib/services/batch/lib/models/fileGetPropertiesFromTaskOptions.js index 8bfb841abe..9e4a374e9a 100644 --- a/lib/services/batch/lib/models/fileGetPropertiesFromTaskOptions.js +++ b/lib/services/batch/lib/models/fileGetPropertiesFromTaskOptions.js @@ -17,22 +17,22 @@ class FileGetPropertiesFromTaskOptions { /** * Create a FileGetPropertiesFromTaskOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/fileListFromComputeNodeNextOptions.js b/lib/services/batch/lib/models/fileListFromComputeNodeNextOptions.js index 5d38496aaa..dca1fd3115 100644 --- a/lib/services/batch/lib/models/fileListFromComputeNodeNextOptions.js +++ b/lib/services/batch/lib/models/fileListFromComputeNodeNextOptions.js @@ -17,14 +17,14 @@ class FileListFromComputeNodeNextOptions { /** * Create a FileListFromComputeNodeNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/fileListFromComputeNodeOptions.js b/lib/services/batch/lib/models/fileListFromComputeNodeOptions.js index 46da36e364..d7259ab1c0 100644 --- a/lib/services/batch/lib/models/fileListFromComputeNodeOptions.js +++ b/lib/services/batch/lib/models/fileListFromComputeNodeOptions.js @@ -17,22 +17,23 @@ class FileListFromComputeNodeOptions { /** * Create a FileListFromComputeNodeOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 files can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 files can be returned. Default value: 1000 + * . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/fileListFromTaskNextOptions.js b/lib/services/batch/lib/models/fileListFromTaskNextOptions.js index 30a2d2d95f..c6b2770901 100644 --- a/lib/services/batch/lib/models/fileListFromTaskNextOptions.js +++ b/lib/services/batch/lib/models/fileListFromTaskNextOptions.js @@ -17,14 +17,14 @@ class FileListFromTaskNextOptions { /** * Create a FileListFromTaskNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/fileListFromTaskOptions.js b/lib/services/batch/lib/models/fileListFromTaskOptions.js index 6f8d5e23c3..8352c9738d 100644 --- a/lib/services/batch/lib/models/fileListFromTaskOptions.js +++ b/lib/services/batch/lib/models/fileListFromTaskOptions.js @@ -17,22 +17,23 @@ class FileListFromTaskOptions { /** * Create a FileListFromTaskOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 files can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 files can be returned. Default value: 1000 + * . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/fileProperties.js b/lib/services/batch/lib/models/fileProperties.js index 5880433078..ac321537d9 100644 --- a/lib/services/batch/lib/models/fileProperties.js +++ b/lib/services/batch/lib/models/fileProperties.js @@ -17,12 +17,13 @@ class FileProperties { /** * Create a FileProperties. - * @member {date} [creationTime] The file creation time. The creation time is - * not returned for files on Linux compute nodes. - * @member {date} lastModified The time at which the file was last modified. - * @member {number} contentLength The length of the file. - * @member {string} [contentType] The content type of the file. - * @member {string} [fileMode] The file mode attribute in octal format. The + * @property {date} [creationTime] The file creation time. The creation time + * is not returned for files on Linux compute nodes. + * @property {date} lastModified The time at which the file was last + * modified. + * @property {number} contentLength The length of the file. + * @property {string} [contentType] The content type of the file. + * @property {string} [fileMode] The file mode attribute in octal format. The * file mode is returned only for files on Linux compute nodes. */ constructor() { diff --git a/lib/services/batch/lib/models/imageReference.js b/lib/services/batch/lib/models/imageReference.js index 80845ad101..3b674ebe88 100644 --- a/lib/services/batch/lib/models/imageReference.js +++ b/lib/services/batch/lib/models/imageReference.js @@ -20,16 +20,16 @@ class ImageReference { /** * Create a ImageReference. - * @member {string} [publisher] The publisher of the Azure Virtual Machines + * @property {string} [publisher] The publisher of the Azure Virtual Machines * Marketplace image. For example, Canonical or MicrosoftWindowsServer. - * @member {string} [offer] The offer type of the Azure Virtual Machines + * @property {string} [offer] The offer type of the Azure Virtual Machines * Marketplace image. For example, UbuntuServer or WindowsServer. - * @member {string} [sku] The SKU of the Azure Virtual Machines Marketplace + * @property {string} [sku] The SKU of the Azure Virtual Machines Marketplace * image. For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [version] The version of the Azure Virtual Machines + * @property {string} [version] The version of the Azure Virtual Machines * Marketplace image. A value of 'latest' can be specified to select the * latest version of an image. If omitted, the default is 'latest'. - * @member {string} [virtualMachineImageId] The ARM resource identifier of + * @property {string} [virtualMachineImageId] The ARM resource identifier of * the virtual machine image. Computes nodes of the pool will be created * using this custom image. This is of the form * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. diff --git a/lib/services/batch/lib/models/inboundEndpoint.js b/lib/services/batch/lib/models/inboundEndpoint.js index f5bf0aff19..a0c0476a6f 100644 --- a/lib/services/batch/lib/models/inboundEndpoint.js +++ b/lib/services/batch/lib/models/inboundEndpoint.js @@ -17,15 +17,15 @@ class InboundEndpoint { /** * Create a InboundEndpoint. - * @member {string} name The name of the endpoint. - * @member {string} protocol The protocol of the endpoint. Possible values + * @property {string} name The name of the endpoint. + * @property {string} protocol The protocol of the endpoint. Possible values * include: 'tcp', 'udp' - * @member {string} publicIPAddress The public IP address of the compute + * @property {string} publicIPAddress The public IP address of the compute * node. - * @member {string} publicFQDN The public fully qualified domain name for the - * compute node. - * @member {number} frontendPort The public port number of the endpoint. - * @member {number} backendPort The backend port number of the endpoint. + * @property {string} publicFQDN The public fully qualified domain name for + * the compute node. + * @property {number} frontendPort The public port number of the endpoint. + * @property {number} backendPort The backend port number of the endpoint. */ constructor() { } diff --git a/lib/services/batch/lib/models/inboundNATPool.js b/lib/services/batch/lib/models/inboundNATPool.js index 16d84ea110..1bf53cf768 100644 --- a/lib/services/batch/lib/models/inboundNATPool.js +++ b/lib/services/batch/lib/models/inboundNATPool.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A inbound NAT pool that can be used to address specific ports on * compute nodes in a Batch pool externally. @@ -20,32 +18,32 @@ const models = require('./index'); class InboundNATPool { /** * Create a InboundNATPool. - * @member {string} name The name of the endpoint. The name must be unique + * @property {string} name The name of the endpoint. 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. - * @member {string} protocol The protocol of the endpoint. Possible values + * @property {string} protocol The protocol of the endpoint. Possible values * include: 'tcp', 'udp' - * @member {number} backendPort The port number on the compute node. This + * @property {number} backendPort The port number on the compute node. This * must be unique within a Batch pool. Acceptable values are between 1 and * 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any * reserved values are provided the request fails with HTTP status code 400. - * @member {number} frontendPortRangeStart The first port number in the range - * of external ports that will be used to provide inbound access to the + * @property {number} frontendPortRangeStart 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. 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. - * @member {number} frontendPortRangeEnd The last port number in the range of - * external ports that will be used to provide inbound access to the + * @property {number} frontendPortRangeEnd 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. 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. - * @member {array} [networkSecurityGroupRules] A list of network security + * @property {array} [networkSecurityGroupRules] A list of network security * group rules that will be applied to the endpoint. The maximum number of * rules that can be specified across all the endpoints on a Batch pool is * 25. If no network security group rules are specified, a default rule will diff --git a/lib/services/batch/lib/models/index.d.ts b/lib/services/batch/lib/models/index.d.ts index 833bca7564..0c52790ca0 100644 --- a/lib/services/batch/lib/models/index.d.ts +++ b/lib/services/batch/lib/models/index.d.ts @@ -1,14910 +1,8153 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the PoolUsageMetrics class. - * @constructor * @summary Usage metrics for a pool across an aggregation interval. - * - * @member {string} poolId The ID of the pool whose metrics are aggregated in - * this entry. - * @member {date} startTime The start time of the aggregation interval covered - * by this entry. - * @member {date} endTime The end time of the aggregation interval covered by - * this entry. - * @member {string} vmSize The size of virtual machines in the pool. All VMs in - * a pool are the same size. For information about available sizes of virtual - * machines in pools, see Choose a VM size for compute nodes in an Azure Batch - * pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {number} totalCoreHours The total core hours used in the pool during - * this aggregation interval. */ export interface PoolUsageMetrics { + /** + * @summary The ID of the pool whose metrics are aggregated in this entry. + */ poolId: string; + /** + * @summary The start time of the aggregation interval covered by this entry. + */ startTime: Date; + /** + * @summary The end time of the aggregation interval covered by this entry. + */ endTime: Date; + /** + * @summary The size of virtual machines in the pool. All VMs in a pool are the same size. + * @description For information about available sizes of virtual machines in pools, see Choose a + * VM size for compute nodes in an Azure Batch pool + * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). + */ vmSize: string; + /** + * @summary The total core hours used in the pool during this aggregation interval. + */ totalCoreHours: number; } /** - * @class - * Initializes a new instance of the ImageReference class. - * @constructor - * @summary A reference to an Azure Virtual Machines Marketplace image or a - * custom Azure Virtual Machine image. To get the list of all Azure Marketplace - * image references verified by Azure Batch, see the 'List node agent SKUs' - * operation. - * - * @member {string} [publisher] The publisher of the Azure Virtual Machines - * Marketplace image. For example, Canonical or MicrosoftWindowsServer. - * @member {string} [offer] The offer type of the Azure Virtual Machines - * Marketplace image. For example, UbuntuServer or WindowsServer. - * @member {string} [sku] The SKU of the Azure Virtual Machines Marketplace - * image. For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [version] The version of the Azure Virtual Machines - * Marketplace image. A value of 'latest' can be specified to select the latest - * version of an image. If omitted, the default is 'latest'. - * @member {string} [virtualMachineImageId] The ARM resource identifier of the - * virtual machine image. Computes nodes of the pool will be created using this - * custom image. This is of the form - * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. + * @summary A reference to an Azure Virtual Machines Marketplace image or a custom Azure Virtual + * Machine image. To get the list of all Azure Marketplace image references verified by Azure + * Batch, see the 'List node agent SKUs' operation. */ export interface ImageReference { + /** + * @summary The publisher of the Azure Virtual Machines Marketplace image. + * @description For example, Canonical or MicrosoftWindowsServer. + */ publisher?: string; + /** + * @summary The offer type of the Azure Virtual Machines Marketplace image. + * @description For example, UbuntuServer or WindowsServer. + */ offer?: string; + /** + * @summary The SKU of the Azure Virtual Machines Marketplace image. + * @description For example, 14.04.0-LTS or 2012-R2-Datacenter. + */ sku?: string; + /** + * @summary The version of the Azure Virtual Machines Marketplace image. + * @description A value of 'latest' can be specified to select the latest version of an image. If + * omitted, the default is 'latest'. + */ version?: string; + /** + * @summary The ARM resource identifier of the virtual machine image. Computes nodes of the pool + * will be created using this custom image. This is of the form + * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} + * @description This property is mutually exclusive with other ImageReference properties. The + * virtual machine image must be in the same region and subscription as the Azure Batch account. + * For more details, see https://docs.microsoft.com/azure/batch/batch-custom-images. + */ virtualMachineImageId?: string; } /** - * @class - * Initializes a new instance of the NodeAgentSku class. - * @constructor * @summary A node agent SKU supported by the Batch service. - * - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. - * - * @member {string} [id] The ID of the node agent SKU. - * @member {array} [verifiedImageReferences] The list of Azure Marketplace - * images verified to be compatible with this node agent SKU. This collection - * is not exhaustive (the node agent may be compatible with other images). - * @member {string} [osType] The type of operating system (e.g. Windows or - * Linux) compatible with the node agent SKU. Possible values include: 'linux', - * 'windows' + * @description The Batch node agent is a program that runs on each node in the pool, and provides + * the command-and-control interface between the node and the Batch service. There are different + * implementations of the node agent, known as SKUs, for different operating systems. */ export interface NodeAgentSku { + /** + * @summary The ID of the node agent SKU. + */ id?: string; + /** + * @summary The list of Azure Marketplace images verified to be compatible with this node agent + * SKU. + * @description This collection is not exhaustive (the node agent may be compatible with other + * images). + */ verifiedImageReferences?: ImageReference[]; + /** + * @summary The type of operating system (e.g. Windows or Linux) compatible with the node agent + * SKU. + * @description Possible values include: 'linux', 'windows' + */ osType?: string; } /** - * @class - * Initializes a new instance of the AuthenticationTokenSettings class. - * @constructor - * @summary The settings for an authentication token that the task can use to - * perform Batch service operations. - * - * @member {array} [access] The Batch resources to which the token grants - * access. The authentication token grants access to a limited set of Batch - * service operations. Currently the only supported value for the access - * property is 'job', which grants access to all operations related to the job - * which contains the task. + * @summary The settings for an authentication token that the task can use to perform Batch service + * operations. */ export interface AuthenticationTokenSettings { + /** + * @summary The Batch resources to which the token grants access. + * @description The authentication token grants access to a limited set of Batch service + * operations. Currently the only supported value for the access property is 'job', which grants + * access to all operations related to the job which contains the task. + */ access?: string[]; } /** - * @class - * Initializes a new instance of the UsageStatistics class. - * @constructor * @summary Statistics related to pool usage information. - * - * @member {date} startTime The start time of the time range covered by the - * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. - * @member {moment.duration} dedicatedCoreTime The aggregated wall-clock time - * of the dedicated compute node cores being part of the pool. */ export interface UsageStatistics { + /** + * @summary The start time of the time range covered by the statistics. + */ startTime: Date; + /** + * @summary The time at which the statistics were last updated. All statistics are limited to the + * range between startTime and lastUpdateTime. + */ lastUpdateTime: Date; + /** + * @summary The aggregated wall-clock time of the dedicated compute node cores being part of the + * pool. + */ dedicatedCoreTime: moment.Duration; } /** - * @class - * Initializes a new instance of the ResourceStatistics class. - * @constructor - * @summary Statistics related to resource consumption by compute nodes in a - * pool. - * - * @member {date} startTime The start time of the time range covered by the - * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. - * @member {number} avgCPUPercentage The average CPU usage across all nodes in - * the pool (percentage per node). - * @member {number} avgMemoryGiB The average memory usage in GiB across all - * nodes in the pool. - * @member {number} peakMemoryGiB The peak memory usage in GiB across all nodes - * in the pool. - * @member {number} avgDiskGiB The average used disk space in GiB across all - * nodes in the pool. - * @member {number} peakDiskGiB The peak used disk space in GiB across all - * nodes in the pool. - * @member {number} diskReadIOps The total number of disk read operations - * across all nodes in the pool. - * @member {number} diskWriteIOps The total number of disk write operations - * across all nodes in the pool. - * @member {number} diskReadGiB The total amount of data in GiB of disk reads - * across all nodes in the pool. - * @member {number} diskWriteGiB The total amount of data in GiB of disk writes - * across all nodes in the pool. - * @member {number} networkReadGiB The total amount of data in GiB of network - * reads across all nodes in the pool. - * @member {number} networkWriteGiB The total amount of data in GiB of network - * writes across all nodes in the pool. + * @summary Statistics related to resource consumption by compute nodes in a pool. */ export interface ResourceStatistics { + /** + * @summary The start time of the time range covered by the statistics. + */ startTime: Date; + /** + * @summary The time at which the statistics were last updated. All statistics are limited to the + * range between startTime and lastUpdateTime. + */ lastUpdateTime: Date; + /** + * @summary The average CPU usage across all nodes in the pool (percentage per node). + */ avgCPUPercentage: number; + /** + * @summary The average memory usage in GiB across all nodes in the pool. + */ avgMemoryGiB: number; + /** + * @summary The peak memory usage in GiB across all nodes in the pool. + */ peakMemoryGiB: number; + /** + * @summary The average used disk space in GiB across all nodes in the pool. + */ avgDiskGiB: number; + /** + * @summary The peak used disk space in GiB across all nodes in the pool. + */ peakDiskGiB: number; + /** + * @summary The total number of disk read operations across all nodes in the pool. + */ diskReadIOps: number; + /** + * @summary The total number of disk write operations across all nodes in the pool. + */ diskWriteIOps: number; + /** + * @summary The total amount of data in GiB of disk reads across all nodes in the pool. + */ diskReadGiB: number; + /** + * @summary The total amount of data in GiB of disk writes across all nodes in the pool. + */ diskWriteGiB: number; + /** + * @summary The total amount of data in GiB of network reads across all nodes in the pool. + */ networkReadGiB: number; + /** + * @summary The total amount of data in GiB of network writes across all nodes in the pool. + */ networkWriteGiB: number; } /** - * @class - * Initializes a new instance of the PoolStatistics class. - * @constructor - * @summary Contains utilization and resource usage statistics for the lifetime - * of a pool. - * - * @member {string} url The URL for the statistics. - * @member {date} startTime The start time of the time range covered by the - * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. - * @member {object} [usageStats] Statistics related to pool usage, such as the - * amount of core-time used. - * @member {date} [usageStats.startTime] - * @member {date} [usageStats.lastUpdateTime] - * @member {moment.duration} [usageStats.dedicatedCoreTime] - * @member {object} [resourceStats] Statistics related to resource consumption - * by compute nodes in the pool. - * @member {date} [resourceStats.startTime] - * @member {date} [resourceStats.lastUpdateTime] - * @member {number} [resourceStats.avgCPUPercentage] - * @member {number} [resourceStats.avgMemoryGiB] - * @member {number} [resourceStats.peakMemoryGiB] - * @member {number} [resourceStats.avgDiskGiB] - * @member {number} [resourceStats.peakDiskGiB] - * @member {number} [resourceStats.diskReadIOps] - * @member {number} [resourceStats.diskWriteIOps] - * @member {number} [resourceStats.diskReadGiB] - * @member {number} [resourceStats.diskWriteGiB] - * @member {number} [resourceStats.networkReadGiB] - * @member {number} [resourceStats.networkWriteGiB] + * @summary Contains utilization and resource usage statistics for the lifetime of a pool. */ export interface PoolStatistics { + /** + * @summary The URL for the statistics. + */ url: string; + /** + * @summary The start time of the time range covered by the statistics. + */ startTime: Date; + /** + * @summary The time at which the statistics were last updated. All statistics are limited to the + * range between startTime and lastUpdateTime. + */ lastUpdateTime: Date; + /** + * @summary Statistics related to pool usage, such as the amount of core-time used. + */ usageStats?: UsageStatistics; + /** + * @summary Statistics related to resource consumption by compute nodes in the pool. + */ resourceStats?: ResourceStatistics; } /** - * @class - * Initializes a new instance of the JobStatistics class. - * @constructor * @summary Resource usage statistics for a job. - * - * @member {string} url The URL of the statistics. - * @member {date} startTime The start time of the time range covered by the - * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. - * @member {moment.duration} userCPUTime The total user mode CPU time (summed - * across all cores and all compute nodes) consumed by all tasks in the job. - * @member {moment.duration} kernelCPUTime The total kernel mode CPU time - * (summed across all cores and all compute nodes) consumed by all tasks in the - * job. - * @member {moment.duration} wallClockTime The total wall clock time of all - * tasks in the job. The wall clock time is the elapsed time from when the - * task started running on a compute node to when it finished (or to the last - * time the statistics were updated, if the task had not finished by then). If - * a task was retried, this includes the wall clock time of all the task - * retries. - * @member {number} readIOps The total number of disk read operations made by - * all tasks in the job. - * @member {number} writeIOps The total number of disk write operations made by - * all tasks in the job. - * @member {number} readIOGiB The total amount of data in GiB read from disk by - * all tasks in the job. - * @member {number} writeIOGiB The total amount of data in GiB written to disk - * by all tasks in the job. - * @member {number} numSucceededTasks The total number of tasks successfully - * completed in the job during the given time range. A task completes - * successfully if it returns exit code 0. - * @member {number} numFailedTasks The total number of tasks in the job that - * failed during the given time range. A task fails if it exhausts its maximum - * retry count without returning exit code 0. - * @member {number} numTaskRetries The total number of retries on all the tasks - * in the job during the given time range. - * @member {moment.duration} waitTime The total wait time of all tasks in the - * job. The wait time for a task is defined as the elapsed time between the - * creation of the task and the start of task execution. (If the task is - * retried due to failures, the wait time is the time to the most recent task - * execution.) This value is only reported in the account lifetime statistics; - * it is not included in the job statistics. */ export interface JobStatistics { + /** + * @summary The URL of the statistics. + */ url: string; + /** + * @summary The start time of the time range covered by the statistics. + */ startTime: Date; + /** + * @summary The time at which the statistics were last updated. All statistics are limited to the + * range between startTime and lastUpdateTime. + */ lastUpdateTime: Date; + /** + * @summary The total user mode CPU time (summed across all cores and all compute nodes) consumed + * by all tasks in the job. + */ userCPUTime: moment.Duration; + /** + * @summary The total kernel mode CPU time (summed across all cores and all compute nodes) + * consumed by all tasks in the job. + */ kernelCPUTime: moment.Duration; + /** + * @summary The total wall clock time of all tasks in the job. + * @description The wall clock time is the elapsed time from when the task started running on a + * compute node to when it finished (or to the last time the statistics were updated, if the task + * had not finished by then). If a task was retried, this includes the wall clock time of all the + * task retries. + */ wallClockTime: moment.Duration; + /** + * @summary The total number of disk read operations made by all tasks in the job. + */ readIOps: number; + /** + * @summary The total number of disk write operations made by all tasks in the job. + */ writeIOps: number; + /** + * @summary The total amount of data in GiB read from disk by all tasks in the job. + */ readIOGiB: number; + /** + * @summary The total amount of data in GiB written to disk by all tasks in the job. + */ writeIOGiB: number; + /** + * @summary The total number of tasks successfully completed in the job during the given time + * range. + * @description A task completes successfully if it returns exit code 0. + */ numSucceededTasks: number; + /** + * @summary The total number of tasks in the job that failed during the given time range. + * @description A task fails if it exhausts its maximum retry count without returning exit code + * 0. + */ numFailedTasks: number; + /** + * @summary The total number of retries on all the tasks in the job during the given time range. + */ numTaskRetries: number; + /** + * @summary The total wait time of all tasks in the job. + * @description The wait time for a task is defined as the elapsed time between the creation of + * the task and the start of task execution. (If the task is retried due to failures, the wait + * time is the time to the most recent task execution.) This value is only reported in the + * account lifetime statistics; it is not included in the job statistics. + */ waitTime: moment.Duration; } /** - * @class - * Initializes a new instance of the NameValuePair class. - * @constructor * @summary Represents a name-value pair. - * - * @member {string} [name] The name in the name-value pair. - * @member {string} [value] The value in the name-value pair. */ export interface NameValuePair { + /** + * @summary The name in the name-value pair. + */ name?: string; + /** + * @summary The value in the name-value pair. + */ value?: string; } /** - * @class - * Initializes a new instance of the DeleteCertificateError class. - * @constructor - * @summary An error encountered by the Batch service when deleting a - * certificate. - * - * @member {string} [code] An identifier for the certificate deletion error. - * Codes are invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the certificate deletion - * error, intended to be suitable for display in a user interface. - * @member {array} [values] A list of additional error details related to the - * certificate deletion error. This list includes details such as the active - * pools and nodes referencing this certificate. However, if a large number of - * resources reference the certificate, the list contains only about the first - * hundred. + * @summary An error encountered by the Batch service when deleting a certificate. */ export interface DeleteCertificateError { + /** + * @summary An identifier for the certificate deletion error. Codes are invariant and are + * intended to be consumed programmatically. + */ code?: string; + /** + * @summary A message describing the certificate deletion error, intended to be suitable for + * display in a user interface. + */ message?: string; + /** + * @summary A list of additional error details related to the certificate deletion error. + * @description This list includes details such as the active pools and nodes referencing this + * certificate. However, if a large number of resources reference the certificate, the list + * contains only about the first hundred. + */ values?: NameValuePair[]; } /** - * @class - * Initializes a new instance of the Certificate class. - * @constructor - * A certificate that can be installed on compute nodes and can be used to - * authenticate operations on the machine. - * - * @member {string} [thumbprint] The X.509 thumbprint of the certificate. This - * is a sequence of up to 40 hex digits. - * @member {string} [thumbprintAlgorithm] The algorithm used to derive the - * thumbprint. - * @member {string} [url] The URL of the certificate. - * @member {string} [state] The current state of the certificate. Possible - * values include: 'active', 'deleting', 'deleteFailed' - * @member {date} [stateTransitionTime] The time at which the certificate - * entered its current state. - * @member {string} [previousState] The previous state of the certificate. This - * property is not set if the certificate is in its initial active state. - * Possible values include: 'active', 'deleting', 'deleteFailed' - * @member {date} [previousStateTransitionTime] The time at which the - * certificate entered its previous state. This property is not set if the - * certificate is in its initial Active state. - * @member {string} [publicData] The public part of the certificate as a - * base-64 encoded .cer file. - * @member {object} [deleteCertificateError] The error that occurred on the - * last attempt to delete this certificate. This property is set only if the - * certificate is in the DeleteFailed state. - * @member {string} [deleteCertificateError.code] - * @member {string} [deleteCertificateError.message] - * @member {array} [deleteCertificateError.values] This list includes details - * such as the active pools and nodes referencing this certificate. However, if - * a large number of resources reference the certificate, the list contains - * only about the first hundred. + * A certificate that can be installed on compute nodes and can be used to authenticate operations + * on the machine. */ export interface Certificate { + /** + * @summary The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits. + */ thumbprint?: string; + /** + * @summary The algorithm used to derive the thumbprint. + */ thumbprintAlgorithm?: string; + /** + * @summary The URL of the certificate. + */ url?: string; + /** + * @summary The current state of the certificate. + * @description Possible values include: 'active', 'deleting', 'deleteFailed' + */ state?: string; + /** + * @summary The time at which the certificate entered its current state. + */ stateTransitionTime?: Date; + /** + * @summary The previous state of the certificate. + * @description This property is not set if the certificate is in its initial active state. + * Possible values include: 'active', 'deleting', 'deleteFailed' + */ previousState?: string; + /** + * @summary The time at which the certificate entered its previous state. + * @description This property is not set if the certificate is in its initial Active state. + */ previousStateTransitionTime?: Date; + /** + * @summary The public part of the certificate as a base-64 encoded .cer file. + */ publicData?: string; + /** + * @summary The error that occurred on the last attempt to delete this certificate. + * @description This property is set only if the certificate is in the DeleteFailed state. + */ deleteCertificateError?: DeleteCertificateError; } /** - * @class - * Initializes a new instance of the ApplicationPackageReference class. - * @constructor - * @summary A reference to an application package to be deployed to compute - * nodes. - * - * @member {string} applicationId The ID of the application to deploy. - * @member {string} [version] The version of the application to deploy. If - * omitted, the default version is deployed. If this is omitted on a pool, and - * no default version is specified for this application, the request fails with - * the error code InvalidApplicationPackageReferences and HTTP status code 409. - * If this is omitted on a task, and no default version is specified for this - * application, the task fails with a pre-processing error. + * @summary A reference to an application package to be deployed to compute nodes. */ export interface ApplicationPackageReference { + /** + * @summary The ID of the application to deploy. + */ applicationId: string; + /** + * @summary The version of the application to deploy. If omitted, the default version is + * deployed. + * @description If this is omitted on a pool, and no default version is specified for this + * application, the request fails with the error code InvalidApplicationPackageReferences and + * HTTP status code 409. If this is omitted on a task, and no default version is specified for + * this application, the task fails with a pre-processing error. + */ version?: string; } /** - * @class - * Initializes a new instance of the ApplicationSummary class. - * @constructor - * @summary Contains information about an application in an Azure Batch - * account. - * - * @member {string} id A string that uniquely identifies the application within - * the account. - * @member {string} displayName The display name for the application. - * @member {array} versions The list of available versions of the application. + * @summary Contains information about an application in an Azure Batch account. */ export interface ApplicationSummary { + /** + * @summary A string that uniquely identifies the application within the account. + */ id: string; + /** + * @summary The display name for the application. + */ displayName: string; + /** + * @summary The list of available versions of the application. + */ versions: string[]; } /** - * @class - * Initializes a new instance of the CertificateAddParameter class. - * @constructor - * @summary A certificate that can be installed on compute nodes and can be - * used to authenticate operations on the machine. - * - * @member {string} thumbprint The X.509 thumbprint of the certificate. This is - * a sequence of up to 40 hex digits (it may include spaces but these are - * removed). - * @member {string} thumbprintAlgorithm The algorithm used to derive the - * thumbprint. This must be sha1. - * @member {string} data The base64-encoded contents of the certificate. The - * maximum size is 10KB. - * @member {string} [certificateFormat] The format of the certificate data. - * Possible values include: 'pfx', 'cer' - * @member {string} [password] The password to access the certificate's private - * key. This is required if the certificate format is pfx. It should be omitted - * if the certificate format is cer. + * @summary A certificate that can be installed on compute nodes and can be used to authenticate + * operations on the machine. */ export interface CertificateAddParameter { + /** + * @summary The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits + * (it may include spaces but these are removed). + */ thumbprint: string; + /** + * @summary The algorithm used to derive the thumbprint. This must be sha1. + */ thumbprintAlgorithm: string; + /** + * @summary The base64-encoded contents of the certificate. The maximum size is 10KB. + */ data: string; + /** + * @summary The format of the certificate data. + * @description Possible values include: 'pfx', 'cer' + */ certificateFormat?: string; + /** + * @summary The password to access the certificate's private key. + * @description This is required if the certificate format is pfx. It should be omitted if the + * certificate format is cer. + */ password?: string; } /** - * @class - * Initializes a new instance of the FileProperties class. - * @constructor * @summary The properties of a file on a compute node. - * - * @member {date} [creationTime] The file creation time. The creation time is - * not returned for files on Linux compute nodes. - * @member {date} lastModified The time at which the file was last modified. - * @member {number} contentLength The length of the file. - * @member {string} [contentType] The content type of the file. - * @member {string} [fileMode] The file mode attribute in octal format. The - * file mode is returned only for files on Linux compute nodes. */ export interface FileProperties { + /** + * @summary The file creation time. + * @description The creation time is not returned for files on Linux compute nodes. + */ creationTime?: Date; + /** + * @summary The time at which the file was last modified. + */ lastModified: Date; + /** + * @summary The length of the file. + */ contentLength: number; + /** + * @summary The content type of the file. + */ contentType?: string; + /** + * @summary The file mode attribute in octal format. + * @description The file mode is returned only for files on Linux compute nodes. + */ fileMode?: string; } /** - * @class - * Initializes a new instance of the NodeFile class. - * @constructor * @summary Information about a file or directory on a compute node. - * - * @member {string} [name] The file path. - * @member {string} [url] The URL of the file. - * @member {boolean} [isDirectory] Whether the object represents a directory. - * @member {object} [properties] The file properties. - * @member {date} [properties.creationTime] The creation time is not returned - * for files on Linux compute nodes. - * @member {date} [properties.lastModified] - * @member {number} [properties.contentLength] - * @member {string} [properties.contentType] - * @member {string} [properties.fileMode] The file mode is returned only for - * files on Linux compute nodes. */ export interface NodeFile { + /** + * @summary The file path. + */ name?: string; + /** + * @summary The URL of the file. + */ url?: string; + /** + * @summary Whether the object represents a directory. + */ isDirectory?: boolean; + /** + * @summary The file properties. + */ properties?: FileProperties; } /** - * @class - * Initializes a new instance of the Schedule class. - * @constructor * @summary The schedule according to which jobs will be created - * - * @member {date} [doNotRunUntil] The earliest time at which any job may be - * created under this job schedule. If you do not specify a doNotRunUntil time, - * the schedule becomes ready to create jobs immediately. - * @member {date} [doNotRunAfter] A time after which no job will be created - * under this job schedule. The schedule will move to the completed state as - * soon as this deadline is past and there is no active job under this job - * schedule. If you do not specify a doNotRunAfter time, and you are creating a - * recurring job schedule, the job schedule will remain active until you - * explicitly terminate it. - * @member {moment.duration} [startWindow] The time interval, starting from the - * time at which the schedule indicates a job should be created, within which a - * job must be created. If a job is not created within the startWindow - * interval, then the 'opportunity' is lost; no job will be created until the - * next recurrence of the schedule. If the schedule is recurring, and the - * startWindow is longer than the recurrence interval, then this is equivalent - * to an infinite startWindow, because the job that is 'due' in one - * recurrenceInterval is not carried forward into the next recurrence interval. - * The default is infinite. The minimum value is 1 minute. If you specify a - * lower value, the Batch service rejects the schedule with an error; if you - * are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {moment.duration} [recurrenceInterval] The time interval between the - * start times of two successive jobs under the job schedule. A job schedule - * can have at most one active job under it at any given time. Because a job - * schedule can have at most one active job under it at any given time, if it - * is time to create a new job under a job schedule, but the previous job is - * still running, the Batch service will not create the new job until the - * previous job finishes. If the previous job does not finish within the - * startWindow period of the new recurrenceInterval, then no new job will be - * scheduled for that interval. For recurring jobs, you should normally specify - * a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, - * you will need an external process to monitor when jobs are created, add - * tasks to the jobs and terminate the jobs ready for the next recurrence. The - * default is that the schedule does not recur: one job is created, within the - * startWindow after the doNotRunUntil time, and the schedule is complete as - * soon as that job finishes. The minimum value is 1 minute. If you specify a - * lower value, the Batch service rejects the schedule with an error; if you - * are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). */ export interface Schedule { + /** + * @summary The earliest time at which any job may be created under this job schedule. + * @description If you do not specify a doNotRunUntil time, the schedule becomes ready to create + * jobs immediately. + */ doNotRunUntil?: Date; + /** + * @summary A time after which no job will be created under this job schedule. The schedule will + * move to the completed state as soon as this deadline is past and there is no active job under + * this job schedule. + * @description If you do not specify a doNotRunAfter time, and you are creating a recurring job + * schedule, the job schedule will remain active until you explicitly terminate it. + */ doNotRunAfter?: Date; + /** + * @summary The time interval, starting from the time at which the schedule indicates a job + * should be created, within which a job must be created. + * @description If a job is not created within the startWindow interval, then the 'opportunity' + * is lost; no job will be created until the next recurrence of the schedule. If the schedule is + * recurring, and the startWindow is longer than the recurrence interval, then this is equivalent + * to an infinite startWindow, because the job that is 'due' in one recurrenceInterval is not + * carried forward into the next recurrence interval. The default is infinite. The minimum value + * is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an + * error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). + */ startWindow?: moment.Duration; + /** + * @summary The time interval between the start times of two successive jobs under the job + * schedule. A job schedule can have at most one active job under it at any given time. + * @description Because a job schedule can have at most one active job under it at any given + * time, if it is time to create a new job under a job schedule, but the previous job is still + * running, the Batch service will not create the new job until the previous job finishes. If the + * previous job does not finish within the startWindow period of the new recurrenceInterval, then + * no new job will be scheduled for that interval. For recurring jobs, you should normally + * specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will + * need an external process to monitor when jobs are created, add tasks to the jobs and terminate + * the jobs ready for the next recurrence. The default is that the schedule does not recur: one + * job is created, within the startWindow after the doNotRunUntil time, and the schedule is + * complete as soon as that job finishes. The minimum value is 1 minute. If you specify a lower + * value, the Batch service rejects the schedule with an error; if you are calling the REST API + * directly, the HTTP status code is 400 (Bad Request). + */ recurrenceInterval?: moment.Duration; } /** - * @class - * Initializes a new instance of the JobConstraints class. - * @constructor * @summary The execution constraints for a job. - * - * @member {moment.duration} [maxWallClockTime] The maximum elapsed time that - * the job may run, measured from the time the job is created. If the job does - * not complete within the time limit, the Batch service terminates it and any - * tasks that are still running. In this case, the termination reason will be - * MaxWallClockTimeExpiry. If this property is not specified, there is no time - * limit on how long the job may run. - * @member {number} [maxTaskRetryCount] The maximum number of times each task - * may be retried. The Batch service retries a task if its exit code is - * nonzero. Note that this value specifically controls the number of retries. - * The Batch service will try each task once, and may then retry up to this - * limit. For example, if the maximum retry count is 3, Batch tries a task up - * to 4 times (one initial try and 3 retries). If the maximum retry count is 0, - * the Batch service does not retry tasks. If the maximum retry count is -1, - * the Batch service retries tasks without limit. The default value is 0 (no - * retries). */ export interface JobConstraints { + /** + * @summary The maximum elapsed time that the job may run, measured from the time the job is + * created. + * @description If the job does not complete within the time limit, the Batch service terminates + * it and any tasks that are still running. In this case, the termination reason will be + * MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long + * the job may run. + */ maxWallClockTime?: moment.Duration; + /** + * @summary The maximum number of times each task may be retried. The Batch service retries a + * task if its exit code is nonzero. + * @description Note that this value specifically controls the number of retries. The Batch + * service will try each task once, and may then retry up to this limit. For example, if the + * maximum retry count is 3, Batch tries a task up to 4 times (one initial try and 3 retries). If + * the maximum retry count is 0, the Batch service does not retry tasks. If the maximum retry + * count is -1, the Batch service retries tasks without limit. The default value is 0 (no + * retries). + */ maxTaskRetryCount?: number; } /** - * @class - * Initializes a new instance of the JobNetworkConfiguration class. - * @constructor * @summary The network configuration for the job. - * - * @member {string} subnetId The ARM resource identifier of the virtual network - * subnet which nodes running tasks from the job will join for the duration of - * the task. This is only supported for jobs running on - * VirtualMachineConfiguration pools. This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes which will run tasks from the job. For more - * details, see - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. */ export interface JobNetworkConfiguration { + /** + * @summary The ARM resource identifier of the virtual network subnet which nodes running tasks + * from the job will join for the duration of the task. + * @description This is only supported for jobs running on VirtualMachineConfiguration pools. + * This is of the form + * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. + * The virtual network must be in the same region and subscription as the Azure Batch account. + * The specified subnet should have enough free IP addresses to accommodate the number of nodes + * which will run tasks from the job. For more details, see + * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. + */ subnetId: string; } /** - * @class - * Initializes a new instance of the ContainerRegistry class. - * @constructor * @summary A private container registry. - * - * @member {string} [registryServer] The registry URL. If omitted, the default - * is "docker.io". - * @member {string} userName The user name to log into the registry server. - * @member {string} password The password to log into the registry server. */ export interface ContainerRegistry { + /** + * @summary The registry URL. + * @description If omitted, the default is "docker.io". + */ registryServer?: string; + /** + * @summary The user name to log into the registry server. + */ userName: string; + /** + * @summary The password to log into the registry server. + */ password: string; } /** - * @class - * Initializes a new instance of the TaskContainerSettings class. - * @constructor * @summary The container settings for a task. - * - * @member {string} [containerRunOptions] Additional options to the container - * create command. These additional options are supplied as arguments to the - * "docker create" command, in addition to those controlled by the Batch - * Service. - * @member {string} imageName The image to use to create the container in which - * the task will run. This is the full image reference, as would be specified - * to "docker pull". If no tag is provided as part of the image name, the tag - * ":latest" is used as a default. - * @member {object} [registry] The private registry which contains the - * container image. This setting can be omitted if was already provided at pool - * creation. - * @member {string} [registry.registryServer] If omitted, the default is - * "docker.io". - * @member {string} [registry.userName] - * @member {string} [registry.password] */ export interface TaskContainerSettings { + /** + * @summary Additional options to the container create command. + * @description These additional options are supplied as arguments to the "docker create" + * command, in addition to those controlled by the Batch Service. + */ containerRunOptions?: string; + /** + * @summary The image to use to create the container in which the task will run. + * @description This is the full image reference, as would be specified to "docker pull". If no + * tag is provided as part of the image name, the tag ":latest" is used as a default. + */ imageName: string; + /** + * @summary The private registry which contains the container image. + * @description This setting can be omitted if was already provided at pool creation. + */ registry?: ContainerRegistry; } /** - * @class - * Initializes a new instance of the ResourceFile class. - * @constructor * @summary A single file or multiple files to be downloaded to a compute node. - * - * @member {string} [autoStorageContainerName] The storage container name in - * the auto storage account. The autoStorageContainerName, storageContainerUrl - * and httpUrl properties are mutually exclusive and one of them must be - * specified. - * @member {string} [storageContainerUrl] The URL of the blob container within - * Azure Blob Storage. The autoStorageContainerName, storageContainerUrl and - * httpUrl properties are mutually exclusive and one of them must be specified. - * This URL must be readable and listable using anonymous access; that is, the - * Batch service does not present any credentials when downloading blobs from - * the container. There are two ways to get such a URL for a container in Azure - * storage: include a Shared Access Signature (SAS) granting read permissions - * on the container, or set the ACL for the container to allow public access. - * @member {string} [httpUrl] The URL of the file to download. The - * autoStorageContainerName, storageContainerUrl and httpUrl properties are - * mutually exclusive and one of them must be specified. If the URL points to - * Azure Blob Storage, it must be readable using anonymous access; that is, the - * Batch service does not present any credentials when downloading the blob. - * There are two ways to get such a URL for a blob in Azure storage: include a - * Shared Access Signature (SAS) granting read permissions on the blob, or set - * the ACL for the blob or its container to allow public access. - * @member {string} [blobPrefix] The blob prefix to use when downloading blobs - * from an Azure Storage container. Only the blobs whose names begin with the - * specified prefix will be downloaded. The property is valid only when - * autoStorageContainerName or storageContainerUrl is used. This prefix can be - * a partial filename or a subdirectory. If a prefix is not specified, all the - * files in the container will be downloaded. - * @member {string} [filePath] The location on the compute node to which to - * download the file(s), relative to the task's working directory. If the - * httpUrl property is specified, the filePath is required and describes the - * path which the file will be downloaded to, including the filename. - * Otherwise, if the autoStorageContainerName or storageContainerUrl property - * is specified, filePath is optional and is the directory to download the - * files to. In the case where filePath is used as a directory, any directory - * structure already associated with the input data will be retained in full - * and appended to the specified filePath directory. The specified relative - * path cannot break out of the task's working directory (for example by using - * '..'). - * @member {string} [fileMode] The file permission mode attribute in octal - * format. This property applies only to files being downloaded to Linux - * compute nodes. It will be ignored if it is specified for a resourceFile - * which will be downloaded to a Windows node. If this property is not - * specified for a Linux node, then a default value of 0770 is applied to the - * file. */ export interface ResourceFile { + /** + * @summary The storage container name in the auto storage account. + * @description The autoStorageContainerName, storageContainerUrl and httpUrl properties are + * mutually exclusive and one of them must be specified. + */ autoStorageContainerName?: string; + /** + * @summary The URL of the blob container within Azure Blob Storage. + * @description The autoStorageContainerName, storageContainerUrl and httpUrl properties are + * mutually exclusive and one of them must be specified. This URL must be readable and listable + * using anonymous access; that is, the Batch service does not present any credentials when + * downloading blobs from the container. There are two ways to get such a URL for a container in + * Azure storage: include a Shared Access Signature (SAS) granting read permissions on the + * container, or set the ACL for the container to allow public access. + */ storageContainerUrl?: string; + /** + * @summary The URL of the file to download. + * @description The autoStorageContainerName, storageContainerUrl and httpUrl properties are + * mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, + * it must be readable using anonymous access; that is, the Batch service does not present any + * credentials when downloading the blob. There are two ways to get such a URL for a blob in + * Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, + * or set the ACL for the blob or its container to allow public access. + */ httpUrl?: string; + /** + * @summary The blob prefix to use when downloading blobs from an Azure Storage container. Only + * the blobs whose names begin with the specified prefix will be downloaded. + * @description The property is valid only when autoStorageContainerName or storageContainerUrl + * is used. This prefix can be a partial filename or a subdirectory. If a prefix is not + * specified, all the files in the container will be downloaded. + */ blobPrefix?: string; + /** + * @summary The location on the compute node to which to download the file(s), relative to the + * task's working directory. + * @description If the httpUrl property is specified, the filePath is required and describes the + * path which the file will be downloaded to, including the filename. Otherwise, if the + * autoStorageContainerName or storageContainerUrl property is specified, filePath is optional + * and is the directory to download the files to. In the case where filePath is used as a + * directory, any directory structure already associated with the input data will be retained in + * full and appended to the specified filePath directory. The specified relative path cannot + * break out of the task's working directory (for example by using '..'). + */ filePath?: string; + /** + * @summary The file permission mode attribute in octal format. + * @description This property applies only to files being downloaded to Linux compute nodes. It + * will be ignored if it is specified for a resourceFile which will be downloaded to a Windows + * node. If this property is not specified for a Linux node, then a default value of 0770 is + * applied to the file. + */ fileMode?: string; } /** - * @class - * Initializes a new instance of the EnvironmentSetting class. - * @constructor * @summary An environment variable to be set on a task process. - * - * @member {string} name The name of the environment variable. - * @member {string} [value] The value of the environment variable. */ export interface EnvironmentSetting { + /** + * @summary The name of the environment variable. + */ name: string; + /** + * @summary The value of the environment variable. + */ value?: string; } /** - * @class - * Initializes a new instance of the ExitOptions class. - * @constructor - * @summary Specifies how the Batch service responds to a particular exit - * condition. - * - * @member {string} [jobAction] 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'. 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [dependencyAction] An action that the Batch service - * performs on tasks that depend on this task. 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). Possible values - * include: 'satisfy', 'block' + * @summary Specifies how the Batch service responds to a particular exit condition. */ export interface ExitOptions { + /** + * @summary 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 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). Possible values include: 'none', + * 'disable', 'terminate' + */ jobAction?: string; + /** + * @summary An action that the Batch service performs on tasks that depend on this task. + * @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). Possible values include: 'satisfy', 'block' + */ dependencyAction?: string; } /** - * @class - * Initializes a new instance of the ExitCodeMapping class. - * @constructor - * @summary How the Batch service should respond if a task exits with a - * particular exit code. - * - * @member {number} code A process exit code. - * @member {object} exitOptions How the Batch service should respond if the - * task exits with this exit code. - * @member {string} [exitOptions.jobAction] 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). - * Possible values include: 'none', 'disable', 'terminate' - * @member {string} [exitOptions.dependencyAction] 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). Possible values - * include: 'satisfy', 'block' + * @summary How the Batch service should respond if a task exits with a particular exit code. */ export interface ExitCodeMapping { + /** + * @summary A process exit code. + */ code: number; + /** + * @summary How the Batch service should respond if the task exits with this exit code. + */ exitOptions: ExitOptions; } /** - * @class - * Initializes a new instance of the ExitCodeRangeMapping class. - * @constructor - * @summary A range of exit codes and how the Batch service should respond to - * exit codes within that range. - * - * @member {number} start The first exit code in the range. - * @member {number} end The last exit code in the range. - * @member {object} exitOptions How the Batch service should respond if the - * task exits with an exit code in the range start to end (inclusive). - * @member {string} [exitOptions.jobAction] 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). - * Possible values include: 'none', 'disable', 'terminate' - * @member {string} [exitOptions.dependencyAction] 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). Possible values - * include: 'satisfy', 'block' + * @summary A range of exit codes and how the Batch service should respond to exit codes within + * that range. */ export interface ExitCodeRangeMapping { + /** + * @summary The first exit code in the range. + */ start: number; + /** + * @summary The last exit code in the range. + */ end: number; + /** + * @summary How the Batch service should respond if the task exits with an exit code in the range + * start to end (inclusive). + */ exitOptions: ExitOptions; } /** - * @class - * Initializes a new instance of the ExitConditions class. - * @constructor - * @summary Specifies how the Batch service should respond when the task - * completes. - * - * @member {array} [exitCodes] A list of individual task exit codes and how the - * Batch service should respond to them. - * @member {array} [exitCodeRanges] A list of task exit code ranges and how the - * Batch service should respond to them. - * @member {object} [preProcessingError] How the Batch service should respond - * if the task fails to start due to an error. - * @member {string} [preProcessingError.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [preProcessingError.dependencyAction] 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). Possible values - * include: 'satisfy', 'block' - * @member {object} [fileUploadError] How the Batch service should respond if a - * file upload error occurs. If the task exited with an exit code that was - * specified via exitCodes or exitCodeRanges, and then encountered a file - * upload error, then the action specified by the exit code takes precedence. - * @member {string} [fileUploadError.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [fileUploadError.dependencyAction] 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). Possible values - * include: 'satisfy', 'block' - * @member {object} [default] How the Batch service should respond if the task - * fails with an exit condition not covered by any of the other properties. - * This value is used if the task exits with any nonzero exit code not listed - * in the exitCodes or exitCodeRanges collection, with a pre-processing error - * if the preProcessingError property is not present, or with a file upload - * error if the fileUploadError property is not present. If you want - * non-default behavior on exit code 0, you must list it explicitly using the - * exitCodes or exitCodeRanges collection. - * @member {string} [default.jobAction] 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). Possible - * values include: 'none', 'disable', 'terminate' - * @member {string} [default.dependencyAction] 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). Possible values - * include: 'satisfy', 'block' + * @summary Specifies how the Batch service should respond when the task completes. */ export interface ExitConditions { + /** + * @summary A list of individual task exit codes and how the Batch service should respond to + * them. + */ exitCodes?: ExitCodeMapping[]; + /** + * @summary A list of task exit code ranges and how the Batch service should respond to them. + */ exitCodeRanges?: ExitCodeRangeMapping[]; + /** + * @summary How the Batch service should respond if the task fails to start due to an error. + */ preProcessingError?: ExitOptions; + /** + * @summary How the Batch service should respond if a file upload error occurs. + * @description If the task exited with an exit code that was specified via exitCodes or + * exitCodeRanges, and then encountered a file upload error, then the action specified by the + * exit code takes precedence. + */ fileUploadError?: ExitOptions; + /** + * @summary How the Batch service should respond if the task fails with an exit condition not + * covered by any of the other properties. + * @description This value is used if the task exits with any nonzero exit code not listed in the + * exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError + * property is not present, or with a file upload error if the fileUploadError property is not + * present. If you want non-default behavior on exit code 0, you must list it explicitly using + * the exitCodes or exitCodeRanges collection. + */ default?: ExitOptions; } /** - * @class - * Initializes a new instance of the AutoUserSpecification class. - * @constructor - * @summary Specifies the parameters for the auto user that runs a task on the - * Batch service. - * - * @member {string} [scope] The scope for the auto user. The default value is - * task. Possible values include: 'task', 'pool' - * @member {string} [elevationLevel] The elevation level of the auto user. The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @summary Specifies the parameters for the auto user that runs a task on the Batch service. */ export interface AutoUserSpecification { + /** + * @summary The scope for the auto user + * @description The default value is task. Possible values include: 'task', 'pool' + */ scope?: string; + /** + * @summary The elevation level of the auto user. + * @description The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + */ elevationLevel?: string; } /** - * @class - * Initializes a new instance of the UserIdentity class. - * @constructor * @summary The definition of the user identity under which the task is run. - * - * Specify either the userName or autoUser property, but not both. - * - * @member {string} [userName] The name of the user identity under which the - * task is run. The userName and autoUser properties are mutually exclusive; - * you must specify one but not both. - * @member {object} [autoUser] The auto user under which the task is run. The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} [autoUser.scope] The default value is task. Possible values - * include: 'task', 'pool' - * @member {string} [autoUser.elevationLevel] The default value is nonAdmin. - * Possible values include: 'nonAdmin', 'admin' + * @description Specify either the userName or autoUser property, but not both. */ export interface UserIdentity { + /** + * @summary The name of the user identity under which the task is run. + * @description The userName and autoUser properties are mutually exclusive; you must specify one + * but not both. + */ userName?: string; + /** + * @summary The auto user under which the task is run. + * @description The userName and autoUser properties are mutually exclusive; you must specify one + * but not both. + */ autoUser?: AutoUserSpecification; } /** - * @class - * Initializes a new instance of the LinuxUserConfiguration class. - * @constructor * @summary Properties used to create a user account on a Linux node. - * - * @member {number} [uid] The user ID of the user account. The uid and gid - * properties must be specified together or not at all. If not specified the - * underlying operating system picks the uid. - * @member {number} [gid] The group ID for the user account. The uid and gid - * properties must be specified together or not at all. If not specified the - * underlying operating system picks the gid. - * @member {string} [sshPrivateKey] The SSH private key for the user account. - * The private key must not be password protected. The private key is used to - * automatically configure asymmetric-key based authentication for SSH between - * nodes in a Linux pool when the pool's enableInterNodeCommunication property - * is true (it is ignored if enableInterNodeCommunication is false). It does - * this by placing the key pair into the user's .ssh directory. If not - * specified, password-less SSH is not configured between nodes (no - * modification of the user's .ssh directory is done). */ export interface LinuxUserConfiguration { + /** + * @summary The user ID of the user account. + * @description The uid and gid properties must be specified together or not at all. If not + * specified the underlying operating system picks the uid. + */ uid?: number; + /** + * @summary The group ID for the user account. + * @description The uid and gid properties must be specified together or not at all. If not + * specified the underlying operating system picks the gid. + */ gid?: number; + /** + * @summary The SSH private key for the user account. + * @description The private key must not be password protected. The private key is used to + * automatically configure asymmetric-key based authentication for SSH between nodes in a Linux + * pool when the pool's enableInterNodeCommunication property is true (it is ignored if + * enableInterNodeCommunication is false). It does this by placing the key pair into the user's + * .ssh directory. If not specified, password-less SSH is not configured between nodes (no + * modification of the user's .ssh directory is done). + */ sshPrivateKey?: string; } /** - * @class - * Initializes a new instance of the WindowsUserConfiguration class. - * @constructor * @summary Properties used to create a user account on a Windows node. - * - * @member {string} [loginMode] The login mode for the user. The default value - * for VirtualMachineConfiguration pools is batch and for - * CloudServiceConfiguration pools is interactive. Possible values include: - * 'batch', 'interactive' */ export interface WindowsUserConfiguration { + /** + * @summary The login mode for the user. + * @description The default value for VirtualMachineConfiguration pools is batch and for + * CloudServiceConfiguration pools is interactive. Possible values include: 'batch', + * 'interactive' + */ loginMode?: string; } /** - * @class - * Initializes a new instance of the UserAccount class. - * @constructor - * @summary Properties used to create a user used to execute tasks on an Azure - * Batch node. - * - * @member {string} name The name of the user account. - * @member {string} password The password for the user account. - * @member {string} [elevationLevel] The elevation level of the user account. - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {object} [linuxUserConfiguration] The Linux-specific user - * configuration for the user account. This property is ignored if specified on - * a Windows pool. If not specified, the user is created with the default - * options. - * @member {number} [linuxUserConfiguration.uid] The uid and gid properties - * must be specified together or not at all. If not specified the underlying - * operating system picks the uid. - * @member {number} [linuxUserConfiguration.gid] The uid and gid properties - * must be specified together or not at all. If not specified the underlying - * operating system picks the gid. - * @member {string} [linuxUserConfiguration.sshPrivateKey] The private key must - * not be password protected. The private key is used to automatically - * configure asymmetric-key based authentication for SSH between nodes in a - * Linux pool when the pool's enableInterNodeCommunication property is true (it - * is ignored if enableInterNodeCommunication is false). It does this by - * placing the key pair into the user's .ssh directory. If not specified, - * password-less SSH is not configured between nodes (no modification of the - * user's .ssh directory is done). - * @member {object} [windowsUserConfiguration] The Windows-specific user - * configuration for the user account. This property can only be specified if - * the user is on a Windows pool. If not specified and on a Windows pool, the - * user is created with the default options. - * @member {string} [windowsUserConfiguration.loginMode] The default value for - * VirtualMachineConfiguration pools is batch and for CloudServiceConfiguration - * pools is interactive. Possible values include: 'batch', 'interactive' + * @summary Properties used to create a user used to execute tasks on an Azure Batch node. */ export interface UserAccount { + /** + * @summary The name of the user account. + */ name: string; + /** + * @summary The password for the user account. + */ password: string; + /** + * @summary The elevation level of the user account. + * @description The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + */ elevationLevel?: string; + /** + * @summary The Linux-specific user configuration for the user account. + * @description This property is ignored if specified on a Windows pool. If not specified, the + * user is created with the default options. + */ linuxUserConfiguration?: LinuxUserConfiguration; + /** + * @summary The Windows-specific user configuration for the user account. + * @description This property can only be specified if the user is on a Windows pool. If not + * specified and on a Windows pool, the user is created with the default options. + */ windowsUserConfiguration?: WindowsUserConfiguration; } /** - * @class - * Initializes a new instance of the TaskConstraints class. - * @constructor * @summary Execution constraints to apply to a task. - * - * @member {moment.duration} [maxWallClockTime] The maximum elapsed time that - * the task may run, measured from the time the task starts. If the task does - * not complete within the time limit, the Batch service terminates it. If this - * is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} [retentionTime] The minimum time to retain the - * task directory on the compute node where it ran, from the time it completes - * execution. After this time, the Batch service may delete the task directory - * and all its contents. The default is 7 days, i.e. the task directory will be - * retained for 7 days unless the compute node is removed or the job is - * deleted. - * @member {number} [maxTaskRetryCount] The maximum number of times the task - * may be retried. The Batch service retries a task if its exit code is - * nonzero. Note that this value specifically controls the number of retries - * for the task executable due to a nonzero exit code. The Batch service will - * try the task once, and may then retry up to this limit. For example, if the - * maximum retry count is 3, Batch tries the task up to 4 times (one initial - * try and 3 retries). If the maximum retry count is 0, the Batch service does - * not retry the task after the first attempt. If the maximum retry count is - * -1, the Batch service retries the task without limit. */ export interface TaskConstraints { + /** + * @summary The maximum elapsed time that the task may run, measured from the time the task + * starts. If the task does not complete within the time limit, the Batch service terminates it. + * @description If this is not specified, there is no time limit on how long the task may run. + */ maxWallClockTime?: moment.Duration; + /** + * @summary The minimum time to retain the task directory on the compute node where it ran, from + * the time it completes execution. After this time, the Batch service may delete the task + * directory and all its contents. + * @description The default is 7 days, i.e. the task directory will be retained for 7 days unless + * the compute node is removed or the job is deleted. + */ retentionTime?: moment.Duration; + /** + * @summary The maximum number of times the task may be retried. The Batch service retries a task + * if its exit code is nonzero. + * @description Note that this value specifically controls the number of retries for the task + * executable due to a nonzero exit code. The Batch service will try the task once, and may then + * retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up + * to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service + * does not retry the task after the first attempt. If the maximum retry count is -1, the Batch + * service retries the task without limit. + */ maxTaskRetryCount?: number; } /** - * @class - * Initializes a new instance of the OutputFileBlobContainerDestination class. - * @constructor - * @summary Specifies a file upload destination within an Azure blob storage - * container. - * - * @member {string} [path] The destination blob or virtual directory within the - * Azure Storage container. If filePattern refers to a specific file (i.e. - * contains no wildcards), then path is the name of the blob to which to upload - * that file. If filePattern contains one or more wildcards (and therefore may - * match multiple files), then path is the name of the blob virtual directory - * (which is prepended to each blob name) to which to upload the file(s). If - * omitted, file(s) are uploaded to the root of the container with a blob name - * matching their file name. - * @member {string} containerUrl The URL of the container within Azure Blob - * Storage to which to upload the file(s). The URL must include a Shared Access - * Signature (SAS) granting write permissions to the container. + * @summary Specifies a file upload destination within an Azure blob storage container. */ export interface OutputFileBlobContainerDestination { + /** + * @summary The destination blob or virtual directory within the Azure Storage container. + * @description If filePattern refers to a specific file (i.e. contains no wildcards), then path + * is the name of the blob to which to upload that file. If filePattern contains one or more + * wildcards (and therefore may match multiple files), then path is the name of the blob virtual + * directory (which is prepended to each blob name) to which to upload the file(s). If omitted, + * file(s) are uploaded to the root of the container with a blob name matching their file name. + */ path?: string; + /** + * @summary The URL of the container within Azure Blob Storage to which to upload the file(s). + * @description The URL must include a Shared Access Signature (SAS) granting write permissions + * to the container. + */ containerUrl: string; } /** - * @class - * Initializes a new instance of the OutputFileDestination class. - * @constructor * @summary The destination to which a file should be uploaded. - * - * @member {object} [container] A location in Azure blob storage to which files - * are uploaded. - * @member {string} [container.path] If filePattern refers to a specific file - * (i.e. contains no wildcards), then path is the name of the blob to which to - * upload that file. If filePattern contains one or more wildcards (and - * therefore may match multiple files), then path is the name of the blob - * virtual directory (which is prepended to each blob name) to which to upload - * the file(s). If omitted, file(s) are uploaded to the root of the container - * with a blob name matching their file name. - * @member {string} [container.containerUrl] The URL must include a Shared - * Access Signature (SAS) granting write permissions to the container. */ export interface OutputFileDestination { + /** + * @summary A location in Azure blob storage to which files are uploaded. + */ container?: OutputFileBlobContainerDestination; } /** - * @class - * Initializes a new instance of the OutputFileUploadOptions class. - * @constructor - * @summary Details about an output file upload operation, including under what - * conditions to perform the upload. - * - * @member {string} uploadCondition The conditions under which the task output - * file or set of files should be uploaded. The default is taskcompletion. - * Possible values include: 'taskSuccess', 'taskFailure', 'taskCompletion' + * @summary Details about an output file upload operation, including under what conditions to + * perform the upload. */ export interface OutputFileUploadOptions { + /** + * @summary The conditions under which the task output file or set of files should be uploaded. + * @description The default is taskcompletion. Possible values include: 'taskSuccess', + * 'taskFailure', 'taskCompletion' + */ uploadCondition: string; } /** - * @class - * Initializes a new instance of the OutputFile class. - * @constructor - * @summary A specification for uploading files from an Azure Batch node to - * another location after the Batch service has finished executing the task - * process. - * - * @member {string} filePattern A pattern indicating which file(s) to upload. - * Both relative and absolute paths are supported. Relative paths are relative - * to the task working directory. The following wildcards are supported: * - * matches 0 or more characters (for example pattern abc* would match abc or - * abcdef), ** matches any directory, ? matches any single character, [abc] - * matches one character in the brackets, and [a-c] matches one character in - * the range. Brackets can include a negation to match any character not - * specified (for example [!abc] matches any character but a, b, or c). If a - * file name starts with "." it is ignored by default but may be matched by - * specifying it explicitly (for example *.gif will not match .a.gif, but - * .*.gif will). A simple example: **\*.txt matches any file that does not - * start in '.' and ends with .txt in the task working directory or any - * subdirectory. If the filename contains a wildcard character it can be - * escaped using brackets (for example abc[*] would match a file named abc*). - * Note that both \ and / are treated as directory separators on Windows, but - * only / is on Linux. Environment variables (%var% on Windows or $var on - * Linux) are expanded prior to the pattern being applied. - * @member {object} destination The destination for the output file(s). - * @member {object} [destination.container] - * @member {string} [destination.container.path] If filePattern refers to a - * specific file (i.e. contains no wildcards), then path is the name of the - * blob to which to upload that file. If filePattern contains one or more - * wildcards (and therefore may match multiple files), then path is the name of - * the blob virtual directory (which is prepended to each blob name) to which - * to upload the file(s). If omitted, file(s) are uploaded to the root of the - * container with a blob name matching their file name. - * @member {string} [destination.container.containerUrl] The URL must include a - * Shared Access Signature (SAS) granting write permissions to the container. - * @member {object} uploadOptions Additional options for the upload operation, - * including under what conditions to perform the upload. - * @member {string} [uploadOptions.uploadCondition] The default is - * taskcompletion. Possible values include: 'taskSuccess', 'taskFailure', - * 'taskCompletion' + * @summary A specification for uploading files from an Azure Batch node to another location after + * the Batch service has finished executing the task process. */ export interface OutputFile { + /** + * @summary A pattern indicating which file(s) to upload. + * @description Both relative and absolute paths are supported. Relative paths are relative to + * the task working directory. The following wildcards are supported: * matches 0 or more + * characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? + * matches any single character, [abc] matches one character in the brackets, and [a-c] matches + * one character in the range. Brackets can include a negation to match any character not + * specified (for example [!abc] matches any character but a, b, or c). If a file name starts + * with "." it is ignored by default but may be matched by specifying it explicitly (for example + * *.gif will not match .a.gif, but .*.gif will). A simple example: **\*.txt matches any file + * that does not start in '.' and ends with .txt in the task working directory or any + * subdirectory. If the filename contains a wildcard character it can be escaped using brackets + * (for example abc[*] would match a file named abc*). Note that both \ and / are treated as + * directory separators on Windows, but only / is on Linux. Environment variables (%var% on + * Windows or $var on Linux) are expanded prior to the pattern being applied. + */ filePattern: string; + /** + * @summary The destination for the output file(s). + */ destination: OutputFileDestination; + /** + * @summary Additional options for the upload operation, including under what conditions to + * perform the upload. + */ uploadOptions: OutputFileUploadOptions; } /** - * @class - * Initializes a new instance of the JobManagerTask class. - * @constructor * @summary Specifies details of a Job Manager task. - * - * The Job Manager task is automatically started when the job is created. The - * Batch service tries to schedule the Job Manager task before any other tasks - * in the job. When shrinking a pool, the Batch service tries to preserve - * compute nodes where Job Manager tasks are running for as long as possible - * (that is, nodes running 'normal' tasks are removed before nodes running Job - * Manager tasks). When a Job Manager task fails and needs to be restarted, the - * system tries to schedule it at the highest priority. If there are no idle - * nodes available, the system may terminate one of the running tasks in the - * pool and return it to the queue in order to make room for the Job Manager - * task to restart. Note that a Job Manager task in one job does not have - * priority over tasks in other jobs. Across jobs, only job level priorities - * are observed. For example, if a Job Manager in a priority 0 job needs to be - * restarted, it will not displace tasks of a priority 1 job. Batch will retry - * tasks when a recovery operation is triggered on a compute node. Examples of - * recovery operations include (but are not limited to) when an unhealthy - * compute node is rebooted or a compute node disappeared due to host failure. - * Retries due to recovery operations are independent of and are not counted - * against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an - * internal retry due to a recovery operation may occur. Because of this, all - * tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * - * @member {string} id A string that uniquely identifies the Job Manager task - * within the job. The ID can contain any combination of alphanumeric - * characters including hyphens and underscores and cannot contain more than 64 - * characters. - * @member {string} [displayName] The display name of the Job Manager task. It - * need not be unique and can contain any Unicode characters up to a maximum - * length of 1024. - * @member {string} commandLine The command line of the Job Manager task. The - * command line does not run under a shell, and therefore cannot take advantage - * of shell features such as environment variable expansion. If you want to - * take advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the Job Manager task runs. If the pool that will run this task has - * containerConfiguration set, this must be set as well. If the pool that will - * run this task doesn't have containerConfiguration set, this must not be set. - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image - * reference, as would be specified to "docker pull". If no tag is provided as - * part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted if - * was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, the - * default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service will - * download to the compute node before running the command line. Files listed - * under this element are located in the task's working directory. There is a - * maximum size for the list of resource files. When the max size is exceeded, - * the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [outputFiles] A list of files that the Batch service will - * upload from the compute node after running the command line. For - * multi-instance tasks, the files will only be uploaded from the compute node - * on which the primary task is executed. - * @member {array} [environmentSettings] A list of environment variable - * settings for the Job Manager task. - * @member {object} [constraints] Constraints that apply to the Job Manager - * task. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not - * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 days, - * i.e. the task directory will be retained for 7 days unless the compute node - * is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries for the task executable due to a - * nonzero exit code. The Batch service will try the task once, and may then - * retry up to this limit. For example, if the maximum retry count is 3, Batch - * tries the task up to 4 times (one initial try and 3 retries). If the maximum - * retry count is 0, the Batch service does not retry the task after the first - * attempt. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {boolean} [killJobOnCompletion] Whether completion of the Job - * Manager task signifies completion of the entire job. If true, when the Job - * Manager task completes, the Batch service marks the job as complete. If any - * tasks are still running at this time (other than Job Release), those tasks - * are terminated. If false, the completion of the Job Manager task does not - * affect the job status. In this case, you should either use the - * onAllTasksComplete attribute to terminate the job, or have a client or user - * terminate the job explicitly. An example of this is if the Job Manager - * creates a set of tasks but then takes no further role in their execution. - * The default value is true. If you are using the onAllTasksComplete and - * onTaskFailure attributes to control job lifetime, and using the Job Manager - * task only to create the tasks for the job (not to monitor progress), then it - * is important to set killJobOnCompletion to false. - * @member {object} [userIdentity] The user identity under which the Job - * Manager task runs. If omitted, the task runs as a non-administrative user - * unique to the task. - * @member {string} [userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value is - * nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [runExclusive] Whether the Job Manager task requires - * exclusive use of the compute node where it runs. If true, no other tasks - * will run on the same compute node for as long as the Job Manager is running. - * If false, other tasks can run simultaneously with the Job Manager on a - * compute node. The Job Manager task counts normally against the node's - * concurrent task limit, so this is only relevant if the node allows multiple - * concurrent tasks. The default value is true. - * @member {array} [applicationPackageReferences] A list of application - * packages that the Batch service will deploy to the compute node before - * running the command line. Application packages are downloaded and deployed - * to a shared directory, not the task working directory. Therefore, if a - * referenced package is already on the compute node, and is up to date, then - * it is not re-downloaded; the existing copy on the compute node is used. If a - * referenced application package cannot be installed, for example because the - * package has been deleted or because download failed, the task fails. - * @member {object} [authenticationTokenSettings] The settings for an - * authentication token that the task can use to perform Batch service - * operations. If this property is set, the Batch service provides the task - * with an authentication token which can be used to authenticate Batch service - * operations without requiring an account access key. The token is provided - * via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations - * that the task can carry out using the token depend on the settings. For - * example, a task can request job permissions in order to add other tasks to - * the job, or check the status of the job or of other tasks under the job. - * @member {array} [authenticationTokenSettings.access] The authentication - * token grants access to a limited set of Batch service operations. Currently - * the only supported value for the access property is 'job', which grants - * access to all operations related to the job which contains the task. - * @member {boolean} [allowLowPriorityNode] Whether the Job Manager task may - * run on a low-priority compute node. The default value is true. + * @description The Job Manager task is automatically started when the job is created. The Batch + * service tries to schedule the Job Manager task before any other tasks in the job. When shrinking + * a pool, the Batch service tries to preserve compute nodes where Job Manager tasks are running + * for as long as possible (that is, nodes running 'normal' tasks are removed before nodes running + * Job Manager tasks). When a Job Manager task fails and needs to be restarted, the system tries to + * schedule it at the highest priority. If there are no idle nodes available, the system may + * terminate one of the running tasks in the pool and return it to the queue in order to make room + * for the Job Manager task to restart. Note that a Job Manager task in one job does not have + * priority over tasks in other jobs. Across jobs, only job level priorities are observed. For + * example, if a Job Manager in a priority 0 job needs to be restarted, it will not displace tasks + * of a priority 1 job. Batch will retry tasks when a recovery operation is triggered on a compute + * node. Examples of recovery operations include (but are not limited to) when an unhealthy compute + * node is rebooted or a compute node disappeared due to host failure. Retries due to recovery + * operations are independent of and are not counted against the maxTaskRetryCount. Even if the + * maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of + * this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and + * restarted without causing any corruption or duplicate data. The best practice for long running + * tasks is to use some form of checkpointing. */ export interface JobManagerTask { + /** + * @summary A string that uniquely identifies the Job Manager task within the job. + * @description The ID can contain any combination of alphanumeric characters including hyphens + * and underscores and cannot contain more than 64 characters. + */ id: string; + /** + * @summary The display name of the Job Manager task. + * @description It need not be unique and can contain any Unicode characters up to a maximum + * length of 1024. + */ displayName?: string; + /** + * @summary The command line of the Job Manager task. + * @description The command line does not run under a shell, and therefore cannot take advantage + * of shell features such as environment variable expansion. If you want to take advantage of + * such features, you should invoke the shell in the command line, for example using "cmd /c + * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file + * paths, it should use a relative path (relative to the task working directory), or use the + * Batch provided environment variable + * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). + */ commandLine: string; + /** + * @summary The settings for the container under which the Job Manager task runs. + * @description If the pool that will run this task has containerConfiguration set, this must be + * set as well. If the pool that will run this task doesn't have containerConfiguration set, this + * must not be set. When this is specified, all directories recursively below the + * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the + * container, all task environment variables are mapped into the container, and the task command + * line is executed in the container. + */ containerSettings?: TaskContainerSettings; + /** + * @summary A list of files that the Batch service will download to the compute node before + * running the command line. + * @description Files listed under this element are located in the task's working directory. + * There is a maximum size for the list of resource files. When the max size is exceeded, the + * request will fail and the response error code will be RequestEntityTooLarge. If this occurs, + * the collection of ResourceFiles must be reduced in size. This can be achieved using .zip + * files, Application Packages, or Docker Containers. + */ resourceFiles?: ResourceFile[]; + /** + * @summary A list of files that the Batch service will upload from the compute node after + * running the command line. + * @description For multi-instance tasks, the files will only be uploaded from the compute node + * on which the primary task is executed. + */ outputFiles?: OutputFile[]; + /** + * @summary A list of environment variable settings for the Job Manager task. + */ environmentSettings?: EnvironmentSetting[]; + /** + * @summary Constraints that apply to the Job Manager task. + */ constraints?: TaskConstraints; + /** + * @summary Whether completion of the Job Manager task signifies completion of the entire job. + * @description If true, when the Job Manager task completes, the Batch service marks the job as + * complete. If any tasks are still running at this time (other than Job Release), those tasks + * are terminated. If false, the completion of the Job Manager task does not affect the job + * status. In this case, you should either use the onAllTasksComplete attribute to terminate the + * job, or have a client or user terminate the job explicitly. An example of this is if the Job + * Manager creates a set of tasks but then takes no further role in their execution. The default + * value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control + * job lifetime, and using the Job Manager task only to create the tasks for the job (not to + * monitor progress), then it is important to set killJobOnCompletion to false. + */ killJobOnCompletion?: boolean; + /** + * @summary The user identity under which the Job Manager task runs. + * @description If omitted, the task runs as a non-administrative user unique to the task. + */ userIdentity?: UserIdentity; + /** + * @summary Whether the Job Manager task requires exclusive use of the compute node where it + * runs. + * @description If true, no other tasks will run on the same compute node for as long as the Job + * Manager is running. If false, other tasks can run simultaneously with the Job Manager on a + * compute node. The Job Manager task counts normally against the node's concurrent task limit, + * so this is only relevant if the node allows multiple concurrent tasks. The default value is + * true. + */ runExclusive?: boolean; + /** + * @summary A list of application packages that the Batch service will deploy to the compute node + * before running the command line. + * @description Application packages are downloaded and deployed to a shared directory, not the + * task working directory. Therefore, if a referenced package is already on the compute node, and + * is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If + * a referenced application package cannot be installed, for example because the package has been + * deleted or because download failed, the task fails. + */ applicationPackageReferences?: ApplicationPackageReference[]; + /** + * @summary The settings for an authentication token that the task can use to perform Batch + * service operations. + * @description If this property is set, the Batch service provides the task with an + * authentication token which can be used to authenticate Batch service operations without + * requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN + * environment variable. The operations that the task can carry out using the token depend on the + * settings. For example, a task can request job permissions in order to add other tasks to the + * job, or check the status of the job or of other tasks under the job. + */ authenticationTokenSettings?: AuthenticationTokenSettings; + /** + * @summary Whether the Job Manager task may run on a low-priority compute node. + * @description The default value is true. + */ allowLowPriorityNode?: boolean; } /** - * @class - * Initializes a new instance of the JobPreparationTask class. - * @constructor - * @summary A Job Preparation task to run before any tasks of the job on any - * given compute node. - * - * You can use Job Preparation to prepare a compute node to run tasks for the - * job. Activities commonly performed in Job Preparation include: Downloading - * common resource files used by all the tasks in the job. The Job Preparation - * task can download these common resource files to the shared location on the - * compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service - * on the compute node so that all tasks of that job can communicate with it. - * If the Job Preparation task fails (that is, exhausts its retry count before - * exiting with exit code 0), Batch will not run tasks of this job on the - * compute node. The node remains ineligible to run tasks of this job until it - * is reimaged. The node remains active and can be used for other jobs. The Job - * Preparation task can run multiple times on the same compute node. Therefore, - * you should write the Job Preparation task to handle re-execution. If the - * compute node is rebooted, the Job Preparation task is run again on the node - * before scheduling any other task of the job, if - * rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not - * previously complete. If the compute node is reimaged, the Job Preparation - * task is run again before scheduling any task of the job. Batch will retry - * tasks when a recovery operation is triggered on a compute node. Examples of - * recovery operations include (but are not limited to) when an unhealthy - * compute node is rebooted or a compute node disappeared due to host failure. - * Retries due to recovery operations are independent of and are not counted - * against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an - * internal retry due to a recovery operation may occur. Because of this, all - * tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * - * @member {string} [id] A string that uniquely identifies the Job Preparation - * task within the job. The ID can contain any combination of alphanumeric - * characters including hyphens and underscores and cannot contain more than 64 - * characters. If you do not specify this property, the Batch service assigns a - * default value of 'jobpreparation'. No other task in the job can have the - * same ID as the Job Preparation task. If you try to submit a task with the - * same id, the Batch service rejects the request with error code - * TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, - * the HTTP status code is 409 (Conflict). - * @member {string} commandLine The command line of the Job Preparation task. - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the Job Preparation task runs. When this is specified, all directories - * recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch - * directories on the node) are mapped into the container, all task environment - * variables are mapped into the container, and the task command line is - * executed in the container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image - * reference, as would be specified to "docker pull". If no tag is provided as - * part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted if - * was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, the - * default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service will - * download to the compute node before running the command line. Files listed - * under this element are located in the task's working directory. There is a - * maximum size for the list of resource files. When the max size is exceeded, - * the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [environmentSettings] A list of environment variable - * settings for the Job Preparation task. - * @member {object} [constraints] Constraints that apply to the Job Preparation - * task. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not - * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 days, - * i.e. the task directory will be retained for 7 days unless the compute node - * is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries for the task executable due to a - * nonzero exit code. The Batch service will try the task once, and may then - * retry up to this limit. For example, if the maximum retry count is 3, Batch - * tries the task up to 4 times (one initial try and 3 retries). If the maximum - * retry count is 0, the Batch service does not retry the task after the first - * attempt. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {boolean} [waitForSuccess] Whether the Batch service should wait for - * the Job Preparation task to complete successfully before scheduling any - * other tasks of the job on the compute node. A Job Preparation task has - * completed successfully if it exits with exit code 0. If true and the Job - * Preparation task fails on a compute node, the Batch service retries the Job - * Preparation task up to its maximum retry count (as specified in the - * constraints element). If the task has still not completed successfully after - * all retries, then the Batch service will not schedule tasks of the job to - * the compute node. The compute node remains active and eligible to run tasks - * of other jobs. If false, the Batch service will not wait for the Job - * Preparation task to complete. In this case, other tasks of the job can start - * executing on the compute node while the Job Preparation task is still - * running; and even if the Job Preparation task fails, new tasks will continue - * to be scheduled on the node. The default value is true. - * @member {object} [userIdentity] The user identity under which the Job - * Preparation task runs. If omitted, the task runs as a non-administrative - * user unique to the task on Windows nodes, or a a non-administrative user - * unique to the pool on Linux nodes. - * @member {string} [userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value is - * nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [rerunOnNodeRebootAfterSuccess] Whether the Batch service - * should rerun the Job Preparation task after a compute node reboots. The Job - * Preparation task is always rerun if a compute node is reimaged, or if the - * Job Preparation task did not complete (e.g. because the reboot occurred - * while the task was running). Therefore, you should always write a Job - * Preparation task to be idempotent and to behave correctly if run multiple - * times. The default value is true. + * @summary A Job Preparation task to run before any tasks of the job on any given compute node. + * @description You can use Job Preparation to prepare a compute node to run tasks for the job. + * Activities commonly performed in Job Preparation include: Downloading common resource files used + * by all the tasks in the job. The Job Preparation task can download these common resource files + * to the shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local + * service on the compute node so that all tasks of that job can communicate with it. If the Job + * Preparation task fails (that is, exhausts its retry count before exiting with exit code 0), + * Batch will not run tasks of this job on the compute node. The node remains ineligible to run + * tasks of this job until it is reimaged. The node remains active and can be used for other jobs. + * The Job Preparation task can run multiple times on the same compute node. Therefore, you should + * write the Job Preparation task to handle re-execution. If the compute node is rebooted, the Job + * Preparation task is run again on the node before scheduling any other task of the job, if + * rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not previously + * complete. If the compute node is reimaged, the Job Preparation task is run again before + * scheduling any task of the job. Batch will retry tasks when a recovery operation is triggered on + * a compute node. Examples of recovery operations include (but are not limited to) when an + * unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries + * due to recovery operations are independent of and are not counted against the maxTaskRetryCount. + * Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. + * Because of this, all tasks should be idempotent. This means tasks need to tolerate being + * interrupted and restarted without causing any corruption or duplicate data. The best practice + * for long running tasks is to use some form of checkpointing. */ export interface JobPreparationTask { + /** + * @summary A string that uniquely identifies the Job Preparation task within the job. + * @description The ID can contain any combination of alphanumeric characters including hyphens + * and underscores and cannot contain more than 64 characters. If you do not specify this + * property, the Batch service assigns a default value of 'jobpreparation'. No other task in the + * job can have the same ID as the Job Preparation task. If you try to submit a task with the + * same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; + * if you are calling the REST API directly, the HTTP status code is 409 (Conflict). + */ id?: string; + /** + * @summary The command line of the Job Preparation task. + * @description The command line does not run under a shell, and therefore cannot take advantage + * of shell features such as environment variable expansion. If you want to take advantage of + * such features, you should invoke the shell in the command line, for example using "cmd /c + * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file + * paths, it should use a relative path (relative to the task working directory), or use the + * Batch provided environment variable + * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). + */ commandLine: string; + /** + * @summary The settings for the container under which the Job Preparation task runs. + * @description When this is specified, all directories recursively below the + * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the + * container, all task environment variables are mapped into the container, and the task command + * line is executed in the container. + */ containerSettings?: TaskContainerSettings; + /** + * @summary A list of files that the Batch service will download to the compute node before + * running the command line. + * @description Files listed under this element are located in the task's working directory. + * There is a maximum size for the list of resource files. When the max size is exceeded, the + * request will fail and the response error code will be RequestEntityTooLarge. If this occurs, + * the collection of ResourceFiles must be reduced in size. This can be achieved using .zip + * files, Application Packages, or Docker Containers. + */ resourceFiles?: ResourceFile[]; + /** + * @summary A list of environment variable settings for the Job Preparation task. + */ environmentSettings?: EnvironmentSetting[]; + /** + * @summary Constraints that apply to the Job Preparation task. + */ constraints?: TaskConstraints; + /** + * @summary Whether the Batch service should wait for the Job Preparation task to complete + * successfully before scheduling any other tasks of the job on the compute node. A Job + * Preparation task has completed successfully if it exits with exit code 0. + * @description If true and the Job Preparation task fails on a compute node, the Batch service + * retries the Job Preparation task up to its maximum retry count (as specified in the + * constraints element). If the task has still not completed successfully after all retries, then + * the Batch service will not schedule tasks of the job to the compute node. The compute node + * remains active and eligible to run tasks of other jobs. If false, the Batch service will not + * wait for the Job Preparation task to complete. In this case, other tasks of the job can start + * executing on the compute node while the Job Preparation task is still running; and even if the + * Job Preparation task fails, new tasks will continue to be scheduled on the node. The default + * value is true. + */ waitForSuccess?: boolean; + /** + * @summary The user identity under which the Job Preparation task runs. + * @description If omitted, the task runs as a non-administrative user unique to the task on + * Windows nodes, or a non-administrative user unique to the pool on Linux nodes. + */ userIdentity?: UserIdentity; + /** + * @summary Whether the Batch service should rerun the Job Preparation task after a compute node + * reboots. + * @description The Job Preparation task is always rerun if a compute node is reimaged, or if the + * Job Preparation task did not complete (e.g. because the reboot occurred while the task was + * running). Therefore, you should always write a Job Preparation task to be idempotent and to + * behave correctly if run multiple times. The default value is true. + */ rerunOnNodeRebootAfterSuccess?: boolean; } /** - * @class - * Initializes a new instance of the JobReleaseTask class. - * @constructor - * @summary A Job Release task to run on job completion on any compute node - * where the job has run. - * - * The Job Release task runs when the job ends, because of one of the - * following: The user calls the Terminate Job API, or the Delete Job API while - * the job is still active, the job's maximum wall clock time constraint is - * reached, and the job is still active, or the job's Job Manager task - * completed, and the job is configured to terminate when the Job Manager - * completes. The Job Release task runs on each compute node where tasks of the - * job have run and the Job Preparation task ran and completed. If you reimage - * a compute node after it has run the Job Preparation task, and the job ends - * without any further tasks of the job running on that compute node (and hence - * the Job Preparation task does not re-run), then the Job Release task does - * not run on that node. If a compute node reboots while the Job Release task - * is still running, the Job Release task runs again when the compute node - * starts up. The job is not marked as complete until all Job Release tasks - * have completed. The Job Release task runs in the background. It does not - * occupy a scheduling slot; that is, it does not count towards the - * maxTasksPerNode limit specified on the pool. - * - * @member {string} [id] A string that uniquely identifies the Job Release task - * within the job. The ID can contain any combination of alphanumeric - * characters including hyphens and underscores and cannot contain more than 64 - * characters. If you do not specify this property, the Batch service assigns a - * default value of 'jobrelease'. No other task in the job can have the same ID - * as the Job Release task. If you try to submit a task with the same id, the - * Batch service rejects the request with error code - * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the - * HTTP status code is 409 (Conflict). - * @member {string} commandLine The command line of the Job Release task. The - * command line does not run under a shell, and therefore cannot take advantage - * of shell features such as environment variable expansion. If you want to - * take advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the Job Release task runs. When this is specified, all directories - * recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch - * directories on the node) are mapped into the container, all task environment - * variables are mapped into the container, and the task command line is - * executed in the container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image - * reference, as would be specified to "docker pull". If no tag is provided as - * part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted if - * was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, the - * default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service will - * download to the compute node before running the command line. There is a - * maximum size for the list of resource files. When the max size is exceeded, - * the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. Files listed under this element are located - * in the task's working directory. - * @member {array} [environmentSettings] A list of environment variable - * settings for the Job Release task. - * @member {moment.duration} [maxWallClockTime] The maximum elapsed time that - * the Job Release task may run on a given compute node, measured from the time - * the task starts. If the task does not complete within the time limit, the - * Batch service terminates it. The default value is 15 minutes. You may not - * specify a timeout longer than 15 minutes. If you do, the Batch service - * rejects it with an error; if you are calling the REST API directly, the HTTP - * status code is 400 (Bad Request). - * @member {moment.duration} [retentionTime] The minimum time to retain the - * task directory for the Job Release task on the compute node. After this - * time, the Batch service may delete the task directory and all its contents. - * The default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {object} [userIdentity] The user identity under which the Job - * Release task runs. If omitted, the task runs as a non-administrative user - * unique to the task. - * @member {string} [userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value is - * nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @summary A Job Release task to run on job completion on any compute node where the job has run. + * @description The Job Release task runs when the job ends, because of one of the following: The + * user calls the Terminate Job API, or the Delete Job API while the job is still active, the job's + * maximum wall clock time constraint is reached, and the job is still active, or the job's Job + * Manager task completed, and the job is configured to terminate when the Job Manager completes. + * The Job Release task runs on each compute node where tasks of the job have run and the Job + * Preparation task ran and completed. If you reimage a compute node after it has run the Job + * Preparation task, and the job ends without any further tasks of the job running on that compute + * node (and hence the Job Preparation task does not re-run), then the Job Release task does not + * run on that node. If a compute node reboots while the Job Release task is still running, the Job + * Release task runs again when the compute node starts up. The job is not marked as complete until + * all Job Release tasks have completed. The Job Release task runs in the background. It does not + * occupy a scheduling slot; that is, it does not count towards the maxTasksPerNode limit specified + * on the pool. */ export interface JobReleaseTask { + /** + * @summary A string that uniquely identifies the Job Release task within the job. + * @description The ID can contain any combination of alphanumeric characters including hyphens + * and underscores and cannot contain more than 64 characters. If you do not specify this + * property, the Batch service assigns a default value of 'jobrelease'. No other task in the job + * can have the same ID as the Job Release task. If you try to submit a task with the same id, + * the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are + * calling the REST API directly, the HTTP status code is 409 (Conflict). + */ id?: string; + /** + * @summary The command line of the Job Release task. + * @description The command line does not run under a shell, and therefore cannot take advantage + * of shell features such as environment variable expansion. If you want to take advantage of + * such features, you should invoke the shell in the command line, for example using "cmd /c + * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file + * paths, it should use a relative path (relative to the task working directory), or use the + * Batch provided environment variable + * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). + */ commandLine: string; + /** + * @summary The settings for the container under which the Job Release task runs. + * @description When this is specified, all directories recursively below the + * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the + * container, all task environment variables are mapped into the container, and the task command + * line is executed in the container. + */ containerSettings?: TaskContainerSettings; + /** + * @summary A list of files that the Batch service will download to the compute node before + * running the command line. There is a maximum size for the list of resource files. When the + * max size is exceeded, the request will fail and the response error code will be + * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in + * size. This can be achieved using .zip files, Application Packages, or Docker Containers. + * @description Files listed under this element are located in the task's working directory. + */ resourceFiles?: ResourceFile[]; + /** + * @summary A list of environment variable settings for the Job Release task. + */ environmentSettings?: EnvironmentSetting[]; + /** + * @summary The maximum elapsed time that the Job Release task may run on a given compute node, + * measured from the time the task starts. If the task does not complete within the time limit, + * the Batch service terminates it. The default value is 15 minutes. You may not specify a + * timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you + * are calling the REST API directly, the HTTP status code is 400 (Bad Request). + */ maxWallClockTime?: moment.Duration; + /** + * @summary The minimum time to retain the task directory for the Job Release task on the compute + * node. After this time, the Batch service may delete the task directory and all its contents. + * @description The default is 7 days, i.e. the task directory will be retained for 7 days unless + * the compute node is removed or the job is deleted. + */ retentionTime?: moment.Duration; + /** + * @summary The user identity under which the Job Release task runs. + * @description If omitted, the task runs as a non-administrative user unique to the task. + */ userIdentity?: UserIdentity; } /** - * @class - * Initializes a new instance of the TaskSchedulingPolicy class. - * @constructor * @summary Specifies how tasks should be distributed across compute nodes. - * - * @member {string} nodeFillType How tasks are distributed across compute nodes - * in a pool. Possible values include: 'spread', 'pack' */ export interface TaskSchedulingPolicy { + /** + * @summary How tasks are distributed across compute nodes in a pool. + * @description Possible values include: 'spread', 'pack' + */ nodeFillType: string; } /** - * @class - * Initializes a new instance of the StartTask class. - * @constructor - * @summary A task which is run when a compute node joins a pool in the Azure - * Batch service, or when the compute node is rebooted or reimaged. - * - * Batch will retry tasks when a recovery operation is triggered on a compute - * node. Examples of recovery operations include (but are not limited to) when - * an unhealthy compute node is rebooted or a compute node disappeared due to - * host failure. Retries due to recovery operations are independent of and are - * not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is - * 0, an internal retry due to a recovery operation may occur. Because of this, - * all tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * - * @member {string} commandLine The command line of the start task. The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command line, - * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in - * Linux. If the command line refers to file paths, it should use a relative - * path (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the start task runs. When this is specified, all directories - * recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch - * directories on the node) are mapped into the container, all task environment - * variables are mapped into the container, and the task command line is - * executed in the container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image - * reference, as would be specified to "docker pull". If no tag is provided as - * part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted if - * was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, the - * default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service will - * download to the compute node before running the command line. There is a - * maximum size for the list of resource files. When the max size is exceeded, - * the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. Files listed under this element are located - * in the task's working directory. - * @member {array} [environmentSettings] A list of environment variable - * settings for the start task. - * @member {object} [userIdentity] The user identity under which the start task - * runs. If omitted, the task runs as a non-administrative user unique to the - * task. - * @member {string} [userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value is - * nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [maxTaskRetryCount] The maximum number of times the task - * may be retried. The Batch service retries a task if its exit code is - * nonzero. Note that this value specifically controls the number of retries. - * The Batch service will try the task once, and may then retry up to this - * limit. For example, if the maximum retry count is 3, Batch tries the task up - * to 4 times (one initial try and 3 retries). If the maximum retry count is 0, - * the Batch service does not retry the task. If the maximum retry count is -1, - * the Batch service retries the task without limit. - * @member {boolean} [waitForSuccess] Whether the Batch service should wait for - * the start task to complete successfully (that is, to exit with exit code 0) - * before scheduling any tasks on the compute node. If true and the start task - * fails on a compute node, the Batch service retries the start task up to its - * maximum retry count (maxTaskRetryCount). If the task has still not completed - * successfully after all retries, then the Batch service marks the compute - * node unusable, and will not schedule tasks to it. This condition can be - * detected via the node state and failure info details. If false, the Batch - * service will not wait for the start task to complete. In this case, other - * tasks can start executing on the compute node while the start task is still - * running; and even if the start task fails, new tasks will continue to be - * scheduled on the node. The default is false. + * @summary A task which is run when a compute node joins a pool in the Azure Batch service, or + * when the compute node is rebooted or reimaged. + * @description Batch will retry tasks when a recovery operation is triggered on a compute node. + * Examples of recovery operations include (but are not limited to) when an unhealthy compute node + * is rebooted or a compute node disappeared due to host failure. Retries due to recovery + * operations are independent of and are not counted against the maxTaskRetryCount. Even if the + * maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of + * this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and + * restarted without causing any corruption or duplicate data. The best practice for long running + * tasks is to use some form of checkpointing. */ export interface StartTask { + /** + * @summary The command line of the start task. + * @description The command line does not run under a shell, and therefore cannot take advantage + * of shell features such as environment variable expansion. If you want to take advantage of + * such features, you should invoke the shell in the command line, for example using "cmd /c + * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file + * paths, it should use a relative path (relative to the task working directory), or use the + * Batch provided environment variable + * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). + */ commandLine: string; + /** + * @summary The settings for the container under which the start task runs. + * @description When this is specified, all directories recursively below the + * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the + * container, all task environment variables are mapped into the container, and the task command + * line is executed in the container. + */ containerSettings?: TaskContainerSettings; + /** + * @summary A list of files that the Batch service will download to the compute node before + * running the command line. There is a maximum size for the list of resource files. When the + * max size is exceeded, the request will fail and the response error code will be + * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in + * size. This can be achieved using .zip files, Application Packages, or Docker Containers. + * @description Files listed under this element are located in the task's working directory. + */ resourceFiles?: ResourceFile[]; + /** + * @summary A list of environment variable settings for the start task. + */ environmentSettings?: EnvironmentSetting[]; + /** + * @summary The user identity under which the start task runs. + * @description If omitted, the task runs as a non-administrative user unique to the task. + */ userIdentity?: UserIdentity; + /** + * @summary The maximum number of times the task may be retried. + * @description The Batch service retries a task if its exit code is nonzero. Note that this + * value specifically controls the number of retries. The Batch service will try the task once, + * and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries + * the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the + * Batch service does not retry the task. If the maximum retry count is -1, the Batch service + * retries the task without limit. + */ maxTaskRetryCount?: number; + /** + * @summary Whether the Batch service should wait for the start task to complete successfully + * (that is, to exit with exit code 0) before scheduling any tasks on the compute node. + * @description If true and the start task fails on a compute node, the Batch service retries the + * start task up to its maximum retry count (maxTaskRetryCount). If the task has still not + * completed successfully after all retries, then the Batch service marks the compute node + * unusable, and will not schedule tasks to it. This condition can be detected via the node state + * and failure info details. If false, the Batch service will not wait for the start task to + * complete. In this case, other tasks can start executing on the compute node while the start + * task is still running; and even if the start task fails, new tasks will continue to be + * scheduled on the node. The default is false. + */ waitForSuccess?: boolean; } /** - * @class - * Initializes a new instance of the CertificateReference class. - * @constructor - * @summary A reference to a certificate to be installed on compute nodes in a - * pool. - * - * @member {string} thumbprint The thumbprint of the certificate. - * @member {string} thumbprintAlgorithm The algorithm with which the thumbprint - * is associated. This must be sha1. - * @member {string} [storeLocation] The location of the certificate store on - * the compute node into which to install the certificate. 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. Possible values include: 'currentUser', 'localMachine' - * @member {string} [storeName] The name of the certificate store on the - * compute node into which to install the certificate. This property is - * applicable only for pools configured with Windows nodes (that is, created - * with cloudServiceConfiguration, or with virtualMachineConfiguration using a - * Windows image reference). Common store names include: My, Root, CA, Trust, - * Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any - * custom store name can also be used. The default value is My. - * @member {array} [visibility] Which user accounts on the compute node should - * have access to the private data of the certificate. You can specify more - * than one visibility in this collection. The default is all accounts. + * @summary A reference to a certificate to be installed on compute nodes in a pool. */ export interface CertificateReference { + /** + * @summary The thumbprint of the certificate. + */ thumbprint: string; + /** + * @summary The algorithm with which the thumbprint is associated. This must be sha1. + */ thumbprintAlgorithm: string; + /** + * @summary 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. + * Possible values include: 'currentUser', 'localMachine' + */ storeLocation?: string; + /** + * @summary The name of the certificate store on the compute node into which to install the + * certificate. + * @description This property is applicable only for pools configured with Windows nodes (that + * is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a + * Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, + * TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be + * used. The default value is My. + */ storeName?: string; + /** + * @summary Which user accounts on the compute node should have access to the private data of the + * certificate. + * @description You can specify more than one visibility in this collection. The default is all + * accounts. + */ visibility?: string[]; } /** - * @class - * Initializes a new instance of the MetadataItem class. - * @constructor * @summary A name-value pair associated with a Batch service resource. - * - * The Batch service does not assign any meaning to this metadata; it is solely - * for the use of user code. - * - * @member {string} name The name of the metadata item. - * @member {string} value The value of the metadata item. + * @description The Batch service does not assign any meaning to this metadata; it is solely for + * the use of user code. */ export interface MetadataItem { + /** + * @summary The name of the metadata item. + */ name: string; + /** + * @summary The value of the metadata item. + */ value: string; } /** - * @class - * Initializes a new instance of the CloudServiceConfiguration class. - * @constructor - * @summary The configuration for nodes in a pool based on the Azure Cloud - * Services platform. - * - * @member {string} osFamily The Azure Guest OS family to be installed on the - * virtual machines in the pool. Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [osVersion] The Azure Guest OS version to be installed on - * the virtual machines in the pool. The default value is * which specifies the - * latest operating system version for the specified OS family. + * @summary The configuration for nodes in a pool based on the Azure Cloud Services platform. */ export interface CloudServiceConfiguration { + /** + * @summary The Azure Guest OS family to be installed on the virtual machines in the pool. + * @description Possible values are: + * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. + * 3 - OS Family 3, equivalent to Windows Server 2012. + * 4 - OS Family 4, equivalent to Windows Server 2012 R2. + * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, see Azure Guest OS + * Releases + * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). + */ osFamily: string; + /** + * @summary The Azure Guest OS version to be installed on the virtual machines in the pool. + * @description The default value is * which specifies the latest operating system version for + * the specified OS family. + */ osVersion?: string; } /** - * @class - * Initializes a new instance of the WindowsConfiguration class. - * @constructor * @summary Windows operating system settings to apply to the virtual machine. - * - * @member {boolean} [enableAutomaticUpdates] Whether automatic updates are - * enabled on the virtual machine. If omitted, the default value is true. */ export interface WindowsConfiguration { + /** + * @summary Whether automatic updates are enabled on the virtual machine. + * @description If omitted, the default value is true. + */ enableAutomaticUpdates?: boolean; } /** - * @class - * Initializes a new instance of the DataDisk class. - * @constructor - * @summary Settings which will be used by the data disks associated to compute - * nodes in the pool. - * - * @member {number} lun The logical unit number. The lun is used to uniquely - * identify each data disk. If attaching multiple disks, each should have a - * distinct lun. - * @member {string} [caching] The type of caching to be enabled for the data - * disks. The default value for caching is readwrite. For information about the - * caching options see: - * https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. - * Possible values include: 'none', 'readOnly', 'readWrite' - * @member {number} diskSizeGB The initial disk size in gigabytes. - * @member {string} [storageAccountType] The storage account type to be used - * for the data disk. If omitted, the default is "standard_lrs". Possible - * values include: 'StandardLRS', 'PremiumLRS' + * @summary Settings which will be used by the data disks associated to compute nodes in the pool. */ export interface DataDisk { + /** + * @summary The logical unit number. + * @description The lun is used to uniquely identify each data disk. If attaching multiple disks, + * each should have a distinct lun. + */ lun: number; + /** + * @summary The type of caching to be enabled for the data disks. + * @description The default value for caching is readwrite. For information about the caching + * options see: + * https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. + * Possible values include: 'none', 'readOnly', 'readWrite' + */ caching?: string; + /** + * @summary The initial disk size in gigabytes. + */ diskSizeGB: number; + /** + * @summary The storage account type to be used for the data disk. + * @description If omitted, the default is "standard_lrs". Possible values include: + * 'StandardLRS', 'PremiumLRS' + */ storageAccountType?: string; } /** - * @class - * Initializes a new instance of the ContainerConfiguration class. - * @constructor * @summary The configuration for container-enabled pools. - * - * @member {array} [containerImageNames] The collection of container image - * names. This is the full image reference, as would be specified to "docker - * pull". An image will be sourced from the default Docker registry unless the - * image is fully qualified with an alternative registry. - * @member {array} [containerRegistries] Additional private registries from - * which containers can be pulled. If any images must be downloaded from a - * private registry which requires credentials, then those credentials must be - * provided here. */ export interface ContainerConfiguration { + /** + * @summary The collection of container image names. + * @description This is the full image reference, as would be specified to "docker pull". An + * image will be sourced from the default Docker registry unless the image is fully qualified + * with an alternative registry. + */ containerImageNames?: string[]; + /** + * @summary Additional private registries from which containers can be pulled. + * @description If any images must be downloaded from a private registry which requires + * credentials, then those credentials must be provided here. + */ containerRegistries?: ContainerRegistry[]; } /** - * @class - * Initializes a new instance of the VirtualMachineConfiguration class. - * @constructor - * @summary The configuration for compute nodes in a pool based on the Azure - * Virtual Machines infrastructure. - * - * @member {object} imageReference A reference to the Azure Virtual Machines - * Marketplace image or the custom Virtual Machine image to use. - * @member {string} [imageReference.publisher] For example, Canonical or - * MicrosoftWindowsServer. - * @member {string} [imageReference.offer] For example, UbuntuServer or - * WindowsServer. - * @member {string} [imageReference.sku] For example, 14.04.0-LTS or - * 2012-R2-Datacenter. - * @member {string} [imageReference.version] A value of 'latest' can be - * specified to select the latest version of an image. If omitted, the default - * is 'latest'. - * @member {string} [imageReference.virtualMachineImageId] This property is - * mutually exclusive with other ImageReference properties. The virtual machine - * image must be in the same region and subscription as the Azure Batch - * account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} nodeAgentSKUId The SKU of the Batch node agent to be - * provisioned on compute nodes in the pool. The Batch node agent is a program - * that runs on each node in the pool, and provides the command-and-control - * interface between the node and the Batch service. There are different - * implementations of the node agent, known as SKUs, for different operating - * systems. You must specify a node agent SKU which matches the selected image - * reference. To get the list of supported node agent SKUs along with their - * list of verified image references, see the 'List supported node agent SKUs' - * operation. - * @member {object} [windowsConfiguration] Windows operating system settings on - * the virtual machine. This property must not be specified if the - * imageReference property specifies a Linux OS image. - * @member {boolean} [windowsConfiguration.enableAutomaticUpdates] If omitted, - * the default value is true. - * @member {array} [dataDisks] The configuration for data disks attached to the - * comptue nodes in the pool. 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. - * @member {string} [licenseType] The type of on-premises license to be used - * when deploying the operating system. This only applies to images that - * contain the Windows operating system, and should only be used when you hold - * valid on-premises licenses for the nodes which will be deployed. If omitted, - * no on-premises licensing discount is applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [containerConfiguration] The container configuration for - * the pool. If specified, setup is performed on each node in the pool to allow - * tasks to run in containers. All regular tasks and job manager tasks run on - * this pool must specify the containerSettings property, and all other tasks - * may specify it. - * @member {array} [containerConfiguration.containerImageNames] This is the - * full image reference, as would be specified to "docker pull". An image will - * be sourced from the default Docker registry unless the image is fully - * qualified with an alternative registry. - * @member {array} [containerConfiguration.containerRegistries] If any images - * must be downloaded from a private registry which requires credentials, then - * those credentials must be provided here. + * @summary The configuration for compute nodes in a pool based on the Azure Virtual Machines + * infrastructure. */ export interface VirtualMachineConfiguration { + /** + * @summary A reference to the Azure Virtual Machines Marketplace image or the custom Virtual + * Machine image to use. + */ imageReference: ImageReference; + /** + * @summary The SKU of the Batch node agent to be provisioned on compute nodes in the pool. + * @description The Batch node agent is a program that runs on each node in the pool, and + * provides the command-and-control interface between the node and the Batch service. There are + * different implementations of the node agent, known as SKUs, for different operating systems. + * You must specify a node agent SKU which matches the selected image reference. To get the list + * of supported node agent SKUs along with their list of verified image references, see the 'List + * supported node agent SKUs' operation. + */ nodeAgentSKUId: string; + /** + * @summary Windows operating system settings on the virtual machine. + * @description This property must not be specified if the imageReference property specifies a + * Linux OS image. + */ windowsConfiguration?: WindowsConfiguration; + /** + * @summary 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. 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. + */ dataDisks?: DataDisk[]; + /** + * @summary The type of on-premises license to be used when deploying the operating system. + * @description This only applies to images that contain the Windows operating system, and should + * only be used when you hold valid on-premises licenses for the nodes which will be deployed. If + * omitted, no on-premises licensing discount is applied. Values are: + * + * Windows_Server - The on-premises license is for Windows Server. + * Windows_Client - The on-premises license is for Windows Client. + + */ licenseType?: string; + /** + * @summary The container configuration for the pool. + * @description If specified, setup is performed on each node in the pool to allow tasks to run + * in containers. All regular tasks and job manager tasks run on this pool must specify the + * containerSettings property, and all other tasks may specify it. + */ containerConfiguration?: ContainerConfiguration; } /** - * @class - * Initializes a new instance of the NetworkSecurityGroupRule class. - * @constructor * @summary A network security group rule to apply to an inbound endpoint. - * - * @member {number} priority The priority for this rule. Priorities within a - * pool must be unique and are evaluated in order of priority. The lower the - * number the higher the priority. For example, rules could be specified with - * order numbers of 150, 250, and 350. The rule with the order number of 150 - * takes precedence over the rule that has an order of 250. Allowed priorities - * are 150 to 3500. If any reserved or duplicate values are provided the - * request fails with HTTP status code 400. - * @member {string} access The action that should be taken for a specified IP - * address, subnet range or tag. Possible values include: 'allow', 'deny' - * @member {string} sourceAddressPrefix The source address prefix or tag to - * match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), - * IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If - * any other values are provided the request fails with HTTP status code 400. */ export interface NetworkSecurityGroupRule { + /** + * @summary The priority for this rule. + * @description Priorities within a pool must be unique and are evaluated in order of priority. + * The lower the number the higher the priority. For example, rules could be specified with order + * numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the + * rule that has an order of 250. Allowed priorities are 150 to 3500. If any reserved or + * duplicate values are provided the request fails with HTTP status code 400. + */ priority: number; + /** + * @summary The action that should be taken for a specified IP address, subnet range or tag. + * @description Possible values include: 'allow', 'deny' + */ access: string; + /** + * @summary The source address prefix or tag to match for the rule. + * @description Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. + * 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the + * request fails with HTTP status code 400. + */ sourceAddressPrefix: string; } /** - * @class - * Initializes a new instance of the InboundNATPool class. - * @constructor - * @summary A inbound NAT pool that can be used to address specific ports on - * compute nodes in a Batch pool externally. - * - * @member {string} name The name of the endpoint. 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. - * @member {string} protocol The protocol of the endpoint. Possible values - * include: 'tcp', 'udp' - * @member {number} backendPort The port number on the compute node. This must - * be unique within a Batch pool. Acceptable values are between 1 and 65535 - * except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved - * values are provided the request fails with HTTP status code 400. - * @member {number} frontendPortRangeStart 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. 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. - * @member {number} frontendPortRangeEnd 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. 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. - * @member {array} [networkSecurityGroupRules] A list of network security group - * rules that will be applied to the endpoint. The maximum number of rules that - * can be specified across all the endpoints on a Batch pool is 25. If no - * network security group rules are specified, a default rule will be created - * to allow inbound access to the specified backendPort. If the maximum number - * of network security group rules is exceeded the request fails with HTTP - * status code 400. + * @summary A inbound NAT pool that can be used to address specific ports on compute nodes in a + * Batch pool externally. */ export interface InboundNATPool { + /** + * @summary The name of the endpoint. + * @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. + */ name: string; + /** + * @summary The protocol of the endpoint. + * @description Possible values include: 'tcp', 'udp' + */ protocol: string; + /** + * @summary The port number on the compute node. + * @description This must be unique within a Batch pool. Acceptable values are between 1 and + * 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are + * provided the request fails with HTTP status code 400. + */ backendPort: number; + /** + * @summary 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. Each range + * must contain at least 40 ports. If any reserved or overlapping values are provided the request + * fails with HTTP status code 400. + */ frontendPortRangeStart: number; + /** + * @summary 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. 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: number; + /** + * @summary A list of network security group rules that will be applied to the endpoint. + * @description The maximum number of rules that can be specified across all the endpoints on a + * Batch pool is 25. If no network security group rules are specified, a default rule will be + * created to allow inbound access to the specified backendPort. If the maximum number of network + * security group rules is exceeded the request fails with HTTP status code 400. + */ networkSecurityGroupRules?: NetworkSecurityGroupRule[]; } /** - * @class - * Initializes a new instance of the PoolEndpointConfiguration class. - * @constructor * @summary The endpoint configuration for a pool. - * - * @member {array} inboundNATPools A list of inbound NAT pools that can be used - * to address specific ports on an individual compute node externally. The - * maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. */ export interface PoolEndpointConfiguration { + /** + * @summary A list of inbound NAT pools that can be used to address specific ports on an + * individual compute node externally. + * @description The maximum number of inbound NAT pools per Batch pool is 5. If the maximum + * number of inbound NAT pools is exceeded the request fails with HTTP status code 400. + */ inboundNATPools: InboundNATPool[]; } /** - * @class - * Initializes a new instance of the NetworkConfiguration class. - * @constructor * The network configuration for a pool. - * - * @member {string} [subnetId] The ARM resource identifier of the virtual - * network subnet which the compute nodes of the pool will join. This is of the - * form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [dynamicVNetAssignmentScope] The scope of dynamic vnet - * assignment. Possible values include: 'none', 'job' - * @member {object} [endpointConfiguration] The configuration for endpoints on - * compute nodes in the Batch pool. Pool endpoint configuration is only - * supported on pools with the virtualMachineConfiguration property. - * @member {array} [endpointConfiguration.inboundNATPools] The maximum number - * of inbound NAT pools per Batch pool is 5. If the maximum number of inbound - * NAT pools is exceeded the request fails with HTTP status code 400. */ export interface NetworkConfiguration { + /** + * @summary The ARM resource identifier of the virtual network subnet which the compute nodes of + * the pool will join. + * @description This is of the form + * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. + * The virtual network must be in the same region and subscription as the Azure Batch account. + * The specified subnet should have enough free IP addresses to accommodate the number of nodes + * in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially + * allocate compute nodes, and a resize error will occur. For pools created with + * virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') + * are supported, but for pools created with cloudServiceConfiguration both ARM and classic + * virtual networks are supported. For more details, see: + * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration + */ subnetId?: string; + /** + * @summary The scope of dynamic vnet assignment. + * @description Possible values include: 'none', 'job' + */ dynamicVNetAssignmentScope?: string; + /** + * @summary The configuration for endpoints on compute nodes in the Batch pool. + * @description Pool endpoint configuration is only supported on pools with the + * virtualMachineConfiguration property. + */ endpointConfiguration?: PoolEndpointConfiguration; } /** - * @class - * Initializes a new instance of the PoolSpecification class. - * @constructor * @summary Specification for creating a new pool. - * - * @member {string} [displayName] The display name for the pool. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. - * @member {string} vmSize The size of the virtual machines in the pool. All - * virtual machines in a pool are the same size. For information about - * available sizes of virtual machines in pools, see Choose a VM size for - * compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} [cloudServiceConfiguration] The cloud service configuration - * for the pool. This property must be specified if the pool needs to be - * created with Azure PaaS VMs. This property and virtualMachineConfiguration - * are mutually exclusive and one of the properties must be specified. If - * neither is specified then the Batch service returns an error; if you are - * calling the REST API directly, the HTTP status code is 400 (Bad Request). - * This property cannot be specified if the Batch account was created with its - * poolAllocationMode property set to 'UserSubscription'. - * @member {string} [cloudServiceConfiguration.osFamily] Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [cloudServiceConfiguration.osVersion] The default value is - * * which specifies the latest operating system version for the specified OS - * family. - * @member {object} [virtualMachineConfiguration] The virtual machine - * configuration for the pool. This property must be specified if the pool - * needs to be created with Azure IaaS VMs. This property and - * cloudServiceConfiguration are mutually exclusive and one of the properties - * must be specified. If neither is specified then the Batch service returns an - * error; if you are calling the REST API directly, the HTTP status code is 400 - * (Bad Request). - * @member {object} [virtualMachineConfiguration.imageReference] - * @member {string} [virtualMachineConfiguration.imageReference.publisher] For - * example, Canonical or MicrosoftWindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.offer] For - * example, UbuntuServer or WindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.sku] For - * example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [virtualMachineConfiguration.imageReference.version] A - * value of 'latest' can be specified to select the latest version of an image. - * If omitted, the default is 'latest'. - * @member {string} - * [virtualMachineConfiguration.imageReference.virtualMachineImageId] This - * property is mutually exclusive with other ImageReference properties. The - * virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch node - * agent is a program that runs on each node in the pool, and provides the - * command-and-control interface between the node and the Batch service. There - * are different implementations of the node agent, known as SKUs, for - * different operating systems. You must specify a node agent SKU which matches - * the selected image reference. To get the list of supported node agent SKUs - * along with their list of verified image references, see the 'List supported - * node agent SKUs' operation. - * @member {object} [virtualMachineConfiguration.windowsConfiguration] This - * property must not be specified if the imageReference property specifies a - * Linux OS image. - * @member {boolean} - * [virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] If - * omitted, the default value is true. - * @member {array} [virtualMachineConfiguration.dataDisks] 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. - * @member {string} [virtualMachineConfiguration.licenseType] This only applies - * to images that contain the Windows operating system, and should only be used - * when you hold valid on-premises licenses for the nodes which will be - * deployed. If omitted, no on-premises licensing discount is applied. Values - * are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [virtualMachineConfiguration.containerConfiguration] If - * specified, setup is performed on each node in the pool to allow tasks to run - * in containers. All regular tasks and job manager tasks run on this pool must - * specify the containerSettings property, and all other tasks may specify it. - * @member {array} - * [virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [virtualMachineConfiguration.containerConfiguration.containerRegistries] If - * any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} [maxTasksPerNode] The maximum number of tasks that can run - * concurrently on a single compute node in the pool. The default value is 1. - * The maximum value of this setting depends on the size of the compute nodes - * in the pool (the vmSize setting). - * @member {object} [taskSchedulingPolicy] How tasks are distributed across - * compute nodes in a pool. - * @member {string} [taskSchedulingPolicy.nodeFillType] Possible values - * include: 'spread', 'pack' - * @member {moment.duration} [resizeTimeout] The timeout for allocation of - * compute nodes to the pool. This timeout applies only to manual scaling; it - * has no effect when enableAutoScale is set to true. The default value is 15 - * minutes. The minimum value is 5 minutes. If you specify a value less than 5 - * minutes, the Batch service rejects the request with an error; if you are - * calling the REST API directly, the HTTP status code is 400 (Bad Request). - * @member {number} [targetDedicatedNodes] The desired number of dedicated - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to true. If enableAutoScale is set to false, then you - * must set either targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} [targetLowPriorityNodes] The desired number of low-priority - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to true. If enableAutoScale is set to false, then you - * must set either targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} [enableAutoScale] Whether the pool size should - * automatically adjust over time. If false, at least one of - * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, - * the autoScaleFormula element is required. The pool automatically resizes - * according to the formula. The default value is false. - * @member {string} [autoScaleFormula] The formula for the desired number of - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to false. It is required if enableAutoScale is set to - * true. The formula is checked for validity before the pool is created. If the - * formula is not valid, the Batch service rejects the request with detailed - * error information. - * @member {moment.duration} [autoScaleEvaluationInterval] The time interval at - * which to automatically adjust the pool size according to the autoscale - * formula. The default value is 15 minutes. The minimum and maximum value are - * 5 minutes and 168 hours respectively. If you specify a value less than 5 - * minutes or greater than 168 hours, the Batch service rejects the request - * with an invalid property value error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {boolean} [enableInterNodeCommunication] Whether the pool permits - * direct communication between nodes. Enabling inter-node communication limits - * the maximum size of the pool due to deployment restrictions on the nodes of - * the pool. This may result in the pool not reaching its desired size. The - * default value is false. - * @member {object} [networkConfiguration] The network configuration for the - * pool. - * @member {string} [networkConfiguration.subnetId] This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [networkConfiguration.dynamicVNetAssignmentScope] Possible - * values include: 'none', 'job' - * @member {object} [networkConfiguration.endpointConfiguration] Pool endpoint - * configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} [networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [startTask] A task to run on each compute node as it joins - * the pool. The task runs when the node is added to the pool or when the node - * is restarted. - * @member {string} [startTask.commandLine] The command line does not run under - * a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure - * Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These - * additional options are supplied as arguments to the "docker create" command, - * in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [startTask.containerSettings.registry] This setting can be - * omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a - * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [startTask.userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically controls - * the number of retries. The Batch service will try the task once, and may - * then retry up to this limit. For example, if the maximum retry count is 3, - * Batch tries the task up to 4 times (one initial try and 3 retries). If the - * maximum retry count is 0, the Batch service does not retry the task. If the - * maximum retry count is -1, the Batch service retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task - * fails on a compute node, the Batch service retries the start task up to its - * maximum retry count (maxTaskRetryCount). If the task has still not completed - * successfully after all retries, then the Batch service marks the compute - * node unusable, and will not schedule tasks to it. This condition can be - * detected via the node state and failure info details. If false, the Batch - * service will not wait for the start task to complete. In this case, other - * tasks can start executing on the compute node while the start task is still - * running; and even if the start task fails, new tasks will continue to be - * scheduled on the node. The default is false. - * @member {array} [certificateReferences] A list of certificates to be - * installed on each compute node in the pool. For Windows compute nodes, the - * Batch service installs the certificates to the specified certificate store - * and location. 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. - * @member {array} [applicationPackageReferences] The list of application - * packages to be installed on each compute node in the pool. - * @member {array} [applicationLicenses] The list of application licenses the - * Batch service will make available on each compute node in the pool. The list - * of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} [userAccounts] The list of user accounts to be created on - * each node in the pool. - * @member {array} [metadata] A list of name-value pairs associated with the - * pool as metadata. The Batch service does not assign any meaning to metadata; - * it is solely for the use of user code. */ export interface PoolSpecification { + /** + * @summary The display name for the pool. + * @description The display name need not be unique and can contain any Unicode characters up to + * a maximum length of 1024. + */ displayName?: string; + /** + * @summary The size of the virtual machines in the pool. All virtual machines in a pool are the + * same size. + * @description For information about available sizes of virtual machines in pools, see Choose a + * VM size for compute nodes in an Azure Batch pool + * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). + */ vmSize: string; + /** + * @summary The cloud service configuration for the pool. + * @description This property must be specified if the pool needs to be created with Azure PaaS + * VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the + * properties must be specified. If neither is specified then the Batch service returns an error; + * if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). This + * property cannot be specified if the Batch account was created with its poolAllocationMode + * property set to 'UserSubscription'. + */ cloudServiceConfiguration?: CloudServiceConfiguration; + /** + * @summary The virtual machine configuration for the pool. + * @description This property must be specified if the pool needs to be created with Azure IaaS + * VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the + * properties must be specified. If neither is specified then the Batch service returns an error; + * if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). + */ virtualMachineConfiguration?: VirtualMachineConfiguration; + /** + * @summary The maximum number of tasks that can run concurrently on a single compute node in the + * pool. + * @description The default value is 1. The maximum value of this setting depends on the size of + * the compute nodes in the pool (the vmSize setting). + */ maxTasksPerNode?: number; + /** + * @summary How tasks are distributed across compute nodes in a pool. + */ taskSchedulingPolicy?: TaskSchedulingPolicy; + /** + * @summary The timeout for allocation of compute nodes to the pool. + * @description This timeout applies only to manual scaling; it has no effect when + * enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 + * minutes. If you specify a value less than 5 minutes, the Batch service rejects the request + * with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad + * Request). + */ resizeTimeout?: moment.Duration; + /** + * @summary The desired number of dedicated compute nodes in the pool. + * @description This property must not be specified if enableAutoScale is set to true. If + * enableAutoScale is set to false, then you must set either targetDedicatedNodes, + * targetLowPriorityNodes, or both. + */ targetDedicatedNodes?: number; + /** + * @summary The desired number of low-priority compute nodes in the pool. + * @description This property must not be specified if enableAutoScale is set to true. If + * enableAutoScale is set to false, then you must set either targetDedicatedNodes, + * targetLowPriorityNodes, or both. + */ targetLowPriorityNodes?: number; + /** + * @summary Whether the pool size should automatically adjust over time. + * @description If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be + * specified. If true, the autoScaleFormula element is required. The pool automatically resizes + * according to the formula. The default value is false. + */ enableAutoScale?: boolean; + /** + * @summary The formula for the desired number of compute nodes in the pool. + * @description This property must not be specified if enableAutoScale is set to false. It is + * required if enableAutoScale is set to true. The formula is checked for validity before the + * pool is created. If the formula is not valid, the Batch service rejects the request with + * detailed error information. + */ autoScaleFormula?: string; + /** + * @summary The time interval at which to automatically adjust the pool size according to the + * autoscale formula. + * @description The default value is 15 minutes. The minimum and maximum value are 5 minutes and + * 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, + * the Batch service rejects the request with an invalid property value error; if you are calling + * the REST API directly, the HTTP status code is 400 (Bad Request). + */ autoScaleEvaluationInterval?: moment.Duration; + /** + * @summary Whether the pool permits direct communication between nodes. + * @description Enabling inter-node communication limits the maximum size of the pool due to + * deployment restrictions on the nodes of the pool. This may result in the pool not reaching its + * desired size. The default value is false. + */ enableInterNodeCommunication?: boolean; + /** + * @summary The network configuration for the pool. + */ networkConfiguration?: NetworkConfiguration; + /** + * @summary A task to run on each compute node as it joins the pool. The task runs when the node + * is added to the pool or when the node is restarted. + */ startTask?: StartTask; + /** + * @summary A list of certificates to be installed on each compute node in the pool. + * @description For Windows compute nodes, the Batch service installs the certificates to the + * specified certificate store and location. 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. + */ certificateReferences?: CertificateReference[]; + /** + * @summary The list of application packages to be installed on each compute node in the pool. + */ applicationPackageReferences?: ApplicationPackageReference[]; + /** + * @summary The list of application licenses the Batch service will make available on each + * compute node in the pool. + * @description The list of application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, pool creation will + * fail. The permitted licenses available on the pool are 'maya', 'vray', '3dsmax', 'arnold'. An + * additional charge applies for each application license added to the pool. + */ applicationLicenses?: string[]; + /** + * @summary The list of user accounts to be created on each node in the pool. + */ userAccounts?: UserAccount[]; + /** + * @summary A list of name-value pairs associated with the pool as metadata. + * @description The Batch service does not assign any meaning to metadata; it is solely for the + * use of user code. + */ metadata?: MetadataItem[]; } /** - * @class - * Initializes a new instance of the AutoPoolSpecification class. - * @constructor - * @summary Specifies characteristics for a temporary 'auto pool'. The Batch - * service will create this auto pool when the job is submitted. - * - * @member {string} [autoPoolIdPrefix] A prefix to be added to the unique - * identifier when a pool is automatically created. The Batch service assigns - * each auto pool a unique identifier on creation. To distinguish between pools - * created for different purposes, you can specify this element to add a prefix - * to the ID that is assigned. The prefix can be up to 20 characters long. - * @member {string} poolLifetimeOption The minimum lifetime of created auto - * pools, and how multiple jobs on a schedule are assigned to pools. Possible - * values include: 'jobSchedule', 'job' - * @member {boolean} [keepAlive] Whether to keep an auto pool alive after its - * lifetime expires. If false, the Batch service deletes the pool once its - * lifetime (as determined by the poolLifetimeOption setting) expires; that is, - * when the job or job schedule completes. If true, the Batch service does not - * delete the pool automatically. It is up to the user to delete auto pools - * created with this option. - * @member {object} [pool] The pool specification for the auto pool. - * @member {string} [pool.displayName] The display name need not be unique and - * can contain any Unicode characters up to a maximum length of 1024. - * @member {string} [pool.vmSize] For information about available sizes of - * virtual machines in pools, see Choose a VM size for compute nodes in an - * Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} [pool.cloudServiceConfiguration] This property must be - * specified if the pool needs to be created with Azure PaaS VMs. This property - * and virtualMachineConfiguration are mutually exclusive and one of the - * properties must be specified. If neither is specified then the Batch service - * returns an error; if you are calling the REST API directly, the HTTP status - * code is 400 (Bad Request). This property cannot be specified if the Batch - * account was created with its poolAllocationMode property set to - * 'UserSubscription'. - * @member {string} [pool.cloudServiceConfiguration.osFamily] Possible values - * are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [pool.cloudServiceConfiguration.osVersion] The default - * value is * which specifies the latest operating system version for the - * specified OS family. - * @member {object} [pool.virtualMachineConfiguration] This property must be - * specified if the pool needs to be created with Azure IaaS VMs. This property - * and cloudServiceConfiguration are mutually exclusive and one of the - * properties must be specified. If neither is specified then the Batch service - * returns an error; if you are calling the REST API directly, the HTTP status - * code is 400 (Bad Request). - * @member {object} [pool.virtualMachineConfiguration.imageReference] - * @member {string} [pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} [pool.virtualMachineConfiguration.imageReference.offer] For - * example, UbuntuServer or WindowsServer. - * @member {string} [pool.virtualMachineConfiguration.imageReference.sku] For - * example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [pool.virtualMachineConfiguration.imageReference.version] A - * value of 'latest' can be specified to select the latest version of an image. - * If omitted, the default is 'latest'. - * @member {string} - * [pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] This - * property is mutually exclusive with other ImageReference properties. The - * virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} [pool.virtualMachineConfiguration.nodeAgentSKUId] The Batch - * node agent is a program that runs on each node in the pool, and provides the - * command-and-control interface between the node and the Batch service. There - * are different implementations of the node agent, known as SKUs, for - * different operating systems. You must specify a node agent SKU which matches - * the selected image reference. To get the list of supported node agent SKUs - * along with their list of verified image references, see the 'List supported - * node agent SKUs' operation. - * @member {object} [pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} [pool.virtualMachineConfiguration.dataDisks] 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. - * @member {string} [pool.virtualMachineConfiguration.licenseType] This only - * applies to images that contain the Windows operating system, and should only - * be used when you hold valid on-premises licenses for the nodes which will be - * deployed. If omitted, no on-premises licensing discount is applied. Values - * are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} [pool.maxTasksPerNode] The default value is 1. The maximum - * value of this setting depends on the size of the compute nodes in the pool - * (the vmSize setting). - * @member {object} [pool.taskSchedulingPolicy] - * @member {string} [pool.taskSchedulingPolicy.nodeFillType] Possible values - * include: 'spread', 'pack' - * @member {moment.duration} [pool.resizeTimeout] This timeout applies only to - * manual scaling; it has no effect when enableAutoScale is set to true. The - * default value is 15 minutes. The minimum value is 5 minutes. If you specify - * a value less than 5 minutes, the Batch service rejects the request with an - * error; if you are calling the REST API directly, the HTTP status code is 400 - * (Bad Request). - * @member {number} [pool.targetDedicatedNodes] This property must not be - * specified if enableAutoScale is set to true. If enableAutoScale is set to - * false, then you must set either targetDedicatedNodes, - * targetLowPriorityNodes, or both. - * @member {number} [pool.targetLowPriorityNodes] This property must not be - * specified if enableAutoScale is set to true. If enableAutoScale is set to - * false, then you must set either targetDedicatedNodes, - * targetLowPriorityNodes, or both. - * @member {boolean} [pool.enableAutoScale] If false, at least one of - * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, - * the autoScaleFormula element is required. The pool automatically resizes - * according to the formula. The default value is false. - * @member {string} [pool.autoScaleFormula] This property must not be specified - * if enableAutoScale is set to false. It is required if enableAutoScale is set - * to true. The formula is checked for validity before the pool is created. If - * the formula is not valid, the Batch service rejects the request with - * detailed error information. - * @member {moment.duration} [pool.autoScaleEvaluationInterval] The default - * value is 15 minutes. The minimum and maximum value are 5 minutes and 168 - * hours respectively. If you specify a value less than 5 minutes or greater - * than 168 hours, the Batch service rejects the request with an invalid - * property value error; if you are calling the REST API directly, the HTTP - * status code is 400 (Bad Request). - * @member {boolean} [pool.enableInterNodeCommunication] Enabling inter-node - * communication limits the maximum size of the pool due to deployment - * restrictions on the nodes of the pool. This may result in the pool not - * reaching its desired size. The default value is false. - * @member {object} [pool.networkConfiguration] - * @member {string} [pool.networkConfiguration.subnetId] This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} [pool.networkConfiguration.endpointConfiguration] Pool - * endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [pool.networkConfiguration.endpointConfiguration.inboundNATPools] The - * maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [pool.startTask] - * @member {string} [pool.startTask.commandLine] The command line does not run - * under a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [pool.startTask.containerSettings] When this is specified, - * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [pool.startTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [pool.startTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} [pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} [pool.startTask.containerSettings.registry.userName] - * @member {string} [pool.startTask.containerSettings.registry.password] - * @member {array} [pool.startTask.resourceFiles] Files listed under this - * element are located in the task's working directory. - * @member {array} [pool.startTask.environmentSettings] - * @member {object} [pool.startTask.userIdentity] If omitted, the task runs as - * a non-administrative user unique to the task. - * @member {string} [pool.startTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [pool.startTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [pool.startTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [pool.startTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [pool.startTask.maxTaskRetryCount] The Batch service - * retries a task if its exit code is nonzero. Note that this value - * specifically controls the number of retries. The Batch service will try the - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {boolean} [pool.startTask.waitForSuccess] If true and the start task - * fails on a compute node, the Batch service retries the start task up to its - * maximum retry count (maxTaskRetryCount). If the task has still not completed - * successfully after all retries, then the Batch service marks the compute - * node unusable, and will not schedule tasks to it. This condition can be - * detected via the node state and failure info details. If false, the Batch - * service will not wait for the start task to complete. In this case, other - * tasks can start executing on the compute node while the start task is still - * running; and even if the start task fails, new tasks will continue to be - * scheduled on the node. The default is false. - * @member {array} [pool.certificateReferences] For Windows compute nodes, the - * Batch service installs the certificates to the specified certificate store - * and location. 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. - * @member {array} [pool.applicationPackageReferences] - * @member {array} [pool.applicationLicenses] The list of application licenses - * must be a subset of available Batch service application licenses. If a - * license is requested which is not supported, pool creation will fail. The - * permitted licenses available on the pool are 'maya', 'vray', '3dsmax', - * 'arnold'. An additional charge applies for each application license added to - * the pool. - * @member {array} [pool.userAccounts] - * @member {array} [pool.metadata] The Batch service does not assign any - * meaning to metadata; it is solely for the use of user code. + * @summary Specifies characteristics for a temporary 'auto pool'. The Batch service will create + * this auto pool when the job is submitted. */ export interface AutoPoolSpecification { + /** + * @summary A prefix to be added to the unique identifier when a pool is automatically created. + * @description The Batch service assigns each auto pool a unique identifier on creation. To + * distinguish between pools created for different purposes, you can specify this element to add + * a prefix to the ID that is assigned. The prefix can be up to 20 characters long. + */ autoPoolIdPrefix?: string; + /** + * @summary The minimum lifetime of created auto pools, and how multiple jobs on a schedule are + * assigned to pools. + * @description Possible values include: 'jobSchedule', 'job' + */ poolLifetimeOption: string; + /** + * @summary Whether to keep an auto pool alive after its lifetime expires. + * @description If false, the Batch service deletes the pool once its lifetime (as determined by + * the poolLifetimeOption setting) expires; that is, when the job or job schedule completes. If + * true, the Batch service does not delete the pool automatically. It is up to the user to delete + * auto pools created with this option. + */ keepAlive?: boolean; + /** + * @summary The pool specification for the auto pool. + */ pool?: PoolSpecification; } /** - * @class - * Initializes a new instance of the PoolInformation class. - * @constructor * @summary Specifies how a job should be assigned to a pool. - * - * @member {string} [poolId] The ID of an existing pool. All the tasks of the - * job will run on the specified pool. You must ensure that the pool referenced - * by this property exists. If the pool does not exist at the time the Batch - * service tries to schedule a job, no tasks for the job will run until you - * create a pool with that id. Note that the Batch service will not reject the - * job request; it will simply not run tasks until the pool exists. You must - * specify either the pool ID or the auto pool specification, but not both. - * @member {object} [autoPoolSpecification] Characteristics for a temporary - * 'auto pool'. The Batch service will create this auto pool when the job is - * submitted. If auto pool creation fails, the Batch service moves the job to a - * completed state, and the pool creation error is set in the job's scheduling - * error property. The Batch service manages the lifetime (both creation and, - * unless keepAlive is specified, deletion) of the auto pool. Any user actions - * that affect the lifetime of the auto pool while the job is active will - * result in unexpected behavior. You must specify either the pool ID or the - * auto pool specification, but not both. - * @member {string} [autoPoolSpecification.autoPoolIdPrefix] The Batch service - * assigns each auto pool a unique identifier on creation. To distinguish - * between pools created for different purposes, you can specify this element - * to add a prefix to the ID that is assigned. The prefix can be up to 20 - * characters long. - * @member {string} [autoPoolSpecification.poolLifetimeOption] Possible values - * include: 'jobSchedule', 'job' - * @member {boolean} [autoPoolSpecification.keepAlive] If false, the Batch - * service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [autoPoolSpecification.pool] - * @member {string} [autoPoolSpecification.pool.displayName] The display name - * need not be unique and can contain any Unicode characters up to a maximum - * length of 1024. - * @member {string} [autoPoolSpecification.pool.vmSize] For information about - * available sizes of virtual machines in pools, see Choose a VM size for - * compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} [autoPoolSpecification.pool.cloudServiceConfiguration] This - * property must be specified if the pool needs to be created with Azure PaaS - * VMs. This property and virtualMachineConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). This property cannot be - * specified if the Batch account was created with its poolAllocationMode - * property set to 'UserSubscription'. - * @member {string} - * [autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] Possible - * values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] The default - * value is * which specifies the latest operating system version for the - * specified OS family. - * @member {object} [autoPoolSpecification.pool.virtualMachineConfiguration] - * This property must be specified if the pool needs to be created with Azure - * IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {object} - * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] The - * Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] 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. - * @member {string} - * [autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] This - * only applies to images that contain the Windows operating system, and should - * only be used when you hold valid on-premises licenses for the nodes which - * will be deployed. If omitted, no on-premises licensing discount is applied. - * Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} [autoPoolSpecification.pool.maxTasksPerNode] The default - * value is 1. The maximum value of this setting depends on the size of the - * compute nodes in the pool (the vmSize setting). - * @member {object} [autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] Possible - * values include: 'spread', 'pack' - * @member {moment.duration} [autoPoolSpecification.pool.resizeTimeout] This - * timeout applies only to manual scaling; it has no effect when - * enableAutoScale is set to true. The default value is 15 minutes. The minimum - * value is 5 minutes. If you specify a value less than 5 minutes, the Batch - * service rejects the request with an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {number} [autoPoolSpecification.pool.targetDedicatedNodes] This - * property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} [autoPoolSpecification.pool.targetLowPriorityNodes] This - * property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} [autoPoolSpecification.pool.enableAutoScale] If false, at - * least one of targetDedicateNodes and targetLowPriorityNodes must be - * specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} [autoPoolSpecification.pool.autoScaleFormula] This property - * must not be specified if enableAutoScale is set to false. It is required if - * enableAutoScale is set to true. The formula is checked for validity before - * the pool is created. If the formula is not valid, the Batch service rejects - * the request with detailed error information. - * @member {moment.duration} - * [autoPoolSpecification.pool.autoScaleEvaluationInterval] The default value - * is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours - * respectively. If you specify a value less than 5 minutes or greater than 168 - * hours, the Batch service rejects the request with an invalid property value - * error; if you are calling the REST API directly, the HTTP status code is 400 - * (Bad Request). - * @member {boolean} [autoPoolSpecification.pool.enableInterNodeCommunication] - * Enabling inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} [autoPoolSpecification.pool.networkConfiguration] - * @member {string} [autoPoolSpecification.pool.networkConfiguration.subnetId] - * This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] Pool - * endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [autoPoolSpecification.pool.startTask] - * @member {string} [autoPoolSpecification.pool.startTask.commandLine] The - * command line does not run under a shell, and therefore cannot take advantage - * of shell features such as environment variable expansion. If you want to - * take advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [autoPoolSpecification.pool.startTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [autoPoolSpecification.pool.startTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no tag - * is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [autoPoolSpecification.pool.startTask.containerSettings.registry] This - * setting can be omitted if was already provided at pool creation. - * @member {string} - * [autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} [autoPoolSpecification.pool.startTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * @member {array} [autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} [autoPoolSpecification.pool.startTask.userIdentity] If - * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} - * [autoPoolSpecification.pool.startTask.userIdentity.userName] The userName - * and autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} - * [autoPoolSpecification.pool.startTask.userIdentity.autoUser] The userName - * and autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} - * [autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] The - * default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [autoPoolSpecification.pool.startTask.maxTaskRetryCount] - * The Batch service retries a task if its exit code is nonzero. Note that this - * value specifically controls the number of retries. The Batch service will - * try the task once, and may then retry up to this limit. For example, if the - * maximum retry count is 3, Batch tries the task up to 4 times (one initial - * try and 3 retries). If the maximum retry count is 0, the Batch service does - * not retry the task. If the maximum retry count is -1, the Batch service - * retries the task without limit. - * @member {boolean} [autoPoolSpecification.pool.startTask.waitForSuccess] If - * true and the start task fails on a compute node, the Batch service retries - * the start task up to its maximum retry count (maxTaskRetryCount). If the - * task has still not completed successfully after all retries, then the Batch - * service marks the compute node unusable, and will not schedule tasks to it. - * This condition can be detected via the node state and failure info details. - * If false, the Batch service will not wait for the start task to complete. In - * this case, other tasks can start executing on the compute node while the - * start task is still running; and even if the start task fails, new tasks - * will continue to be scheduled on the node. The default is false. - * @member {array} [autoPoolSpecification.pool.certificateReferences] For - * Windows compute nodes, the Batch service installs the certificates to the - * specified certificate store and location. 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. - * @member {array} [autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [autoPoolSpecification.pool.applicationLicenses] The list of - * application licenses must be a subset of available Batch service application - * licenses. If a license is requested which is not supported, pool creation - * will fail. The permitted licenses available on the pool are 'maya', 'vray', - * '3dsmax', 'arnold'. An additional charge applies for each application - * license added to the pool. - * @member {array} [autoPoolSpecification.pool.userAccounts] - * @member {array} [autoPoolSpecification.pool.metadata] The Batch service does - * not assign any meaning to metadata; it is solely for the use of user code. */ export interface PoolInformation { + /** + * @summary The ID of an existing pool. All the tasks of the job will run on the specified pool. + * @description You must ensure that the pool referenced by this property exists. If the pool + * does not exist at the time the Batch service tries to schedule a job, no tasks for the job + * will run until you create a pool with that id. Note that the Batch service will not reject the + * job request; it will simply not run tasks until the pool exists. You must specify either the + * pool ID or the auto pool specification, but not both. + */ poolId?: string; + /** + * @summary Characteristics for a temporary 'auto pool'. The Batch service will create this auto + * pool when the job is submitted. + * @description If auto pool creation fails, the Batch service moves the job to a completed + * state, and the pool creation error is set in the job's scheduling error property. The Batch + * service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of + * the auto pool. Any user actions that affect the lifetime of the auto pool while the job is + * active will result in unexpected behavior. You must specify either the pool ID or the auto + * pool specification, but not both. + */ autoPoolSpecification?: AutoPoolSpecification; } /** - * @class - * Initializes a new instance of the JobSpecification class. - * @constructor * @summary Specifies details of the jobs to be created on a schedule. - * - * @member {number} [priority] The priority of jobs created under this - * schedule. Priority values can range from -1000 to 1000, with -1000 being the - * lowest priority and 1000 being the highest priority. The default value is 0. - * This priority is used as the default for all jobs under the job schedule. - * You can update a job's priority after it has been created using by using the - * update job API. - * @member {string} [displayName] The display name for jobs created under this - * schedule. The name need not be unique and can contain any Unicode characters - * up to a maximum length of 1024. - * @member {boolean} [usesTaskDependencies] Whether tasks in the job can define - * dependencies on each other. The default is false. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in a job created under this schedule are in the - * completed state. 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. Possible values include: - * 'noAction', 'terminateJob' - * @member {string} [onTaskFailure] 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. The default is noaction. - * Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [networkConfiguration] The network configuration for the - * job. - * @member {string} [networkConfiguration.subnetId] This is only supported for - * jobs running on VirtualMachineConfiguration pools. This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes which will run tasks from the job. For more - * details, see - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [constraints] The execution constraints for jobs created - * under this schedule. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does not - * complete within the time limit, the Batch service terminates it and any - * tasks that are still running. In this case, the termination reason will be - * MaxWallClockTimeExpiry. If this property is not specified, there is no time - * limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries. The Batch service will try each - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries a task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * tasks. If the maximum retry count is -1, the Batch service retries tasks - * without limit. The default value is 0 (no retries). - * @member {object} [jobManagerTask] The details of a Job Manager task to be - * launched when a job is started under this schedule. If the job does not - * specify a Job Manager task, the user must explicitly add tasks to the job - * using the Task API. If the job does specify a Job Manager task, the Batch - * service creates the Job Manager task when the job is created, and will try - * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobManagerTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot contain - * more than 64 characters. - * @member {string} [jobManagerTask.displayName] It need not be unique and can - * contain any Unicode characters up to a maximum length of 1024. - * @member {string} [jobManagerTask.commandLine] The command line does not run - * under a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobManagerTask.containerSettings] If the pool that will - * run this task has containerConfiguration set, this must be set as well. If - * the pool that will run this task doesn't have containerConfiguration set, - * this must not be set. When this is specified, all directories recursively - * below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the - * node) are mapped into the container, all task environment variables are - * mapped into the container, and the task command line is executed in the - * container. - * @member {string} [jobManagerTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} [jobManagerTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} [jobManagerTask.containerSettings.registry.userName] - * @member {string} [jobManagerTask.containerSettings.registry.password] - * @member {array} [jobManagerTask.resourceFiles] Files listed under this - * element are located in the task's working directory. There is a maximum size - * for the list of resource files. When the max size is exceeded, the request - * will fail and the response error code will be RequestEntityTooLarge. If this - * occurs, the collection of ResourceFiles must be reduced in size. This can be - * achieved using .zip files, Application Packages, or Docker Containers. - * @member {array} [jobManagerTask.outputFiles] For multi-instance tasks, the - * files will only be uploaded from the compute node on which the primary task - * is executed. - * @member {array} [jobManagerTask.environmentSettings] - * @member {object} [jobManagerTask.constraints] - * @member {moment.duration} [jobManagerTask.constraints.maxWallClockTime] If - * this is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} [jobManagerTask.constraints.retentionTime] The - * default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {number} [jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobManagerTask.killJobOnCompletion] If true, when the Job - * Manager task completes, the Batch service marks the job as complete. If any - * tasks are still running at this time (other than Job Release), those tasks - * are terminated. If false, the completion of the Job Manager task does not - * affect the job status. In this case, you should either use the - * onAllTasksComplete attribute to terminate the job, or have a client or user - * terminate the job explicitly. An example of this is if the Job Manager - * creates a set of tasks but then takes no further role in their execution. - * The default value is true. If you are using the onAllTasksComplete and - * onTaskFailure attributes to control job lifetime, and using the Job Manager - * task only to create the tasks for the job (not to monitor progress), then it - * is important to set killJobOnCompletion to false. - * @member {object} [jobManagerTask.userIdentity] If omitted, the task runs as - * a non-administrative user unique to the task. - * @member {string} [jobManagerTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [jobManagerTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobManagerTask.runExclusive] If true, no other tasks will - * run on the same compute node for as long as the Job Manager is running. If - * false, other tasks can run simultaneously with the Job Manager on a compute - * node. The Job Manager task counts normally against the node's concurrent - * task limit, so this is only relevant if the node allows multiple concurrent - * tasks. The default value is true. - * @member {array} [jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the existing - * copy on the compute node is used. If a referenced application package cannot - * be installed, for example because the package has been deleted or because - * download failed, the task fails. - * @member {object} [jobManagerTask.authenticationTokenSettings] If this - * property is set, the Batch service provides the task with an authentication - * token which can be used to authenticate Batch service operations without - * requiring an account access key. The token is provided via the - * AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the - * task can carry out using the token depend on the settings. For example, a - * task can request job permissions in order to add other tasks to the job, or - * check the status of the job or of other tasks under the job. - * @member {array} [jobManagerTask.authenticationTokenSettings.access] The - * authentication token grants access to a limited set of Batch service - * operations. Currently the only supported value for the access property is - * 'job', which grants access to all operations related to the job which - * contains the task. - * @member {boolean} [jobManagerTask.allowLowPriorityNode] The default value is - * true. - * @member {object} [jobPreparationTask] The Job Preparation task for jobs - * created under this schedule. If a job has a Job Preparation task, the Batch - * service will run the Job Preparation task on a compute node before starting - * any tasks of that job on that compute node. - * @member {string} [jobPreparationTask.id] The ID can contain any combination - * of alphanumeric characters including hyphens and underscores and cannot - * contain more than 64 characters. If you do not specify this property, the - * Batch service assigns a default value of 'jobpreparation'. No other task in - * the job can have the same ID as the Job Preparation task. If you try to - * submit a task with the same id, the Batch service rejects the request with - * error code TaskIdSameAsJobPreparationTask; if you are calling the REST API - * directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobPreparationTask.commandLine] The command line does not - * run under a shell, and therefore cannot take advantage of shell features - * such as environment variable expansion. If you want to take advantage of - * such features, you should invoke the shell in the command line, for example - * using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If - * the command line refers to file paths, it should use a relative path - * (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobPreparationTask.containerSettings] When this is - * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the - * root of Azure Batch directories on the node) are mapped into the container, - * all task environment variables are mapped into the container, and the task - * command line is executed in the container. - * @member {string} [jobPreparationTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no tag - * is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} [jobPreparationTask.containerSettings.registry] This - * setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobPreparationTask.containerSettings.registry.registryServer] If omitted, - * the default is "docker.io". - * @member {string} [jobPreparationTask.containerSettings.registry.userName] - * @member {string} [jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobPreparationTask.resourceFiles] Files listed under this - * element are located in the task's working directory. There is a maximum - * size for the list of resource files. When the max size is exceeded, the - * request will fail and the response error code will be RequestEntityTooLarge. - * If this occurs, the collection of ResourceFiles must be reduced in size. - * This can be achieved using .zip files, Application Packages, or Docker - * Containers. - * @member {array} [jobPreparationTask.environmentSettings] - * @member {object} [jobPreparationTask.constraints] - * @member {moment.duration} [jobPreparationTask.constraints.maxWallClockTime] - * If this is not specified, there is no time limit on how long the task may - * run. - * @member {moment.duration} [jobPreparationTask.constraints.retentionTime] The - * default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note - * that this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobPreparationTask.waitForSuccess] If true and the Job - * Preparation task fails on a compute node, the Batch service retries the Job - * Preparation task up to its maximum retry count (as specified in the - * constraints element). If the task has still not completed successfully after - * all retries, then the Batch service will not schedule tasks of the job to - * the compute node. The compute node remains active and eligible to run tasks - * of other jobs. If false, the Batch service will not wait for the Job - * Preparation task to complete. In this case, other tasks of the job can start - * executing on the compute node while the Job Preparation task is still - * running; and even if the Job Preparation task fails, new tasks will continue - * to be scheduled on the node. The default value is true. - * @member {object} [jobPreparationTask.userIdentity] If omitted, the task runs - * as a non-administrative user unique to the task on Windows nodes, or a a - * non-administrative user unique to the pool on Linux nodes. - * @member {string} [jobPreparationTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [jobPreparationTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [jobPreparationTask.userIdentity.autoUser.scope] The - * default value is task. Possible values include: 'task', 'pool' - * @member {string} [jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The Job - * Preparation task is always rerun if a compute node is reimaged, or if the - * Job Preparation task did not complete (e.g. because the reboot occurred - * while the task was running). Therefore, you should always write a Job - * Preparation task to be idempotent and to behave correctly if run multiple - * times. The default value is true. - * @member {object} [jobReleaseTask] The Job Release task for jobs created - * under this schedule. The primary purpose of the Job Release task is to undo - * changes to compute nodes made by the Job Preparation task. Example - * activities include deleting local files, or shutting down services that were - * started as part of job preparation. A Job Release task cannot be specified - * without also specifying a Job Preparation task for the job. The Batch - * service runs the Job Release task on the compute nodes that have run the Job - * Preparation task. - * @member {string} [jobReleaseTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot contain - * more than 64 characters. If you do not specify this property, the Batch - * service assigns a default value of 'jobrelease'. No other task in the job - * can have the same ID as the Job Release task. If you try to submit a task - * with the same id, the Batch service rejects the request with error code - * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the - * HTTP status code is 409 (Conflict). - * @member {string} [jobReleaseTask.commandLine] The command line does not run - * under a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobReleaseTask.containerSettings] When this is specified, - * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [jobReleaseTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} [jobReleaseTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} [jobReleaseTask.containerSettings.registry.userName] - * @member {string} [jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobReleaseTask.resourceFiles] Files listed under this - * element are located in the task's working directory. - * @member {array} [jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobReleaseTask.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the compute - * node is removed or the job is deleted. - * @member {object} [jobReleaseTask.userIdentity] If omitted, the task runs as - * a non-administrative user unique to the task. - * @member {string} [jobReleaseTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [jobReleaseTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [commonEnvironmentSettings] A list of common environment - * variable settings. These environment variables are set for all tasks in jobs - * created under this schedule (including the Job Manager, Job Preparation and - * Job Release tasks). Individual tasks can override an environment setting - * specified here by specifying the same setting name with a different value. - * @member {object} poolInfo The pool on which the Batch service runs the tasks - * of jobs created under this schedule. - * @member {string} [poolInfo.poolId] You must ensure that the pool referenced - * by this property exists. If the pool does not exist at the time the Batch - * service tries to schedule a job, no tasks for the job will run until you - * create a pool with that id. Note that the Batch service will not reject the - * job request; it will simply not run tasks until the pool exists. You must - * specify either the pool ID or the auto pool specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation - * fails, the Batch service moves the job to a completed state, and the pool - * creation error is set in the job's scheduling error property. The Batch - * service manages the lifetime (both creation and, unless keepAlive is - * specified, deletion) of the auto pool. Any user actions that affect the - * lifetime of the auto pool while the job is active will result in unexpected - * behavior. You must specify either the pool ID or the auto pool - * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The Batch - * service assigns each auto pool a unique identifier on creation. To - * distinguish between pools created for different purposes, you can specify - * this element to add a prefix to the ID that is assigned. The prefix can be - * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] - * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For - * information about available sizes of virtual machines in pools, see Choose a - * VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This - * property must be specified if the pool needs to be created with Azure PaaS - * VMs. This property and virtualMachineConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). This property cannot be - * specified if the Batch account was created with its poolAllocationMode - * property set to 'UserSubscription'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] - * Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] - * The default value is * which specifies the latest operating system version - * for the specified OS family. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This - * property must be specified if the pool needs to be created with Azure IaaS - * VMs. This property and cloudServiceConfiguration are mutually exclusive and - * one of the properties must be specified. If neither is specified then the - * Batch service returns an error; if you are calling the REST API directly, - * the HTTP status code is 400 (Bad Request). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] - * 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. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] - * This only applies to images that contain the Windows operating system, and - * should only be used when you hold valid on-premises licenses for the nodes - * which will be deployed. If omitted, no on-premises licensing discount is - * applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size of - * the compute nodes in the pool (the vmSize setting). - * @member {object} [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] - * Possible values include: 'spread', 'pack' - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies - * only to manual scaling; it has no effect when enableAutoScale is set to - * true. The default value is 15 minutes. The minimum value is 5 minutes. If - * you specify a value less than 5 minutes, the Batch service rejects the - * request with an error; if you are calling the REST API directly, the HTTP - * status code is 400 (Bad Request). - * @member {number} [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} - * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property - * must not be specified if enableAutoScale is set to true. If enableAutoScale - * is set to false, then you must set either targetDedicatedNodes, - * targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] This - * property must not be specified if enableAutoScale is set to false. It is - * required if enableAutoScale is set to true. The formula is checked for - * validity before the pool is created. If the formula is not valid, the Batch - * service rejects the request with detailed error information. - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The - * default value is 15 minutes. The minimum and maximum value are 5 minutes and - * 168 hours respectively. If you specify a value less than 5 minutes or - * greater than 168 hours, the Batch service rejects the request with an - * invalid property value error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] Enabling - * inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This is - * of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] - * Pool endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} [poolInfo.autoPoolSpecification.pool.startTask.commandLine] - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When this - * is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR - * (the root of Azure Batch directories on the node) are mapped into the - * container, all task environment variables are mapped into the container, and - * the task command line is executed in the container. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] - * This is the full image reference, as would be specified to "docker pull". If - * no tag is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] - * This setting can be omitted if was already provided at pool creation. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed - * under this element are located in the task's working directory. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, the - * task runs as a non-administrative user unique to the task. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] - * The default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} - * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The Batch - * service retries a task if its exit code is nonzero. Note that this value - * specifically controls the number of retries. The Batch service will try the - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and - * the start task fails on a compute node, the Batch service retries the start - * task up to its maximum retry count (maxTaskRetryCount). If the task has - * still not completed successfully after all retries, then the Batch service - * marks the compute node unusable, and will not schedule tasks to it. This - * condition can be detected via the node state and failure info details. If - * false, the Batch service will not wait for the start task to complete. In - * this case, other tasks can start executing on the compute node while the - * start task is still running; and even if the start task fails, new tasks - * will continue to be scheduled on the node. The default is false. - * @member {array} [poolInfo.autoPoolSpecification.pool.certificateReferences] - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch - * service does not assign any meaning to metadata; it is solely for the use of - * user code. - * @member {array} [metadata] A list of name-value pairs associated with each - * job created under this schedule as metadata. The Batch service does not - * assign any meaning to metadata; it is solely for the use of user code. */ export interface JobSpecification { + /** + * @summary The priority of jobs created under this schedule. + * @description Priority values can range from -1000 to 1000, with -1000 being the lowest + * priority and 1000 being the highest priority. The default value is 0. This priority is used as + * the default for all jobs under the job schedule. You can update a job's priority after it has + * been created using by using the update job API. + */ priority?: number; + /** + * @summary The display name for jobs created under this schedule. + * @description The name need not be unique and can contain any Unicode characters up to a + * maximum length of 1024. + */ displayName?: string; + /** + * @summary Whether tasks in the job can define dependencies on each other. The default is false. + */ usesTaskDependencies?: boolean; + /** + * @summary 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. Possible values include: 'noAction', + * 'terminateJob' + */ onAllTasksComplete?: string; + /** + * @summary 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. Possible values include: 'noAction', + * 'performExitOptionsJobAction' + */ onTaskFailure?: string; + /** + * @summary The network configuration for the job. + */ networkConfiguration?: JobNetworkConfiguration; + /** + * @summary The execution constraints for jobs created under this schedule. + */ constraints?: JobConstraints; + /** + * @summary The details of a Job Manager task to be launched when a job is started under this + * schedule. + * @description If the job does not specify a Job Manager task, the user must explicitly add + * tasks to the job using the Task API. If the job does specify a Job Manager task, the Batch + * service creates the Job Manager task when the job is created, and will try to schedule the Job + * Manager task before scheduling other tasks in the job. + */ jobManagerTask?: JobManagerTask; + /** + * @summary The Job Preparation task for jobs created under this schedule. + * @description If a job has a Job Preparation task, the Batch service will run the Job + * Preparation task on a compute node before starting any tasks of that job on that compute node. + */ jobPreparationTask?: JobPreparationTask; + /** + * @summary The Job Release task for jobs created under this schedule. + * @description The primary purpose of the Job Release task is to undo changes to compute nodes + * made by the Job Preparation task. Example activities include deleting local files, or shutting + * down services that were started as part of job preparation. A Job Release task cannot be + * specified without also specifying a Job Preparation task for the job. The Batch service runs + * the Job Release task on the compute nodes that have run the Job Preparation task. + */ jobReleaseTask?: JobReleaseTask; + /** + * @summary A list of common environment variable settings. These environment variables are set + * for all tasks in jobs created under this schedule (including the Job Manager, Job Preparation + * and Job Release tasks). + * @description Individual tasks can override an environment setting specified here by specifying + * the same setting name with a different value. + */ commonEnvironmentSettings?: EnvironmentSetting[]; + /** + * @summary The pool on which the Batch service runs the tasks of jobs created under this + * schedule. + */ poolInfo: PoolInformation; + /** + * @summary A list of name-value pairs associated with each job created under this schedule as + * metadata. + * @description The Batch service does not assign any meaning to metadata; it is solely for the + * use of user code. + */ metadata?: MetadataItem[]; } /** - * @class - * Initializes a new instance of the RecentJob class. - * @constructor - * @summary Information about the most recent job to run under the job - * schedule. - * - * @member {string} [id] The ID of the job. - * @member {string} [url] The URL of the job. + * @summary Information about the most recent job to run under the job schedule. */ export interface RecentJob { + /** + * @summary The ID of the job. + */ id?: string; + /** + * @summary The URL of the job. + */ url?: string; } /** - * @class - * Initializes a new instance of the JobScheduleExecutionInformation class. - * @constructor - * @summary Contains information about jobs that have been and will be run - * under a job schedule. - * - * @member {date} [nextRunTime] The next time at which a job will be created - * under this schedule. This property is meaningful only if the schedule is in - * the active state when the time comes around. For example, if the schedule is - * disabled, no job will be created at nextRunTime unless the job is enabled - * before then. - * @member {object} [recentJob] Information about the most recent job under the - * job schedule. This property is present only if the at least one job has run - * under the schedule. - * @member {string} [recentJob.id] - * @member {string} [recentJob.url] - * @member {date} [endTime] The time at which the schedule ended. This property - * is set only if the job schedule is in the completed state. + * @summary Contains information about jobs that have been and will be run under a job schedule. */ export interface JobScheduleExecutionInformation { + /** + * @summary The next time at which a job will be created under this schedule. + * @description This property is meaningful only if the schedule is in the active state when the + * time comes around. For example, if the schedule is disabled, no job will be created at + * nextRunTime unless the job is enabled before then. + */ nextRunTime?: Date; + /** + * @summary Information about the most recent job under the job schedule. + * @description This property is present only if the at least one job has run under the schedule. + */ recentJob?: RecentJob; + /** + * @summary The time at which the schedule ended. + * @description This property is set only if the job schedule is in the completed state. + */ endTime?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleStatistics class. - * @constructor * @summary Resource usage statistics for a job schedule. - * - * @member {string} url The URL of the statistics. - * @member {date} startTime The start time of the time range covered by the - * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. - * @member {moment.duration} userCPUTime The total user mode CPU time (summed - * across all cores and all compute nodes) consumed by all tasks in all jobs - * created under the schedule. - * @member {moment.duration} kernelCPUTime The total kernel mode CPU time - * (summed across all cores and all compute nodes) consumed by all tasks in all - * jobs created under the schedule. - * @member {moment.duration} wallClockTime The total wall clock time of all the - * tasks in all the jobs created under the schedule. The wall clock time is the - * elapsed time from when the task started running on a compute node to when it - * finished (or to the last time the statistics were updated, if the task had - * not finished by then). If a task was retried, this includes the wall clock - * time of all the task retries. - * @member {number} readIOps The total number of disk read operations made by - * all tasks in all jobs created under the schedule. - * @member {number} writeIOps The total number of disk write operations made by - * all tasks in all jobs created under the schedule. - * @member {number} readIOGiB The total gibibytes read from disk by all tasks - * in all jobs created under the schedule. - * @member {number} writeIOGiB The total gibibytes written to disk by all tasks - * in all jobs created under the schedule. - * @member {number} numSucceededTasks The total number of tasks successfully - * completed during the given time range in jobs created under the schedule. A - * task completes successfully if it returns exit code 0. - * @member {number} numFailedTasks The total number of tasks that failed during - * the given time range in jobs created under the schedule. A task fails if it - * exhausts its maximum retry count without returning exit code 0. - * @member {number} numTaskRetries The total number of retries during the given - * time range on all tasks in all jobs created under the schedule. - * @member {moment.duration} waitTime The total wait time of all tasks in all - * jobs created under the schedule. The wait time for a task is defined as the - * elapsed time between the creation of the task and the start of task - * execution. (If the task is retried due to failures, the wait time is the - * time to the most recent task execution.). This value is only reported in the - * account lifetime statistics; it is not included in the job statistics. */ export interface JobScheduleStatistics { + /** + * @summary The URL of the statistics. + */ url: string; + /** + * @summary The start time of the time range covered by the statistics. + */ startTime: Date; + /** + * @summary The time at which the statistics were last updated. All statistics are limited to the + * range between startTime and lastUpdateTime. + */ lastUpdateTime: Date; + /** + * @summary The total user mode CPU time (summed across all cores and all compute nodes) consumed + * by all tasks in all jobs created under the schedule. + */ userCPUTime: moment.Duration; + /** + * @summary The total kernel mode CPU time (summed across all cores and all compute nodes) + * consumed by all tasks in all jobs created under the schedule. + */ kernelCPUTime: moment.Duration; + /** + * @summary The total wall clock time of all the tasks in all the jobs created under the + * schedule. + * @description The wall clock time is the elapsed time from when the task started running on a + * compute node to when it finished (or to the last time the statistics were updated, if the task + * had not finished by then). If a task was retried, this includes the wall clock time of all the + * task retries. + */ wallClockTime: moment.Duration; + /** + * @summary The total number of disk read operations made by all tasks in all jobs created under + * the schedule. + */ readIOps: number; + /** + * @summary The total number of disk write operations made by all tasks in all jobs created under + * the schedule. + */ writeIOps: number; + /** + * @summary The total gibibytes read from disk by all tasks in all jobs created under the + * schedule. + */ readIOGiB: number; + /** + * @summary The total gibibytes written to disk by all tasks in all jobs created under the + * schedule. + */ writeIOGiB: number; + /** + * @summary The total number of tasks successfully completed during the given time range in jobs + * created under the schedule. A task completes successfully if it returns exit code 0. + */ numSucceededTasks: number; + /** + * @summary The total number of tasks that failed during the given time range in jobs created + * under the schedule. A task fails if it exhausts its maximum retry count without returning exit + * code 0. + */ numFailedTasks: number; + /** + * @summary The total number of retries during the given time range on all tasks in all jobs + * created under the schedule. + */ numTaskRetries: number; + /** + * @summary The total wait time of all tasks in all jobs created under the schedule. The wait + * time for a task is defined as the elapsed time between the creation of the task and the start + * of task execution. (If the task is retried due to failures, the wait time is the time to the + * most recent task execution.) + * @description This value is only reported in the account lifetime statistics; it is not + * included in the job statistics. + */ waitTime: moment.Duration; } /** - * @class - * Initializes a new instance of the CloudJobSchedule class. - * @constructor - * @summary A job schedule that allows recurring jobs by specifying when to run - * jobs and a specification used to create each job. - * - * @member {string} [id] A string that uniquely identifies the schedule within - * the account. - * @member {string} [displayName] The display name for the schedule. - * @member {string} [url] The URL of the job schedule. - * @member {string} [eTag] The ETag of the job schedule. This is an opaque - * string. You can use it to detect whether the job schedule has changed - * between requests. In particular, you can be pass the ETag with an Update Job - * Schedule request to specify that your changes should take effect only if - * nobody else has modified the schedule in the meantime. - * @member {date} [lastModified] The last modified time of the job schedule. - * This is the last time at which the schedule level data, such as the job - * specification or recurrence information, changed. It does not factor in - * job-level changes such as new jobs being created or jobs changing state. - * @member {date} [creationTime] The creation time of the job schedule. - * @member {string} [state] The current state of the job schedule. Possible - * values include: 'active', 'completed', 'disabled', 'terminating', 'deleting' - * @member {date} [stateTransitionTime] The time at which the job schedule - * entered the current state. - * @member {string} [previousState] The previous state of the job schedule. - * This property is not present if the job schedule is in its initial active - * state. Possible values include: 'active', 'completed', 'disabled', - * 'terminating', 'deleting' - * @member {date} [previousStateTransitionTime] The time at which the job - * schedule entered its previous state. This property is not present if the job - * schedule is in its initial active state. - * @member {object} [schedule] The schedule according to which jobs will be - * created. - * @member {date} [schedule.doNotRunUntil] If you do not specify a - * doNotRunUntil time, the schedule becomes ready to create jobs immediately. - * @member {date} [schedule.doNotRunAfter] If you do not specify a - * doNotRunAfter time, and you are creating a recurring job schedule, the job - * schedule will remain active until you explicitly terminate it. - * @member {moment.duration} [schedule.startWindow] If a job is not created - * within the startWindow interval, then the 'opportunity' is lost; no job will - * be created until the next recurrence of the schedule. If the schedule is - * recurring, and the startWindow is longer than the recurrence interval, then - * this is equivalent to an infinite startWindow, because the job that is 'due' - * in one recurrenceInterval is not carried forward into the next recurrence - * interval. The default is infinite. The minimum value is 1 minute. If you - * specify a lower value, the Batch service rejects the schedule with an error; - * if you are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {moment.duration} [schedule.recurrenceInterval] Because a job - * schedule can have at most one active job under it at any given time, if it - * is time to create a new job under a job schedule, but the previous job is - * still running, the Batch service will not create the new job until the - * previous job finishes. If the previous job does not finish within the - * startWindow period of the new recurrenceInterval, then no new job will be - * scheduled for that interval. For recurring jobs, you should normally specify - * a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, - * you will need an external process to monitor when jobs are created, add - * tasks to the jobs and terminate the jobs ready for the next recurrence. The - * default is that the schedule does not recur: one job is created, within the - * startWindow after the doNotRunUntil time, and the schedule is complete as - * soon as that job finishes. The minimum value is 1 minute. If you specify a - * lower value, the Batch service rejects the schedule with an error; if you - * are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {object} [jobSpecification] The details of the jobs to be created on - * this schedule. - * @member {number} [jobSpecification.priority] Priority values can range from - * -1000 to 1000, with -1000 being the lowest priority and 1000 being the - * highest priority. The default value is 0. This priority is used as the - * default for all jobs under the job schedule. You can update a job's priority - * after it has been created using by using the update job API. - * @member {string} [jobSpecification.displayName] The name need not be unique - * and can contain any Unicode characters up to a maximum length of 1024. - * @member {boolean} [jobSpecification.usesTaskDependencies] - * @member {string} [jobSpecification.onAllTasksComplete] 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. Possible values include: 'noAction', 'terminateJob' - * @member {string} [jobSpecification.onTaskFailure] The default is noaction. - * Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [jobSpecification.networkConfiguration] - * @member {string} [jobSpecification.networkConfiguration.subnetId] This is - * only supported for jobs running on VirtualMachineConfiguration pools. This - * is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes which will run tasks from the job. For more - * details, see - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [jobSpecification.constraints] - * @member {moment.duration} [jobSpecification.constraints.maxWallClockTime] If - * the job does not complete within the time limit, the Batch service - * terminates it and any tasks that are still running. In this case, the - * termination reason will be MaxWallClockTimeExpiry. If this property is not - * specified, there is no time limit on how long the job may run. - * @member {number} [jobSpecification.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries. The Batch service - * will try each task once, and may then retry up to this limit. For example, - * if the maximum retry count is 3, Batch tries a task up to 4 times (one - * initial try and 3 retries). If the maximum retry count is 0, the Batch - * service does not retry tasks. If the maximum retry count is -1, the Batch - * service retries tasks without limit. The default value is 0 (no retries). - * @member {object} [jobSpecification.jobManagerTask] If the job does not - * specify a Job Manager task, the user must explicitly add tasks to the job - * using the Task API. If the job does specify a Job Manager task, the Batch - * service creates the Job Manager task when the job is created, and will try - * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobSpecification.jobManagerTask.id] The ID can contain any - * combination of alphanumeric characters including hyphens and underscores and - * cannot contain more than 64 characters. - * @member {string} [jobSpecification.jobManagerTask.displayName] It need not - * be unique and can contain any Unicode characters up to a maximum length of - * 1024. - * @member {string} [jobSpecification.jobManagerTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command line, - * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in - * Linux. If the command line refers to file paths, it should use a relative - * path (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobManagerTask.containerSettings] If the - * pool that will run this task has containerConfiguration set, this must be - * set as well. If the pool that will run this task doesn't have - * containerConfiguration set, this must not be set. When this is specified, - * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} - * [jobSpecification.jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobManagerTask.resourceFiles] Files listed - * under this element are located in the task's working directory. There is a - * maximum size for the list of resource files. When the max size is exceeded, - * the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [jobSpecification.jobManagerTask.outputFiles] For - * multi-instance tasks, the files will only be uploaded from the compute node - * on which the primary task is executed. - * @member {array} [jobSpecification.jobManagerTask.environmentSettings] - * @member {object} [jobSpecification.jobManagerTask.constraints] - * @member {moment.duration} - * [jobSpecification.jobManagerTask.constraints.maxWallClockTime] If this is - * not specified, there is no time limit on how long the task may run. - * @member {moment.duration} - * [jobSpecification.jobManagerTask.constraints.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the compute - * node is removed or the job is deleted. - * @member {number} - * [jobSpecification.jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] If - * true, when the Job Manager task completes, the Batch service marks the job - * as complete. If any tasks are still running at this time (other than Job - * Release), those tasks are terminated. If false, the completion of the Job - * Manager task does not affect the job status. In this case, you should either - * use the onAllTasksComplete attribute to terminate the job, or have a client - * or user terminate the job explicitly. An example of this is if the Job - * Manager creates a set of tasks but then takes no further role in their - * execution. The default value is true. If you are using the - * onAllTasksComplete and onTaskFailure attributes to control job lifetime, and - * using the Job Manager task only to create the tasks for the job (not to - * monitor progress), then it is important to set killJobOnCompletion to false. - * @member {object} [jobSpecification.jobManagerTask.userIdentity] If omitted, - * the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobManagerTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [jobSpecification.jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobSpecification.jobManagerTask.runExclusive] If true, no - * other tasks will run on the same compute node for as long as the Job Manager - * is running. If false, other tasks can run simultaneously with the Job - * Manager on a compute node. The Job Manager task counts normally against the - * node's concurrent task limit, so this is only relevant if the node allows - * multiple concurrent tasks. The default value is true. - * @member {array} - * [jobSpecification.jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the existing - * copy on the compute node is used. If a referenced application package cannot - * be installed, for example because the package has been deleted or because - * download failed, the task fails. - * @member {object} - * [jobSpecification.jobManagerTask.authenticationTokenSettings] If this - * property is set, the Batch service provides the task with an authentication - * token which can be used to authenticate Batch service operations without - * requiring an account access key. The token is provided via the - * AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the - * task can carry out using the token depend on the settings. For example, a - * task can request job permissions in order to add other tasks to the job, or - * check the status of the job or of other tasks under the job. - * @member {array} - * [jobSpecification.jobManagerTask.authenticationTokenSettings.access] The - * authentication token grants access to a limited set of Batch service - * operations. Currently the only supported value for the access property is - * 'job', which grants access to all operations related to the job which - * contains the task. - * @member {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] The - * default value is true. - * @member {object} [jobSpecification.jobPreparationTask] If a job has a Job - * Preparation task, the Batch service will run the Job Preparation task on a - * compute node before starting any tasks of that job on that compute node. - * @member {string} [jobSpecification.jobPreparationTask.id] The ID can contain - * any combination of alphanumeric characters including hyphens and underscores - * and cannot contain more than 64 characters. If you do not specify this - * property, the Batch service assigns a default value of 'jobpreparation'. No - * other task in the job can have the same ID as the Job Preparation task. If - * you try to submit a task with the same id, the Batch service rejects the - * request with error code TaskIdSameAsJobPreparationTask; if you are calling - * the REST API directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobPreparationTask.commandLine] The - * command line does not run under a shell, and therefore cannot take advantage - * of shell features such as environment variable expansion. If you want to - * take advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobPreparationTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no tag - * is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [jobSpecification.jobPreparationTask.containerSettings.registry] This - * setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobPreparationTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [jobSpecification.jobPreparationTask.environmentSettings] - * @member {object} [jobSpecification.jobPreparationTask.constraints] - * @member {moment.duration} - * [jobSpecification.jobPreparationTask.constraints.maxWallClockTime] If this - * is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} - * [jobSpecification.jobPreparationTask.constraints.retentionTime] The default - * is 7 days, i.e. the task directory will be retained for 7 days unless the - * compute node is removed or the job is deleted. - * @member {number} - * [jobSpecification.jobPreparationTask.constraints.maxTaskRetryCount] Note - * that this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] If - * true and the Job Preparation task fails on a compute node, the Batch service - * retries the Job Preparation task up to its maximum retry count (as specified - * in the constraints element). If the task has still not completed - * successfully after all retries, then the Batch service will not schedule - * tasks of the job to the compute node. The compute node remains active and - * eligible to run tasks of other jobs. If false, the Batch service will not - * wait for the Job Preparation task to complete. In this case, other tasks of - * the job can start executing on the compute node while the Job Preparation - * task is still running; and even if the Job Preparation task fails, new tasks - * will continue to be scheduled on the node. The default value is true. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity] If - * omitted, the task runs as a non-administrative user unique to the task on - * Windows nodes, or a a non-administrative user unique to the pool on Linux - * nodes. - * @member {string} [jobSpecification.jobPreparationTask.userIdentity.userName] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity.autoUser] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {string} - * [jobSpecification.jobPreparationTask.userIdentity.autoUser.scope] The - * default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} - * [jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] The Job - * Preparation task is always rerun if a compute node is reimaged, or if the - * Job Preparation task did not complete (e.g. because the reboot occurred - * while the task was running). Therefore, you should always write a Job - * Preparation task to be idempotent and to behave correctly if run multiple - * times. The default value is true. - * @member {object} [jobSpecification.jobReleaseTask] The primary purpose of - * the Job Release task is to undo changes to compute nodes made by the Job - * Preparation task. Example activities include deleting local files, or - * shutting down services that were started as part of job preparation. A Job - * Release task cannot be specified without also specifying a Job Preparation - * task for the job. The Batch service runs the Job Release task on the compute - * nodes that have run the Job Preparation task. - * @member {string} [jobSpecification.jobReleaseTask.id] The ID can contain any - * combination of alphanumeric characters including hyphens and underscores and - * cannot contain more than 64 characters. If you do not specify this property, - * the Batch service assigns a default value of 'jobrelease'. No other task in - * the job can have the same ID as the Job Release task. If you try to submit a - * task with the same id, the Batch service rejects the request with error code - * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the - * HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobReleaseTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command line, - * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in - * Linux. If the command line refers to file paths, it should use a relative - * path (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobReleaseTask.containerSettings] When - * this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} - * [jobSpecification.jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobReleaseTask.resourceFiles] Files listed - * under this element are located in the task's working directory. - * @member {array} [jobSpecification.jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobSpecification.jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobSpecification.jobReleaseTask.retentionTime] - * The default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity] If omitted, - * the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobReleaseTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [jobSpecification.jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [jobSpecification.commonEnvironmentSettings] Individual - * tasks can override an environment setting specified here by specifying the - * same setting name with a different value. - * @member {object} [jobSpecification.poolInfo] - * @member {string} [jobSpecification.poolInfo.poolId] You must ensure that the - * pool referenced by this property exists. If the pool does not exist at the - * time the Batch service tries to schedule a job, no tasks for the job will - * run until you create a pool with that id. Note that the Batch service will - * not reject the job request; it will simply not run tasks until the pool - * exists. You must specify either the pool ID or the auto pool specification, - * but not both. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification] If auto - * pool creation fails, the Batch service moves the job to a completed state, - * and the pool creation error is set in the job's scheduling error property. - * The Batch service manages the lifetime (both creation and, unless keepAlive - * is specified, deletion) of the auto pool. Any user actions that affect the - * lifetime of the auto pool while the job is active will result in unexpected - * behavior. You must specify either the pool ID or the auto pool - * specification, but not both. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.autoPoolIdPrefix] The Batch - * service assigns each auto pool a unique identifier on creation. To - * distinguish between pools created for different purposes, you can specify - * this element to add a prefix to the ID that is assigned. The prefix can be - * up to 20 characters long. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.poolLifetimeOption] - * Possible values include: 'jobSchedule', 'job' - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.displayName] The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.vmSize] For - * information about available sizes of virtual machines in pools, see Choose a - * VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] - * This property must be specified if the pool needs to be created with Azure - * PaaS VMs. This property and virtualMachineConfiguration are mutually - * exclusive and one of the properties must be specified. If neither is - * specified then the Batch service returns an error; if you are calling the - * REST API directly, the HTTP status code is 400 (Bad Request). This property - * cannot be specified if the Batch account was created with its - * poolAllocationMode property set to 'UserSubscription'. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] - * Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] - * The default value is * which specifies the latest operating system version - * for the specified OS family. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] - * This property must be specified if the pool needs to be created with Azure - * IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] - * 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. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] - * This only applies to images that contain the Windows operating system, and - * should only be used when you hold valid on-premises licenses for the nodes - * which will be deployed. If omitted, no on-premises licensing discount is - * applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size of - * the compute nodes in the pool (the vmSize setting). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] - * Possible values include: 'spread', 'pack' - * @member {moment.duration} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.resizeTimeout] This - * timeout applies only to manual scaling; it has no effect when - * enableAutoScale is set to true. The default value is 15 minutes. The minimum - * value is 5 minutes. If you specify a value less than 5 minutes, the Batch - * service rejects the request with an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleFormula] This - * property must not be specified if enableAutoScale is set to false. It is - * required if enableAutoScale is set to true. The formula is checked for - * validity before the pool is created. If the formula is not valid, the Batch - * service rejects the request with detailed error information. - * @member {moment.duration} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] - * The default value is 15 minutes. The minimum and maximum value are 5 minutes - * and 168 hours respectively. If you specify a value less than 5 minutes or - * greater than 168 hours, the Batch service rejects the request with an - * invalid property value error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] - * Enabling inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] - * This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] - * Pool endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.commandLine] - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] - * This is the full image reference, as would be specified to "docker pull". If - * no tag is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] - * This setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] - * Files listed under this element are located in the task's working directory. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity] - * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] - * The default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] - * The Batch service retries a task if its exit code is nonzero. Note that this - * value specifically controls the number of retries. The Batch service will - * try the task once, and may then retry up to this limit. For example, if the - * maximum retry count is 3, Batch tries the task up to 4 times (one initial - * try and 3 retries). If the maximum retry count is 0, the Batch service does - * not retry the task. If the maximum retry count is -1, the Batch service - * retries the task without limit. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] - * If true and the start task fails on a compute node, the Batch service - * retries the start task up to its maximum retry count (maxTaskRetryCount). If - * the task has still not completed successfully after all retries, then the - * Batch service marks the compute node unusable, and will not schedule tasks - * to it. This condition can be detected via the node state and failure info - * details. If false, the Batch service will not wait for the start task to - * complete. In this case, other tasks can start executing on the compute node - * while the start task is still running; and even if the start task fails, new - * tasks will continue to be scheduled on the node. The default is false. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.certificateReferences] - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.metadata] The Batch - * service does not assign any meaning to metadata; it is solely for the use of - * user code. - * @member {array} [jobSpecification.metadata] The Batch service does not - * assign any meaning to metadata; it is solely for the use of user code. - * @member {object} [executionInfo] Information about jobs that have been and - * will be run under this schedule. - * @member {date} [executionInfo.nextRunTime] This property is meaningful only - * if the schedule is in the active state when the time comes around. For - * example, if the schedule is disabled, no job will be created at nextRunTime - * unless the job is enabled before then. - * @member {object} [executionInfo.recentJob] This property is present only if - * the at least one job has run under the schedule. - * @member {string} [executionInfo.recentJob.id] - * @member {string} [executionInfo.recentJob.url] - * @member {date} [executionInfo.endTime] This property is set only if the job - * schedule is in the completed state. - * @member {array} [metadata] A list of name-value pairs associated with the - * schedule as metadata. The Batch service does not assign any meaning to - * metadata; it is solely for the use of user code. - * @member {object} [stats] The lifetime resource usage statistics for the job - * schedule. The statistics may not be immediately available. The Batch service - * performs periodic roll-up of statistics. The typical delay is about 30 - * minutes. - * @member {string} [stats.url] - * @member {date} [stats.startTime] - * @member {date} [stats.lastUpdateTime] - * @member {moment.duration} [stats.userCPUTime] - * @member {moment.duration} [stats.kernelCPUTime] - * @member {moment.duration} [stats.wallClockTime] The wall clock time is the - * elapsed time from when the task started running on a compute node to when it - * finished (or to the last time the statistics were updated, if the task had - * not finished by then). If a task was retried, this includes the wall clock - * time of all the task retries. - * @member {number} [stats.readIOps] - * @member {number} [stats.writeIOps] - * @member {number} [stats.readIOGiB] - * @member {number} [stats.writeIOGiB] - * @member {number} [stats.numSucceededTasks] - * @member {number} [stats.numFailedTasks] - * @member {number} [stats.numTaskRetries] - * @member {moment.duration} [stats.waitTime] This value is only reported in - * the account lifetime statistics; it is not included in the job statistics. + * @summary A job schedule that allows recurring jobs by specifying when to run jobs and a + * specification used to create each job. */ export interface CloudJobSchedule { + /** + * @summary A string that uniquely identifies the schedule within the account. + */ id?: string; + /** + * @summary The display name for the schedule. + */ displayName?: string; + /** + * @summary The URL of the job schedule. + */ url?: string; + /** + * @summary The ETag of the job schedule. + * @description This is an opaque string. You can use it to detect whether the job schedule has + * changed between requests. In particular, you can be pass the ETag with an Update Job Schedule + * request to specify that your changes should take effect only if nobody else has modified the + * schedule in the meantime. + */ eTag?: string; + /** + * @summary The last modified time of the job schedule. + * @description This is the last time at which the schedule level data, such as the job + * specification or recurrence information, changed. It does not factor in job-level changes such + * as new jobs being created or jobs changing state. + */ lastModified?: Date; + /** + * @summary The creation time of the job schedule. + */ creationTime?: Date; + /** + * @summary The current state of the job schedule. + * @description Possible values include: 'active', 'completed', 'disabled', 'terminating', + * 'deleting' + */ state?: string; + /** + * @summary The time at which the job schedule entered the current state. + */ stateTransitionTime?: Date; + /** + * @summary The previous state of the job schedule. + * @description This property is not present if the job schedule is in its initial active state. + * Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting' + */ previousState?: string; + /** + * @summary The time at which the job schedule entered its previous state. + * @description This property is not present if the job schedule is in its initial active state. + */ previousStateTransitionTime?: Date; + /** + * @summary The schedule according to which jobs will be created. + */ schedule?: Schedule; + /** + * @summary The details of the jobs to be created on this schedule. + */ jobSpecification?: JobSpecification; + /** + * @summary Information about jobs that have been and will be run under this schedule. + */ executionInfo?: JobScheduleExecutionInformation; + /** + * @summary A list of name-value pairs associated with the schedule as metadata. + * @description The Batch service does not assign any meaning to metadata; it is solely for the + * use of user code. + */ metadata?: MetadataItem[]; + /** + * @summary The lifetime resource usage statistics for the job schedule. The statistics may not + * be immediately available. The Batch service performs periodic roll-up of statistics. The + * typical delay is about 30 minutes. + */ stats?: JobScheduleStatistics; } /** - * @class - * Initializes a new instance of the JobScheduleAddParameter class. - * @constructor - * @summary A job schedule that allows recurring jobs by specifying when to run - * jobs and a specification used to create each job. - * - * @member {string} id A string that uniquely identifies the schedule within - * the account. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you may - * not have two IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the schedule. The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {object} schedule The schedule according to which jobs will be - * created. - * @member {date} [schedule.doNotRunUntil] If you do not specify a - * doNotRunUntil time, the schedule becomes ready to create jobs immediately. - * @member {date} [schedule.doNotRunAfter] If you do not specify a - * doNotRunAfter time, and you are creating a recurring job schedule, the job - * schedule will remain active until you explicitly terminate it. - * @member {moment.duration} [schedule.startWindow] If a job is not created - * within the startWindow interval, then the 'opportunity' is lost; no job will - * be created until the next recurrence of the schedule. If the schedule is - * recurring, and the startWindow is longer than the recurrence interval, then - * this is equivalent to an infinite startWindow, because the job that is 'due' - * in one recurrenceInterval is not carried forward into the next recurrence - * interval. The default is infinite. The minimum value is 1 minute. If you - * specify a lower value, the Batch service rejects the schedule with an error; - * if you are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {moment.duration} [schedule.recurrenceInterval] Because a job - * schedule can have at most one active job under it at any given time, if it - * is time to create a new job under a job schedule, but the previous job is - * still running, the Batch service will not create the new job until the - * previous job finishes. If the previous job does not finish within the - * startWindow period of the new recurrenceInterval, then no new job will be - * scheduled for that interval. For recurring jobs, you should normally specify - * a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, - * you will need an external process to monitor when jobs are created, add - * tasks to the jobs and terminate the jobs ready for the next recurrence. The - * default is that the schedule does not recur: one job is created, within the - * startWindow after the doNotRunUntil time, and the schedule is complete as - * soon as that job finishes. The minimum value is 1 minute. If you specify a - * lower value, the Batch service rejects the schedule with an error; if you - * are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {object} jobSpecification The details of the jobs to be created on - * this schedule. - * @member {number} [jobSpecification.priority] Priority values can range from - * -1000 to 1000, with -1000 being the lowest priority and 1000 being the - * highest priority. The default value is 0. This priority is used as the - * default for all jobs under the job schedule. You can update a job's priority - * after it has been created using by using the update job API. - * @member {string} [jobSpecification.displayName] The name need not be unique - * and can contain any Unicode characters up to a maximum length of 1024. - * @member {boolean} [jobSpecification.usesTaskDependencies] - * @member {string} [jobSpecification.onAllTasksComplete] 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. Possible values include: 'noAction', 'terminateJob' - * @member {string} [jobSpecification.onTaskFailure] The default is noaction. - * Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [jobSpecification.networkConfiguration] - * @member {string} [jobSpecification.networkConfiguration.subnetId] This is - * only supported for jobs running on VirtualMachineConfiguration pools. This - * is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes which will run tasks from the job. For more - * details, see - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [jobSpecification.constraints] - * @member {moment.duration} [jobSpecification.constraints.maxWallClockTime] If - * the job does not complete within the time limit, the Batch service - * terminates it and any tasks that are still running. In this case, the - * termination reason will be MaxWallClockTimeExpiry. If this property is not - * specified, there is no time limit on how long the job may run. - * @member {number} [jobSpecification.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries. The Batch service - * will try each task once, and may then retry up to this limit. For example, - * if the maximum retry count is 3, Batch tries a task up to 4 times (one - * initial try and 3 retries). If the maximum retry count is 0, the Batch - * service does not retry tasks. If the maximum retry count is -1, the Batch - * service retries tasks without limit. The default value is 0 (no retries). - * @member {object} [jobSpecification.jobManagerTask] If the job does not - * specify a Job Manager task, the user must explicitly add tasks to the job - * using the Task API. If the job does specify a Job Manager task, the Batch - * service creates the Job Manager task when the job is created, and will try - * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobSpecification.jobManagerTask.id] The ID can contain any - * combination of alphanumeric characters including hyphens and underscores and - * cannot contain more than 64 characters. - * @member {string} [jobSpecification.jobManagerTask.displayName] It need not - * be unique and can contain any Unicode characters up to a maximum length of - * 1024. - * @member {string} [jobSpecification.jobManagerTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command line, - * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in - * Linux. If the command line refers to file paths, it should use a relative - * path (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobManagerTask.containerSettings] If the - * pool that will run this task has containerConfiguration set, this must be - * set as well. If the pool that will run this task doesn't have - * containerConfiguration set, this must not be set. When this is specified, - * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} - * [jobSpecification.jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobManagerTask.resourceFiles] Files listed - * under this element are located in the task's working directory. There is a - * maximum size for the list of resource files. When the max size is exceeded, - * the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [jobSpecification.jobManagerTask.outputFiles] For - * multi-instance tasks, the files will only be uploaded from the compute node - * on which the primary task is executed. - * @member {array} [jobSpecification.jobManagerTask.environmentSettings] - * @member {object} [jobSpecification.jobManagerTask.constraints] - * @member {moment.duration} - * [jobSpecification.jobManagerTask.constraints.maxWallClockTime] If this is - * not specified, there is no time limit on how long the task may run. - * @member {moment.duration} - * [jobSpecification.jobManagerTask.constraints.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the compute - * node is removed or the job is deleted. - * @member {number} - * [jobSpecification.jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] If - * true, when the Job Manager task completes, the Batch service marks the job - * as complete. If any tasks are still running at this time (other than Job - * Release), those tasks are terminated. If false, the completion of the Job - * Manager task does not affect the job status. In this case, you should either - * use the onAllTasksComplete attribute to terminate the job, or have a client - * or user terminate the job explicitly. An example of this is if the Job - * Manager creates a set of tasks but then takes no further role in their - * execution. The default value is true. If you are using the - * onAllTasksComplete and onTaskFailure attributes to control job lifetime, and - * using the Job Manager task only to create the tasks for the job (not to - * monitor progress), then it is important to set killJobOnCompletion to false. - * @member {object} [jobSpecification.jobManagerTask.userIdentity] If omitted, - * the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobManagerTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [jobSpecification.jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobSpecification.jobManagerTask.runExclusive] If true, no - * other tasks will run on the same compute node for as long as the Job Manager - * is running. If false, other tasks can run simultaneously with the Job - * Manager on a compute node. The Job Manager task counts normally against the - * node's concurrent task limit, so this is only relevant if the node allows - * multiple concurrent tasks. The default value is true. - * @member {array} - * [jobSpecification.jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the existing - * copy on the compute node is used. If a referenced application package cannot - * be installed, for example because the package has been deleted or because - * download failed, the task fails. - * @member {object} - * [jobSpecification.jobManagerTask.authenticationTokenSettings] If this - * property is set, the Batch service provides the task with an authentication - * token which can be used to authenticate Batch service operations without - * requiring an account access key. The token is provided via the - * AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the - * task can carry out using the token depend on the settings. For example, a - * task can request job permissions in order to add other tasks to the job, or - * check the status of the job or of other tasks under the job. - * @member {array} - * [jobSpecification.jobManagerTask.authenticationTokenSettings.access] The - * authentication token grants access to a limited set of Batch service - * operations. Currently the only supported value for the access property is - * 'job', which grants access to all operations related to the job which - * contains the task. - * @member {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] The - * default value is true. - * @member {object} [jobSpecification.jobPreparationTask] If a job has a Job - * Preparation task, the Batch service will run the Job Preparation task on a - * compute node before starting any tasks of that job on that compute node. - * @member {string} [jobSpecification.jobPreparationTask.id] The ID can contain - * any combination of alphanumeric characters including hyphens and underscores - * and cannot contain more than 64 characters. If you do not specify this - * property, the Batch service assigns a default value of 'jobpreparation'. No - * other task in the job can have the same ID as the Job Preparation task. If - * you try to submit a task with the same id, the Batch service rejects the - * request with error code TaskIdSameAsJobPreparationTask; if you are calling - * the REST API directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobPreparationTask.commandLine] The - * command line does not run under a shell, and therefore cannot take advantage - * of shell features such as environment variable expansion. If you want to - * take advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobPreparationTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no tag - * is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [jobSpecification.jobPreparationTask.containerSettings.registry] This - * setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobPreparationTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [jobSpecification.jobPreparationTask.environmentSettings] - * @member {object} [jobSpecification.jobPreparationTask.constraints] - * @member {moment.duration} - * [jobSpecification.jobPreparationTask.constraints.maxWallClockTime] If this - * is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} - * [jobSpecification.jobPreparationTask.constraints.retentionTime] The default - * is 7 days, i.e. the task directory will be retained for 7 days unless the - * compute node is removed or the job is deleted. - * @member {number} - * [jobSpecification.jobPreparationTask.constraints.maxTaskRetryCount] Note - * that this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] If - * true and the Job Preparation task fails on a compute node, the Batch service - * retries the Job Preparation task up to its maximum retry count (as specified - * in the constraints element). If the task has still not completed - * successfully after all retries, then the Batch service will not schedule - * tasks of the job to the compute node. The compute node remains active and - * eligible to run tasks of other jobs. If false, the Batch service will not - * wait for the Job Preparation task to complete. In this case, other tasks of - * the job can start executing on the compute node while the Job Preparation - * task is still running; and even if the Job Preparation task fails, new tasks - * will continue to be scheduled on the node. The default value is true. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity] If - * omitted, the task runs as a non-administrative user unique to the task on - * Windows nodes, or a a non-administrative user unique to the pool on Linux - * nodes. - * @member {string} [jobSpecification.jobPreparationTask.userIdentity.userName] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity.autoUser] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {string} - * [jobSpecification.jobPreparationTask.userIdentity.autoUser.scope] The - * default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} - * [jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] The Job - * Preparation task is always rerun if a compute node is reimaged, or if the - * Job Preparation task did not complete (e.g. because the reboot occurred - * while the task was running). Therefore, you should always write a Job - * Preparation task to be idempotent and to behave correctly if run multiple - * times. The default value is true. - * @member {object} [jobSpecification.jobReleaseTask] The primary purpose of - * the Job Release task is to undo changes to compute nodes made by the Job - * Preparation task. Example activities include deleting local files, or - * shutting down services that were started as part of job preparation. A Job - * Release task cannot be specified without also specifying a Job Preparation - * task for the job. The Batch service runs the Job Release task on the compute - * nodes that have run the Job Preparation task. - * @member {string} [jobSpecification.jobReleaseTask.id] The ID can contain any - * combination of alphanumeric characters including hyphens and underscores and - * cannot contain more than 64 characters. If you do not specify this property, - * the Batch service assigns a default value of 'jobrelease'. No other task in - * the job can have the same ID as the Job Release task. If you try to submit a - * task with the same id, the Batch service rejects the request with error code - * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the - * HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobReleaseTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command line, - * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in - * Linux. If the command line refers to file paths, it should use a relative - * path (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobReleaseTask.containerSettings] When - * this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} - * [jobSpecification.jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobReleaseTask.resourceFiles] Files listed - * under this element are located in the task's working directory. - * @member {array} [jobSpecification.jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobSpecification.jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobSpecification.jobReleaseTask.retentionTime] - * The default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity] If omitted, - * the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobReleaseTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [jobSpecification.jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [jobSpecification.commonEnvironmentSettings] Individual - * tasks can override an environment setting specified here by specifying the - * same setting name with a different value. - * @member {object} [jobSpecification.poolInfo] - * @member {string} [jobSpecification.poolInfo.poolId] You must ensure that the - * pool referenced by this property exists. If the pool does not exist at the - * time the Batch service tries to schedule a job, no tasks for the job will - * run until you create a pool with that id. Note that the Batch service will - * not reject the job request; it will simply not run tasks until the pool - * exists. You must specify either the pool ID or the auto pool specification, - * but not both. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification] If auto - * pool creation fails, the Batch service moves the job to a completed state, - * and the pool creation error is set in the job's scheduling error property. - * The Batch service manages the lifetime (both creation and, unless keepAlive - * is specified, deletion) of the auto pool. Any user actions that affect the - * lifetime of the auto pool while the job is active will result in unexpected - * behavior. You must specify either the pool ID or the auto pool - * specification, but not both. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.autoPoolIdPrefix] The Batch - * service assigns each auto pool a unique identifier on creation. To - * distinguish between pools created for different purposes, you can specify - * this element to add a prefix to the ID that is assigned. The prefix can be - * up to 20 characters long. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.poolLifetimeOption] - * Possible values include: 'jobSchedule', 'job' - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.displayName] The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.vmSize] For - * information about available sizes of virtual machines in pools, see Choose a - * VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] - * This property must be specified if the pool needs to be created with Azure - * PaaS VMs. This property and virtualMachineConfiguration are mutually - * exclusive and one of the properties must be specified. If neither is - * specified then the Batch service returns an error; if you are calling the - * REST API directly, the HTTP status code is 400 (Bad Request). This property - * cannot be specified if the Batch account was created with its - * poolAllocationMode property set to 'UserSubscription'. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] - * Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] - * The default value is * which specifies the latest operating system version - * for the specified OS family. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] - * This property must be specified if the pool needs to be created with Azure - * IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] - * 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. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] - * This only applies to images that contain the Windows operating system, and - * should only be used when you hold valid on-premises licenses for the nodes - * which will be deployed. If omitted, no on-premises licensing discount is - * applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size of - * the compute nodes in the pool (the vmSize setting). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] - * Possible values include: 'spread', 'pack' - * @member {moment.duration} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.resizeTimeout] This - * timeout applies only to manual scaling; it has no effect when - * enableAutoScale is set to true. The default value is 15 minutes. The minimum - * value is 5 minutes. If you specify a value less than 5 minutes, the Batch - * service rejects the request with an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleFormula] This - * property must not be specified if enableAutoScale is set to false. It is - * required if enableAutoScale is set to true. The formula is checked for - * validity before the pool is created. If the formula is not valid, the Batch - * service rejects the request with detailed error information. - * @member {moment.duration} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] - * The default value is 15 minutes. The minimum and maximum value are 5 minutes - * and 168 hours respectively. If you specify a value less than 5 minutes or - * greater than 168 hours, the Batch service rejects the request with an - * invalid property value error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] - * Enabling inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] - * This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] - * Pool endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.commandLine] - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] - * This is the full image reference, as would be specified to "docker pull". If - * no tag is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] - * This setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] - * Files listed under this element are located in the task's working directory. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity] - * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] - * The default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] - * The Batch service retries a task if its exit code is nonzero. Note that this - * value specifically controls the number of retries. The Batch service will - * try the task once, and may then retry up to this limit. For example, if the - * maximum retry count is 3, Batch tries the task up to 4 times (one initial - * try and 3 retries). If the maximum retry count is 0, the Batch service does - * not retry the task. If the maximum retry count is -1, the Batch service - * retries the task without limit. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] - * If true and the start task fails on a compute node, the Batch service - * retries the start task up to its maximum retry count (maxTaskRetryCount). If - * the task has still not completed successfully after all retries, then the - * Batch service marks the compute node unusable, and will not schedule tasks - * to it. This condition can be detected via the node state and failure info - * details. If false, the Batch service will not wait for the start task to - * complete. In this case, other tasks can start executing on the compute node - * while the start task is still running; and even if the start task fails, new - * tasks will continue to be scheduled on the node. The default is false. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.certificateReferences] - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.metadata] The Batch - * service does not assign any meaning to metadata; it is solely for the use of - * user code. - * @member {array} [jobSpecification.metadata] The Batch service does not - * assign any meaning to metadata; it is solely for the use of user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * schedule as metadata. The Batch service does not assign any meaning to - * metadata; it is solely for the use of user code. + * @summary A job schedule that allows recurring jobs by specifying when to run jobs and a + * specification used to create each job. */ export interface JobScheduleAddParameter { + /** + * @summary A string that uniquely identifies the schedule within the account. + * @description The ID can contain any combination of alphanumeric characters including hyphens + * and underscores, and cannot contain more than 64 characters. The ID is case-preserving and + * case-insensitive (that is, you may not have two IDs within an account that differ only by + * case). + */ id: string; + /** + * @summary The display name for the schedule. + * @description The display name need not be unique and can contain any Unicode characters up to + * a maximum length of 1024. + */ displayName?: string; + /** + * @summary The schedule according to which jobs will be created. + */ schedule: Schedule; + /** + * @summary The details of the jobs to be created on this schedule. + */ jobSpecification: JobSpecification; + /** + * @summary A list of name-value pairs associated with the schedule as metadata. + * @description The Batch service does not assign any meaning to metadata; it is solely for the + * use of user code. + */ metadata?: MetadataItem[]; } /** - * @class - * Initializes a new instance of the JobSchedulingError class. - * @constructor * @summary An error encountered by the Batch service when scheduling a job. - * - * @member {string} category The category of the job scheduling error. Possible - * values include: 'userError', 'serverError' - * @member {string} [code] An identifier for the job scheduling error. Codes - * are invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the job scheduling error, - * intended to be suitable for display in a user interface. - * @member {array} [details] A list of additional error details related to the - * scheduling error. */ export interface JobSchedulingError { + /** + * @summary The category of the job scheduling error. + * @description Possible values include: 'userError', 'serverError' + */ category: string; + /** + * @summary An identifier for the job scheduling error. Codes are invariant and are intended to + * be consumed programmatically. + */ code?: string; + /** + * @summary A message describing the job scheduling error, intended to be suitable for display in + * a user interface. + */ message?: string; + /** + * @summary A list of additional error details related to the scheduling error. + */ details?: NameValuePair[]; } /** - * @class - * Initializes a new instance of the JobExecutionInformation class. - * @constructor - * @summary Contains information about the execution of a job in the Azure - * Batch service. - * - * @member {date} startTime The start time of the job. This is the time at - * which the job was created. - * @member {date} [endTime] The completion time of the job. This property is - * set only if the job is in the completed state. - * @member {string} [poolId] The ID of the pool to which this job is assigned. - * This element contains the actual pool where the job is assigned. When you - * get job details from the service, they also contain a poolInfo element, - * which contains the pool configuration data from when the job was added or - * updated. That poolInfo element may also contain a poolId element. If it - * does, the two IDs are the same. If it does not, it means the job ran on an - * auto pool, and this property contains the ID of that auto pool. - * @member {object} [schedulingError] Details of any error encountered by the - * service in starting the job. This property is not set if there was no error - * starting the job. - * @member {string} [schedulingError.category] Possible values include: - * 'userError', 'serverError' - * @member {string} [schedulingError.code] - * @member {string} [schedulingError.message] - * @member {array} [schedulingError.details] - * @member {string} [terminateReason] A string describing the reason the job - * ended. 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. + * @summary Contains information about the execution of a job in the Azure Batch service. */ export interface JobExecutionInformation { + /** + * @summary The start time of the job. + * @description This is the time at which the job was created. + */ startTime: Date; + /** + * @summary The completion time of the job. + * @description This property is set only if the job is in the completed state. + */ endTime?: Date; + /** + * @summary The ID of the pool to which this job is assigned. + * @description This element contains the actual pool where the job is assigned. When you get job + * details from the service, they also contain a poolInfo element, which contains the pool + * configuration data from when the job was added or updated. That poolInfo element may also + * contain a poolId element. If it does, the two IDs are the same. If it does not, it means the + * job ran on an auto pool, and this property contains the ID of that auto pool. + */ poolId?: string; + /** + * @summary Details of any error encountered by the service in starting the job. + * @description This property is not set if there was no error starting the job. + */ schedulingError?: JobSchedulingError; + /** + * @summary 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. + */ terminateReason?: string; } /** - * @class - * Initializes a new instance of the CloudJob class. - * @constructor * @summary An Azure Batch job. - * - * @member {string} [id] A string that uniquely identifies the job within the - * account. The ID is case-preserving and case-insensitive (that is, you may - * not have two IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the job. - * @member {boolean} [usesTaskDependencies] Whether tasks in the job can define - * dependencies on each other. The default is false. - * @member {string} [url] The URL of the job. - * @member {string} [eTag] The ETag of the job. This is an opaque string. You - * can use it to detect whether the job has changed between requests. In - * particular, you can be pass the ETag when updating a job to specify that - * your changes should take effect only if nobody else has modified the job in - * the meantime. - * @member {date} [lastModified] The last modified time of the job. This is the - * last time at which the job level data, such as the job state or priority, - * changed. It does not factor in task-level changes such as adding new tasks - * or tasks changing state. - * @member {date} [creationTime] The creation time of the job. - * @member {string} [state] The current state of the job. Possible values - * include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', - * 'completed', 'deleting' - * @member {date} [stateTransitionTime] The time at which the job entered its - * current state. - * @member {string} [previousState] The previous state of the job. This - * property is not set if the job is in its initial Active state. Possible - * values include: 'active', 'disabling', 'disabled', 'enabling', - * 'terminating', 'completed', 'deleting' - * @member {date} [previousStateTransitionTime] The time at which the job - * entered its previous state. This property is not set if the job is in its - * initial Active state. - * @member {number} [priority] The priority of the job. Priority values can - * range from -1000 to 1000, with -1000 being the lowest priority and 1000 - * being the highest priority. The default value is 0. - * @member {object} [constraints] The execution constraints for the job. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does not - * complete within the time limit, the Batch service terminates it and any - * tasks that are still running. In this case, the termination reason will be - * MaxWallClockTimeExpiry. If this property is not specified, there is no time - * limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries. The Batch service will try each - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries a task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * tasks. If the maximum retry count is -1, the Batch service retries tasks - * without limit. The default value is 0 (no retries). - * @member {object} [jobManagerTask] Details of a Job Manager task to be - * launched when the job is started. - * @member {string} [jobManagerTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot contain - * more than 64 characters. - * @member {string} [jobManagerTask.displayName] It need not be unique and can - * contain any Unicode characters up to a maximum length of 1024. - * @member {string} [jobManagerTask.commandLine] The command line does not run - * under a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobManagerTask.containerSettings] If the pool that will - * run this task has containerConfiguration set, this must be set as well. If - * the pool that will run this task doesn't have containerConfiguration set, - * this must not be set. When this is specified, all directories recursively - * below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the - * node) are mapped into the container, all task environment variables are - * mapped into the container, and the task command line is executed in the - * container. - * @member {string} [jobManagerTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} [jobManagerTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} [jobManagerTask.containerSettings.registry.userName] - * @member {string} [jobManagerTask.containerSettings.registry.password] - * @member {array} [jobManagerTask.resourceFiles] Files listed under this - * element are located in the task's working directory. There is a maximum size - * for the list of resource files. When the max size is exceeded, the request - * will fail and the response error code will be RequestEntityTooLarge. If this - * occurs, the collection of ResourceFiles must be reduced in size. This can be - * achieved using .zip files, Application Packages, or Docker Containers. - * @member {array} [jobManagerTask.outputFiles] For multi-instance tasks, the - * files will only be uploaded from the compute node on which the primary task - * is executed. - * @member {array} [jobManagerTask.environmentSettings] - * @member {object} [jobManagerTask.constraints] - * @member {moment.duration} [jobManagerTask.constraints.maxWallClockTime] If - * this is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} [jobManagerTask.constraints.retentionTime] The - * default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {number} [jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobManagerTask.killJobOnCompletion] If true, when the Job - * Manager task completes, the Batch service marks the job as complete. If any - * tasks are still running at this time (other than Job Release), those tasks - * are terminated. If false, the completion of the Job Manager task does not - * affect the job status. In this case, you should either use the - * onAllTasksComplete attribute to terminate the job, or have a client or user - * terminate the job explicitly. An example of this is if the Job Manager - * creates a set of tasks but then takes no further role in their execution. - * The default value is true. If you are using the onAllTasksComplete and - * onTaskFailure attributes to control job lifetime, and using the Job Manager - * task only to create the tasks for the job (not to monitor progress), then it - * is important to set killJobOnCompletion to false. - * @member {object} [jobManagerTask.userIdentity] If omitted, the task runs as - * a non-administrative user unique to the task. - * @member {string} [jobManagerTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [jobManagerTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobManagerTask.runExclusive] If true, no other tasks will - * run on the same compute node for as long as the Job Manager is running. If - * false, other tasks can run simultaneously with the Job Manager on a compute - * node. The Job Manager task counts normally against the node's concurrent - * task limit, so this is only relevant if the node allows multiple concurrent - * tasks. The default value is true. - * @member {array} [jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the existing - * copy on the compute node is used. If a referenced application package cannot - * be installed, for example because the package has been deleted or because - * download failed, the task fails. - * @member {object} [jobManagerTask.authenticationTokenSettings] If this - * property is set, the Batch service provides the task with an authentication - * token which can be used to authenticate Batch service operations without - * requiring an account access key. The token is provided via the - * AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the - * task can carry out using the token depend on the settings. For example, a - * task can request job permissions in order to add other tasks to the job, or - * check the status of the job or of other tasks under the job. - * @member {array} [jobManagerTask.authenticationTokenSettings.access] The - * authentication token grants access to a limited set of Batch service - * operations. Currently the only supported value for the access property is - * 'job', which grants access to all operations related to the job which - * contains the task. - * @member {boolean} [jobManagerTask.allowLowPriorityNode] The default value is - * true. - * @member {object} [jobPreparationTask] The Job Preparation task. The Job - * Preparation task is a special task run on each node before any other task of - * the job. - * @member {string} [jobPreparationTask.id] The ID can contain any combination - * of alphanumeric characters including hyphens and underscores and cannot - * contain more than 64 characters. If you do not specify this property, the - * Batch service assigns a default value of 'jobpreparation'. No other task in - * the job can have the same ID as the Job Preparation task. If you try to - * submit a task with the same id, the Batch service rejects the request with - * error code TaskIdSameAsJobPreparationTask; if you are calling the REST API - * directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobPreparationTask.commandLine] The command line does not - * run under a shell, and therefore cannot take advantage of shell features - * such as environment variable expansion. If you want to take advantage of - * such features, you should invoke the shell in the command line, for example - * using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If - * the command line refers to file paths, it should use a relative path - * (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobPreparationTask.containerSettings] When this is - * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the - * root of Azure Batch directories on the node) are mapped into the container, - * all task environment variables are mapped into the container, and the task - * command line is executed in the container. - * @member {string} [jobPreparationTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no tag - * is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} [jobPreparationTask.containerSettings.registry] This - * setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobPreparationTask.containerSettings.registry.registryServer] If omitted, - * the default is "docker.io". - * @member {string} [jobPreparationTask.containerSettings.registry.userName] - * @member {string} [jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobPreparationTask.resourceFiles] Files listed under this - * element are located in the task's working directory. There is a maximum - * size for the list of resource files. When the max size is exceeded, the - * request will fail and the response error code will be RequestEntityTooLarge. - * If this occurs, the collection of ResourceFiles must be reduced in size. - * This can be achieved using .zip files, Application Packages, or Docker - * Containers. - * @member {array} [jobPreparationTask.environmentSettings] - * @member {object} [jobPreparationTask.constraints] - * @member {moment.duration} [jobPreparationTask.constraints.maxWallClockTime] - * If this is not specified, there is no time limit on how long the task may - * run. - * @member {moment.duration} [jobPreparationTask.constraints.retentionTime] The - * default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note - * that this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobPreparationTask.waitForSuccess] If true and the Job - * Preparation task fails on a compute node, the Batch service retries the Job - * Preparation task up to its maximum retry count (as specified in the - * constraints element). If the task has still not completed successfully after - * all retries, then the Batch service will not schedule tasks of the job to - * the compute node. The compute node remains active and eligible to run tasks - * of other jobs. If false, the Batch service will not wait for the Job - * Preparation task to complete. In this case, other tasks of the job can start - * executing on the compute node while the Job Preparation task is still - * running; and even if the Job Preparation task fails, new tasks will continue - * to be scheduled on the node. The default value is true. - * @member {object} [jobPreparationTask.userIdentity] If omitted, the task runs - * as a non-administrative user unique to the task on Windows nodes, or a a - * non-administrative user unique to the pool on Linux nodes. - * @member {string} [jobPreparationTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [jobPreparationTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [jobPreparationTask.userIdentity.autoUser.scope] The - * default value is task. Possible values include: 'task', 'pool' - * @member {string} [jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The Job - * Preparation task is always rerun if a compute node is reimaged, or if the - * Job Preparation task did not complete (e.g. because the reboot occurred - * while the task was running). Therefore, you should always write a Job - * Preparation task to be idempotent and to behave correctly if run multiple - * times. The default value is true. - * @member {object} [jobReleaseTask] The Job Release task. The Job Release task - * is a special task run at the end of the job on each node that has run any - * other task of the job. - * @member {string} [jobReleaseTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot contain - * more than 64 characters. If you do not specify this property, the Batch - * service assigns a default value of 'jobrelease'. No other task in the job - * can have the same ID as the Job Release task. If you try to submit a task - * with the same id, the Batch service rejects the request with error code - * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the - * HTTP status code is 409 (Conflict). - * @member {string} [jobReleaseTask.commandLine] The command line does not run - * under a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobReleaseTask.containerSettings] When this is specified, - * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [jobReleaseTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} [jobReleaseTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} [jobReleaseTask.containerSettings.registry.userName] - * @member {string} [jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobReleaseTask.resourceFiles] Files listed under this - * element are located in the task's working directory. - * @member {array} [jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobReleaseTask.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the compute - * node is removed or the job is deleted. - * @member {object} [jobReleaseTask.userIdentity] If omitted, the task runs as - * a non-administrative user unique to the task. - * @member {string} [jobReleaseTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [jobReleaseTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [commonEnvironmentSettings] The list of common environment - * variable settings. These environment variables are set for all tasks in the - * job (including the Job Manager, Job Preparation and Job Release tasks). - * Individual tasks can override an environment setting specified here by - * specifying the same setting name with a different value. - * @member {object} [poolInfo] The pool settings associated with the job. - * @member {string} [poolInfo.poolId] You must ensure that the pool referenced - * by this property exists. If the pool does not exist at the time the Batch - * service tries to schedule a job, no tasks for the job will run until you - * create a pool with that id. Note that the Batch service will not reject the - * job request; it will simply not run tasks until the pool exists. You must - * specify either the pool ID or the auto pool specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation - * fails, the Batch service moves the job to a completed state, and the pool - * creation error is set in the job's scheduling error property. The Batch - * service manages the lifetime (both creation and, unless keepAlive is - * specified, deletion) of the auto pool. Any user actions that affect the - * lifetime of the auto pool while the job is active will result in unexpected - * behavior. You must specify either the pool ID or the auto pool - * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The Batch - * service assigns each auto pool a unique identifier on creation. To - * distinguish between pools created for different purposes, you can specify - * this element to add a prefix to the ID that is assigned. The prefix can be - * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] - * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For - * information about available sizes of virtual machines in pools, see Choose a - * VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This - * property must be specified if the pool needs to be created with Azure PaaS - * VMs. This property and virtualMachineConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). This property cannot be - * specified if the Batch account was created with its poolAllocationMode - * property set to 'UserSubscription'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] - * Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] - * The default value is * which specifies the latest operating system version - * for the specified OS family. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This - * property must be specified if the pool needs to be created with Azure IaaS - * VMs. This property and cloudServiceConfiguration are mutually exclusive and - * one of the properties must be specified. If neither is specified then the - * Batch service returns an error; if you are calling the REST API directly, - * the HTTP status code is 400 (Bad Request). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] - * 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. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] - * This only applies to images that contain the Windows operating system, and - * should only be used when you hold valid on-premises licenses for the nodes - * which will be deployed. If omitted, no on-premises licensing discount is - * applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size of - * the compute nodes in the pool (the vmSize setting). - * @member {object} [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] - * Possible values include: 'spread', 'pack' - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies - * only to manual scaling; it has no effect when enableAutoScale is set to - * true. The default value is 15 minutes. The minimum value is 5 minutes. If - * you specify a value less than 5 minutes, the Batch service rejects the - * request with an error; if you are calling the REST API directly, the HTTP - * status code is 400 (Bad Request). - * @member {number} [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} - * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property - * must not be specified if enableAutoScale is set to true. If enableAutoScale - * is set to false, then you must set either targetDedicatedNodes, - * targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] This - * property must not be specified if enableAutoScale is set to false. It is - * required if enableAutoScale is set to true. The formula is checked for - * validity before the pool is created. If the formula is not valid, the Batch - * service rejects the request with detailed error information. - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The - * default value is 15 minutes. The minimum and maximum value are 5 minutes and - * 168 hours respectively. If you specify a value less than 5 minutes or - * greater than 168 hours, the Batch service rejects the request with an - * invalid property value error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] Enabling - * inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This is - * of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] - * Pool endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} [poolInfo.autoPoolSpecification.pool.startTask.commandLine] - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When this - * is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR - * (the root of Azure Batch directories on the node) are mapped into the - * container, all task environment variables are mapped into the container, and - * the task command line is executed in the container. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] - * This is the full image reference, as would be specified to "docker pull". If - * no tag is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] - * This setting can be omitted if was already provided at pool creation. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed - * under this element are located in the task's working directory. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, the - * task runs as a non-administrative user unique to the task. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] - * The default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} - * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The Batch - * service retries a task if its exit code is nonzero. Note that this value - * specifically controls the number of retries. The Batch service will try the - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and - * the start task fails on a compute node, the Batch service retries the start - * task up to its maximum retry count (maxTaskRetryCount). If the task has - * still not completed successfully after all retries, then the Batch service - * marks the compute node unusable, and will not schedule tasks to it. This - * condition can be detected via the node state and failure info details. If - * false, the Batch service will not wait for the start task to complete. In - * this case, other tasks can start executing on the compute node while the - * start task is still running; and even if the start task fails, new tasks - * will continue to be scheduled on the node. The default is false. - * @member {array} [poolInfo.autoPoolSpecification.pool.certificateReferences] - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch - * service does not assign any meaning to metadata; it is solely for the use of - * user code. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in the job are in the completed state. The default is - * noaction. Possible values include: 'noAction', 'terminateJob' - * @member {string} [onTaskFailure] The action the Batch service should take - * when any task in the job fails. 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. Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [networkConfiguration] The network configuration for the - * job. - * @member {string} [networkConfiguration.subnetId] This is only supported for - * jobs running on VirtualMachineConfiguration pools. This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes which will run tasks from the job. For more - * details, see - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {array} [metadata] A list of name-value pairs associated with the - * job as metadata. The Batch service does not assign any meaning to metadata; - * it is solely for the use of user code. - * @member {object} [executionInfo] The execution information for the job. - * @member {date} [executionInfo.startTime] This is the time at which the job - * was created. - * @member {date} [executionInfo.endTime] This property is set only if the job - * is in the completed state. - * @member {string} [executionInfo.poolId] This element contains the actual - * pool where the job is assigned. When you get job details from the service, - * they also contain a poolInfo element, which contains the pool configuration - * data from when the job was added or updated. That poolInfo element may also - * contain a poolId element. If it does, the two IDs are the same. If it does - * not, it means the job ran on an auto pool, and this property contains the ID - * of that auto pool. - * @member {object} [executionInfo.schedulingError] This property is not set if - * there was no error starting the job. - * @member {string} [executionInfo.schedulingError.category] Possible values - * include: 'userError', 'serverError' - * @member {string} [executionInfo.schedulingError.code] - * @member {string} [executionInfo.schedulingError.message] - * @member {array} [executionInfo.schedulingError.details] - * @member {string} [executionInfo.terminateReason] 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. - * @member {object} [stats] Resource usage statistics for the entire lifetime - * of the job. The statistics may not be immediately available. The Batch - * service performs periodic roll-up of statistics. The typical delay is about - * 30 minutes. - * @member {string} [stats.url] - * @member {date} [stats.startTime] - * @member {date} [stats.lastUpdateTime] - * @member {moment.duration} [stats.userCPUTime] - * @member {moment.duration} [stats.kernelCPUTime] - * @member {moment.duration} [stats.wallClockTime] The wall clock time is the - * elapsed time from when the task started running on a compute node to when it - * finished (or to the last time the statistics were updated, if the task had - * not finished by then). If a task was retried, this includes the wall clock - * time of all the task retries. - * @member {number} [stats.readIOps] - * @member {number} [stats.writeIOps] - * @member {number} [stats.readIOGiB] - * @member {number} [stats.writeIOGiB] - * @member {number} [stats.numSucceededTasks] A task completes successfully if - * it returns exit code 0. - * @member {number} [stats.numFailedTasks] A task fails if it exhausts its - * maximum retry count without returning exit code 0. - * @member {number} [stats.numTaskRetries] - * @member {moment.duration} [stats.waitTime] The wait time for a task is - * defined as the elapsed time between the creation of the task and the start - * of task execution. (If the task is retried due to failures, the wait time is - * the time to the most recent task execution.) This value is only reported in - * the account lifetime statistics; it is not included in the job statistics. */ export interface CloudJob { + /** + * @summary A string that uniquely identifies the job within the account. + * @description The ID is case-preserving and case-insensitive (that is, you may not have two IDs + * within an account that differ only by case). + */ id?: string; + /** + * @summary The display name for the job. + */ displayName?: string; + /** + * @summary Whether tasks in the job can define dependencies on each other. The default is false. + */ usesTaskDependencies?: boolean; + /** + * @summary The URL of the job. + */ url?: string; + /** + * @summary The ETag of the job. + * @description This is an opaque string. You can use it to detect whether the job has changed + * between requests. In particular, you can be pass the ETag when updating a job to specify that + * your changes should take effect only if nobody else has modified the job in the meantime. + */ eTag?: string; + /** + * @summary The last modified time of the job. + * @description This is the last time at which the job level data, such as the job state or + * priority, changed. It does not factor in task-level changes such as adding new tasks or tasks + * changing state. + */ lastModified?: Date; + /** + * @summary The creation time of the job. + */ creationTime?: Date; + /** + * @summary The current state of the job. + * @description Possible values include: 'active', 'disabling', 'disabled', 'enabling', + * 'terminating', 'completed', 'deleting' + */ state?: string; + /** + * @summary The time at which the job entered its current state. + */ stateTransitionTime?: Date; + /** + * @summary The previous state of the job. + * @description This property is not set if the job is in its initial Active state. Possible + * values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', + * 'deleting' + */ previousState?: string; + /** + * @summary The time at which the job entered its previous state. + * @description This property is not set if the job is in its initial Active state. + */ previousStateTransitionTime?: Date; + /** + * @summary The priority of the job. + * @description Priority values can range from -1000 to 1000, with -1000 being the lowest + * priority and 1000 being the highest priority. The default value is 0. + */ priority?: number; + /** + * @summary The execution constraints for the job. + */ constraints?: JobConstraints; + /** + * @summary Details of a Job Manager task to be launched when the job is started. + */ jobManagerTask?: JobManagerTask; + /** + * @summary The Job Preparation task. + * @description The Job Preparation task is a special task run on each node before any other task + * of the job. + */ jobPreparationTask?: JobPreparationTask; + /** + * @summary The Job Release task. + * @description The Job Release task is a special task run at the end of the job on each node + * that has run any other task of the job. + */ jobReleaseTask?: JobReleaseTask; + /** + * @summary The list of common environment variable settings. These environment variables are set + * for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks). + * @description Individual tasks can override an environment setting specified here by specifying + * the same setting name with a different value. + */ commonEnvironmentSettings?: EnvironmentSetting[]; + /** + * @summary The pool settings associated with the job. + */ poolInfo?: PoolInformation; + /** + * @summary The action the Batch service should take when all tasks in the job are in the + * completed state. + * @description The default is noaction. Possible values include: 'noAction', 'terminateJob' + */ onAllTasksComplete?: string; + /** + * @summary 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. The default is + * noaction. Possible values include: 'noAction', 'performExitOptionsJobAction' + */ onTaskFailure?: string; + /** + * @summary The network configuration for the job. + */ networkConfiguration?: JobNetworkConfiguration; + /** + * @summary A list of name-value pairs associated with the job as metadata. + * @description The Batch service does not assign any meaning to metadata; it is solely for the + * use of user code. + */ metadata?: MetadataItem[]; + /** + * @summary The execution information for the job. + */ executionInfo?: JobExecutionInformation; + /** + * @summary Resource usage statistics for the entire lifetime of the job. The statistics may not + * be immediately available. The Batch service performs periodic roll-up of statistics. The + * typical delay is about 30 minutes. + */ stats?: JobStatistics; } /** - * @class - * Initializes a new instance of the JobAddParameter class. - * @constructor * @summary An Azure Batch job to add. - * - * @member {string} id A string that uniquely identifies the job within the - * account. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you may - * not have two IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the job. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. - * @member {number} [priority] The priority of the job. Priority values can - * range from -1000 to 1000, with -1000 being the lowest priority and 1000 - * being the highest priority. The default value is 0. - * @member {object} [constraints] The execution constraints for the job. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does not - * complete within the time limit, the Batch service terminates it and any - * tasks that are still running. In this case, the termination reason will be - * MaxWallClockTimeExpiry. If this property is not specified, there is no time - * limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries. The Batch service will try each - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries a task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * tasks. If the maximum retry count is -1, the Batch service retries tasks - * without limit. The default value is 0 (no retries). - * @member {object} [jobManagerTask] Details of a Job Manager task to be - * launched when the job is started. If the job does not specify a Job Manager - * task, the user must explicitly add tasks to the job. If the job does specify - * a Job Manager task, the Batch service creates the Job Manager task when the - * job is created, and will try to schedule the Job Manager task before - * scheduling other tasks in the job. The Job Manager task's typical purpose is - * to control and/or monitor job execution, for example by deciding what - * additional tasks to run, determining when the work is complete, etc. - * (However, a Job Manager task is not restricted to these activities - it is a - * fully-fledged task in the system and perform whatever actions are required - * for the job.) For example, a Job Manager task might download a file - * specified as a parameter, analyze the contents of that file and submit - * additional tasks based on those contents. - * @member {string} [jobManagerTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot contain - * more than 64 characters. - * @member {string} [jobManagerTask.displayName] It need not be unique and can - * contain any Unicode characters up to a maximum length of 1024. - * @member {string} [jobManagerTask.commandLine] The command line does not run - * under a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobManagerTask.containerSettings] If the pool that will - * run this task has containerConfiguration set, this must be set as well. If - * the pool that will run this task doesn't have containerConfiguration set, - * this must not be set. When this is specified, all directories recursively - * below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the - * node) are mapped into the container, all task environment variables are - * mapped into the container, and the task command line is executed in the - * container. - * @member {string} [jobManagerTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} [jobManagerTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} [jobManagerTask.containerSettings.registry.userName] - * @member {string} [jobManagerTask.containerSettings.registry.password] - * @member {array} [jobManagerTask.resourceFiles] Files listed under this - * element are located in the task's working directory. There is a maximum size - * for the list of resource files. When the max size is exceeded, the request - * will fail and the response error code will be RequestEntityTooLarge. If this - * occurs, the collection of ResourceFiles must be reduced in size. This can be - * achieved using .zip files, Application Packages, or Docker Containers. - * @member {array} [jobManagerTask.outputFiles] For multi-instance tasks, the - * files will only be uploaded from the compute node on which the primary task - * is executed. - * @member {array} [jobManagerTask.environmentSettings] - * @member {object} [jobManagerTask.constraints] - * @member {moment.duration} [jobManagerTask.constraints.maxWallClockTime] If - * this is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} [jobManagerTask.constraints.retentionTime] The - * default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {number} [jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobManagerTask.killJobOnCompletion] If true, when the Job - * Manager task completes, the Batch service marks the job as complete. If any - * tasks are still running at this time (other than Job Release), those tasks - * are terminated. If false, the completion of the Job Manager task does not - * affect the job status. In this case, you should either use the - * onAllTasksComplete attribute to terminate the job, or have a client or user - * terminate the job explicitly. An example of this is if the Job Manager - * creates a set of tasks but then takes no further role in their execution. - * The default value is true. If you are using the onAllTasksComplete and - * onTaskFailure attributes to control job lifetime, and using the Job Manager - * task only to create the tasks for the job (not to monitor progress), then it - * is important to set killJobOnCompletion to false. - * @member {object} [jobManagerTask.userIdentity] If omitted, the task runs as - * a non-administrative user unique to the task. - * @member {string} [jobManagerTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [jobManagerTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobManagerTask.runExclusive] If true, no other tasks will - * run on the same compute node for as long as the Job Manager is running. If - * false, other tasks can run simultaneously with the Job Manager on a compute - * node. The Job Manager task counts normally against the node's concurrent - * task limit, so this is only relevant if the node allows multiple concurrent - * tasks. The default value is true. - * @member {array} [jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the existing - * copy on the compute node is used. If a referenced application package cannot - * be installed, for example because the package has been deleted or because - * download failed, the task fails. - * @member {object} [jobManagerTask.authenticationTokenSettings] If this - * property is set, the Batch service provides the task with an authentication - * token which can be used to authenticate Batch service operations without - * requiring an account access key. The token is provided via the - * AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the - * task can carry out using the token depend on the settings. For example, a - * task can request job permissions in order to add other tasks to the job, or - * check the status of the job or of other tasks under the job. - * @member {array} [jobManagerTask.authenticationTokenSettings.access] The - * authentication token grants access to a limited set of Batch service - * operations. Currently the only supported value for the access property is - * 'job', which grants access to all operations related to the job which - * contains the task. - * @member {boolean} [jobManagerTask.allowLowPriorityNode] The default value is - * true. - * @member {object} [jobPreparationTask] The Job Preparation task. If a job has - * a Job Preparation task, the Batch service will run the Job Preparation task - * on a compute node before starting any tasks of that job on that compute - * node. - * @member {string} [jobPreparationTask.id] The ID can contain any combination - * of alphanumeric characters including hyphens and underscores and cannot - * contain more than 64 characters. If you do not specify this property, the - * Batch service assigns a default value of 'jobpreparation'. No other task in - * the job can have the same ID as the Job Preparation task. If you try to - * submit a task with the same id, the Batch service rejects the request with - * error code TaskIdSameAsJobPreparationTask; if you are calling the REST API - * directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobPreparationTask.commandLine] The command line does not - * run under a shell, and therefore cannot take advantage of shell features - * such as environment variable expansion. If you want to take advantage of - * such features, you should invoke the shell in the command line, for example - * using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If - * the command line refers to file paths, it should use a relative path - * (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobPreparationTask.containerSettings] When this is - * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the - * root of Azure Batch directories on the node) are mapped into the container, - * all task environment variables are mapped into the container, and the task - * command line is executed in the container. - * @member {string} [jobPreparationTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no tag - * is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} [jobPreparationTask.containerSettings.registry] This - * setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobPreparationTask.containerSettings.registry.registryServer] If omitted, - * the default is "docker.io". - * @member {string} [jobPreparationTask.containerSettings.registry.userName] - * @member {string} [jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobPreparationTask.resourceFiles] Files listed under this - * element are located in the task's working directory. There is a maximum - * size for the list of resource files. When the max size is exceeded, the - * request will fail and the response error code will be RequestEntityTooLarge. - * If this occurs, the collection of ResourceFiles must be reduced in size. - * This can be achieved using .zip files, Application Packages, or Docker - * Containers. - * @member {array} [jobPreparationTask.environmentSettings] - * @member {object} [jobPreparationTask.constraints] - * @member {moment.duration} [jobPreparationTask.constraints.maxWallClockTime] - * If this is not specified, there is no time limit on how long the task may - * run. - * @member {moment.duration} [jobPreparationTask.constraints.retentionTime] The - * default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note - * that this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobPreparationTask.waitForSuccess] If true and the Job - * Preparation task fails on a compute node, the Batch service retries the Job - * Preparation task up to its maximum retry count (as specified in the - * constraints element). If the task has still not completed successfully after - * all retries, then the Batch service will not schedule tasks of the job to - * the compute node. The compute node remains active and eligible to run tasks - * of other jobs. If false, the Batch service will not wait for the Job - * Preparation task to complete. In this case, other tasks of the job can start - * executing on the compute node while the Job Preparation task is still - * running; and even if the Job Preparation task fails, new tasks will continue - * to be scheduled on the node. The default value is true. - * @member {object} [jobPreparationTask.userIdentity] If omitted, the task runs - * as a non-administrative user unique to the task on Windows nodes, or a a - * non-administrative user unique to the pool on Linux nodes. - * @member {string} [jobPreparationTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [jobPreparationTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [jobPreparationTask.userIdentity.autoUser.scope] The - * default value is task. Possible values include: 'task', 'pool' - * @member {string} [jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The Job - * Preparation task is always rerun if a compute node is reimaged, or if the - * Job Preparation task did not complete (e.g. because the reboot occurred - * while the task was running). Therefore, you should always write a Job - * Preparation task to be idempotent and to behave correctly if run multiple - * times. The default value is true. - * @member {object} [jobReleaseTask] The Job Release task. A Job Release task - * cannot be specified without also specifying a Job Preparation task for the - * job. The Batch service runs the Job Release task on the compute nodes that - * have run the Job Preparation task. The primary purpose of the Job Release - * task is to undo changes to compute nodes made by the Job Preparation task. - * Example activities include deleting local files, or shutting down services - * that were started as part of job preparation. - * @member {string} [jobReleaseTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot contain - * more than 64 characters. If you do not specify this property, the Batch - * service assigns a default value of 'jobrelease'. No other task in the job - * can have the same ID as the Job Release task. If you try to submit a task - * with the same id, the Batch service rejects the request with error code - * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the - * HTTP status code is 409 (Conflict). - * @member {string} [jobReleaseTask.commandLine] The command line does not run - * under a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobReleaseTask.containerSettings] When this is specified, - * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [jobReleaseTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} [jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} [jobReleaseTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} [jobReleaseTask.containerSettings.registry.userName] - * @member {string} [jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobReleaseTask.resourceFiles] Files listed under this - * element are located in the task's working directory. - * @member {array} [jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobReleaseTask.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the compute - * node is removed or the job is deleted. - * @member {object} [jobReleaseTask.userIdentity] If omitted, the task runs as - * a non-administrative user unique to the task. - * @member {string} [jobReleaseTask.userIdentity.userName] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {object} [jobReleaseTask.userIdentity.autoUser] The userName and - * autoUser properties are mutually exclusive; you must specify one but not - * both. - * @member {string} [jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [commonEnvironmentSettings] The list of common environment - * variable settings. These environment variables are set for all tasks in the - * job (including the Job Manager, Job Preparation and Job Release tasks). - * Individual tasks can override an environment setting specified here by - * specifying the same setting name with a different value. - * @member {object} poolInfo The pool on which the Batch service runs the job's - * tasks. - * @member {string} [poolInfo.poolId] You must ensure that the pool referenced - * by this property exists. If the pool does not exist at the time the Batch - * service tries to schedule a job, no tasks for the job will run until you - * create a pool with that id. Note that the Batch service will not reject the - * job request; it will simply not run tasks until the pool exists. You must - * specify either the pool ID or the auto pool specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation - * fails, the Batch service moves the job to a completed state, and the pool - * creation error is set in the job's scheduling error property. The Batch - * service manages the lifetime (both creation and, unless keepAlive is - * specified, deletion) of the auto pool. Any user actions that affect the - * lifetime of the auto pool while the job is active will result in unexpected - * behavior. You must specify either the pool ID or the auto pool - * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The Batch - * service assigns each auto pool a unique identifier on creation. To - * distinguish between pools created for different purposes, you can specify - * this element to add a prefix to the ID that is assigned. The prefix can be - * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] - * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For - * information about available sizes of virtual machines in pools, see Choose a - * VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This - * property must be specified if the pool needs to be created with Azure PaaS - * VMs. This property and virtualMachineConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). This property cannot be - * specified if the Batch account was created with its poolAllocationMode - * property set to 'UserSubscription'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] - * Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] - * The default value is * which specifies the latest operating system version - * for the specified OS family. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This - * property must be specified if the pool needs to be created with Azure IaaS - * VMs. This property and cloudServiceConfiguration are mutually exclusive and - * one of the properties must be specified. If neither is specified then the - * Batch service returns an error; if you are calling the REST API directly, - * the HTTP status code is 400 (Bad Request). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] - * 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. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] - * This only applies to images that contain the Windows operating system, and - * should only be used when you hold valid on-premises licenses for the nodes - * which will be deployed. If omitted, no on-premises licensing discount is - * applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size of - * the compute nodes in the pool (the vmSize setting). - * @member {object} [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] - * Possible values include: 'spread', 'pack' - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies - * only to manual scaling; it has no effect when enableAutoScale is set to - * true. The default value is 15 minutes. The minimum value is 5 minutes. If - * you specify a value less than 5 minutes, the Batch service rejects the - * request with an error; if you are calling the REST API directly, the HTTP - * status code is 400 (Bad Request). - * @member {number} [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} - * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property - * must not be specified if enableAutoScale is set to true. If enableAutoScale - * is set to false, then you must set either targetDedicatedNodes, - * targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] This - * property must not be specified if enableAutoScale is set to false. It is - * required if enableAutoScale is set to true. The formula is checked for - * validity before the pool is created. If the formula is not valid, the Batch - * service rejects the request with detailed error information. - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The - * default value is 15 minutes. The minimum and maximum value are 5 minutes and - * 168 hours respectively. If you specify a value less than 5 minutes or - * greater than 168 hours, the Batch service rejects the request with an - * invalid property value error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] Enabling - * inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This is - * of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] - * Pool endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} [poolInfo.autoPoolSpecification.pool.startTask.commandLine] - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When this - * is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR - * (the root of Azure Batch directories on the node) are mapped into the - * container, all task environment variables are mapped into the container, and - * the task command line is executed in the container. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] - * This is the full image reference, as would be specified to "docker pull". If - * no tag is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] - * This setting can be omitted if was already provided at pool creation. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed - * under this element are located in the task's working directory. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, the - * task runs as a non-administrative user unique to the task. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] - * The default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} - * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The Batch - * service retries a task if its exit code is nonzero. Note that this value - * specifically controls the number of retries. The Batch service will try the - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and - * the start task fails on a compute node, the Batch service retries the start - * task up to its maximum retry count (maxTaskRetryCount). If the task has - * still not completed successfully after all retries, then the Batch service - * marks the compute node unusable, and will not schedule tasks to it. This - * condition can be detected via the node state and failure info details. If - * false, the Batch service will not wait for the start task to complete. In - * this case, other tasks can start executing on the compute node while the - * start task is still running; and even if the start task fails, new tasks - * will continue to be scheduled on the node. The default is false. - * @member {array} [poolInfo.autoPoolSpecification.pool.certificateReferences] - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch - * service does not assign any meaning to metadata; it is solely for the use of - * user code. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in the job are in the completed state. 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. Possible values include: 'noAction', 'terminateJob' - * @member {string} [onTaskFailure] The action the Batch service should take - * when any task in the job fails. 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. Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {array} [metadata] A list of name-value pairs associated with the - * job as metadata. The Batch service does not assign any meaning to metadata; - * it is solely for the use of user code. - * @member {boolean} [usesTaskDependencies] Whether tasks in the job can define - * dependencies on each other. The default is false. - * @member {object} [networkConfiguration] The network configuration for the - * job. - * @member {string} [networkConfiguration.subnetId] This is only supported for - * jobs running on VirtualMachineConfiguration pools. This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes which will run tasks from the job. For more - * details, see - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. */ export interface JobAddParameter { + /** + * @summary A string that uniquely identifies the job within the account. + * @description The ID can contain any combination of alphanumeric characters including hyphens + * and underscores, and cannot contain more than 64 characters. The ID is case-preserving and + * case-insensitive (that is, you may not have two IDs within an account that differ only by + * case). + */ id: string; + /** + * @summary The display name for the job. + * @description The display name need not be unique and can contain any Unicode characters up to + * a maximum length of 1024. + */ displayName?: string; + /** + * @summary The priority of the job. + * @description Priority values can range from -1000 to 1000, with -1000 being the lowest + * priority and 1000 being the highest priority. The default value is 0. + */ priority?: number; + /** + * The execution constraints for the job. + */ constraints?: JobConstraints; + /** + * @summary Details of a Job Manager task to be launched when the job is started. + * @description If the job does not specify a Job Manager task, the user must explicitly add + * tasks to the job. If the job does specify a Job Manager task, the Batch service creates the + * Job Manager task when the job is created, and will try to schedule the Job Manager task before + * scheduling other tasks in the job. The Job Manager task's typical purpose is to control and/or + * monitor job execution, for example by deciding what additional tasks to run, determining when + * the work is complete, etc. (However, a Job Manager task is not restricted to these activities + * - it is a fully-fledged task in the system and perform whatever actions are required for the + * job.) For example, a Job Manager task might download a file specified as a parameter, analyze + * the contents of that file and submit additional tasks based on those contents. + */ jobManagerTask?: JobManagerTask; + /** + * @summary The Job Preparation task. + * @description If a job has a Job Preparation task, the Batch service will run the Job + * Preparation task on a compute node before starting any tasks of that job on that compute node. + */ jobPreparationTask?: JobPreparationTask; + /** + * @summary The Job Release task. + * @description A Job Release task cannot be specified without also specifying a Job Preparation + * task for the job. The Batch service runs the Job Release task on the compute nodes that have + * run the Job Preparation task. The primary purpose of the Job Release task is to undo changes + * to compute nodes made by the Job Preparation task. Example activities include deleting local + * files, or shutting down services that were started as part of job preparation. + */ jobReleaseTask?: JobReleaseTask; + /** + * @summary The list of common environment variable settings. These environment variables are set + * for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks). + * @description Individual tasks can override an environment setting specified here by specifying + * the same setting name with a different value. + */ commonEnvironmentSettings?: EnvironmentSetting[]; + /** + * @summary The pool on which the Batch service runs the job's tasks. + */ poolInfo: PoolInformation; + /** + * @summary 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. The default is noaction. Possible values include: 'noAction', + * 'terminateJob' + */ onAllTasksComplete?: string; + /** + * @summary 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. The default is + * noaction. Possible values include: 'noAction', 'performExitOptionsJobAction' + */ onTaskFailure?: string; + /** + * @summary A list of name-value pairs associated with the job as metadata. + * @description The Batch service does not assign any meaning to metadata; it is solely for the + * use of user code. + */ metadata?: MetadataItem[]; + /** + * @summary Whether tasks in the job can define dependencies on each other. The default is false. + */ usesTaskDependencies?: boolean; + /** + * @summary The network configuration for the job. + */ networkConfiguration?: JobNetworkConfiguration; } /** - * @class - * Initializes a new instance of the TaskContainerExecutionInformation class. - * @constructor * @summary Contains information about the container which a task is executing. - * - * @member {string} [containerId] The ID of the container. - * @member {string} [state] The state of the container. This is the state of - * the container according to the Docker service. It is equivalent to the - * status field returned by "docker inspect". - * @member {string} [error] Detailed error information about the container. - * This is the detailed error string from the Docker service, if available. It - * is equivalent to the error field returned by "docker inspect". */ export interface TaskContainerExecutionInformation { + /** + * @summary The ID of the container. + */ containerId?: string; + /** + * @summary The state of the container. + * @description This is the state of the container according to the Docker service. It is + * equivalent to the status field returned by "docker inspect". + */ state?: string; + /** + * @summary Detailed error information about the container. + * @description This is the detailed error string from the Docker service, if available. It is + * equivalent to the error field returned by "docker inspect". + */ error?: string; } /** - * @class - * Initializes a new instance of the TaskFailureInformation class. - * @constructor * @summary Information about a task failure. - * - * @member {string} category The category of the task error. Possible values - * include: 'userError', 'serverError' - * @member {string} [code] An identifier for the task error. Codes are - * invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the task error, intended to - * be suitable for display in a user interface. - * @member {array} [details] A list of additional details related to the error. */ export interface TaskFailureInformation { + /** + * @summary The category of the task error. + * @description Possible values include: 'userError', 'serverError' + */ category: string; + /** + * @summary An identifier for the task error. Codes are invariant and are intended to be consumed + * programmatically. + */ code?: string; + /** + * @summary A message describing the task error, intended to be suitable for display in a user + * interface. + */ message?: string; + /** + * @summary A list of additional details related to the error. + */ details?: NameValuePair[]; } /** - * @class - * Initializes a new instance of the JobPreparationTaskExecutionInformation class. - * @constructor - * @summary Contains information about the execution of a Job Preparation task - * on a compute node. - * - * @member {date} startTime The time at which the task started running. If the - * task has been restarted or retried, this is the most recent time at which - * the task started running. - * @member {date} [endTime] The time at which the Job Preparation task - * completed. This property is set only if the task is in the Completed state. - * @member {string} state The current state of the Job Preparation task on the - * compute node. Possible values include: 'running', 'completed' - * @member {string} [taskRootDirectory] The root directory of the Job - * Preparation task on the compute node. You can use this path to retrieve - * files created by the task, such as log files. - * @member {string} [taskRootDirectoryUrl] The URL to the root directory of the - * Job Preparation task on the compute node. - * @member {number} [exitCode] The exit code of the program specified on the - * task command line. This parameter is returned only if the task is in the - * completed state. The exit code for a process reflects the specific - * convention implemented by the application developer for that process. If you - * use the exit code value to make decisions in your code, be sure that you - * know the exit code convention used by the application process. Note that the - * exit code may also be generated by the compute node operating system, such - * as when a process is forcibly terminated. - * @member {object} [containerInfo] Information about the container under which - * the task is executing. This property is set only if the task runs in a - * container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string - * from the Docker service, if available. It is equivalent to the error field - * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: - * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {number} retryCount The number of times the task has been retried by - * the Batch service. Task application failures (non-zero exit code) are - * retried, pre-processing errors (the task could not be run) and file upload - * errors are not retried. The Batch service will retry the task up to the - * limit specified by the constraints. Task application failures (non-zero exit - * code) are retried, pre-processing errors (the task could not be run) and - * file upload errors are not retried. The Batch service will retry the task up - * to the limit specified by the constraints. - * @member {date} [lastRetryTime] The most recent time at which a retry of the - * Job Preparation task started running. This property is set only if the task - * was retried (i.e. retryCount is nonzero). If present, this is typically the - * same as startTime, but may be different if the task has been restarted for - * reasons other than retry; for example, if the compute node was rebooted - * during a retry, then the startTime is updated but the lastRetryTime is not. - * @member {string} [result] The result of the task execution. If the value is - * 'failed', then the details of the failure can be found in the failureInfo - * property. Possible values include: 'success', 'failure' + * @summary Contains information about the execution of a Job Preparation task on a compute node. */ export interface JobPreparationTaskExecutionInformation { + /** + * @summary The time at which the task started running. + * @description If the task has been restarted or retried, this is the most recent time at which + * the task started running. + */ startTime: Date; + /** + * @summary The time at which the Job Preparation task completed. + * @description This property is set only if the task is in the Completed state. + */ endTime?: Date; + /** + * @summary The current state of the Job Preparation task on the compute node. + * @description Possible values include: 'running', 'completed' + */ state: string; + /** + * @summary The root directory of the Job Preparation task on the compute node. You can use this + * path to retrieve files created by the task, such as log files. + */ taskRootDirectory?: string; + /** + * @summary The URL to the root directory of the Job Preparation task on the compute node. + */ taskRootDirectoryUrl?: string; + /** + * @summary The exit code of the program specified on the task command line. + * @description This parameter is returned only if the task is in the completed state. The exit + * code for a process reflects the specific convention implemented by the application developer + * for that process. If you use the exit code value to make decisions in your code, be sure that + * you know the exit code convention used by the application process. Note that the exit code may + * also be generated by the compute node operating system, such as when a process is forcibly + * terminated. + */ exitCode?: number; + /** + * @summary Information about the container under which the task is executing. + * @description This property is set only if the task runs in a container context. + */ containerInfo?: TaskContainerExecutionInformation; + /** + * @summary Information describing the task failure, if any. + * @description This property is set only if the task is in the completed state and encountered a + * failure. + */ failureInfo?: TaskFailureInformation; + /** + * @summary The number of times the task has been retried by the Batch service. Task application + * failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) + * and file upload errors are not retried. The Batch service will retry the task up to the limit + * specified by the constraints. + * @description Task application failures (non-zero exit code) are retried, pre-processing errors + * (the task could not be run) and file upload errors are not retried. The Batch service will + * retry the task up to the limit specified by the constraints. + */ retryCount: number; + /** + * @summary The most recent time at which a retry of the Job Preparation task started running. + * @description This property is set only if the task was retried (i.e. retryCount is nonzero). + * If present, this is typically the same as startTime, but may be different if the task has been + * restarted for reasons other than retry; for example, if the compute node was rebooted during a + * retry, then the startTime is updated but the lastRetryTime is not. + */ lastRetryTime?: Date; + /** + * @summary The result of the task execution. + * @description If the value is 'failed', then the details of the failure can be found in the + * failureInfo property. Possible values include: 'success', 'failure' + */ result?: string; } /** - * @class - * Initializes a new instance of the JobReleaseTaskExecutionInformation class. - * @constructor - * @summary Contains information about the execution of a Job Release task on a - * compute node. - * - * @member {date} startTime The time at which the task started running. If the - * task has been restarted or retried, this is the most recent time at which - * the task started running. - * @member {date} [endTime] The time at which the Job Release task completed. - * This property is set only if the task is in the Completed state. - * @member {string} state The current state of the Job Release task on the - * compute node. Possible values include: 'running', 'completed' - * @member {string} [taskRootDirectory] The root directory of the Job Release - * task on the compute node. You can use this path to retrieve files created by - * the task, such as log files. - * @member {string} [taskRootDirectoryUrl] The URL to the root directory of the - * Job Release task on the compute node. - * @member {number} [exitCode] The exit code of the program specified on the - * task command line. This parameter is returned only if the task is in the - * completed state. The exit code for a process reflects the specific - * convention implemented by the application developer for that process. If you - * use the exit code value to make decisions in your code, be sure that you - * know the exit code convention used by the application process. Note that the - * exit code may also be generated by the compute node operating system, such - * as when a process is forcibly terminated. - * @member {object} [containerInfo] Information about the container under which - * the task is executing. This property is set only if the task runs in a - * container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string - * from the Docker service, if available. It is equivalent to the error field - * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: - * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {string} [result] The result of the task execution. If the value is - * 'failed', then the details of the failure can be found in the failureInfo - * property. Possible values include: 'success', 'failure' + * @summary Contains information about the execution of a Job Release task on a compute node. */ export interface JobReleaseTaskExecutionInformation { + /** + * @summary The time at which the task started running. + * @description If the task has been restarted or retried, this is the most recent time at which + * the task started running. + */ startTime: Date; + /** + * @summary The time at which the Job Release task completed. + * @description This property is set only if the task is in the Completed state. + */ endTime?: Date; + /** + * @summary The current state of the Job Release task on the compute node. + * @description Possible values include: 'running', 'completed' + */ state: string; + /** + * @summary The root directory of the Job Release task on the compute node. You can use this path + * to retrieve files created by the task, such as log files. + */ taskRootDirectory?: string; + /** + * @summary The URL to the root directory of the Job Release task on the compute node. + */ taskRootDirectoryUrl?: string; + /** + * @summary The exit code of the program specified on the task command line. + * @description This parameter is returned only if the task is in the completed state. The exit + * code for a process reflects the specific convention implemented by the application developer + * for that process. If you use the exit code value to make decisions in your code, be sure that + * you know the exit code convention used by the application process. Note that the exit code may + * also be generated by the compute node operating system, such as when a process is forcibly + * terminated. + */ exitCode?: number; + /** + * @summary Information about the container under which the task is executing. + * @description This property is set only if the task runs in a container context. + */ containerInfo?: TaskContainerExecutionInformation; + /** + * @summary Information describing the task failure, if any. + * @description This property is set only if the task is in the completed state and encountered a + * failure. + */ failureInfo?: TaskFailureInformation; + /** + * @summary The result of the task execution. + * @description If the value is 'failed', then the details of the failure can be found in the + * failureInfo property. Possible values include: 'success', 'failure' + */ result?: string; } /** - * @class - * Initializes a new instance of the JobPreparationAndReleaseTaskExecutionInformation class. - * @constructor - * @summary The status of the Job Preparation and Job Release tasks on a - * compute node. - * - * @member {string} [poolId] The ID of the pool containing the compute node to - * which this entry refers. - * @member {string} [nodeId] The ID of the compute node to which this entry - * refers. - * @member {string} [nodeUrl] The URL of the compute node to which this entry - * refers. - * @member {object} [jobPreparationTaskExecutionInfo] Information about the - * execution status of the Job Preparation task on this compute node. - * @member {date} [jobPreparationTaskExecutionInfo.startTime] If the task has - * been restarted or retried, this is the most recent time at which the task - * started running. - * @member {date} [jobPreparationTaskExecutionInfo.endTime] This property is - * set only if the task is in the Completed state. - * @member {string} [jobPreparationTaskExecutionInfo.state] Possible values - * include: 'running', 'completed' - * @member {string} [jobPreparationTaskExecutionInfo.taskRootDirectory] - * @member {string} [jobPreparationTaskExecutionInfo.taskRootDirectoryUrl] - * @member {number} [jobPreparationTaskExecutionInfo.exitCode] This parameter - * is returned only if the task is in the completed state. The exit code for a - * process reflects the specific convention implemented by the application - * developer for that process. If you use the exit code value to make decisions - * in your code, be sure that you know the exit code convention used by the - * application process. Note that the exit code may also be generated by the - * compute node operating system, such as when a process is forcibly - * terminated. - * @member {object} [jobPreparationTaskExecutionInfo.containerInfo] This - * property is set only if the task runs in a container context. - * @member {string} [jobPreparationTaskExecutionInfo.containerInfo.containerId] - * @member {string} [jobPreparationTaskExecutionInfo.containerInfo.state] This - * is the state of the container according to the Docker service. It is - * equivalent to the status field returned by "docker inspect". - * @member {string} [jobPreparationTaskExecutionInfo.containerInfo.error] This - * is the detailed error string from the Docker service, if available. It is - * equivalent to the error field returned by "docker inspect". - * @member {object} [jobPreparationTaskExecutionInfo.failureInfo] This property - * is set only if the task is in the completed state and encountered a failure. - * @member {string} [jobPreparationTaskExecutionInfo.failureInfo.category] - * Possible values include: 'userError', 'serverError' - * @member {string} [jobPreparationTaskExecutionInfo.failureInfo.code] - * @member {string} [jobPreparationTaskExecutionInfo.failureInfo.message] - * @member {array} [jobPreparationTaskExecutionInfo.failureInfo.details] - * @member {number} [jobPreparationTaskExecutionInfo.retryCount] Task - * application failures (non-zero exit code) are retried, pre-processing errors - * (the task could not be run) and file upload errors are not retried. The - * Batch service will retry the task up to the limit specified by the - * constraints. - * @member {date} [jobPreparationTaskExecutionInfo.lastRetryTime] This property - * is set only if the task was retried (i.e. retryCount is nonzero). If - * present, this is typically the same as startTime, but may be different if - * the task has been restarted for reasons other than retry; for example, if - * the compute node was rebooted during a retry, then the startTime is updated - * but the lastRetryTime is not. - * @member {string} [jobPreparationTaskExecutionInfo.result] If the value is - * 'failed', then the details of the failure can be found in the failureInfo - * property. Possible values include: 'success', 'failure' - * @member {object} [jobReleaseTaskExecutionInfo] Information about the - * execution status of the Job Release task on this compute node. This property - * is set only if the Job Release task has run on the node. - * @member {date} [jobReleaseTaskExecutionInfo.startTime] If the task has been - * restarted or retried, this is the most recent time at which the task started - * running. - * @member {date} [jobReleaseTaskExecutionInfo.endTime] This property is set - * only if the task is in the Completed state. - * @member {string} [jobReleaseTaskExecutionInfo.state] Possible values - * include: 'running', 'completed' - * @member {string} [jobReleaseTaskExecutionInfo.taskRootDirectory] - * @member {string} [jobReleaseTaskExecutionInfo.taskRootDirectoryUrl] - * @member {number} [jobReleaseTaskExecutionInfo.exitCode] This parameter is - * returned only if the task is in the completed state. The exit code for a - * process reflects the specific convention implemented by the application - * developer for that process. If you use the exit code value to make decisions - * in your code, be sure that you know the exit code convention used by the - * application process. Note that the exit code may also be generated by the - * compute node operating system, such as when a process is forcibly - * terminated. - * @member {object} [jobReleaseTaskExecutionInfo.containerInfo] This property - * is set only if the task runs in a container context. - * @member {string} [jobReleaseTaskExecutionInfo.containerInfo.containerId] - * @member {string} [jobReleaseTaskExecutionInfo.containerInfo.state] This is - * the state of the container according to the Docker service. It is equivalent - * to the status field returned by "docker inspect". - * @member {string} [jobReleaseTaskExecutionInfo.containerInfo.error] This is - * the detailed error string from the Docker service, if available. It is - * equivalent to the error field returned by "docker inspect". - * @member {object} [jobReleaseTaskExecutionInfo.failureInfo] This property is - * set only if the task is in the completed state and encountered a failure. - * @member {string} [jobReleaseTaskExecutionInfo.failureInfo.category] Possible - * values include: 'userError', 'serverError' - * @member {string} [jobReleaseTaskExecutionInfo.failureInfo.code] - * @member {string} [jobReleaseTaskExecutionInfo.failureInfo.message] - * @member {array} [jobReleaseTaskExecutionInfo.failureInfo.details] - * @member {string} [jobReleaseTaskExecutionInfo.result] If the value is - * 'failed', then the details of the failure can be found in the failureInfo - * property. Possible values include: 'success', 'failure' + * @summary The status of the Job Preparation and Job Release tasks on a compute node. */ export interface JobPreparationAndReleaseTaskExecutionInformation { + /** + * @summary The ID of the pool containing the compute node to which this entry refers. + */ poolId?: string; + /** + * @summary The ID of the compute node to which this entry refers. + */ nodeId?: string; + /** + * @summary The URL of the compute node to which this entry refers. + */ nodeUrl?: string; + /** + * @summary Information about the execution status of the Job Preparation task on this compute + * node. + */ jobPreparationTaskExecutionInfo?: JobPreparationTaskExecutionInformation; + /** + * @summary Information about the execution status of the Job Release task on this compute node. + * @description This property is set only if the Job Release task has run on the node. + */ jobReleaseTaskExecutionInfo?: JobReleaseTaskExecutionInformation; } /** - * @class - * Initializes a new instance of the TaskCounts class. - * @constructor * @summary The task counts for a job. - * - * @member {number} active The number of tasks in the active state. - * @member {number} running The number of tasks in the running or preparing - * state. - * @member {number} completed The number of tasks in the completed state. - * @member {number} succeeded The number of tasks which succeeded. A task - * succeeds if its result (found in the executionInfo property) is 'success'. - * @member {number} failed The number of tasks which failed. A task fails if - * its result (found in the executionInfo property) is 'failure'. */ export interface TaskCounts { + /** + * @summary The number of tasks in the active state. + */ active: number; + /** + * @summary The number of tasks in the running or preparing state. + */ running: number; + /** + * @summary The number of tasks in the completed state. + */ completed: number; + /** + * @summary The number of tasks which succeeded. A task succeeds if its result (found in the + * executionInfo property) is 'success'. + */ succeeded: number; + /** + * @summary The number of tasks which failed. A task fails if its result (found in the + * executionInfo property) is 'failure'. + */ failed: number; } /** - * @class - * Initializes a new instance of the AutoScaleRunError class. - * @constructor - * @summary An error that occurred when executing or evaluating a pool - * autoscale formula. - * - * @member {string} [code] An identifier for the autoscale error. Codes are - * invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the autoscale error, - * intended to be suitable for display in a user interface. - * @member {array} [values] A list of additional error details related to the - * autoscale error. + * @summary An error that occurred when executing or evaluating a pool autoscale formula. */ export interface AutoScaleRunError { + /** + * @summary An identifier for the autoscale error. Codes are invariant and are intended to be + * consumed programmatically. + */ code?: string; + /** + * @summary A message describing the autoscale error, intended to be suitable for display in a + * user interface. + */ message?: string; + /** + * @summary A list of additional error details related to the autoscale error. + */ values?: NameValuePair[]; } /** - * @class - * Initializes a new instance of the AutoScaleRun class. - * @constructor - * @summary The results and errors from an execution of a pool autoscale - * formula. - * - * @member {date} timestamp The time at which the autoscale formula was last - * evaluated. - * @member {string} [results] The final values of all variables used in the - * evaluation of the autoscale formula. Each variable value is returned in the - * form $variable=value, and variables are separated by semicolons. - * @member {object} [error] Details of the error encountered evaluating the - * autoscale formula on the pool, if the evaluation was unsuccessful. - * @member {string} [error.code] - * @member {string} [error.message] - * @member {array} [error.values] + * @summary The results and errors from an execution of a pool autoscale formula. */ export interface AutoScaleRun { + /** + * @summary The time at which the autoscale formula was last evaluated. + */ timestamp: Date; + /** + * @summary The final values of all variables used in the evaluation of the autoscale formula. + * @description Each variable value is returned in the form $variable=value, and variables are + * separated by semicolons. + */ results?: string; + /** + * @summary Details of the error encountered evaluating the autoscale formula on the pool, if the + * evaluation was unsuccessful. + */ error?: AutoScaleRunError; } /** - * @class - * Initializes a new instance of the ResizeError class. - * @constructor * @summary An error that occurred when resizing a pool. - * - * @member {string} [code] An identifier for the pool resize error. Codes are - * invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the pool resize error, - * intended to be suitable for display in a user interface. - * @member {array} [values] A list of additional error details related to the - * pool resize error. */ export interface ResizeError { + /** + * @summary An identifier for the pool resize error. Codes are invariant and are intended to be + * consumed programmatically. + */ code?: string; + /** + * @summary A message describing the pool resize error, intended to be suitable for display in a + * user interface. + */ message?: string; + /** + * @summary A list of additional error details related to the pool resize error. + */ values?: NameValuePair[]; } /** - * @class - * Initializes a new instance of the CloudPool class. - * @constructor * @summary A pool in the Azure Batch service. - * - * @member {string} [id] A string that uniquely identifies the pool within the - * account. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you may - * not have two IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the pool. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. - * @member {string} [url] The URL of the pool. - * @member {string} [eTag] The ETag of the pool. This is an opaque string. You - * can use it to detect whether the pool has changed between requests. In - * particular, you can be pass the ETag when updating a pool to specify that - * your changes should take effect only if nobody else has modified the pool in - * the meantime. - * @member {date} [lastModified] The last modified time of the pool. This is - * the last time at which the pool level data, such as the targetDedicatedNodes - * or enableAutoscale settings, changed. It does not factor in node-level - * changes such as a compute node changing state. - * @member {date} [creationTime] The creation time of the pool. - * @member {string} [state] The current state of the pool. Possible values - * include: 'active', 'deleting' - * @member {date} [stateTransitionTime] The time at which the pool entered its - * current state. - * @member {string} [allocationState] Whether the pool is resizing. Possible - * values include: 'steady', 'resizing', 'stopping' - * @member {date} [allocationStateTransitionTime] The time at which the pool - * entered its current allocation state. - * @member {string} [vmSize] The size of virtual machines in the pool. All - * virtual machines in a pool are the same size. For information about - * available sizes of virtual machines in pools, see Choose a VM size for - * compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} [cloudServiceConfiguration] The cloud service configuration - * for the pool. This property and virtualMachineConfiguration are mutually - * exclusive and one of the properties must be specified. This property cannot - * be specified if the Batch account was created with its poolAllocationMode - * property set to 'UserSubscription'. - * @member {string} [cloudServiceConfiguration.osFamily] Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [cloudServiceConfiguration.osVersion] The default value is - * * which specifies the latest operating system version for the specified OS - * family. - * @member {object} [virtualMachineConfiguration] The virtual machine - * configuration for the pool. This property and cloudServiceConfiguration are - * mutually exclusive and one of the properties must be specified. - * @member {object} [virtualMachineConfiguration.imageReference] - * @member {string} [virtualMachineConfiguration.imageReference.publisher] For - * example, Canonical or MicrosoftWindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.offer] For - * example, UbuntuServer or WindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.sku] For - * example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [virtualMachineConfiguration.imageReference.version] A - * value of 'latest' can be specified to select the latest version of an image. - * If omitted, the default is 'latest'. - * @member {string} - * [virtualMachineConfiguration.imageReference.virtualMachineImageId] This - * property is mutually exclusive with other ImageReference properties. The - * virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch node - * agent is a program that runs on each node in the pool, and provides the - * command-and-control interface between the node and the Batch service. There - * are different implementations of the node agent, known as SKUs, for - * different operating systems. You must specify a node agent SKU which matches - * the selected image reference. To get the list of supported node agent SKUs - * along with their list of verified image references, see the 'List supported - * node agent SKUs' operation. - * @member {object} [virtualMachineConfiguration.windowsConfiguration] This - * property must not be specified if the imageReference property specifies a - * Linux OS image. - * @member {boolean} - * [virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] If - * omitted, the default value is true. - * @member {array} [virtualMachineConfiguration.dataDisks] 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. - * @member {string} [virtualMachineConfiguration.licenseType] This only applies - * to images that contain the Windows operating system, and should only be used - * when you hold valid on-premises licenses for the nodes which will be - * deployed. If omitted, no on-premises licensing discount is applied. Values - * are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [virtualMachineConfiguration.containerConfiguration] If - * specified, setup is performed on each node in the pool to allow tasks to run - * in containers. All regular tasks and job manager tasks run on this pool must - * specify the containerSettings property, and all other tasks may specify it. - * @member {array} - * [virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [virtualMachineConfiguration.containerConfiguration.containerRegistries] If - * any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {moment.duration} [resizeTimeout] The timeout for allocation of - * compute nodes to the pool. This is the timeout for the most recent resize - * operation. (The initial sizing when the pool is created counts as a resize.) - * The default value is 15 minutes. - * @member {array} [resizeErrors] A list of errors encountered while performing - * the last resize on the pool. This property is set only if one or more errors - * occurred during the last pool resize, and only when the pool allocationState - * is Steady. - * @member {number} [currentDedicatedNodes] The number of dedicated compute - * nodes currently in the pool. - * @member {number} [currentLowPriorityNodes] The number of low-priority - * compute nodes currently in the pool. Low-priority compute nodes which have - * been preempted are included in this count. - * @member {number} [targetDedicatedNodes] The desired number of dedicated - * compute nodes in the pool. - * @member {number} [targetLowPriorityNodes] The desired number of low-priority - * compute nodes in the pool. - * @member {boolean} [enableAutoScale] Whether the pool size should - * automatically adjust over time. If false, at least one of - * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, - * the autoScaleFormula property is required and the pool automatically resizes - * according to the formula. The default value is false. - * @member {string} [autoScaleFormula] A formula for the desired number of - * compute nodes in the pool. This property is set only if the pool - * automatically scales, i.e. enableAutoScale is true. - * @member {moment.duration} [autoScaleEvaluationInterval] The time interval at - * which to automatically adjust the pool size according to the autoscale - * formula. This property is set only if the pool automatically scales, i.e. - * enableAutoScale is true. - * @member {object} [autoScaleRun] The results and errors from the last - * execution of the autoscale formula. This property is set only if the pool - * automatically scales, i.e. enableAutoScale is true. - * @member {date} [autoScaleRun.timestamp] - * @member {string} [autoScaleRun.results] Each variable value is returned in - * the form $variable=value, and variables are separated by semicolons. - * @member {object} [autoScaleRun.error] - * @member {string} [autoScaleRun.error.code] - * @member {string} [autoScaleRun.error.message] - * @member {array} [autoScaleRun.error.values] - * @member {boolean} [enableInterNodeCommunication] Whether the pool permits - * direct communication between nodes. This imposes restrictions on which nodes - * can be assigned to the pool. Specifying this value can reduce the chance of - * the requested number of nodes to be allocated in the pool. - * @member {object} [networkConfiguration] The network configuration for the - * pool. - * @member {string} [networkConfiguration.subnetId] This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [networkConfiguration.dynamicVNetAssignmentScope] Possible - * values include: 'none', 'job' - * @member {object} [networkConfiguration.endpointConfiguration] Pool endpoint - * configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} [networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [startTask] A task specified to run on each compute node as - * it joins the pool. - * @member {string} [startTask.commandLine] The command line does not run under - * a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure - * Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These - * additional options are supplied as arguments to the "docker create" command, - * in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [startTask.containerSettings.registry] This setting can be - * omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a - * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [startTask.userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically controls - * the number of retries. The Batch service will try the task once, and may - * then retry up to this limit. For example, if the maximum retry count is 3, - * Batch tries the task up to 4 times (one initial try and 3 retries). If the - * maximum retry count is 0, the Batch service does not retry the task. If the - * maximum retry count is -1, the Batch service retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task - * fails on a compute node, the Batch service retries the start task up to its - * maximum retry count (maxTaskRetryCount). If the task has still not completed - * successfully after all retries, then the Batch service marks the compute - * node unusable, and will not schedule tasks to it. This condition can be - * detected via the node state and failure info details. If false, the Batch - * service will not wait for the start task to complete. In this case, other - * tasks can start executing on the compute node while the start task is still - * running; and even if the start task fails, new tasks will continue to be - * scheduled on the node. The default is false. - * @member {array} [certificateReferences] The list of certificates to be - * installed on each compute node in the pool. For Windows compute nodes, the - * Batch service installs the certificates to the specified certificate store - * and location. 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. - * @member {array} [applicationPackageReferences] The list of application - * packages to be installed on each compute node in the pool. - * @member {array} [applicationLicenses] The list of application licenses the - * Batch service will make available on each compute node in the pool. The list - * of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. - * @member {number} [maxTasksPerNode] The maximum number of tasks that can run - * concurrently on a single compute node in the pool. - * @member {object} [taskSchedulingPolicy] How tasks are distributed across - * compute nodes in a pool. - * @member {string} [taskSchedulingPolicy.nodeFillType] Possible values - * include: 'spread', 'pack' - * @member {array} [userAccounts] The list of user accounts to be created on - * each node in the pool. - * @member {array} [metadata] A list of name-value pairs associated with the - * pool as metadata. - * @member {object} [stats] Utilization and resource usage statistics for the - * entire lifetime of the pool. The statistics may not be immediately - * available. The Batch service performs periodic roll-up of statistics. The - * typical delay is about 30 minutes. - * @member {string} [stats.url] - * @member {date} [stats.startTime] - * @member {date} [stats.lastUpdateTime] - * @member {object} [stats.usageStats] - * @member {date} [stats.usageStats.startTime] - * @member {date} [stats.usageStats.lastUpdateTime] - * @member {moment.duration} [stats.usageStats.dedicatedCoreTime] - * @member {object} [stats.resourceStats] - * @member {date} [stats.resourceStats.startTime] - * @member {date} [stats.resourceStats.lastUpdateTime] - * @member {number} [stats.resourceStats.avgCPUPercentage] - * @member {number} [stats.resourceStats.avgMemoryGiB] - * @member {number} [stats.resourceStats.peakMemoryGiB] - * @member {number} [stats.resourceStats.avgDiskGiB] - * @member {number} [stats.resourceStats.peakDiskGiB] - * @member {number} [stats.resourceStats.diskReadIOps] - * @member {number} [stats.resourceStats.diskWriteIOps] - * @member {number} [stats.resourceStats.diskReadGiB] - * @member {number} [stats.resourceStats.diskWriteGiB] - * @member {number} [stats.resourceStats.networkReadGiB] - * @member {number} [stats.resourceStats.networkWriteGiB] */ export interface CloudPool { + /** + * @summary A string that uniquely identifies the pool within the account. + * @description The ID can contain any combination of alphanumeric characters including hyphens + * and underscores, and cannot contain more than 64 characters. The ID is case-preserving and + * case-insensitive (that is, you may not have two IDs within an account that differ only by + * case). + */ id?: string; + /** + * @summary The display name for the pool. + * @description The display name need not be unique and can contain any Unicode characters up to + * a maximum length of 1024. + */ displayName?: string; + /** + * @summary The URL of the pool. + */ url?: string; + /** + * @summary The ETag of the pool. + * @description This is an opaque string. You can use it to detect whether the pool has changed + * between requests. In particular, you can be pass the ETag when updating a pool to specify that + * your changes should take effect only if nobody else has modified the pool in the meantime. + */ eTag?: string; + /** + * @summary The last modified time of the pool. + * @description This is the last time at which the pool level data, such as the + * targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level + * changes such as a compute node changing state. + */ lastModified?: Date; + /** + * @summary The creation time of the pool. + */ creationTime?: Date; + /** + * @summary The current state of the pool. + * @description Possible values include: 'active', 'deleting' + */ state?: string; + /** + * @summary The time at which the pool entered its current state. + */ stateTransitionTime?: Date; + /** + * @summary Whether the pool is resizing. + * @description Possible values include: 'steady', 'resizing', 'stopping' + */ allocationState?: string; + /** + * @summary The time at which the pool entered its current allocation state. + */ allocationStateTransitionTime?: Date; + /** + * @summary The size of virtual machines in the pool. All virtual machines in a pool are the same + * size. + * @description For information about available sizes of virtual machines in pools, see Choose a + * VM size for compute nodes in an Azure Batch pool + * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). + */ vmSize?: string; + /** + * @summary The cloud service configuration for the pool. + * @description This property and virtualMachineConfiguration are mutually exclusive and one of + * the properties must be specified. This property cannot be specified if the Batch account was + * created with its poolAllocationMode property set to 'UserSubscription'. + */ cloudServiceConfiguration?: CloudServiceConfiguration; + /** + * @summary The virtual machine configuration for the pool. + * @description This property and cloudServiceConfiguration are mutually exclusive and one of the + * properties must be specified. + */ virtualMachineConfiguration?: VirtualMachineConfiguration; + /** + * @summary The timeout for allocation of compute nodes to the pool. + * @description This is the timeout for the most recent resize operation. (The initial sizing + * when the pool is created counts as a resize.) The default value is 15 minutes. + */ resizeTimeout?: moment.Duration; + /** + * @summary A list of errors encountered while performing the last resize on the pool. + * @description This property is set only if one or more errors occurred during the last pool + * resize, and only when the pool allocationState is Steady. + */ resizeErrors?: ResizeError[]; + /** + * @summary The number of dedicated compute nodes currently in the pool. + */ currentDedicatedNodes?: number; + /** + * @summary The number of low-priority compute nodes currently in the pool. + * @description Low-priority compute nodes which have been preempted are included in this count. + */ currentLowPriorityNodes?: number; + /** + * @summary The desired number of dedicated compute nodes in the pool. + */ targetDedicatedNodes?: number; + /** + * @summary The desired number of low-priority compute nodes in the pool. + */ targetLowPriorityNodes?: number; + /** + * @summary Whether the pool size should automatically adjust over time. + * @description If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be + * specified. If true, the autoScaleFormula property is required and the pool automatically + * resizes according to the formula. The default value is false. + */ enableAutoScale?: boolean; + /** + * @summary A formula for the desired number of compute nodes in the pool. + * @description This property is set only if the pool automatically scales, i.e. enableAutoScale + * is true. + */ autoScaleFormula?: string; + /** + * @summary The time interval at which to automatically adjust the pool size according to the + * autoscale formula. + * @description This property is set only if the pool automatically scales, i.e. enableAutoScale + * is true. + */ autoScaleEvaluationInterval?: moment.Duration; + /** + * @summary The results and errors from the last execution of the autoscale formula. + * @description This property is set only if the pool automatically scales, i.e. enableAutoScale + * is true. + */ autoScaleRun?: AutoScaleRun; + /** + * @summary Whether the pool permits direct communication between nodes. + * @description This imposes restrictions on which nodes can be assigned to the pool. Specifying + * this value can reduce the chance of the requested number of nodes to be allocated in the pool. + */ enableInterNodeCommunication?: boolean; + /** + * @summary The network configuration for the pool. + */ networkConfiguration?: NetworkConfiguration; + /** + * @summary A task specified to run on each compute node as it joins the pool. + */ startTask?: StartTask; + /** + * @summary The list of certificates to be installed on each compute node in the pool. + * @description For Windows compute nodes, the Batch service installs the certificates to the + * specified certificate store and location. 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. + */ certificateReferences?: CertificateReference[]; + /** + * @summary The list of application packages to be installed on each compute node in the pool. + */ applicationPackageReferences?: ApplicationPackageReference[]; + /** + * @summary The list of application licenses the Batch service will make available on each + * compute node in the pool. + * @description The list of application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, pool creation will + * fail. + */ applicationLicenses?: string[]; + /** + * @summary The maximum number of tasks that can run concurrently on a single compute node in the + * pool. + */ maxTasksPerNode?: number; + /** + * @summary How tasks are distributed across compute nodes in a pool. + */ taskSchedulingPolicy?: TaskSchedulingPolicy; + /** + * @summary The list of user accounts to be created on each node in the pool. + */ userAccounts?: UserAccount[]; + /** + * @summary A list of name-value pairs associated with the pool as metadata. + */ metadata?: MetadataItem[]; + /** + * @summary Utilization and resource usage statistics for the entire lifetime of the pool. The + * statistics may not be immediately available. The Batch service performs periodic roll-up of + * statistics. The typical delay is about 30 minutes. + */ stats?: PoolStatistics; } /** - * @class - * Initializes a new instance of the PoolAddParameter class. - * @constructor * @summary A pool in the Azure Batch service to add. - * - * @member {string} id A string that uniquely identifies the pool within the - * account. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you may - * not have two pool IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the pool. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. - * @member {string} vmSize The size of virtual machines in the pool. All - * virtual machines in a pool are the same size. For information about - * available sizes of virtual machines for Cloud Services pools (pools created - * with cloudServiceConfiguration), see Sizes for Cloud Services - * (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). - * Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. - * For information about available VM sizes for pools using images from the - * Virtual Machines Marketplace (pools created with - * virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) - * (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) - * or Sizes for Virtual Machines (Windows) - * (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). - * Batch supports all Azure VM sizes except STANDARD_A0 and those with premium - * storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). - * @member {object} [cloudServiceConfiguration] The cloud service configuration - * for the pool. This property and virtualMachineConfiguration are mutually - * exclusive and one of the properties must be specified. This property cannot - * be specified if the Batch account was created with its poolAllocationMode - * property set to 'UserSubscription'. - * @member {string} [cloudServiceConfiguration.osFamily] Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [cloudServiceConfiguration.osVersion] The default value is - * * which specifies the latest operating system version for the specified OS - * family. - * @member {object} [virtualMachineConfiguration] The virtual machine - * configuration for the pool. This property and cloudServiceConfiguration are - * mutually exclusive and one of the properties must be specified. - * @member {object} [virtualMachineConfiguration.imageReference] - * @member {string} [virtualMachineConfiguration.imageReference.publisher] For - * example, Canonical or MicrosoftWindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.offer] For - * example, UbuntuServer or WindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.sku] For - * example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [virtualMachineConfiguration.imageReference.version] A - * value of 'latest' can be specified to select the latest version of an image. - * If omitted, the default is 'latest'. - * @member {string} - * [virtualMachineConfiguration.imageReference.virtualMachineImageId] This - * property is mutually exclusive with other ImageReference properties. The - * virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch node - * agent is a program that runs on each node in the pool, and provides the - * command-and-control interface between the node and the Batch service. There - * are different implementations of the node agent, known as SKUs, for - * different operating systems. You must specify a node agent SKU which matches - * the selected image reference. To get the list of supported node agent SKUs - * along with their list of verified image references, see the 'List supported - * node agent SKUs' operation. - * @member {object} [virtualMachineConfiguration.windowsConfiguration] This - * property must not be specified if the imageReference property specifies a - * Linux OS image. - * @member {boolean} - * [virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] If - * omitted, the default value is true. - * @member {array} [virtualMachineConfiguration.dataDisks] 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. - * @member {string} [virtualMachineConfiguration.licenseType] This only applies - * to images that contain the Windows operating system, and should only be used - * when you hold valid on-premises licenses for the nodes which will be - * deployed. If omitted, no on-premises licensing discount is applied. Values - * are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [virtualMachineConfiguration.containerConfiguration] If - * specified, setup is performed on each node in the pool to allow tasks to run - * in containers. All regular tasks and job manager tasks run on this pool must - * specify the containerSettings property, and all other tasks may specify it. - * @member {array} - * [virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [virtualMachineConfiguration.containerConfiguration.containerRegistries] If - * any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {moment.duration} [resizeTimeout] The timeout for allocation of - * compute nodes to the pool. This timeout applies only to manual scaling; it - * has no effect when enableAutoScale is set to true. The default value is 15 - * minutes. The minimum value is 5 minutes. If you specify a value less than 5 - * minutes, the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {number} [targetDedicatedNodes] The desired number of dedicated - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to true. If enableAutoScale is set to false, then you - * must set either targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} [targetLowPriorityNodes] The desired number of low-priority - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to true. If enableAutoScale is set to false, then you - * must set either targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} [enableAutoScale] Whether the pool size should - * automatically adjust over time. If false, at least one of - * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, - * the autoScaleFormula property is required and the pool automatically resizes - * according to the formula. The default value is false. - * @member {string} [autoScaleFormula] A formula for the desired number of - * compute nodes in the pool. This property must not be specified if - * enableAutoScale is set to false. It is required if enableAutoScale is set to - * true. The formula is checked for validity before the pool is created. If the - * formula is not valid, the Batch service rejects the request with detailed - * error information. For more information about specifying this formula, see - * 'Automatically scale compute nodes in an Azure Batch pool' - * (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/). - * @member {moment.duration} [autoScaleEvaluationInterval] The time interval at - * which to automatically adjust the pool size according to the autoscale - * formula. The default value is 15 minutes. The minimum and maximum value are - * 5 minutes and 168 hours respectively. If you specify a value less than 5 - * minutes or greater than 168 hours, the Batch service returns an error; if - * you are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {boolean} [enableInterNodeCommunication] Whether the pool permits - * direct communication between nodes. Enabling inter-node communication limits - * the maximum size of the pool due to deployment restrictions on the nodes of - * the pool. This may result in the pool not reaching its desired size. The - * default value is false. - * @member {object} [networkConfiguration] The network configuration for the - * pool. - * @member {string} [networkConfiguration.subnetId] This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [networkConfiguration.dynamicVNetAssignmentScope] Possible - * values include: 'none', 'job' - * @member {object} [networkConfiguration.endpointConfiguration] Pool endpoint - * configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} [networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [startTask] A task specified to run on each compute node as - * it joins the pool. The task runs when the node is added to the pool or when - * the node is restarted. - * @member {string} [startTask.commandLine] The command line does not run under - * a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure - * Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These - * additional options are supplied as arguments to the "docker create" command, - * in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [startTask.containerSettings.registry] This setting can be - * omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a - * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [startTask.userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically controls - * the number of retries. The Batch service will try the task once, and may - * then retry up to this limit. For example, if the maximum retry count is 3, - * Batch tries the task up to 4 times (one initial try and 3 retries). If the - * maximum retry count is 0, the Batch service does not retry the task. If the - * maximum retry count is -1, the Batch service retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task - * fails on a compute node, the Batch service retries the start task up to its - * maximum retry count (maxTaskRetryCount). If the task has still not completed - * successfully after all retries, then the Batch service marks the compute - * node unusable, and will not schedule tasks to it. This condition can be - * detected via the node state and failure info details. If false, the Batch - * service will not wait for the start task to complete. In this case, other - * tasks can start executing on the compute node while the start task is still - * running; and even if the start task fails, new tasks will continue to be - * scheduled on the node. The default is false. - * @member {array} [certificateReferences] The list of certificates to be - * installed on each compute node in the pool. For Windows compute nodes, the - * Batch service installs the certificates to the specified certificate store - * and location. 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. - * @member {array} [applicationPackageReferences] The list of application - * packages to be installed on each compute node in the pool. - * @member {array} [applicationLicenses] The list of application licenses the - * Batch service will make available on each compute node in the pool. The list - * of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. - * @member {number} [maxTasksPerNode] The maximum number of tasks that can run - * concurrently on a single compute node in the pool. The default value is 1. - * The maximum value of this setting depends on the size of the compute nodes - * in the pool (the vmSize setting). - * @member {object} [taskSchedulingPolicy] How tasks are distributed across - * compute nodes in a pool. - * @member {string} [taskSchedulingPolicy.nodeFillType] Possible values - * include: 'spread', 'pack' - * @member {array} [userAccounts] The list of user accounts to be created on - * each node in the pool. - * @member {array} [metadata] A list of name-value pairs associated with the - * pool as metadata. The Batch service does not assign any meaning to metadata; - * it is solely for the use of user code. */ export interface PoolAddParameter { + /** + * @summary A string that uniquely identifies the pool within the account. + * @description The ID can contain any combination of alphanumeric characters including hyphens + * and underscores, and cannot contain more than 64 characters. The ID is case-preserving and + * case-insensitive (that is, you may not have two pool IDs within an account that differ only by + * case). + */ id: string; + /** + * @summary The display name for the pool. + * @description The display name need not be unique and can contain any Unicode characters up to + * a maximum length of 1024. + */ displayName?: string; + /** + * @summary The size of virtual machines in the pool. All virtual machines in a pool are the same + * size. + * @description For information about available sizes of virtual machines for Cloud Services + * pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services + * (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch + * supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about + * available VM sizes for pools using images from the Virtual Machines Marketplace (pools created + * with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) + * (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes + * for Virtual Machines (Windows) + * (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch + * supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, + * STANDARD_DS, and STANDARD_DSV2 series). + */ vmSize: string; + /** + * @summary The cloud service configuration for the pool. + * @description This property and virtualMachineConfiguration are mutually exclusive and one of + * the properties must be specified. This property cannot be specified if the Batch account was + * created with its poolAllocationMode property set to 'UserSubscription'. + */ cloudServiceConfiguration?: CloudServiceConfiguration; + /** + * @summary The virtual machine configuration for the pool. + * @description This property and cloudServiceConfiguration are mutually exclusive and one of the + * properties must be specified. + */ virtualMachineConfiguration?: VirtualMachineConfiguration; + /** + * @summary The timeout for allocation of compute nodes to the pool. + * @description This timeout applies only to manual scaling; it has no effect when + * enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 + * minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if + * you are calling the REST API directly, the HTTP status code is 400 (Bad Request). + */ resizeTimeout?: moment.Duration; + /** + * @summary The desired number of dedicated compute nodes in the pool. + * @description This property must not be specified if enableAutoScale is set to true. If + * enableAutoScale is set to false, then you must set either targetDedicatedNodes, + * targetLowPriorityNodes, or both. + */ targetDedicatedNodes?: number; + /** + * @summary The desired number of low-priority compute nodes in the pool. + * @description This property must not be specified if enableAutoScale is set to true. If + * enableAutoScale is set to false, then you must set either targetDedicatedNodes, + * targetLowPriorityNodes, or both. + */ targetLowPriorityNodes?: number; + /** + * @summary Whether the pool size should automatically adjust over time. + * @description If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be + * specified. If true, the autoScaleFormula property is required and the pool automatically + * resizes according to the formula. The default value is false. + */ enableAutoScale?: boolean; + /** + * @summary A formula for the desired number of compute nodes in the pool. + * @description This property must not be specified if enableAutoScale is set to false. It is + * required if enableAutoScale is set to true. The formula is checked for validity before the + * pool is created. If the formula is not valid, the Batch service rejects the request with + * detailed error information. For more information about specifying this formula, see + * 'Automatically scale compute nodes in an Azure Batch pool' + * (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/). + */ autoScaleFormula?: string; + /** + * @summary The time interval at which to automatically adjust the pool size according to the + * autoscale formula. + * @description The default value is 15 minutes. The minimum and maximum value are 5 minutes and + * 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, + * the Batch service returns an error; if you are calling the REST API directly, the HTTP status + * code is 400 (Bad Request). + */ autoScaleEvaluationInterval?: moment.Duration; + /** + * @summary Whether the pool permits direct communication between nodes. + * @description Enabling inter-node communication limits the maximum size of the pool due to + * deployment restrictions on the nodes of the pool. This may result in the pool not reaching its + * desired size. The default value is false. + */ enableInterNodeCommunication?: boolean; + /** + * @summary The network configuration for the pool. + */ networkConfiguration?: NetworkConfiguration; + /** + * @summary A task specified to run on each compute node as it joins the pool. + * @description The task runs when the node is added to the pool or when the node is restarted. + */ startTask?: StartTask; + /** + * @summary The list of certificates to be installed on each compute node in the pool. + * @description For Windows compute nodes, the Batch service installs the certificates to the + * specified certificate store and location. 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. + */ certificateReferences?: CertificateReference[]; + /** + * @summary The list of application packages to be installed on each compute node in the pool. + */ applicationPackageReferences?: ApplicationPackageReference[]; + /** + * @summary The list of application licenses the Batch service will make available on each + * compute node in the pool. + * @description The list of application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, pool creation will + * fail. + */ applicationLicenses?: string[]; + /** + * @summary The maximum number of tasks that can run concurrently on a single compute node in the + * pool. + * @description The default value is 1. The maximum value of this setting depends on the size of + * the compute nodes in the pool (the vmSize setting). + */ maxTasksPerNode?: number; + /** + * @summary How tasks are distributed across compute nodes in a pool. + */ taskSchedulingPolicy?: TaskSchedulingPolicy; + /** + * @summary The list of user accounts to be created on each node in the pool. + */ userAccounts?: UserAccount[]; + /** + * @summary A list of name-value pairs associated with the pool as metadata. + * @description The Batch service does not assign any meaning to metadata; it is solely for the + * use of user code. + */ metadata?: MetadataItem[]; } /** - * @class - * Initializes a new instance of the AffinityInformation class. - * @constructor - * @summary A locality hint that can be used by the Batch service to select a - * compute node on which to start a task. - * - * @member {string} affinityId An opaque string representing the location of a - * compute node or a task that has run previously. You can pass the affinityId - * of a compute node to indicate that this task needs to run on that compute - * node. Note that this is just a soft affinity. If the target node is busy or - * unavailable at the time the task is scheduled, then the task will be - * scheduled elsewhere. + * @summary A locality hint that can be used by the Batch service to select a compute node on which + * to start a task. */ export interface AffinityInformation { + /** + * @summary An opaque string representing the location of a compute node or a task that has run + * previously. + * @description You can pass the affinityId of a compute node to indicate that this task needs to + * run on that compute node. Note that this is just a soft affinity. If the target node is busy + * or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere. + */ affinityId: string; } /** - * @class - * Initializes a new instance of the TaskExecutionInformation class. - * @constructor * @summary Information about the execution of a task. - * - * @member {date} [startTime] The time at which the task started running. - * 'Running' corresponds to the running state, so if the task specifies - * resource files or application packages, then the start time reflects the - * time at which the task started downloading or deploying these. If the task - * has been restarted or retried, this is the most recent time at which the - * task started running. This property is present only for tasks that are in - * the running or completed state. - * @member {date} [endTime] The time at which the task completed. This property - * is set only if the task is in the Completed state. - * @member {number} [exitCode] The exit code of the program specified on the - * task command line. This property is set only if the task is in the completed - * state. In general, the exit code for a process reflects the specific - * convention implemented by the application developer for that process. If you - * use the exit code value to make decisions in your code, be sure that you - * know the exit code convention used by the application process. However, if - * the Batch service terminates the task (due to timeout, or user termination - * via the API) you may see an operating system-defined exit code. - * @member {object} [containerInfo] Information about the container under which - * the task is executing. This property is set only if the task runs in a - * container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string - * from the Docker service, if available. It is equivalent to the error field - * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: - * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {number} retryCount The number of times the task has been retried by - * the Batch service. Task application failures (non-zero exit code) are - * retried, pre-processing errors (the task could not be run) and file upload - * errors are not retried. The Batch service will retry the task up to the - * limit specified by the constraints. - * @member {date} [lastRetryTime] The most recent time at which a retry of the - * task started running. This element is present only if the task was retried - * (i.e. retryCount is nonzero). If present, this is typically the same as - * startTime, but may be different if the task has been restarted for reasons - * other than retry; for example, if the compute node was rebooted during a - * retry, then the startTime is updated but the lastRetryTime is not. - * @member {number} requeueCount The number of times the task has been requeued - * by the Batch service as the result of a user request. When the user removes - * nodes from a pool (by resizing/shrinking the pool) or when the job is being - * disabled, the user can specify that running tasks on the nodes be requeued - * for execution. This count tracks how many times the task has been requeued - * for these reasons. - * @member {date} [lastRequeueTime] The most recent time at which the task has - * been requeued by the Batch service as the result of a user request. This - * property is set only if the requeueCount is nonzero. - * @member {string} [result] The result of the task execution. If the value is - * 'failed', then the details of the failure can be found in the failureInfo - * property. Possible values include: 'success', 'failure' */ export interface TaskExecutionInformation { + /** + * @summary The time at which the task started running. + * @description 'Running' corresponds to the running state, so if the task specifies resource + * files or application packages, then the start time reflects the time at which the task started + * downloading or deploying these. If the task has been restarted or retried, this is the most + * recent time at which the task started running. This property is present only for tasks that + * are in the running or completed state. + */ startTime?: Date; + /** + * @summary The time at which the task completed. + * @description This property is set only if the task is in the Completed state. + */ endTime?: Date; + /** + * @summary The exit code of the program specified on the task command line. + * @description This property is set only if the task is in the completed state. In general, the + * exit code for a process reflects the specific convention implemented by the application + * developer for that process. If you use the exit code value to make decisions in your code, be + * sure that you know the exit code convention used by the application process. However, if the + * Batch service terminates the task (due to timeout, or user termination via the API) you may + * see an operating system-defined exit code. + */ exitCode?: number; + /** + * @summary Information about the container under which the task is executing. + * @description This property is set only if the task runs in a container context. + */ containerInfo?: TaskContainerExecutionInformation; + /** + * @summary Information describing the task failure, if any. + * @description This property is set only if the task is in the completed state and encountered a + * failure. + */ failureInfo?: TaskFailureInformation; + /** + * @summary The number of times the task has been retried by the Batch service. + * @description Task application failures (non-zero exit code) are retried, pre-processing errors + * (the task could not be run) and file upload errors are not retried. The Batch service will + * retry the task up to the limit specified by the constraints. + */ retryCount: number; + /** + * @summary The most recent time at which a retry of the task started running. + * @description This element is present only if the task was retried (i.e. retryCount is + * nonzero). If present, this is typically the same as startTime, but may be different if the + * task has been restarted for reasons other than retry; for example, if the compute node was + * rebooted during a retry, then the startTime is updated but the lastRetryTime is not. + */ lastRetryTime?: Date; + /** + * @summary The number of times the task has been requeued by the Batch service as the result of + * a user request. + * @description When the user removes nodes from a pool (by resizing/shrinking the pool) or when + * the job is being disabled, the user can specify that running tasks on the nodes be requeued + * for execution. This count tracks how many times the task has been requeued for these reasons. + */ requeueCount: number; + /** + * @summary The most recent time at which the task has been requeued by the Batch service as the + * result of a user request. + * @description This property is set only if the requeueCount is nonzero. + */ lastRequeueTime?: Date; + /** + * @summary The result of the task execution. + * @description If the value is 'failed', then the details of the failure can be found in the + * failureInfo property. Possible values include: 'success', 'failure' + */ result?: string; } /** - * @class - * Initializes a new instance of the ComputeNodeInformation class. - * @constructor * @summary Information about the compute node on which a task ran. - * - * @member {string} [affinityId] An identifier for the compute node on which - * the task ran, which can be passed when adding a task to request that the - * task be scheduled on this compute node. - * @member {string} [nodeUrl] The URL of the node on which the task ran. . - * @member {string} [poolId] The ID of the pool on which the task ran. - * @member {string} [nodeId] The ID of the node on which the task ran. - * @member {string} [taskRootDirectory] The root directory of the task on the - * compute node. - * @member {string} [taskRootDirectoryUrl] The URL to the root directory of the - * task on the compute node. */ export interface ComputeNodeInformation { + /** + * @summary An identifier for the compute node on which the task ran, which can be passed when + * adding a task to request that the task be scheduled on this compute node. + */ affinityId?: string; + /** + * @summary The URL of the node on which the task ran. + */ nodeUrl?: string; + /** + * @summary The ID of the pool on which the task ran. + */ poolId?: string; + /** + * @summary The ID of the node on which the task ran. + */ nodeId?: string; + /** + * @summary The root directory of the task on the compute node. + */ taskRootDirectory?: string; + /** + * @summary The URL to the root directory of the task on the compute node. + */ taskRootDirectoryUrl?: string; } /** - * @class - * Initializes a new instance of the NodeAgentInformation class. - * @constructor * @summary Information about the node agent. - * - * The Batch node agent is a program that runs on each node in the pool and - * provides Batch capability on the compute node. - * - * @member {string} version The version of the Batch node agent running on the - * compute node. This version number can be checked against the node agent - * release notes located at - * https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. - * @member {date} lastUpdateTime The time when the node agent was updated on - * the compute node. This is the most recent time that the node agent was - * updated to a new version. + * @description The Batch node agent is a program that runs on each node in the pool and provides + * Batch capability on the compute node. */ export interface NodeAgentInformation { + /** + * @summary The version of the Batch node agent running on the compute node. + * @description This version number can be checked against the node agent release notes located + * at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. + */ version: string; + /** + * @summary The time when the node agent was updated on the compute node. + * @description This is the most recent time that the node agent was updated to a new version. + */ lastUpdateTime: Date; } /** - * @class - * Initializes a new instance of the MultiInstanceSettings class. - * @constructor * @summary Settings which specify how to run a multi-instance task. - * - * Multi-instance tasks are commonly used to support MPI tasks. - * - * @member {number} [numberOfInstances] The number of compute nodes required by - * the task. If omitted, the default is 1. - * @member {string} coordinationCommandLine The command line to run on all the - * compute nodes to enable them to coordinate when the primary runs the main - * task command. A typical coordination command line launches a background - * service and verifies that the service is ready to process inter-node - * messages. - * @member {array} [commonResourceFiles] A list of files that the Batch service - * will download before running the coordination command line. The difference - * between common resource files and task resource files is that common - * resource files are downloaded for all subtasks including the primary, - * whereas task resource files are downloaded only for the primary. Also note - * that these resource files are not downloaded to the task working directory, - * but instead are downloaded to the task root directory (one directory above - * the working directory). There is a maximum size for the list of resource - * files. When the max size is exceeded, the request will fail and the - * response error code will be RequestEntityTooLarge. If this occurs, the - * collection of ResourceFiles must be reduced in size. This can be achieved - * using .zip files, Application Packages, or Docker Containers. + * @description Multi-instance tasks are commonly used to support MPI tasks. */ export interface MultiInstanceSettings { + /** + * @summary The number of compute nodes required by the task. + * @description If omitted, the default is 1. + */ numberOfInstances?: number; + /** + * @summary The command line to run on all the compute nodes to enable them to coordinate when + * the primary runs the main task command. + * @description A typical coordination command line launches a background service and verifies + * that the service is ready to process inter-node messages. + */ coordinationCommandLine: string; + /** + * @summary A list of files that the Batch service will download before running the coordination + * command line. + * @description The difference between common resource files and task resource files is that + * common resource files are downloaded for all subtasks including the primary, whereas task + * resource files are downloaded only for the primary. Also note that these resource files are + * not downloaded to the task working directory, but instead are downloaded to the task root + * directory (one directory above the working directory). There is a maximum size for the list + * of resource files. When the max size is exceeded, the request will fail and the response + * error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must + * be reduced in size. This can be achieved using .zip files, Application Packages, or Docker + * Containers. + */ commonResourceFiles?: ResourceFile[]; } /** - * @class - * Initializes a new instance of the TaskStatistics class. - * @constructor * @summary Resource usage statistics for a task. - * - * @member {string} url The URL of the statistics. - * @member {date} startTime The start time of the time range covered by the - * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last - * updated. All statistics are limited to the range between startTime and - * lastUpdateTime. - * @member {moment.duration} userCPUTime The total user mode CPU time (summed - * across all cores and all compute nodes) consumed by the task. - * @member {moment.duration} kernelCPUTime The total kernel mode CPU time - * (summed across all cores and all compute nodes) consumed by the task. - * @member {moment.duration} wallClockTime The total wall clock time of the - * task. The wall clock time is the elapsed time from when the task started - * running on a compute node to when it finished (or to the last time the - * statistics were updated, if the task had not finished by then). If the task - * was retried, this includes the wall clock time of all the task retries. - * @member {number} readIOps The total number of disk read operations made by - * the task. - * @member {number} writeIOps The total number of disk write operations made by - * the task. - * @member {number} readIOGiB The total gibibytes read from disk by the task. - * @member {number} writeIOGiB The total gibibytes written to disk by the task. - * @member {moment.duration} waitTime The total wait time of the task. The wait - * time for a task is defined as the elapsed time between the creation of the - * task and the start of task execution. (If the task is retried due to - * failures, the wait time is the time to the most recent task execution.). */ export interface TaskStatistics { + /** + * @summary The URL of the statistics. + */ url: string; + /** + * @summary The start time of the time range covered by the statistics. + */ startTime: Date; + /** + * @summary The time at which the statistics were last updated. All statistics are limited to the + * range between startTime and lastUpdateTime. + */ lastUpdateTime: Date; + /** + * @summary The total user mode CPU time (summed across all cores and all compute nodes) consumed + * by the task. + */ userCPUTime: moment.Duration; + /** + * @summary The total kernel mode CPU time (summed across all cores and all compute nodes) + * consumed by the task. + */ kernelCPUTime: moment.Duration; + /** + * @summary The total wall clock time of the task. + * @description The wall clock time is the elapsed time from when the task started running on a + * compute node to when it finished (or to the last time the statistics were updated, if the task + * had not finished by then). If the task was retried, this includes the wall clock time of all + * the task retries. + */ wallClockTime: moment.Duration; + /** + * @summary The total number of disk read operations made by the task. + */ readIOps: number; + /** + * @summary The total number of disk write operations made by the task. + */ writeIOps: number; + /** + * @summary The total gibibytes read from disk by the task. + */ readIOGiB: number; + /** + * @summary The total gibibytes written to disk by the task. + */ writeIOGiB: number; + /** + * @summary The total wait time of the task. The wait time for a task is defined as the elapsed + * time between the creation of the task and the start of task execution. (If the task is retried + * due to failures, the wait time is the time to the most recent task execution.) + */ waitTime: moment.Duration; } /** - * @class - * Initializes a new instance of the TaskIdRange class. - * @constructor - * @summary A range of task IDs that a task can depend on. All tasks with IDs - * in the range must complete successfully before the dependent task can be - * scheduled. - * - * The start and end of the range are inclusive. For example, if a range has - * start 9 and end 12, then it represents tasks '9', '10', '11' and '12'. - * - * @member {number} start The first task ID in the range. - * @member {number} end The last task ID in the range. + * @summary A range of task IDs that a task can depend on. All tasks with IDs in the range must + * complete successfully before the dependent task can be scheduled. + * @description The start and end of the range are inclusive. For example, if a range has start 9 + * and end 12, then it represents tasks '9', '10', '11' and '12'. */ export interface TaskIdRange { + /** + * @summary The first task ID in the range. + */ start: number; + /** + * @summary The last task ID in the range. + */ end: number; } /** - * @class - * Initializes a new instance of the TaskDependencies class. - * @constructor - * @summary Specifies any dependencies of a task. Any task that is explicitly - * specified or within a dependency range must complete before the dependant - * task will be scheduled. - * - * @member {array} [taskIds] The list of task IDs that this task depends on. - * All tasks in this list must complete successfully before the dependent task - * can be scheduled. The taskIds collection is limited to 64000 characters - * total (i.e. the combined length of all task IDs). If the taskIds collection - * exceeds the maximum length, the Add Task request fails with error code - * TaskDependencyListTooLong. In this case consider using task ID ranges - * instead. - * @member {array} [taskIdRanges] The list of task ID ranges that this task - * depends on. All tasks in all ranges must complete successfully before the - * dependent task can be scheduled. + * @summary Specifies any dependencies of a task. Any task that is explicitly specified or within a + * dependency range must complete before the dependant task will be scheduled. */ export interface TaskDependencies { + /** + * @summary The list of task IDs that this task depends on. All tasks in this list must complete + * successfully before the dependent task can be scheduled. + * @description The taskIds collection is limited to 64000 characters total (i.e. the combined + * length of all task IDs). If the taskIds collection exceeds the maximum length, the Add Task + * request fails with error code TaskDependencyListTooLong. In this case consider using task ID + * ranges instead. + */ taskIds?: string[]; + /** + * @summary The list of task ID ranges that this task depends on. All tasks in all ranges must + * complete successfully before the dependent task can be scheduled. + */ taskIdRanges?: TaskIdRange[]; } /** - * @class - * Initializes a new instance of the CloudTask class. - * @constructor * @summary An Azure Batch task. - * - * Batch will retry tasks when a recovery operation is triggered on a compute - * node. Examples of recovery operations include (but are not limited to) when - * an unhealthy compute node is rebooted or a compute node disappeared due to - * host failure. Retries due to recovery operations are independent of and are - * not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is - * 0, an internal retry due to a recovery operation may occur. Because of this, - * all tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * - * @member {string} [id] A string that uniquely identifies the task within the - * job. The ID can contain any combination of alphanumeric characters including - * hyphens and underscores, and cannot contain more than 64 characters. - * @member {string} [displayName] A display name for the task. The display name - * need not be unique and can contain any Unicode characters up to a maximum - * length of 1024. - * @member {string} [url] The URL of the task. - * @member {string} [eTag] The ETag of the task. This is an opaque string. You - * can use it to detect whether the task has changed between requests. In - * particular, you can be pass the ETag when updating a task to specify that - * your changes should take effect only if nobody else has modified the task in - * the meantime. - * @member {date} [lastModified] The last modified time of the task. - * @member {date} [creationTime] The creation time of the task. - * @member {object} [exitConditions] How the Batch service should respond when - * the task completes. - * @member {array} [exitConditions.exitCodes] - * @member {array} [exitConditions.exitCodeRanges] - * @member {object} [exitConditions.preProcessingError] - * @member {string} [exitConditions.preProcessingError.jobAction] 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). Possible values include: 'none', 'disable', - * 'terminate' - * @member {string} [exitConditions.preProcessingError.dependencyAction] 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). Possible - * values include: 'satisfy', 'block' - * @member {object} [exitConditions.fileUploadError] If the task exited with an - * exit code that was specified via exitCodes or exitCodeRanges, and then - * encountered a file upload error, then the action specified by the exit code - * takes precedence. - * @member {string} [exitConditions.fileUploadError.jobAction] 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). Possible values include: 'none', 'disable', - * 'terminate' - * @member {string} [exitConditions.fileUploadError.dependencyAction] 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). Possible - * values include: 'satisfy', 'block' - * @member {object} [exitConditions.default] This value is used if the task - * exits with any nonzero exit code not listed in the exitCodes or - * exitCodeRanges collection, with a pre-processing error if the - * preProcessingError property is not present, or with a file upload error if - * the fileUploadError property is not present. If you want non-default - * behavior on exit code 0, you must list it explicitly using the exitCodes or - * exitCodeRanges collection. - * @member {string} [exitConditions.default.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [exitConditions.default.dependencyAction] 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). Possible values - * include: 'satisfy', 'block' - * @member {string} [state] The current state of the task. Possible values - * include: 'active', 'preparing', 'running', 'completed' - * @member {date} [stateTransitionTime] The time at which the task entered its - * current state. - * @member {string} [previousState] The previous state of the task. This - * property is not set if the task is in its initial Active state. Possible - * values include: 'active', 'preparing', 'running', 'completed' - * @member {date} [previousStateTransitionTime] The time at which the task - * entered its previous state. This property is not set if the task is in its - * initial Active state. - * @member {string} [commandLine] The command line of the task. For - * multi-instance tasks, the command line is executed as the primary task, - * after the primary task and all subtasks have finished executing the - * coordination command line. The command line does not run under a shell, and - * therefore cannot take advantage of shell features such as environment - * variable expansion. If you want to take advantage of such features, you - * should invoke the shell in the command line, for example using "cmd /c - * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command - * line refers to file paths, it should use a relative path (relative to the - * task working directory), or use the Batch provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the task runs. If the pool that will run this task has - * containerConfiguration set, this must be set as well. If the pool that will - * run this task doesn't have containerConfiguration set, this must not be set. - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image - * reference, as would be specified to "docker pull". If no tag is provided as - * part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted if - * was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, the - * default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service will - * download to the compute node before running the command line. For - * multi-instance tasks, the resource files will only be downloaded to the - * compute node on which the primary task is executed. There is a maximum size - * for the list of resource files. When the max size is exceeded, the request - * will fail and the response error code will be RequestEntityTooLarge. If this - * occurs, the collection of ResourceFiles must be reduced in size. This can be - * achieved using .zip files, Application Packages, or Docker Containers. - * @member {array} [outputFiles] A list of files that the Batch service will - * upload from the compute node after running the command line. For - * multi-instance tasks, the files will only be uploaded from the compute node - * on which the primary task is executed. - * @member {array} [environmentSettings] A list of environment variable - * settings for the task. - * @member {object} [affinityInfo] A locality hint that can be used by the - * Batch service to select a compute node on which to start the new task. - * @member {string} [affinityInfo.affinityId] You can pass the affinityId of a - * compute node to indicate that this task needs to run on that compute node. - * Note that this is just a soft affinity. If the target node is busy or - * unavailable at the time the task is scheduled, then the task will be - * scheduled elsewhere. - * @member {object} [constraints] The execution constraints that apply to this - * task. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not - * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 days, - * i.e. the task directory will be retained for 7 days unless the compute node - * is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries for the task executable due to a - * nonzero exit code. The Batch service will try the task once, and may then - * retry up to this limit. For example, if the maximum retry count is 3, Batch - * tries the task up to 4 times (one initial try and 3 retries). If the maximum - * retry count is 0, the Batch service does not retry the task after the first - * attempt. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {object} [userIdentity] The user identity under which the task runs. - * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value is - * nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {object} [executionInfo] Information about the execution of the - * task. - * @member {date} [executionInfo.startTime] 'Running' corresponds to the - * running state, so if the task specifies resource files or application - * packages, then the start time reflects the time at which the task started - * downloading or deploying these. If the task has been restarted or retried, - * this is the most recent time at which the task started running. This - * property is present only for tasks that are in the running or completed - * state. - * @member {date} [executionInfo.endTime] This property is set only if the task - * is in the Completed state. - * @member {number} [executionInfo.exitCode] This property is set only if the - * task is in the completed state. In general, the exit code for a process - * reflects the specific convention implemented by the application developer - * for that process. If you use the exit code value to make decisions in your - * code, be sure that you know the exit code convention used by the application - * process. However, if the Batch service terminates the task (due to timeout, - * or user termination via the API) you may see an operating system-defined - * exit code. - * @member {object} [executionInfo.containerInfo] This property is set only if - * the task runs in a container context. - * @member {string} [executionInfo.containerInfo.containerId] - * @member {string} [executionInfo.containerInfo.state] This is the state of - * the container according to the Docker service. It is equivalent to the - * status field returned by "docker inspect". - * @member {string} [executionInfo.containerInfo.error] This is the detailed - * error string from the Docker service, if available. It is equivalent to the - * error field returned by "docker inspect". - * @member {object} [executionInfo.failureInfo] This property is set only if - * the task is in the completed state and encountered a failure. - * @member {string} [executionInfo.failureInfo.category] Possible values - * include: 'userError', 'serverError' - * @member {string} [executionInfo.failureInfo.code] - * @member {string} [executionInfo.failureInfo.message] - * @member {array} [executionInfo.failureInfo.details] - * @member {number} [executionInfo.retryCount] Task application failures - * (non-zero exit code) are retried, pre-processing errors (the task could not - * be run) and file upload errors are not retried. The Batch service will retry - * the task up to the limit specified by the constraints. - * @member {date} [executionInfo.lastRetryTime] This element is present only if - * the task was retried (i.e. retryCount is nonzero). If present, this is - * typically the same as startTime, but may be different if the task has been - * restarted for reasons other than retry; for example, if the compute node was - * rebooted during a retry, then the startTime is updated but the lastRetryTime - * is not. - * @member {number} [executionInfo.requeueCount] When the user removes nodes - * from a pool (by resizing/shrinking the pool) or when the job is being - * disabled, the user can specify that running tasks on the nodes be requeued - * for execution. This count tracks how many times the task has been requeued - * for these reasons. - * @member {date} [executionInfo.lastRequeueTime] This property is set only if - * the requeueCount is nonzero. - * @member {string} [executionInfo.result] If the value is 'failed', then the - * details of the failure can be found in the failureInfo property. Possible - * values include: 'success', 'failure' - * @member {object} [nodeInfo] Information about the compute node on which the - * task ran. - * @member {string} [nodeInfo.affinityId] - * @member {string} [nodeInfo.nodeUrl] - * @member {string} [nodeInfo.poolId] - * @member {string} [nodeInfo.nodeId] - * @member {string} [nodeInfo.taskRootDirectory] - * @member {string} [nodeInfo.taskRootDirectoryUrl] - * @member {object} [multiInstanceSettings] An object that indicates that the - * task is a multi-instance task, and contains information about how to run the - * multi-instance task. - * @member {number} [multiInstanceSettings.numberOfInstances] If omitted, the - * default is 1. - * @member {string} [multiInstanceSettings.coordinationCommandLine] A typical - * coordination command line launches a background service and verifies that - * the service is ready to process inter-node messages. - * @member {array} [multiInstanceSettings.commonResourceFiles] The difference - * between common resource files and task resource files is that common - * resource files are downloaded for all subtasks including the primary, - * whereas task resource files are downloaded only for the primary. Also note - * that these resource files are not downloaded to the task working directory, - * but instead are downloaded to the task root directory (one directory above - * the working directory). There is a maximum size for the list of resource - * files. When the max size is exceeded, the request will fail and the - * response error code will be RequestEntityTooLarge. If this occurs, the - * collection of ResourceFiles must be reduced in size. This can be achieved - * using .zip files, Application Packages, or Docker Containers. - * @member {object} [stats] Resource usage statistics for the task. - * @member {string} [stats.url] - * @member {date} [stats.startTime] - * @member {date} [stats.lastUpdateTime] - * @member {moment.duration} [stats.userCPUTime] - * @member {moment.duration} [stats.kernelCPUTime] - * @member {moment.duration} [stats.wallClockTime] The wall clock time is the - * elapsed time from when the task started running on a compute node to when it - * finished (or to the last time the statistics were updated, if the task had - * not finished by then). If the task was retried, this includes the wall clock - * time of all the task retries. - * @member {number} [stats.readIOps] - * @member {number} [stats.writeIOps] - * @member {number} [stats.readIOGiB] - * @member {number} [stats.writeIOGiB] - * @member {moment.duration} [stats.waitTime] - * @member {object} [dependsOn] The tasks that this task depends on. This task - * will not be scheduled until all tasks that it depends on have completed - * successfully. If any of those tasks fail and exhaust their retry counts, - * this task will never be scheduled. - * @member {array} [dependsOn.taskIds] The taskIds collection is limited to - * 64000 characters total (i.e. the combined length of all task IDs). If the - * taskIds collection exceeds the maximum length, the Add Task request fails - * with error code TaskDependencyListTooLong. In this case consider using task - * ID ranges instead. - * @member {array} [dependsOn.taskIdRanges] - * @member {array} [applicationPackageReferences] A list of application - * packages that the Batch service will deploy to the compute node before - * running the command line. Application packages are downloaded and deployed - * to a shared directory, not the task working directory. Therefore, if a - * referenced package is already on the compute node, and is up to date, then - * it is not re-downloaded; the existing copy on the compute node is used. If a - * referenced application package cannot be installed, for example because the - * package has been deleted or because download failed, the task fails. - * @member {object} [authenticationTokenSettings] The settings for an - * authentication token that the task can use to perform Batch service - * operations. If this property is set, the Batch service provides the task - * with an authentication token which can be used to authenticate Batch service - * operations without requiring an account access key. The token is provided - * via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations - * that the task can carry out using the token depend on the settings. For - * example, a task can request job permissions in order to add other tasks to - * the job, or check the status of the job or of other tasks under the job. - * @member {array} [authenticationTokenSettings.access] The authentication - * token grants access to a limited set of Batch service operations. Currently - * the only supported value for the access property is 'job', which grants - * access to all operations related to the job which contains the task. + * @description Batch will retry tasks when a recovery operation is triggered on a compute node. + * Examples of recovery operations include (but are not limited to) when an unhealthy compute node + * is rebooted or a compute node disappeared due to host failure. Retries due to recovery + * operations are independent of and are not counted against the maxTaskRetryCount. Even if the + * maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of + * this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and + * restarted without causing any corruption or duplicate data. The best practice for long running + * tasks is to use some form of checkpointing. */ export interface CloudTask { + /** + * @summary A string that uniquely identifies the task within the job. + * @description The ID can contain any combination of alphanumeric characters including hyphens + * and underscores, and cannot contain more than 64 characters. + */ id?: string; + /** + * @summary A display name for the task. + * @description The display name need not be unique and can contain any Unicode characters up to + * a maximum length of 1024. + */ displayName?: string; + /** + * @summary The URL of the task. + */ url?: string; + /** + * @summary The ETag of the task. + * @description This is an opaque string. You can use it to detect whether the task has changed + * between requests. In particular, you can be pass the ETag when updating a task to specify that + * your changes should take effect only if nobody else has modified the task in the meantime. + */ eTag?: string; + /** + * @summary The last modified time of the task. + */ lastModified?: Date; + /** + * @summary The creation time of the task. + */ creationTime?: Date; + /** + * How the Batch service should respond when the task completes. + */ exitConditions?: ExitConditions; + /** + * @summary The current state of the task. + * @description Possible values include: 'active', 'preparing', 'running', 'completed' + */ state?: string; + /** + * @summary The time at which the task entered its current state. + */ stateTransitionTime?: Date; + /** + * @summary The previous state of the task. + * @description This property is not set if the task is in its initial Active state. Possible + * values include: 'active', 'preparing', 'running', 'completed' + */ previousState?: string; + /** + * @summary The time at which the task entered its previous state. + * @description This property is not set if the task is in its initial Active state. + */ previousStateTransitionTime?: Date; + /** + * @summary The command line of the task. + * @description For multi-instance tasks, the command line is executed as the primary task, after + * the primary task and all subtasks have finished executing the coordination command line. The + * command line does not run under a shell, and therefore cannot take advantage of shell features + * such as environment variable expansion. If you want to take advantage of such features, you + * should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows + * or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a + * relative path (relative to the task working directory), or use the Batch provided environment + * variable + * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). + */ commandLine?: string; + /** + * @summary The settings for the container under which the task runs. + * @description If the pool that will run this task has containerConfiguration set, this must be + * set as well. If the pool that will run this task doesn't have containerConfiguration set, this + * must not be set. When this is specified, all directories recursively below the + * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the + * container, all task environment variables are mapped into the container, and the task command + * line is executed in the container. + */ containerSettings?: TaskContainerSettings; + /** + * @summary A list of files that the Batch service will download to the compute node before + * running the command line. + * @description For multi-instance tasks, the resource files will only be downloaded to the + * compute node on which the primary task is executed. There is a maximum size for the list of + * resource files. When the max size is exceeded, the request will fail and the response error + * code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be + * reduced in size. This can be achieved using .zip files, Application Packages, or Docker + * Containers. + */ resourceFiles?: ResourceFile[]; + /** + * @summary A list of files that the Batch service will upload from the compute node after + * running the command line. + * @description For multi-instance tasks, the files will only be uploaded from the compute node + * on which the primary task is executed. + */ outputFiles?: OutputFile[]; + /** + * @summary A list of environment variable settings for the task. + */ environmentSettings?: EnvironmentSetting[]; + /** + * @summary A locality hint that can be used by the Batch service to select a compute node on + * which to start the new task. + */ affinityInfo?: AffinityInformation; + /** + * @summary The execution constraints that apply to this task. + */ constraints?: TaskConstraints; + /** + * @summary The user identity under which the task runs. + * @description If omitted, the task runs as a non-administrative user unique to the task. + */ userIdentity?: UserIdentity; + /** + * @summary Information about the execution of the task. + */ executionInfo?: TaskExecutionInformation; + /** + * @summary Information about the compute node on which the task ran. + */ nodeInfo?: ComputeNodeInformation; + /** + * @summary An object that indicates that the task is a multi-instance task, and contains + * information about how to run the multi-instance task. + */ multiInstanceSettings?: MultiInstanceSettings; + /** + * @summary Resource usage statistics for the task. + */ stats?: TaskStatistics; + /** + * @summary The tasks that this task depends on. + * @description This task will not be scheduled until all tasks that it depends on have completed + * successfully. If any of those tasks fail and exhaust their retry counts, this task will never + * be scheduled. + */ dependsOn?: TaskDependencies; + /** + * @summary A list of application packages that the Batch service will deploy to the compute node + * before running the command line. + * @description Application packages are downloaded and deployed to a shared directory, not the + * task working directory. Therefore, if a referenced package is already on the compute node, and + * is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If + * a referenced application package cannot be installed, for example because the package has been + * deleted or because download failed, the task fails. + */ applicationPackageReferences?: ApplicationPackageReference[]; + /** + * @summary The settings for an authentication token that the task can use to perform Batch + * service operations. + * @description If this property is set, the Batch service provides the task with an + * authentication token which can be used to authenticate Batch service operations without + * requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN + * environment variable. The operations that the task can carry out using the token depend on the + * settings. For example, a task can request job permissions in order to add other tasks to the + * job, or check the status of the job or of other tasks under the job. + */ authenticationTokenSettings?: AuthenticationTokenSettings; } /** - * @class - * Initializes a new instance of the TaskAddParameter class. - * @constructor * @summary An Azure Batch task to add. - * - * Batch will retry tasks when a recovery operation is triggered on a compute - * node. Examples of recovery operations include (but are not limited to) when - * an unhealthy compute node is rebooted or a compute node disappeared due to - * host failure. Retries due to recovery operations are independent of and are - * not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is - * 0, an internal retry due to a recovery operation may occur. Because of this, - * all tasks should be idempotent. This means tasks need to tolerate being - * interrupted and restarted without causing any corruption or duplicate data. - * The best practice for long running tasks is to use some form of - * checkpointing. - * - * @member {string} id A string that uniquely identifies the task within the - * job. The ID can contain any combination of alphanumeric characters including - * hyphens and underscores, and cannot contain more than 64 characters. The ID - * is case-preserving and case-insensitive (that is, you may not have two IDs - * within a job that differ only by case). - * @member {string} [displayName] A display name for the task. The display name - * need not be unique and can contain any Unicode characters up to a maximum - * length of 1024. - * @member {string} commandLine The command line of the task. For - * multi-instance tasks, the command line is executed as the primary task, - * after the primary task and all subtasks have finished executing the - * coordination command line. The command line does not run under a shell, and - * therefore cannot take advantage of shell features such as environment - * variable expansion. If you want to take advantage of such features, you - * should invoke the shell in the command line, for example using "cmd /c - * MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command - * line refers to file paths, it should use a relative path (relative to the - * task working directory), or use the Batch provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the task runs. If the pool that will run this task has - * containerConfiguration set, this must be set as well. If the pool that will - * run this task doesn't have containerConfiguration set, this must not be set. - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image - * reference, as would be specified to "docker pull". If no tag is provided as - * part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted if - * was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, the - * default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {object} [exitConditions] How the Batch service should respond when - * the task completes. - * @member {array} [exitConditions.exitCodes] - * @member {array} [exitConditions.exitCodeRanges] - * @member {object} [exitConditions.preProcessingError] - * @member {string} [exitConditions.preProcessingError.jobAction] 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). Possible values include: 'none', 'disable', - * 'terminate' - * @member {string} [exitConditions.preProcessingError.dependencyAction] 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). Possible - * values include: 'satisfy', 'block' - * @member {object} [exitConditions.fileUploadError] If the task exited with an - * exit code that was specified via exitCodes or exitCodeRanges, and then - * encountered a file upload error, then the action specified by the exit code - * takes precedence. - * @member {string} [exitConditions.fileUploadError.jobAction] 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). Possible values include: 'none', 'disable', - * 'terminate' - * @member {string} [exitConditions.fileUploadError.dependencyAction] 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). Possible - * values include: 'satisfy', 'block' - * @member {object} [exitConditions.default] This value is used if the task - * exits with any nonzero exit code not listed in the exitCodes or - * exitCodeRanges collection, with a pre-processing error if the - * preProcessingError property is not present, or with a file upload error if - * the fileUploadError property is not present. If you want non-default - * behavior on exit code 0, you must list it explicitly using the exitCodes or - * exitCodeRanges collection. - * @member {string} [exitConditions.default.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [exitConditions.default.dependencyAction] 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). Possible values - * include: 'satisfy', 'block' - * @member {array} [resourceFiles] A list of files that the Batch service will - * download to the compute node before running the command line. For - * multi-instance tasks, the resource files will only be downloaded to the - * compute node on which the primary task is executed. There is a maximum size - * for the list of resource files. When the max size is exceeded, the request - * will fail and the response error code will be RequestEntityTooLarge. If this - * occurs, the collection of ResourceFiles must be reduced in size. This can be - * achieved using .zip files, Application Packages, or Docker Containers. - * @member {array} [outputFiles] A list of files that the Batch service will - * upload from the compute node after running the command line. For - * multi-instance tasks, the files will only be uploaded from the compute node - * on which the primary task is executed. - * @member {array} [environmentSettings] A list of environment variable - * settings for the task. - * @member {object} [affinityInfo] A locality hint that can be used by the - * Batch service to select a compute node on which to start the new task. - * @member {string} [affinityInfo.affinityId] You can pass the affinityId of a - * compute node to indicate that this task needs to run on that compute node. - * Note that this is just a soft affinity. If the target node is busy or - * unavailable at the time the task is scheduled, then the task will be - * scheduled elsewhere. - * @member {object} [constraints] The execution constraints that apply to this - * task. If you do not specify constraints, the maxTaskRetryCount is the - * maxTaskRetryCount specified for the job, the maxWallClockTime is infinite, - * and the retentionTime is 7 days. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not - * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 days, - * i.e. the task directory will be retained for 7 days unless the compute node - * is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries for the task executable due to a - * nonzero exit code. The Batch service will try the task once, and may then - * retry up to this limit. For example, if the maximum retry count is 3, Batch - * tries the task up to 4 times (one initial try and 3 retries). If the maximum - * retry count is 0, the Batch service does not retry the task after the first - * attempt. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {object} [userIdentity] The user identity under which the task runs. - * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value is - * nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {object} [multiInstanceSettings] An object that indicates that the - * task is a multi-instance task, and contains information about how to run the - * multi-instance task. - * @member {number} [multiInstanceSettings.numberOfInstances] If omitted, the - * default is 1. - * @member {string} [multiInstanceSettings.coordinationCommandLine] A typical - * coordination command line launches a background service and verifies that - * the service is ready to process inter-node messages. - * @member {array} [multiInstanceSettings.commonResourceFiles] The difference - * between common resource files and task resource files is that common - * resource files are downloaded for all subtasks including the primary, - * whereas task resource files are downloaded only for the primary. Also note - * that these resource files are not downloaded to the task working directory, - * but instead are downloaded to the task root directory (one directory above - * the working directory). There is a maximum size for the list of resource - * files. When the max size is exceeded, the request will fail and the - * response error code will be RequestEntityTooLarge. If this occurs, the - * collection of ResourceFiles must be reduced in size. This can be achieved - * using .zip files, Application Packages, or Docker Containers. - * @member {object} [dependsOn] The tasks that this task depends on. This task - * will not be scheduled until all tasks that it depends on have completed - * successfully. If any of those tasks fail and exhaust their retry counts, - * this task will never be scheduled. If the job does not have - * usesTaskDependencies set to true, and this element is present, the request - * fails with error code TaskDependenciesNotSpecifiedOnJob. - * @member {array} [dependsOn.taskIds] The taskIds collection is limited to - * 64000 characters total (i.e. the combined length of all task IDs). If the - * taskIds collection exceeds the maximum length, the Add Task request fails - * with error code TaskDependencyListTooLong. In this case consider using task - * ID ranges instead. - * @member {array} [dependsOn.taskIdRanges] - * @member {array} [applicationPackageReferences] A list of application - * packages that the Batch service will deploy to the compute node before - * running the command line. Application packages are downloaded and deployed - * to a shared directory, not the task working directory. Therefore, if a - * referenced package is already on the compute node, and is up to date, then - * it is not re-downloaded; the existing copy on the compute node is used. If a - * referenced application package cannot be installed, for example because the - * package has been deleted or because download failed, the task fails. - * @member {object} [authenticationTokenSettings] The settings for an - * authentication token that the task can use to perform Batch service - * operations. If this property is set, the Batch service provides the task - * with an authentication token which can be used to authenticate Batch service - * operations without requiring an account access key. The token is provided - * via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations - * that the task can carry out using the token depend on the settings. For - * example, a task can request job permissions in order to add other tasks to - * the job, or check the status of the job or of other tasks under the job. - * @member {array} [authenticationTokenSettings.access] The authentication - * token grants access to a limited set of Batch service operations. Currently - * the only supported value for the access property is 'job', which grants - * access to all operations related to the job which contains the task. + * @description Batch will retry tasks when a recovery operation is triggered on a compute node. + * Examples of recovery operations include (but are not limited to) when an unhealthy compute node + * is rebooted or a compute node disappeared due to host failure. Retries due to recovery + * operations are independent of and are not counted against the maxTaskRetryCount. Even if the + * maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of + * this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and + * restarted without causing any corruption or duplicate data. The best practice for long running + * tasks is to use some form of checkpointing. */ export interface TaskAddParameter { + /** + * @summary A string that uniquely identifies the task within the job. + * @description The ID can contain any combination of alphanumeric characters including hyphens + * and underscores, and cannot contain more than 64 characters. The ID is case-preserving and + * case-insensitive (that is, you may not have two IDs within a job that differ only by case). + */ id: string; + /** + * @summary A display name for the task. + * @description The display name need not be unique and can contain any Unicode characters up to + * a maximum length of 1024. + */ displayName?: string; + /** + * @summary The command line of the task. + * @description For multi-instance tasks, the command line is executed as the primary task, after + * the primary task and all subtasks have finished executing the coordination command line. The + * command line does not run under a shell, and therefore cannot take advantage of shell features + * such as environment variable expansion. If you want to take advantage of such features, you + * should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows + * or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a + * relative path (relative to the task working directory), or use the Batch provided environment + * variable + * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). + */ commandLine: string; + /** + * @summary The settings for the container under which the task runs. + * @description If the pool that will run this task has containerConfiguration set, this must be + * set as well. If the pool that will run this task doesn't have containerConfiguration set, this + * must not be set. When this is specified, all directories recursively below the + * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the + * container, all task environment variables are mapped into the container, and the task command + * line is executed in the container. + */ containerSettings?: TaskContainerSettings; + /** + * How the Batch service should respond when the task completes. + */ exitConditions?: ExitConditions; + /** + * @summary A list of files that the Batch service will download to the compute node before + * running the command line. + * @description For multi-instance tasks, the resource files will only be downloaded to the + * compute node on which the primary task is executed. There is a maximum size for the list of + * resource files. When the max size is exceeded, the request will fail and the response error + * code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be + * reduced in size. This can be achieved using .zip files, Application Packages, or Docker + * Containers. + */ resourceFiles?: ResourceFile[]; + /** + * @summary A list of files that the Batch service will upload from the compute node after + * running the command line. + * @description For multi-instance tasks, the files will only be uploaded from the compute node + * on which the primary task is executed. + */ outputFiles?: OutputFile[]; + /** + * @summary A list of environment variable settings for the task. + */ environmentSettings?: EnvironmentSetting[]; + /** + * @summary A locality hint that can be used by the Batch service to select a compute node on + * which to start the new task. + */ affinityInfo?: AffinityInformation; + /** + * @summary The execution constraints that apply to this task. + * @description If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount + * specified for the job, the maxWallClockTime is infinite, and the retentionTime is 7 days. + */ constraints?: TaskConstraints; + /** + * @summary The user identity under which the task runs. + * @description If omitted, the task runs as a non-administrative user unique to the task. + */ userIdentity?: UserIdentity; + /** + * @summary An object that indicates that the task is a multi-instance task, and contains + * information about how to run the multi-instance task. + */ multiInstanceSettings?: MultiInstanceSettings; + /** + * @summary The tasks that this task depends on. + * @description This task will not be scheduled until all tasks that it depends on have completed + * successfully. If any of those tasks fail and exhaust their retry counts, this task will never + * be scheduled. If the job does not have usesTaskDependencies set to true, and this element is + * present, the request fails with error code TaskDependenciesNotSpecifiedOnJob. + */ dependsOn?: TaskDependencies; + /** + * @summary A list of application packages that the Batch service will deploy to the compute node + * before running the command line. + * @description Application packages are downloaded and deployed to a shared directory, not the + * task working directory. Therefore, if a referenced package is already on the compute node, and + * is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If + * a referenced application package cannot be installed, for example because the package has been + * deleted or because download failed, the task fails. + */ applicationPackageReferences?: ApplicationPackageReference[]; + /** + * @summary The settings for an authentication token that the task can use to perform Batch + * service operations. + * @description If this property is set, the Batch service provides the task with an + * authentication token which can be used to authenticate Batch service operations without + * requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN + * environment variable. The operations that the task can carry out using the token depend on the + * settings. For example, a task can request job permissions in order to add other tasks to the + * job, or check the status of the job or of other tasks under the job. + */ authenticationTokenSettings?: AuthenticationTokenSettings; } /** - * @class - * Initializes a new instance of the TaskAddCollectionParameter class. - * @constructor * @summary A collection of Azure Batch tasks to add. - * - * @member {array} value The collection of tasks to add. The maximum count of - * tasks is 100. The total serialized size of this collection must be less than - * 1MB. If it is greater than 1MB (for example if each task has 100's of - * resource files or environment variables), the request will fail with code - * 'RequestBodyTooLarge' and should be retried again with fewer tasks. */ export interface TaskAddCollectionParameter { + /** + * @summary The collection of tasks to add. The maximum count of tasks is 100. + * @description The total serialized size of this collection must be less than 1MB. If it is + * greater than 1MB (for example if each task has 100's of resource files or environment + * variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again + * with fewer tasks. + */ value: TaskAddParameter[]; } /** - * @class - * Initializes a new instance of the ErrorMessage class. - * @constructor * @summary An error message received in an Azure Batch error response. - * - * @member {string} [lang] The language code of the error message. - * @member {string} [value] The text of the message. */ export interface ErrorMessage { + /** + * @summary The language code of the error message + */ lang?: string; + /** + * @summary The text of the message. + */ value?: string; } /** - * @class - * Initializes a new instance of the BatchErrorDetail class. - * @constructor - * @summary An item of additional information included in an Azure Batch error - * response. - * - * @member {string} [key] An identifier specifying the meaning of the Value - * property. - * @member {string} [value] The additional information included with the error - * response. + * @summary An item of additional information included in an Azure Batch error response. */ export interface BatchErrorDetail { + /** + * @summary An identifier specifying the meaning of the Value property. + */ key?: string; + /** + * @summary The additional information included with the error response. + */ value?: string; } /** - * @class - * Initializes a new instance of the BatchError class. - * @constructor * @summary An error response received from the Azure Batch service. - * - * @member {string} [code] An identifier for the error. Codes are invariant and - * are intended to be consumed programmatically. - * @member {object} [message] A message describing the error, intended to be - * suitable for display in a user interface. - * @member {string} [message.lang] - * @member {string} [message.value] - * @member {array} [values] A collection of key-value pairs containing - * additional details about the error. */ export interface BatchError { + /** + * @summary An identifier for the error. Codes are invariant and are intended to be consumed + * programmatically. + */ code?: string; + /** + * @summary A message describing the error, intended to be suitable for display in a user + * interface. + */ message?: ErrorMessage; + /** + * @summary A collection of key-value pairs containing additional details about the error. + */ values?: BatchErrorDetail[]; } /** - * @class - * Initializes a new instance of the TaskAddResult class. - * @constructor - * @summary Result for a single task added as part of an add task collection - * operation. - * - * @member {string} status The status of the add task request. Possible values - * include: 'success', 'clientError', 'serverError' - * @member {string} taskId The ID of the task for which this is the result. - * @member {string} [eTag] The ETag of the task, if the task was successfully - * added. You can use this to detect whether the task has changed between - * requests. In particular, you can be pass the ETag with an Update Task - * request to specify that your changes should take effect only if nobody else - * has modified the job in the meantime. - * @member {date} [lastModified] The last modified time of the task. - * @member {string} [location] The URL of the task, if the task was - * successfully added. - * @member {object} [error] The error encountered while attempting to add the - * task. - * @member {string} [error.code] - * @member {object} [error.message] - * @member {string} [error.message.lang] - * @member {string} [error.message.value] - * @member {array} [error.values] + * @summary Result for a single task added as part of an add task collection operation. */ export interface TaskAddResult { + /** + * @summary The status of the add task request. + * @description Possible values include: 'success', 'clientError', 'serverError' + */ status: string; + /** + * @summary The ID of the task for which this is the result. + */ taskId: string; + /** + * @summary The ETag of the task, if the task was successfully added. + * @description You can use this to detect whether the task has changed between requests. In + * particular, you can be pass the ETag with an Update Task request to specify that your changes + * should take effect only if nobody else has modified the job in the meantime. + */ eTag?: string; + /** + * @summary The last modified time of the task. + */ lastModified?: Date; + /** + * @summary The URL of the task, if the task was successfully added. + */ location?: string; + /** + * @summary The error encountered while attempting to add the task. + */ error?: BatchError; } /** - * @class - * Initializes a new instance of the TaskAddCollectionResult class. - * @constructor * @summary The result of adding a collection of tasks to a job. - * - * @member {array} [value] The results of the add task collection operation. */ export interface TaskAddCollectionResult { + /** + * @summary The results of the add task collection operation. + */ value?: TaskAddResult[]; } /** - * @class - * Initializes a new instance of the SubtaskInformation class. - * @constructor * @summary Information about an Azure Batch subtask. - * - * @member {number} [id] The ID of the subtask. - * @member {object} [nodeInfo] Information about the compute node on which the - * subtask ran. - * @member {string} [nodeInfo.affinityId] - * @member {string} [nodeInfo.nodeUrl] - * @member {string} [nodeInfo.poolId] - * @member {string} [nodeInfo.nodeId] - * @member {string} [nodeInfo.taskRootDirectory] - * @member {string} [nodeInfo.taskRootDirectoryUrl] - * @member {date} [startTime] The time at which the subtask started running. If - * the subtask has been restarted or retried, this is the most recent time at - * which the subtask started running. - * @member {date} [endTime] The time at which the subtask completed. This - * property is set only if the subtask is in the Completed state. - * @member {number} [exitCode] The exit code of the program specified on the - * subtask command line. This property is set only if the subtask is in the - * completed state. In general, the exit code for a process reflects the - * specific convention implemented by the application developer for that - * process. If you use the exit code value to make decisions in your code, be - * sure that you know the exit code convention used by the application process. - * However, if the Batch service terminates the subtask (due to timeout, or - * user termination via the API) you may see an operating system-defined exit - * code. - * @member {object} [containerInfo] Information about the container under which - * the task is executing. This property is set only if the task runs in a - * container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string - * from the Docker service, if available. It is equivalent to the error field - * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: - * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {string} [state] The current state of the subtask. Possible values - * include: 'preparing', 'running', 'completed' - * @member {date} [stateTransitionTime] The time at which the subtask entered - * its current state. - * @member {string} [previousState] The previous state of the subtask. This - * property is not set if the subtask is in its initial running state. Possible - * values include: 'preparing', 'running', 'completed' - * @member {date} [previousStateTransitionTime] The time at which the subtask - * entered its previous state. This property is not set if the subtask is in - * its initial running state. - * @member {string} [result] The result of the task execution. If the value is - * 'failed', then the details of the failure can be found in the failureInfo - * property. Possible values include: 'success', 'failure' */ export interface SubtaskInformation { + /** + * @summary The ID of the subtask. + */ id?: number; + /** + * @summary Information about the compute node on which the subtask ran. + */ nodeInfo?: ComputeNodeInformation; + /** + * @summary The time at which the subtask started running. If the subtask has been restarted or + * retried, this is the most recent time at which the subtask started running. + */ startTime?: Date; + /** + * @summary The time at which the subtask completed. + * @description This property is set only if the subtask is in the Completed state. + */ endTime?: Date; + /** + * @summary The exit code of the program specified on the subtask command line. + * @description This property is set only if the subtask is in the completed state. In general, + * the exit code for a process reflects the specific convention implemented by the application + * developer for that process. If you use the exit code value to make decisions in your code, be + * sure that you know the exit code convention used by the application process. However, if the + * Batch service terminates the subtask (due to timeout, or user termination via the API) you may + * see an operating system-defined exit code. + */ exitCode?: number; + /** + * @summary Information about the container under which the task is executing. + * @description This property is set only if the task runs in a container context. + */ containerInfo?: TaskContainerExecutionInformation; + /** + * @summary Information describing the task failure, if any. + * @description This property is set only if the task is in the completed state and encountered a + * failure. + */ failureInfo?: TaskFailureInformation; + /** + * @summary The current state of the subtask. + * @description Possible values include: 'preparing', 'running', 'completed' + */ state?: string; + /** + * @summary The time at which the subtask entered its current state. + */ stateTransitionTime?: Date; + /** + * @summary The previous state of the subtask. + * @description This property is not set if the subtask is in its initial running state. Possible + * values include: 'preparing', 'running', 'completed' + */ previousState?: string; + /** + * @summary The time at which the subtask entered its previous state. + * @description This property is not set if the subtask is in its initial running state. + */ previousStateTransitionTime?: Date; + /** + * @summary The result of the task execution. + * @description If the value is 'failed', then the details of the failure can be found in the + * failureInfo property. Possible values include: 'success', 'failure' + */ result?: string; } /** - * @class - * Initializes a new instance of the CloudTaskListSubtasksResult class. - * @constructor * @summary The result of listing the subtasks of a task. - * - * @member {array} [value] The list of subtasks. */ export interface CloudTaskListSubtasksResult { + /** + * @summary The list of subtasks. + */ value?: SubtaskInformation[]; } /** - * @class - * Initializes a new instance of the TaskInformation class. - * @constructor * @summary Information about a task running on a compute node. - * - * @member {string} [taskUrl] The URL of the task. - * @member {string} [jobId] The ID of the job to which the task belongs. - * @member {string} [taskId] The ID of the task. - * @member {number} [subtaskId] The ID of the subtask if the task is a - * multi-instance task. - * @member {string} taskState The current state of the task. Possible values - * include: 'active', 'preparing', 'running', 'completed' - * @member {object} [executionInfo] Information about the execution of the - * task. - * @member {date} [executionInfo.startTime] 'Running' corresponds to the - * running state, so if the task specifies resource files or application - * packages, then the start time reflects the time at which the task started - * downloading or deploying these. If the task has been restarted or retried, - * this is the most recent time at which the task started running. This - * property is present only for tasks that are in the running or completed - * state. - * @member {date} [executionInfo.endTime] This property is set only if the task - * is in the Completed state. - * @member {number} [executionInfo.exitCode] This property is set only if the - * task is in the completed state. In general, the exit code for a process - * reflects the specific convention implemented by the application developer - * for that process. If you use the exit code value to make decisions in your - * code, be sure that you know the exit code convention used by the application - * process. However, if the Batch service terminates the task (due to timeout, - * or user termination via the API) you may see an operating system-defined - * exit code. - * @member {object} [executionInfo.containerInfo] This property is set only if - * the task runs in a container context. - * @member {string} [executionInfo.containerInfo.containerId] - * @member {string} [executionInfo.containerInfo.state] This is the state of - * the container according to the Docker service. It is equivalent to the - * status field returned by "docker inspect". - * @member {string} [executionInfo.containerInfo.error] This is the detailed - * error string from the Docker service, if available. It is equivalent to the - * error field returned by "docker inspect". - * @member {object} [executionInfo.failureInfo] This property is set only if - * the task is in the completed state and encountered a failure. - * @member {string} [executionInfo.failureInfo.category] Possible values - * include: 'userError', 'serverError' - * @member {string} [executionInfo.failureInfo.code] - * @member {string} [executionInfo.failureInfo.message] - * @member {array} [executionInfo.failureInfo.details] - * @member {number} [executionInfo.retryCount] Task application failures - * (non-zero exit code) are retried, pre-processing errors (the task could not - * be run) and file upload errors are not retried. The Batch service will retry - * the task up to the limit specified by the constraints. - * @member {date} [executionInfo.lastRetryTime] This element is present only if - * the task was retried (i.e. retryCount is nonzero). If present, this is - * typically the same as startTime, but may be different if the task has been - * restarted for reasons other than retry; for example, if the compute node was - * rebooted during a retry, then the startTime is updated but the lastRetryTime - * is not. - * @member {number} [executionInfo.requeueCount] When the user removes nodes - * from a pool (by resizing/shrinking the pool) or when the job is being - * disabled, the user can specify that running tasks on the nodes be requeued - * for execution. This count tracks how many times the task has been requeued - * for these reasons. - * @member {date} [executionInfo.lastRequeueTime] This property is set only if - * the requeueCount is nonzero. - * @member {string} [executionInfo.result] If the value is 'failed', then the - * details of the failure can be found in the failureInfo property. Possible - * values include: 'success', 'failure' */ export interface TaskInformation { + /** + * @summary The URL of the task. + */ taskUrl?: string; + /** + * @summary The ID of the job to which the task belongs. + */ jobId?: string; + /** + * @summary The ID of the task. + */ taskId?: string; + /** + * @summary The ID of the subtask if the task is a multi-instance task. + */ subtaskId?: number; + /** + * @summary The current state of the task. + * @description Possible values include: 'active', 'preparing', 'running', 'completed' + */ taskState: string; + /** + * @summary Information about the execution of the task. + */ executionInfo?: TaskExecutionInformation; } /** - * @class - * Initializes a new instance of the StartTaskInformation class. - * @constructor * @summary Information about a start task running on a compute node. - * - * @member {string} state The state of the start task on the compute node. - * Possible values include: 'running', 'completed' - * @member {date} startTime The time at which the start task started running. - * This value is reset every time the task is restarted or retried (that is, - * this is the most recent time at which the start task started running). - * @member {date} [endTime] The time at which the start task stopped running. - * This is the end time of the most recent run of the start task, if that run - * has completed (even if that run failed and a retry is pending). This element - * is not present if the start task is currently running. - * @member {number} [exitCode] The exit code of the program specified on the - * start task command line. This property is set only if the start task is in - * the completed state. In general, the exit code for a process reflects the - * specific convention implemented by the application developer for that - * process. If you use the exit code value to make decisions in your code, be - * sure that you know the exit code convention used by the application process. - * However, if the Batch service terminates the start task (due to timeout, or - * user termination via the API) you may see an operating system-defined exit - * code. - * @member {object} [containerInfo] Information about the container under which - * the task is executing. This property is set only if the task runs in a - * container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string - * from the Docker service, if available. It is equivalent to the error field - * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: - * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {number} retryCount The number of times the task has been retried by - * the Batch service. Task application failures (non-zero exit code) are - * retried, pre-processing errors (the task could not be run) and file upload - * errors are not retried. The Batch service will retry the task up to the - * limit specified by the constraints. - * @member {date} [lastRetryTime] The most recent time at which a retry of the - * task started running. This element is present only if the task was retried - * (i.e. retryCount is nonzero). If present, this is typically the same as - * startTime, but may be different if the task has been restarted for reasons - * other than retry; for example, if the compute node was rebooted during a - * retry, then the startTime is updated but the lastRetryTime is not. - * @member {string} [result] The result of the task execution. If the value is - * 'failed', then the details of the failure can be found in the failureInfo - * property. Possible values include: 'success', 'failure' */ export interface StartTaskInformation { + /** + * @summary The state of the start task on the compute node. + * @description Possible values include: 'running', 'completed' + */ state: string; + /** + * @summary The time at which the start task started running. + * @description This value is reset every time the task is restarted or retried (that is, this is + * the most recent time at which the start task started running). + */ startTime: Date; + /** + * @summary The time at which the start task stopped running. + * @description This is the end time of the most recent run of the start task, if that run has + * completed (even if that run failed and a retry is pending). This element is not present if the + * start task is currently running. + */ endTime?: Date; + /** + * @summary The exit code of the program specified on the start task command line. + * @description This property is set only if the start task is in the completed state. In + * general, the exit code for a process reflects the specific convention implemented by the + * application developer for that process. If you use the exit code value to make decisions in + * your code, be sure that you know the exit code convention used by the application process. + * However, if the Batch service terminates the start task (due to timeout, or user termination + * via the API) you may see an operating system-defined exit code. + */ exitCode?: number; + /** + * @summary Information about the container under which the task is executing. + * @description This property is set only if the task runs in a container context. + */ containerInfo?: TaskContainerExecutionInformation; + /** + * @summary Information describing the task failure, if any. + * @description This property is set only if the task is in the completed state and encountered a + * failure. + */ failureInfo?: TaskFailureInformation; + /** + * @summary The number of times the task has been retried by the Batch service. + * @description Task application failures (non-zero exit code) are retried, pre-processing errors + * (the task could not be run) and file upload errors are not retried. The Batch service will + * retry the task up to the limit specified by the constraints. + */ retryCount: number; + /** + * @summary The most recent time at which a retry of the task started running. + * @description This element is present only if the task was retried (i.e. retryCount is + * nonzero). If present, this is typically the same as startTime, but may be different if the + * task has been restarted for reasons other than retry; for example, if the compute node was + * rebooted during a retry, then the startTime is updated but the lastRetryTime is not. + */ lastRetryTime?: Date; + /** + * @summary The result of the task execution. + * @description If the value is 'failed', then the details of the failure can be found in the + * failureInfo property. Possible values include: 'success', 'failure' + */ result?: string; } /** - * @class - * Initializes a new instance of the ComputeNodeError class. - * @constructor * @summary An error encountered by a compute node. - * - * @member {string} [code] An identifier for the compute node error. Codes are - * invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the compute node error, - * intended to be suitable for display in a user interface. - * @member {array} [errorDetails] The list of additional error details related - * to the compute node error. */ export interface ComputeNodeError { + /** + * @summary An identifier for the compute node error. Codes are invariant and are intended to be + * consumed programmatically. + */ code?: string; + /** + * @summary A message describing the compute node error, intended to be suitable for display in a + * user interface. + */ message?: string; + /** + * @summary The list of additional error details related to the compute node error. + */ errorDetails?: NameValuePair[]; } /** - * @class - * Initializes a new instance of the InboundEndpoint class. - * @constructor * @summary An inbound endpoint on a compute node. - * - * @member {string} name The name of the endpoint. - * @member {string} protocol The protocol of the endpoint. Possible values - * include: 'tcp', 'udp' - * @member {string} publicIPAddress The public IP address of the compute node. - * @member {string} publicFQDN The public fully qualified domain name for the - * compute node. - * @member {number} frontendPort The public port number of the endpoint. - * @member {number} backendPort The backend port number of the endpoint. */ export interface InboundEndpoint { + /** + * @summary The name of the endpoint. + */ name: string; + /** + * @summary The protocol of the endpoint. + * @description Possible values include: 'tcp', 'udp' + */ protocol: string; + /** + * @summary The public IP address of the compute node. + */ publicIPAddress: string; + /** + * @summary The public fully qualified domain name for the compute node. + */ publicFQDN: string; + /** + * @summary The public port number of the endpoint. + */ frontendPort: number; + /** + * @summary The backend port number of the endpoint. + */ backendPort: number; } /** - * @class - * Initializes a new instance of the ComputeNodeEndpointConfiguration class. - * @constructor * @summary The endpoint configuration for the compute node. - * - * @member {array} inboundEndpoints The list of inbound endpoints that are - * accessible on the compute node. */ export interface ComputeNodeEndpointConfiguration { + /** + * @summary The list of inbound endpoints that are accessible on the compute node. + */ inboundEndpoints: InboundEndpoint[]; } /** - * @class - * Initializes a new instance of the ComputeNode class. - * @constructor * @summary A compute node in the Batch service. - * - * @member {string} [id] The ID of the compute node. Every node that is added - * to a pool is assigned a unique ID. Whenever a node is removed from a pool, - * all of its local files are deleted, and the ID is reclaimed and could be - * reused for new nodes. - * @member {string} [url] The URL of the compute node. - * @member {string} [state] The current state of the compute node. 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. Possible values include: 'idle', 'rebooting', 'reimaging', - * 'running', 'unusable', 'creating', 'starting', 'waitingForStartTask', - * 'startTaskFailed', 'unknown', 'leavingPool', 'offline', 'preempted' - * @member {string} [schedulingState] Whether the compute node is available for - * task scheduling. Possible values include: 'enabled', 'disabled' - * @member {date} [stateTransitionTime] The time at which the compute node - * entered its current state. - * @member {date} [lastBootTime] The last time at which the compute node was - * started. This property may not be present if the node state is unusable. - * @member {date} [allocationTime] The time at which this compute node was - * allocated to the pool. This is the time when the node was initially - * allocated and doesn't change once set. It is not updated when the node is - * service healed or preempted. - * @member {string} [ipAddress] The IP address that other compute nodes can use - * to communicate with this compute node. Every node that is added to a pool is - * assigned a unique IP address. Whenever a node is removed from a pool, all of - * its local files are deleted, and the IP address is reclaimed and could be - * reused for new nodes. - * @member {string} [affinityId] An identifier which can be passed when adding - * a task to request that the task be scheduled on this node. Note that this is - * just a soft affinity. If the target node is busy or unavailable at the time - * the task is scheduled, then the task will be scheduled elsewhere. - * @member {string} [vmSize] The size of the virtual machine hosting the - * compute node. For information about available sizes of virtual machines in - * pools, see Choose a VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {number} [totalTasksRun] The total number of job tasks completed on - * the compute node. This includes Job Manager tasks and normal tasks, but not - * Job Preparation, Job Release or Start tasks. - * @member {number} [runningTasksCount] The total number of currently running - * job tasks on the compute node. This includes Job Manager tasks and normal - * tasks, but not Job Preparation, Job Release or Start tasks. - * @member {number} [totalTasksSucceeded] The total number of job tasks which - * completed successfully (with exitCode 0) on the compute node. This includes - * Job Manager tasks and normal tasks, but not Job Preparation, Job Release or - * Start tasks. - * @member {array} [recentTasks] A list of tasks whose state has recently - * changed. This property is present only if at least one task has run on this - * node since it was assigned to the pool. - * @member {object} [startTask] The task specified to run on the compute node - * as it joins the pool. - * @member {string} [startTask.commandLine] The command line does not run under - * a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure - * Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These - * additional options are supplied as arguments to the "docker create" command, - * in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [startTask.containerSettings.registry] This setting can be - * omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a - * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [startTask.userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically controls - * the number of retries. The Batch service will try the task once, and may - * then retry up to this limit. For example, if the maximum retry count is 3, - * Batch tries the task up to 4 times (one initial try and 3 retries). If the - * maximum retry count is 0, the Batch service does not retry the task. If the - * maximum retry count is -1, the Batch service retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task - * fails on a compute node, the Batch service retries the start task up to its - * maximum retry count (maxTaskRetryCount). If the task has still not completed - * successfully after all retries, then the Batch service marks the compute - * node unusable, and will not schedule tasks to it. This condition can be - * detected via the node state and failure info details. If false, the Batch - * service will not wait for the start task to complete. In this case, other - * tasks can start executing on the compute node while the start task is still - * running; and even if the start task fails, new tasks will continue to be - * scheduled on the node. The default is false. - * @member {object} [startTaskInfo] Runtime information about the execution of - * the start task on the compute node. - * @member {string} [startTaskInfo.state] Possible values include: 'running', - * 'completed' - * @member {date} [startTaskInfo.startTime] This value is reset every time the - * task is restarted or retried (that is, this is the most recent time at which - * the start task started running). - * @member {date} [startTaskInfo.endTime] This is the end time of the most - * recent run of the start task, if that run has completed (even if that run - * failed and a retry is pending). This element is not present if the start - * task is currently running. - * @member {number} [startTaskInfo.exitCode] This property is set only if the - * start task is in the completed state. In general, the exit code for a - * process reflects the specific convention implemented by the application - * developer for that process. If you use the exit code value to make decisions - * in your code, be sure that you know the exit code convention used by the - * application process. However, if the Batch service terminates the start task - * (due to timeout, or user termination via the API) you may see an operating - * system-defined exit code. - * @member {object} [startTaskInfo.containerInfo] This property is set only if - * the task runs in a container context. - * @member {string} [startTaskInfo.containerInfo.containerId] - * @member {string} [startTaskInfo.containerInfo.state] This is the state of - * the container according to the Docker service. It is equivalent to the - * status field returned by "docker inspect". - * @member {string} [startTaskInfo.containerInfo.error] This is the detailed - * error string from the Docker service, if available. It is equivalent to the - * error field returned by "docker inspect". - * @member {object} [startTaskInfo.failureInfo] This property is set only if - * the task is in the completed state and encountered a failure. - * @member {string} [startTaskInfo.failureInfo.category] Possible values - * include: 'userError', 'serverError' - * @member {string} [startTaskInfo.failureInfo.code] - * @member {string} [startTaskInfo.failureInfo.message] - * @member {array} [startTaskInfo.failureInfo.details] - * @member {number} [startTaskInfo.retryCount] Task application failures - * (non-zero exit code) are retried, pre-processing errors (the task could not - * be run) and file upload errors are not retried. The Batch service will retry - * the task up to the limit specified by the constraints. - * @member {date} [startTaskInfo.lastRetryTime] This element is present only if - * the task was retried (i.e. retryCount is nonzero). If present, this is - * typically the same as startTime, but may be different if the task has been - * restarted for reasons other than retry; for example, if the compute node was - * rebooted during a retry, then the startTime is updated but the lastRetryTime - * is not. - * @member {string} [startTaskInfo.result] If the value is 'failed', then the - * details of the failure can be found in the failureInfo property. Possible - * values include: 'success', 'failure' - * @member {array} [certificateReferences] The list of certificates installed - * on the compute node. For Windows compute nodes, the Batch service installs - * the certificates to the specified certificate store and location. 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. - * @member {array} [errors] The list of errors that are currently being - * encountered by the compute node. - * @member {boolean} [isDedicated] Whether this compute node is a dedicated - * node. If false, the node is a low-priority node. - * @member {object} [endpointConfiguration] The endpoint configuration for the - * compute node. - * @member {array} [endpointConfiguration.inboundEndpoints] - * @member {object} [nodeAgentInfo] Information about the node agent version - * and the time the node upgraded to a new version. - * @member {string} [nodeAgentInfo.version] This version number can be checked - * against the node agent release notes located at - * https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. - * @member {date} [nodeAgentInfo.lastUpdateTime] This is the most recent time - * that the node agent was updated to a new version. */ export interface ComputeNode { + /** + * @summary The ID of the compute node. + * @description Every node that is added to a pool is assigned a unique ID. Whenever a node is + * removed from a pool, all of its local files are deleted, and the ID is reclaimed and could be + * reused for new nodes. + */ id?: string; + /** + * @summary The URL of the compute node. + */ url?: string; + /** + * @summary The current state of the compute node. + * @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. Possible + * values include: 'idle', 'rebooting', 'reimaging', 'running', 'unusable', 'creating', + * 'starting', 'waitingForStartTask', 'startTaskFailed', 'unknown', 'leavingPool', 'offline', + * 'preempted' + */ state?: string; + /** + * @summary Whether the compute node is available for task scheduling. + * @description Possible values include: 'enabled', 'disabled' + */ schedulingState?: string; + /** + * @summary The time at which the compute node entered its current state. + */ stateTransitionTime?: Date; + /** + * @summary The last time at which the compute node was started. + * @description This property may not be present if the node state is unusable. + */ lastBootTime?: Date; + /** + * @summary The time at which this compute node was allocated to the pool. + * @description This is the time when the node was initially allocated and doesn't change once + * set. It is not updated when the node is service healed or preempted. + */ allocationTime?: Date; + /** + * @summary The IP address that other compute nodes can use to communicate with this compute + * node. + * @description Every node that is added to a pool is assigned a unique IP address. Whenever a + * node is removed from a pool, all of its local files are deleted, and the IP address is + * reclaimed and could be reused for new nodes. + */ ipAddress?: string; + /** + * @summary An identifier which can be passed when adding a task to request that the task be + * scheduled on this node. + * @description Note that this is just a soft affinity. If the target node is busy or unavailable + * at the time the task is scheduled, then the task will be scheduled elsewhere. + */ affinityId?: string; + /** + * @summary The size of the virtual machine hosting the compute node. + * @description For information about available sizes of virtual machines in pools, see Choose a + * VM size for compute nodes in an Azure Batch pool + * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). + */ vmSize?: string; + /** + * @summary The total number of job tasks completed on the compute node. This includes Job + * Manager tasks and normal tasks, but not Job Preparation, Job Release or Start tasks. + */ totalTasksRun?: number; + /** + * @summary The total number of currently running job tasks on the compute node. This includes + * Job Manager tasks and normal tasks, but not Job Preparation, Job Release or Start tasks. + */ runningTasksCount?: number; + /** + * @summary The total number of job tasks which completed successfully (with exitCode 0) on the + * compute node. This includes Job Manager tasks and normal tasks, but not Job Preparation, Job + * Release or Start tasks. + */ totalTasksSucceeded?: number; + /** + * @summary A list of tasks whose state has recently changed. + * @description This property is present only if at least one task has run on this node since it + * was assigned to the pool. + */ recentTasks?: TaskInformation[]; + /** + * @summary The task specified to run on the compute node as it joins the pool. + */ startTask?: StartTask; + /** + * @summary Runtime information about the execution of the start task on the compute node. + */ startTaskInfo?: StartTaskInformation; + /** + * @summary The list of certificates installed on the compute node. + * @description For Windows compute nodes, the Batch service installs the certificates to the + * specified certificate store and location. 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. + */ certificateReferences?: CertificateReference[]; + /** + * @summary The list of errors that are currently being encountered by the compute node. + */ errors?: ComputeNodeError[]; + /** + * @summary Whether this compute node is a dedicated node. If false, the node is a low-priority + * node. + */ isDedicated?: boolean; + /** + * @summary The endpoint configuration for the compute node. + */ endpointConfiguration?: ComputeNodeEndpointConfiguration; + /** + * @summary Information about the node agent version and the time the node upgraded to a new + * version. + */ nodeAgentInfo?: NodeAgentInformation; } /** - * @class - * Initializes a new instance of the ComputeNodeUser class. - * @constructor * @summary A user account for RDP or SSH access on a compute node. - * - * @member {string} name The user name of the account. - * @member {boolean} [isAdmin] Whether the account should be an administrator - * on the compute node. The default value is false. - * @member {date} [expiryTime] The time at which the account should expire. If - * omitted, the default is 1 day from the current time. For Linux compute - * nodes, the expiryTime has a precision up to a day. - * @member {string} [password] The password of the account. The password is - * required for Windows nodes (those created with 'cloudServiceConfiguration', - * or created with 'virtualMachineConfiguration' using a Windows image - * reference). For Linux compute nodes, the password can optionally be - * specified along with the sshPublicKey property. - * @member {string} [sshPublicKey] The SSH public key that can be used for - * remote login to the compute node. The public key should be compatible with - * OpenSSH encoding and should be base 64 encoded. This property can be - * specified only for Linux nodes. If this is specified for a Windows node, - * then the Batch service rejects the request; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). */ export interface ComputeNodeUser { + /** + * @summary The user name of the account. + */ name: string; + /** + * @summary Whether the account should be an administrator on the compute node. + * @description The default value is false. + */ isAdmin?: boolean; + /** + * @summary The time at which the account should expire. + * @description If omitted, the default is 1 day from the current time. For Linux compute nodes, + * the expiryTime has a precision up to a day. + */ expiryTime?: Date; + /** + * @summary The password of the account. + * @description The password is required for Windows nodes (those created with + * 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows + * image reference). For Linux compute nodes, the password can optionally be specified along with + * the sshPublicKey property. + */ password?: string; + /** + * @summary The SSH public key that can be used for remote login to the compute node. + * @description The public key should be compatible with OpenSSH encoding and should be base 64 + * encoded. This property can be specified only for Linux nodes. If this is specified for a + * Windows node, then the Batch service rejects the request; if you are calling the REST API + * directly, the HTTP status code is 400 (Bad Request). + */ sshPublicKey?: string; } /** - * @class - * Initializes a new instance of the ComputeNodeGetRemoteLoginSettingsResult class. - * @constructor * @summary The remote login settings for a compute node. - * - * @member {string} remoteLoginIPAddress The IP address used for remote login - * to the compute node. - * @member {number} remoteLoginPort The port used for remote login to the - * compute node. */ export interface ComputeNodeGetRemoteLoginSettingsResult { + /** + * @summary The IP address used for remote login to the compute node. + */ remoteLoginIPAddress: string; + /** + * @summary The port used for remote login to the compute node. + */ remoteLoginPort: number; } /** - * @class - * Initializes a new instance of the JobSchedulePatchParameter class. - * @constructor * @summary The set of changes to be made to a job schedule. - * - * @member {object} [schedule] The schedule according to which jobs will be - * created. If you do not specify this element, the existing schedule is left - * unchanged. - * @member {date} [schedule.doNotRunUntil] If you do not specify a - * doNotRunUntil time, the schedule becomes ready to create jobs immediately. - * @member {date} [schedule.doNotRunAfter] If you do not specify a - * doNotRunAfter time, and you are creating a recurring job schedule, the job - * schedule will remain active until you explicitly terminate it. - * @member {moment.duration} [schedule.startWindow] If a job is not created - * within the startWindow interval, then the 'opportunity' is lost; no job will - * be created until the next recurrence of the schedule. If the schedule is - * recurring, and the startWindow is longer than the recurrence interval, then - * this is equivalent to an infinite startWindow, because the job that is 'due' - * in one recurrenceInterval is not carried forward into the next recurrence - * interval. The default is infinite. The minimum value is 1 minute. If you - * specify a lower value, the Batch service rejects the schedule with an error; - * if you are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {moment.duration} [schedule.recurrenceInterval] Because a job - * schedule can have at most one active job under it at any given time, if it - * is time to create a new job under a job schedule, but the previous job is - * still running, the Batch service will not create the new job until the - * previous job finishes. If the previous job does not finish within the - * startWindow period of the new recurrenceInterval, then no new job will be - * scheduled for that interval. For recurring jobs, you should normally specify - * a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, - * you will need an external process to monitor when jobs are created, add - * tasks to the jobs and terminate the jobs ready for the next recurrence. The - * default is that the schedule does not recur: one job is created, within the - * startWindow after the doNotRunUntil time, and the schedule is complete as - * soon as that job finishes. The minimum value is 1 minute. If you specify a - * lower value, the Batch service rejects the schedule with an error; if you - * are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {object} [jobSpecification] The details of the jobs to be created on - * this schedule. Updates affect only jobs that are started after the update - * has taken place. Any currently active job continues with the older - * specification. - * @member {number} [jobSpecification.priority] Priority values can range from - * -1000 to 1000, with -1000 being the lowest priority and 1000 being the - * highest priority. The default value is 0. This priority is used as the - * default for all jobs under the job schedule. You can update a job's priority - * after it has been created using by using the update job API. - * @member {string} [jobSpecification.displayName] The name need not be unique - * and can contain any Unicode characters up to a maximum length of 1024. - * @member {boolean} [jobSpecification.usesTaskDependencies] - * @member {string} [jobSpecification.onAllTasksComplete] 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. Possible values include: 'noAction', 'terminateJob' - * @member {string} [jobSpecification.onTaskFailure] The default is noaction. - * Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [jobSpecification.networkConfiguration] - * @member {string} [jobSpecification.networkConfiguration.subnetId] This is - * only supported for jobs running on VirtualMachineConfiguration pools. This - * is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes which will run tasks from the job. For more - * details, see - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [jobSpecification.constraints] - * @member {moment.duration} [jobSpecification.constraints.maxWallClockTime] If - * the job does not complete within the time limit, the Batch service - * terminates it and any tasks that are still running. In this case, the - * termination reason will be MaxWallClockTimeExpiry. If this property is not - * specified, there is no time limit on how long the job may run. - * @member {number} [jobSpecification.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries. The Batch service - * will try each task once, and may then retry up to this limit. For example, - * if the maximum retry count is 3, Batch tries a task up to 4 times (one - * initial try and 3 retries). If the maximum retry count is 0, the Batch - * service does not retry tasks. If the maximum retry count is -1, the Batch - * service retries tasks without limit. The default value is 0 (no retries). - * @member {object} [jobSpecification.jobManagerTask] If the job does not - * specify a Job Manager task, the user must explicitly add tasks to the job - * using the Task API. If the job does specify a Job Manager task, the Batch - * service creates the Job Manager task when the job is created, and will try - * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobSpecification.jobManagerTask.id] The ID can contain any - * combination of alphanumeric characters including hyphens and underscores and - * cannot contain more than 64 characters. - * @member {string} [jobSpecification.jobManagerTask.displayName] It need not - * be unique and can contain any Unicode characters up to a maximum length of - * 1024. - * @member {string} [jobSpecification.jobManagerTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command line, - * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in - * Linux. If the command line refers to file paths, it should use a relative - * path (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobManagerTask.containerSettings] If the - * pool that will run this task has containerConfiguration set, this must be - * set as well. If the pool that will run this task doesn't have - * containerConfiguration set, this must not be set. When this is specified, - * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} - * [jobSpecification.jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobManagerTask.resourceFiles] Files listed - * under this element are located in the task's working directory. There is a - * maximum size for the list of resource files. When the max size is exceeded, - * the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [jobSpecification.jobManagerTask.outputFiles] For - * multi-instance tasks, the files will only be uploaded from the compute node - * on which the primary task is executed. - * @member {array} [jobSpecification.jobManagerTask.environmentSettings] - * @member {object} [jobSpecification.jobManagerTask.constraints] - * @member {moment.duration} - * [jobSpecification.jobManagerTask.constraints.maxWallClockTime] If this is - * not specified, there is no time limit on how long the task may run. - * @member {moment.duration} - * [jobSpecification.jobManagerTask.constraints.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the compute - * node is removed or the job is deleted. - * @member {number} - * [jobSpecification.jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] If - * true, when the Job Manager task completes, the Batch service marks the job - * as complete. If any tasks are still running at this time (other than Job - * Release), those tasks are terminated. If false, the completion of the Job - * Manager task does not affect the job status. In this case, you should either - * use the onAllTasksComplete attribute to terminate the job, or have a client - * or user terminate the job explicitly. An example of this is if the Job - * Manager creates a set of tasks but then takes no further role in their - * execution. The default value is true. If you are using the - * onAllTasksComplete and onTaskFailure attributes to control job lifetime, and - * using the Job Manager task only to create the tasks for the job (not to - * monitor progress), then it is important to set killJobOnCompletion to false. - * @member {object} [jobSpecification.jobManagerTask.userIdentity] If omitted, - * the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobManagerTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [jobSpecification.jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobSpecification.jobManagerTask.runExclusive] If true, no - * other tasks will run on the same compute node for as long as the Job Manager - * is running. If false, other tasks can run simultaneously with the Job - * Manager on a compute node. The Job Manager task counts normally against the - * node's concurrent task limit, so this is only relevant if the node allows - * multiple concurrent tasks. The default value is true. - * @member {array} - * [jobSpecification.jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the existing - * copy on the compute node is used. If a referenced application package cannot - * be installed, for example because the package has been deleted or because - * download failed, the task fails. - * @member {object} - * [jobSpecification.jobManagerTask.authenticationTokenSettings] If this - * property is set, the Batch service provides the task with an authentication - * token which can be used to authenticate Batch service operations without - * requiring an account access key. The token is provided via the - * AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the - * task can carry out using the token depend on the settings. For example, a - * task can request job permissions in order to add other tasks to the job, or - * check the status of the job or of other tasks under the job. - * @member {array} - * [jobSpecification.jobManagerTask.authenticationTokenSettings.access] The - * authentication token grants access to a limited set of Batch service - * operations. Currently the only supported value for the access property is - * 'job', which grants access to all operations related to the job which - * contains the task. - * @member {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] The - * default value is true. - * @member {object} [jobSpecification.jobPreparationTask] If a job has a Job - * Preparation task, the Batch service will run the Job Preparation task on a - * compute node before starting any tasks of that job on that compute node. - * @member {string} [jobSpecification.jobPreparationTask.id] The ID can contain - * any combination of alphanumeric characters including hyphens and underscores - * and cannot contain more than 64 characters. If you do not specify this - * property, the Batch service assigns a default value of 'jobpreparation'. No - * other task in the job can have the same ID as the Job Preparation task. If - * you try to submit a task with the same id, the Batch service rejects the - * request with error code TaskIdSameAsJobPreparationTask; if you are calling - * the REST API directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobPreparationTask.commandLine] The - * command line does not run under a shell, and therefore cannot take advantage - * of shell features such as environment variable expansion. If you want to - * take advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobPreparationTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no tag - * is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [jobSpecification.jobPreparationTask.containerSettings.registry] This - * setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobPreparationTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [jobSpecification.jobPreparationTask.environmentSettings] - * @member {object} [jobSpecification.jobPreparationTask.constraints] - * @member {moment.duration} - * [jobSpecification.jobPreparationTask.constraints.maxWallClockTime] If this - * is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} - * [jobSpecification.jobPreparationTask.constraints.retentionTime] The default - * is 7 days, i.e. the task directory will be retained for 7 days unless the - * compute node is removed or the job is deleted. - * @member {number} - * [jobSpecification.jobPreparationTask.constraints.maxTaskRetryCount] Note - * that this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] If - * true and the Job Preparation task fails on a compute node, the Batch service - * retries the Job Preparation task up to its maximum retry count (as specified - * in the constraints element). If the task has still not completed - * successfully after all retries, then the Batch service will not schedule - * tasks of the job to the compute node. The compute node remains active and - * eligible to run tasks of other jobs. If false, the Batch service will not - * wait for the Job Preparation task to complete. In this case, other tasks of - * the job can start executing on the compute node while the Job Preparation - * task is still running; and even if the Job Preparation task fails, new tasks - * will continue to be scheduled on the node. The default value is true. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity] If - * omitted, the task runs as a non-administrative user unique to the task on - * Windows nodes, or a a non-administrative user unique to the pool on Linux - * nodes. - * @member {string} [jobSpecification.jobPreparationTask.userIdentity.userName] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity.autoUser] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {string} - * [jobSpecification.jobPreparationTask.userIdentity.autoUser.scope] The - * default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} - * [jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] The Job - * Preparation task is always rerun if a compute node is reimaged, or if the - * Job Preparation task did not complete (e.g. because the reboot occurred - * while the task was running). Therefore, you should always write a Job - * Preparation task to be idempotent and to behave correctly if run multiple - * times. The default value is true. - * @member {object} [jobSpecification.jobReleaseTask] The primary purpose of - * the Job Release task is to undo changes to compute nodes made by the Job - * Preparation task. Example activities include deleting local files, or - * shutting down services that were started as part of job preparation. A Job - * Release task cannot be specified without also specifying a Job Preparation - * task for the job. The Batch service runs the Job Release task on the compute - * nodes that have run the Job Preparation task. - * @member {string} [jobSpecification.jobReleaseTask.id] The ID can contain any - * combination of alphanumeric characters including hyphens and underscores and - * cannot contain more than 64 characters. If you do not specify this property, - * the Batch service assigns a default value of 'jobrelease'. No other task in - * the job can have the same ID as the Job Release task. If you try to submit a - * task with the same id, the Batch service rejects the request with error code - * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the - * HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobReleaseTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command line, - * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in - * Linux. If the command line refers to file paths, it should use a relative - * path (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobReleaseTask.containerSettings] When - * this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} - * [jobSpecification.jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobReleaseTask.resourceFiles] Files listed - * under this element are located in the task's working directory. - * @member {array} [jobSpecification.jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobSpecification.jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobSpecification.jobReleaseTask.retentionTime] - * The default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity] If omitted, - * the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobReleaseTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [jobSpecification.jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [jobSpecification.commonEnvironmentSettings] Individual - * tasks can override an environment setting specified here by specifying the - * same setting name with a different value. - * @member {object} [jobSpecification.poolInfo] - * @member {string} [jobSpecification.poolInfo.poolId] You must ensure that the - * pool referenced by this property exists. If the pool does not exist at the - * time the Batch service tries to schedule a job, no tasks for the job will - * run until you create a pool with that id. Note that the Batch service will - * not reject the job request; it will simply not run tasks until the pool - * exists. You must specify either the pool ID or the auto pool specification, - * but not both. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification] If auto - * pool creation fails, the Batch service moves the job to a completed state, - * and the pool creation error is set in the job's scheduling error property. - * The Batch service manages the lifetime (both creation and, unless keepAlive - * is specified, deletion) of the auto pool. Any user actions that affect the - * lifetime of the auto pool while the job is active will result in unexpected - * behavior. You must specify either the pool ID or the auto pool - * specification, but not both. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.autoPoolIdPrefix] The Batch - * service assigns each auto pool a unique identifier on creation. To - * distinguish between pools created for different purposes, you can specify - * this element to add a prefix to the ID that is assigned. The prefix can be - * up to 20 characters long. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.poolLifetimeOption] - * Possible values include: 'jobSchedule', 'job' - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.displayName] The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.vmSize] For - * information about available sizes of virtual machines in pools, see Choose a - * VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] - * This property must be specified if the pool needs to be created with Azure - * PaaS VMs. This property and virtualMachineConfiguration are mutually - * exclusive and one of the properties must be specified. If neither is - * specified then the Batch service returns an error; if you are calling the - * REST API directly, the HTTP status code is 400 (Bad Request). This property - * cannot be specified if the Batch account was created with its - * poolAllocationMode property set to 'UserSubscription'. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] - * Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] - * The default value is * which specifies the latest operating system version - * for the specified OS family. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] - * This property must be specified if the pool needs to be created with Azure - * IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] - * 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. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] - * This only applies to images that contain the Windows operating system, and - * should only be used when you hold valid on-premises licenses for the nodes - * which will be deployed. If omitted, no on-premises licensing discount is - * applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size of - * the compute nodes in the pool (the vmSize setting). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] - * Possible values include: 'spread', 'pack' - * @member {moment.duration} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.resizeTimeout] This - * timeout applies only to manual scaling; it has no effect when - * enableAutoScale is set to true. The default value is 15 minutes. The minimum - * value is 5 minutes. If you specify a value less than 5 minutes, the Batch - * service rejects the request with an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleFormula] This - * property must not be specified if enableAutoScale is set to false. It is - * required if enableAutoScale is set to true. The formula is checked for - * validity before the pool is created. If the formula is not valid, the Batch - * service rejects the request with detailed error information. - * @member {moment.duration} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] - * The default value is 15 minutes. The minimum and maximum value are 5 minutes - * and 168 hours respectively. If you specify a value less than 5 minutes or - * greater than 168 hours, the Batch service rejects the request with an - * invalid property value error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] - * Enabling inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] - * This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] - * Pool endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.commandLine] - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] - * This is the full image reference, as would be specified to "docker pull". If - * no tag is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] - * This setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] - * Files listed under this element are located in the task's working directory. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity] - * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] - * The default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] - * The Batch service retries a task if its exit code is nonzero. Note that this - * value specifically controls the number of retries. The Batch service will - * try the task once, and may then retry up to this limit. For example, if the - * maximum retry count is 3, Batch tries the task up to 4 times (one initial - * try and 3 retries). If the maximum retry count is 0, the Batch service does - * not retry the task. If the maximum retry count is -1, the Batch service - * retries the task without limit. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] - * If true and the start task fails on a compute node, the Batch service - * retries the start task up to its maximum retry count (maxTaskRetryCount). If - * the task has still not completed successfully after all retries, then the - * Batch service marks the compute node unusable, and will not schedule tasks - * to it. This condition can be detected via the node state and failure info - * details. If false, the Batch service will not wait for the start task to - * complete. In this case, other tasks can start executing on the compute node - * while the start task is still running; and even if the start task fails, new - * tasks will continue to be scheduled on the node. The default is false. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.certificateReferences] - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.metadata] The Batch - * service does not assign any meaning to metadata; it is solely for the use of - * user code. - * @member {array} [jobSpecification.metadata] The Batch service does not - * assign any meaning to metadata; it is solely for the use of user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * job schedule as metadata. If you do not specify this element, existing - * metadata is left unchanged. */ export interface JobSchedulePatchParameter { + /** + * @summary The schedule according to which jobs will be created. + * @description If you do not specify this element, the existing schedule is left unchanged. + */ schedule?: Schedule; + /** + * @summary The details of the jobs to be created on this schedule. + * @description Updates affect only jobs that are started after the update has taken place. Any + * currently active job continues with the older specification. + */ jobSpecification?: JobSpecification; + /** + * @summary A list of name-value pairs associated with the job schedule as metadata. + * @description If you do not specify this element, existing metadata is left unchanged. + */ metadata?: MetadataItem[]; } /** - * @class - * Initializes a new instance of the JobScheduleUpdateParameter class. - * @constructor * @summary The set of changes to be made to a job schedule. - * - * @member {object} schedule The schedule according to which jobs will be - * created. If you do not specify this element, it is equivalent to passing the - * default schedule: that is, a single job scheduled to run immediately. - * @member {date} [schedule.doNotRunUntil] If you do not specify a - * doNotRunUntil time, the schedule becomes ready to create jobs immediately. - * @member {date} [schedule.doNotRunAfter] If you do not specify a - * doNotRunAfter time, and you are creating a recurring job schedule, the job - * schedule will remain active until you explicitly terminate it. - * @member {moment.duration} [schedule.startWindow] If a job is not created - * within the startWindow interval, then the 'opportunity' is lost; no job will - * be created until the next recurrence of the schedule. If the schedule is - * recurring, and the startWindow is longer than the recurrence interval, then - * this is equivalent to an infinite startWindow, because the job that is 'due' - * in one recurrenceInterval is not carried forward into the next recurrence - * interval. The default is infinite. The minimum value is 1 minute. If you - * specify a lower value, the Batch service rejects the schedule with an error; - * if you are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {moment.duration} [schedule.recurrenceInterval] Because a job - * schedule can have at most one active job under it at any given time, if it - * is time to create a new job under a job schedule, but the previous job is - * still running, the Batch service will not create the new job until the - * previous job finishes. If the previous job does not finish within the - * startWindow period of the new recurrenceInterval, then no new job will be - * scheduled for that interval. For recurring jobs, you should normally specify - * a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, - * you will need an external process to monitor when jobs are created, add - * tasks to the jobs and terminate the jobs ready for the next recurrence. The - * default is that the schedule does not recur: one job is created, within the - * startWindow after the doNotRunUntil time, and the schedule is complete as - * soon as that job finishes. The minimum value is 1 minute. If you specify a - * lower value, the Batch service rejects the schedule with an error; if you - * are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {object} jobSpecification Details of the jobs to be created on this - * schedule. Updates affect only jobs that are started after the update has - * taken place. Any currently active job continues with the older - * specification. - * @member {number} [jobSpecification.priority] Priority values can range from - * -1000 to 1000, with -1000 being the lowest priority and 1000 being the - * highest priority. The default value is 0. This priority is used as the - * default for all jobs under the job schedule. You can update a job's priority - * after it has been created using by using the update job API. - * @member {string} [jobSpecification.displayName] The name need not be unique - * and can contain any Unicode characters up to a maximum length of 1024. - * @member {boolean} [jobSpecification.usesTaskDependencies] - * @member {string} [jobSpecification.onAllTasksComplete] 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. Possible values include: 'noAction', 'terminateJob' - * @member {string} [jobSpecification.onTaskFailure] The default is noaction. - * Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [jobSpecification.networkConfiguration] - * @member {string} [jobSpecification.networkConfiguration.subnetId] This is - * only supported for jobs running on VirtualMachineConfiguration pools. This - * is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes which will run tasks from the job. For more - * details, see - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [jobSpecification.constraints] - * @member {moment.duration} [jobSpecification.constraints.maxWallClockTime] If - * the job does not complete within the time limit, the Batch service - * terminates it and any tasks that are still running. In this case, the - * termination reason will be MaxWallClockTimeExpiry. If this property is not - * specified, there is no time limit on how long the job may run. - * @member {number} [jobSpecification.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries. The Batch service - * will try each task once, and may then retry up to this limit. For example, - * if the maximum retry count is 3, Batch tries a task up to 4 times (one - * initial try and 3 retries). If the maximum retry count is 0, the Batch - * service does not retry tasks. If the maximum retry count is -1, the Batch - * service retries tasks without limit. The default value is 0 (no retries). - * @member {object} [jobSpecification.jobManagerTask] If the job does not - * specify a Job Manager task, the user must explicitly add tasks to the job - * using the Task API. If the job does specify a Job Manager task, the Batch - * service creates the Job Manager task when the job is created, and will try - * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobSpecification.jobManagerTask.id] The ID can contain any - * combination of alphanumeric characters including hyphens and underscores and - * cannot contain more than 64 characters. - * @member {string} [jobSpecification.jobManagerTask.displayName] It need not - * be unique and can contain any Unicode characters up to a maximum length of - * 1024. - * @member {string} [jobSpecification.jobManagerTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command line, - * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in - * Linux. If the command line refers to file paths, it should use a relative - * path (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobManagerTask.containerSettings] If the - * pool that will run this task has containerConfiguration set, this must be - * set as well. If the pool that will run this task doesn't have - * containerConfiguration set, this must not be set. When this is specified, - * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of - * Azure Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} - * [jobSpecification.jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobManagerTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobManagerTask.resourceFiles] Files listed - * under this element are located in the task's working directory. There is a - * maximum size for the list of resource files. When the max size is exceeded, - * the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [jobSpecification.jobManagerTask.outputFiles] For - * multi-instance tasks, the files will only be uploaded from the compute node - * on which the primary task is executed. - * @member {array} [jobSpecification.jobManagerTask.environmentSettings] - * @member {object} [jobSpecification.jobManagerTask.constraints] - * @member {moment.duration} - * [jobSpecification.jobManagerTask.constraints.maxWallClockTime] If this is - * not specified, there is no time limit on how long the task may run. - * @member {moment.duration} - * [jobSpecification.jobManagerTask.constraints.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the compute - * node is removed or the job is deleted. - * @member {number} - * [jobSpecification.jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] If - * true, when the Job Manager task completes, the Batch service marks the job - * as complete. If any tasks are still running at this time (other than Job - * Release), those tasks are terminated. If false, the completion of the Job - * Manager task does not affect the job status. In this case, you should either - * use the onAllTasksComplete attribute to terminate the job, or have a client - * or user terminate the job explicitly. An example of this is if the Job - * Manager creates a set of tasks but then takes no further role in their - * execution. The default value is true. If you are using the - * onAllTasksComplete and onTaskFailure attributes to control job lifetime, and - * using the Job Manager task only to create the tasks for the job (not to - * monitor progress), then it is important to set killJobOnCompletion to false. - * @member {object} [jobSpecification.jobManagerTask.userIdentity] If omitted, - * the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobManagerTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [jobSpecification.jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobSpecification.jobManagerTask.runExclusive] If true, no - * other tasks will run on the same compute node for as long as the Job Manager - * is running. If false, other tasks can run simultaneously with the Job - * Manager on a compute node. The Job Manager task counts normally against the - * node's concurrent task limit, so this is only relevant if the node allows - * multiple concurrent tasks. The default value is true. - * @member {array} - * [jobSpecification.jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the existing - * copy on the compute node is used. If a referenced application package cannot - * be installed, for example because the package has been deleted or because - * download failed, the task fails. - * @member {object} - * [jobSpecification.jobManagerTask.authenticationTokenSettings] If this - * property is set, the Batch service provides the task with an authentication - * token which can be used to authenticate Batch service operations without - * requiring an account access key. The token is provided via the - * AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the - * task can carry out using the token depend on the settings. For example, a - * task can request job permissions in order to add other tasks to the job, or - * check the status of the job or of other tasks under the job. - * @member {array} - * [jobSpecification.jobManagerTask.authenticationTokenSettings.access] The - * authentication token grants access to a limited set of Batch service - * operations. Currently the only supported value for the access property is - * 'job', which grants access to all operations related to the job which - * contains the task. - * @member {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] The - * default value is true. - * @member {object} [jobSpecification.jobPreparationTask] If a job has a Job - * Preparation task, the Batch service will run the Job Preparation task on a - * compute node before starting any tasks of that job on that compute node. - * @member {string} [jobSpecification.jobPreparationTask.id] The ID can contain - * any combination of alphanumeric characters including hyphens and underscores - * and cannot contain more than 64 characters. If you do not specify this - * property, the Batch service assigns a default value of 'jobpreparation'. No - * other task in the job can have the same ID as the Job Preparation task. If - * you try to submit a task with the same id, the Batch service rejects the - * request with error code TaskIdSameAsJobPreparationTask; if you are calling - * the REST API directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobPreparationTask.commandLine] The - * command line does not run under a shell, and therefore cannot take advantage - * of shell features such as environment variable expansion. If you want to - * take advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobPreparationTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no tag - * is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [jobSpecification.jobPreparationTask.containerSettings.registry] This - * setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobPreparationTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must - * be reduced in size. This can be achieved using .zip files, Application - * Packages, or Docker Containers. - * @member {array} [jobSpecification.jobPreparationTask.environmentSettings] - * @member {object} [jobSpecification.jobPreparationTask.constraints] - * @member {moment.duration} - * [jobSpecification.jobPreparationTask.constraints.maxWallClockTime] If this - * is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} - * [jobSpecification.jobPreparationTask.constraints.retentionTime] The default - * is 7 days, i.e. the task directory will be retained for 7 days unless the - * compute node is removed or the job is deleted. - * @member {number} - * [jobSpecification.jobPreparationTask.constraints.maxTaskRetryCount] Note - * that this value specifically controls the number of retries for the task - * executable due to a nonzero exit code. The Batch service will try the task - * once, and may then retry up to this limit. For example, if the maximum retry - * count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task after the first attempt. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] If - * true and the Job Preparation task fails on a compute node, the Batch service - * retries the Job Preparation task up to its maximum retry count (as specified - * in the constraints element). If the task has still not completed - * successfully after all retries, then the Batch service will not schedule - * tasks of the job to the compute node. The compute node remains active and - * eligible to run tasks of other jobs. If false, the Batch service will not - * wait for the Job Preparation task to complete. In this case, other tasks of - * the job can start executing on the compute node while the Job Preparation - * task is still running; and even if the Job Preparation task fails, new tasks - * will continue to be scheduled on the node. The default value is true. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity] If - * omitted, the task runs as a non-administrative user unique to the task on - * Windows nodes, or a a non-administrative user unique to the pool on Linux - * nodes. - * @member {string} [jobSpecification.jobPreparationTask.userIdentity.userName] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity.autoUser] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {string} - * [jobSpecification.jobPreparationTask.userIdentity.autoUser.scope] The - * default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} - * [jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] The Job - * Preparation task is always rerun if a compute node is reimaged, or if the - * Job Preparation task did not complete (e.g. because the reboot occurred - * while the task was running). Therefore, you should always write a Job - * Preparation task to be idempotent and to behave correctly if run multiple - * times. The default value is true. - * @member {object} [jobSpecification.jobReleaseTask] The primary purpose of - * the Job Release task is to undo changes to compute nodes made by the Job - * Preparation task. Example activities include deleting local files, or - * shutting down services that were started as part of job preparation. A Job - * Release task cannot be specified without also specifying a Job Preparation - * task for the job. The Batch service runs the Job Release task on the compute - * nodes that have run the Job Preparation task. - * @member {string} [jobSpecification.jobReleaseTask.id] The ID can contain any - * combination of alphanumeric characters including hyphens and underscores and - * cannot contain more than 64 characters. If you do not specify this property, - * the Batch service assigns a default value of 'jobrelease'. No other task in - * the job can have the same ID as the Job Release task. If you try to submit a - * task with the same id, the Batch service rejects the request with error code - * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the - * HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobReleaseTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command line, - * for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in - * Linux. If the command line refers to file paths, it should use a relative - * path (relative to the task working directory), or use the Batch provided - * environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobReleaseTask.containerSettings] When - * this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} - * [jobSpecification.jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobReleaseTask.resourceFiles] Files listed - * under this element are located in the task's working directory. - * @member {array} [jobSpecification.jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobSpecification.jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobSpecification.jobReleaseTask.retentionTime] - * The default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity] If omitted, - * the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobReleaseTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [jobSpecification.jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [jobSpecification.commonEnvironmentSettings] Individual - * tasks can override an environment setting specified here by specifying the - * same setting name with a different value. - * @member {object} [jobSpecification.poolInfo] - * @member {string} [jobSpecification.poolInfo.poolId] You must ensure that the - * pool referenced by this property exists. If the pool does not exist at the - * time the Batch service tries to schedule a job, no tasks for the job will - * run until you create a pool with that id. Note that the Batch service will - * not reject the job request; it will simply not run tasks until the pool - * exists. You must specify either the pool ID or the auto pool specification, - * but not both. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification] If auto - * pool creation fails, the Batch service moves the job to a completed state, - * and the pool creation error is set in the job's scheduling error property. - * The Batch service manages the lifetime (both creation and, unless keepAlive - * is specified, deletion) of the auto pool. Any user actions that affect the - * lifetime of the auto pool while the job is active will result in unexpected - * behavior. You must specify either the pool ID or the auto pool - * specification, but not both. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.autoPoolIdPrefix] The Batch - * service assigns each auto pool a unique identifier on creation. To - * distinguish between pools created for different purposes, you can specify - * this element to add a prefix to the ID that is assigned. The prefix can be - * up to 20 characters long. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.poolLifetimeOption] - * Possible values include: 'jobSchedule', 'job' - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.displayName] The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.vmSize] For - * information about available sizes of virtual machines in pools, see Choose a - * VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] - * This property must be specified if the pool needs to be created with Azure - * PaaS VMs. This property and virtualMachineConfiguration are mutually - * exclusive and one of the properties must be specified. If neither is - * specified then the Batch service returns an error; if you are calling the - * REST API directly, the HTTP status code is 400 (Bad Request). This property - * cannot be specified if the Batch account was created with its - * poolAllocationMode property set to 'UserSubscription'. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] - * Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] - * The default value is * which specifies the latest operating system version - * for the specified OS family. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] - * This property must be specified if the pool needs to be created with Azure - * IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] - * 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. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] - * This only applies to images that contain the Windows operating system, and - * should only be used when you hold valid on-premises licenses for the nodes - * which will be deployed. If omitted, no on-premises licensing discount is - * applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size of - * the compute nodes in the pool (the vmSize setting). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] - * Possible values include: 'spread', 'pack' - * @member {moment.duration} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.resizeTimeout] This - * timeout applies only to manual scaling; it has no effect when - * enableAutoScale is set to true. The default value is 15 minutes. The minimum - * value is 5 minutes. If you specify a value less than 5 minutes, the Batch - * service rejects the request with an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleFormula] This - * property must not be specified if enableAutoScale is set to false. It is - * required if enableAutoScale is set to true. The formula is checked for - * validity before the pool is created. If the formula is not valid, the Batch - * service rejects the request with detailed error information. - * @member {moment.duration} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] - * The default value is 15 minutes. The minimum and maximum value are 5 minutes - * and 168 hours respectively. If you specify a value less than 5 minutes or - * greater than 168 hours, the Batch service rejects the request with an - * invalid property value error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] - * Enabling inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] - * This is of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] - * Pool endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.commandLine] - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are - * mapped into the container, all task environment variables are mapped into - * the container, and the task command line is executed in the container. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] - * This is the full image reference, as would be specified to "docker pull". If - * no tag is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] - * This setting can be omitted if was already provided at pool creation. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] - * Files listed under this element are located in the task's working directory. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity] - * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {object} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] - * The userName and autoUser properties are mutually exclusive; you must - * specify one but not both. - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] - * The default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] - * The Batch service retries a task if its exit code is nonzero. Note that this - * value specifically controls the number of retries. The Batch service will - * try the task once, and may then retry up to this limit. For example, if the - * maximum retry count is 3, Batch tries the task up to 4 times (one initial - * try and 3 retries). If the maximum retry count is 0, the Batch service does - * not retry the task. If the maximum retry count is -1, the Batch service - * retries the task without limit. - * @member {boolean} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] - * If true and the start task fails on a compute node, the Batch service - * retries the start task up to its maximum retry count (maxTaskRetryCount). If - * the task has still not completed successfully after all retries, then the - * Batch service marks the compute node unusable, and will not schedule tasks - * to it. This condition can be detected via the node state and failure info - * details. If false, the Batch service will not wait for the start task to - * complete. In this case, other tasks can start executing on the compute node - * while the start task is still running; and even if the start task fails, new - * tasks will continue to be scheduled on the node. The default is false. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.certificateReferences] - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} - * [jobSpecification.poolInfo.autoPoolSpecification.pool.metadata] The Batch - * service does not assign any meaning to metadata; it is solely for the use of - * user code. - * @member {array} [jobSpecification.metadata] The Batch service does not - * assign any meaning to metadata; it is solely for the use of user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * job schedule as metadata. If you do not specify this element, it takes the - * default value of an empty list; in effect, any existing metadata is deleted. */ export interface JobScheduleUpdateParameter { + /** + * @summary The schedule according to which jobs will be created. + * @description If you do not specify this element, it is equivalent to passing the default + * schedule: that is, a single job scheduled to run immediately. + */ schedule: Schedule; + /** + * @summary Details of the jobs to be created on this schedule. + * @description Updates affect only jobs that are started after the update has taken place. Any + * currently active job continues with the older specification. + */ jobSpecification: JobSpecification; + /** + * @summary A list of name-value pairs associated with the job schedule as metadata. + * @description If you do not specify this element, it takes the default value of an empty list; + * in effect, any existing metadata is deleted. + */ metadata?: MetadataItem[]; } /** - * @class - * Initializes a new instance of the JobDisableParameter class. - * @constructor * @summary Options when disabling a job. - * - * @member {string} disableTasks What to do with active tasks associated with - * the job. Possible values include: 'requeue', 'terminate', 'wait' */ export interface JobDisableParameter { + /** + * @summary What to do with active tasks associated with the job. + * @description Possible values include: 'requeue', 'terminate', 'wait' + */ disableTasks: string; } /** - * @class - * Initializes a new instance of the JobTerminateParameter class. - * @constructor * @summary Options when terminating a job. - * - * @member {string} [terminateReason] The text you want to appear as the job's - * TerminateReason. The default is 'UserTerminate'. */ export interface JobTerminateParameter { + /** + * @summary The text you want to appear as the job's TerminateReason. The default is + * 'UserTerminate'. + */ terminateReason?: string; } /** - * @class - * Initializes a new instance of the JobPatchParameter class. - * @constructor * @summary The set of changes to be made to a job. - * - * @member {number} [priority] The priority of the job. Priority values can - * range from -1000 to 1000, with -1000 being the lowest priority and 1000 - * being the highest priority. If omitted, the priority of the job is left - * unchanged. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in the job are in the completed state. 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). - * Possible values include: 'noAction', 'terminateJob' - * @member {object} [constraints] The execution constraints for the job. If - * omitted, the existing execution constraints are left unchanged. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does not - * complete within the time limit, the Batch service terminates it and any - * tasks that are still running. In this case, the termination reason will be - * MaxWallClockTimeExpiry. If this property is not specified, there is no time - * limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries. The Batch service will try each - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries a task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * tasks. If the maximum retry count is -1, the Batch service retries tasks - * without limit. The default value is 0 (no retries). - * @member {object} [poolInfo] The pool on which the Batch service runs the - * job's tasks. You may change the pool for a job only when the job is - * disabled. The Patch Job call will fail if you include the poolInfo element - * and the job is not disabled. If you specify an autoPoolSpecification - * specification in the poolInfo, only the keepAlive property can be updated, - * and then only if the auto pool has a poolLifetimeOption of job. If omitted, - * the job continues to run on its current pool. - * @member {string} [poolInfo.poolId] You must ensure that the pool referenced - * by this property exists. If the pool does not exist at the time the Batch - * service tries to schedule a job, no tasks for the job will run until you - * create a pool with that id. Note that the Batch service will not reject the - * job request; it will simply not run tasks until the pool exists. You must - * specify either the pool ID or the auto pool specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation - * fails, the Batch service moves the job to a completed state, and the pool - * creation error is set in the job's scheduling error property. The Batch - * service manages the lifetime (both creation and, unless keepAlive is - * specified, deletion) of the auto pool. Any user actions that affect the - * lifetime of the auto pool while the job is active will result in unexpected - * behavior. You must specify either the pool ID or the auto pool - * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The Batch - * service assigns each auto pool a unique identifier on creation. To - * distinguish between pools created for different purposes, you can specify - * this element to add a prefix to the ID that is assigned. The prefix can be - * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] - * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For - * information about available sizes of virtual machines in pools, see Choose a - * VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This - * property must be specified if the pool needs to be created with Azure PaaS - * VMs. This property and virtualMachineConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). This property cannot be - * specified if the Batch account was created with its poolAllocationMode - * property set to 'UserSubscription'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] - * Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] - * The default value is * which specifies the latest operating system version - * for the specified OS family. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This - * property must be specified if the pool needs to be created with Azure IaaS - * VMs. This property and cloudServiceConfiguration are mutually exclusive and - * one of the properties must be specified. If neither is specified then the - * Batch service returns an error; if you are calling the REST API directly, - * the HTTP status code is 400 (Bad Request). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] - * 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. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] - * This only applies to images that contain the Windows operating system, and - * should only be used when you hold valid on-premises licenses for the nodes - * which will be deployed. If omitted, no on-premises licensing discount is - * applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size of - * the compute nodes in the pool (the vmSize setting). - * @member {object} [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] - * Possible values include: 'spread', 'pack' - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies - * only to manual scaling; it has no effect when enableAutoScale is set to - * true. The default value is 15 minutes. The minimum value is 5 minutes. If - * you specify a value less than 5 minutes, the Batch service rejects the - * request with an error; if you are calling the REST API directly, the HTTP - * status code is 400 (Bad Request). - * @member {number} [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} - * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property - * must not be specified if enableAutoScale is set to true. If enableAutoScale - * is set to false, then you must set either targetDedicatedNodes, - * targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] This - * property must not be specified if enableAutoScale is set to false. It is - * required if enableAutoScale is set to true. The formula is checked for - * validity before the pool is created. If the formula is not valid, the Batch - * service rejects the request with detailed error information. - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The - * default value is 15 minutes. The minimum and maximum value are 5 minutes and - * 168 hours respectively. If you specify a value less than 5 minutes or - * greater than 168 hours, the Batch service rejects the request with an - * invalid property value error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] Enabling - * inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This is - * of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] - * Pool endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} [poolInfo.autoPoolSpecification.pool.startTask.commandLine] - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When this - * is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR - * (the root of Azure Batch directories on the node) are mapped into the - * container, all task environment variables are mapped into the container, and - * the task command line is executed in the container. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] - * This is the full image reference, as would be specified to "docker pull". If - * no tag is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] - * This setting can be omitted if was already provided at pool creation. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed - * under this element are located in the task's working directory. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, the - * task runs as a non-administrative user unique to the task. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] - * The default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} - * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The Batch - * service retries a task if its exit code is nonzero. Note that this value - * specifically controls the number of retries. The Batch service will try the - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and - * the start task fails on a compute node, the Batch service retries the start - * task up to its maximum retry count (maxTaskRetryCount). If the task has - * still not completed successfully after all retries, then the Batch service - * marks the compute node unusable, and will not schedule tasks to it. This - * condition can be detected via the node state and failure info details. If - * false, the Batch service will not wait for the start task to complete. In - * this case, other tasks can start executing on the compute node while the - * start task is still running; and even if the start task fails, new tasks - * will continue to be scheduled on the node. The default is false. - * @member {array} [poolInfo.autoPoolSpecification.pool.certificateReferences] - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch - * service does not assign any meaning to metadata; it is solely for the use of - * user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * job as metadata. If omitted, the existing job metadata is left unchanged. */ export interface JobPatchParameter { + /** + * @summary The priority of the job. + * @description Priority values can range from -1000 to 1000, with -1000 being the lowest + * priority and 1000 being the highest priority. If omitted, the priority of the job is left + * unchanged. + */ priority?: number; + /** + * @summary 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). Possible values include: 'noAction', 'terminateJob' + */ onAllTasksComplete?: string; + /** + * @summary The execution constraints for the job. + * @description If omitted, the existing execution constraints are left unchanged. + */ constraints?: JobConstraints; + /** + * @summary The pool on which the Batch service runs the job's tasks. + * @description You may change the pool for a job only when the job is disabled. The Patch Job + * call will fail if you include the poolInfo element and the job is not disabled. If you specify + * an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be + * updated, and then only if the auto pool has a poolLifetimeOption of job. If omitted, the job + * continues to run on its current pool. + */ poolInfo?: PoolInformation; + /** + * @summary A list of name-value pairs associated with the job as metadata. + * @description If omitted, the existing job metadata is left unchanged. + */ metadata?: MetadataItem[]; } /** - * @class - * Initializes a new instance of the JobUpdateParameter class. - * @constructor * @summary The set of changes to be made to a job. - * - * @member {number} [priority] The priority of the job. Priority values can - * range from -1000 to 1000, with -1000 being the lowest priority and 1000 - * being the highest priority. If omitted, it is set to the default value 0. - * @member {object} [constraints] The execution constraints for the job. If - * omitted, the constraints are cleared. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does not - * complete within the time limit, the Batch service terminates it and any - * tasks that are still running. In this case, the termination reason will be - * MaxWallClockTimeExpiry. If this property is not specified, there is no time - * limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries. The Batch service will try each - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries a task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * tasks. If the maximum retry count is -1, the Batch service retries tasks - * without limit. The default value is 0 (no retries). - * @member {object} poolInfo The pool on which the Batch service runs the job's - * tasks. You may change the pool for a job only when the job is disabled. The - * Update Job call will fail if you include the poolInfo element and the job is - * not disabled. If you specify an autoPoolSpecification specification in the - * poolInfo, only the keepAlive property can be updated, and then only if the - * auto pool has a poolLifetimeOption of job. - * @member {string} [poolInfo.poolId] You must ensure that the pool referenced - * by this property exists. If the pool does not exist at the time the Batch - * service tries to schedule a job, no tasks for the job will run until you - * create a pool with that id. Note that the Batch service will not reject the - * job request; it will simply not run tasks until the pool exists. You must - * specify either the pool ID or the auto pool specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation - * fails, the Batch service moves the job to a completed state, and the pool - * creation error is set in the job's scheduling error property. The Batch - * service manages the lifetime (both creation and, unless keepAlive is - * specified, deletion) of the auto pool. Any user actions that affect the - * lifetime of the auto pool while the job is active will result in unexpected - * behavior. You must specify either the pool ID or the auto pool - * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The Batch - * service assigns each auto pool a unique identifier on creation. To - * distinguish between pools created for different purposes, you can specify - * this element to add a prefix to the ID that is assigned. The prefix can be - * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] - * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the - * poolLifetimeOption setting) expires; that is, when the job or job schedule - * completes. If true, the Batch service does not delete the pool - * automatically. It is up to the user to delete auto pools created with this - * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The - * display name need not be unique and can contain any Unicode characters up to - * a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For - * information about available sizes of virtual machines in pools, see Choose a - * VM size for compute nodes in an Azure Batch pool - * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This - * property must be specified if the pool needs to be created with Azure PaaS - * VMs. This property and virtualMachineConfiguration are mutually exclusive - * and one of the properties must be specified. If neither is specified then - * the Batch service returns an error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). This property cannot be - * specified if the Batch account was created with its poolAllocationMode - * property set to 'UserSubscription'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] - * Possible values are: - * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. - * 3 - OS Family 3, equivalent to Windows Server 2012. - * 4 - OS Family 4, equivalent to Windows Server 2012 R2. - * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, - * see Azure Guest OS Releases - * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} - * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] - * The default value is * which specifies the latest operating system version - * for the specified OS family. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This - * property must be specified if the pool needs to be created with Azure IaaS - * VMs. This property and cloudServiceConfiguration are mutually exclusive and - * one of the properties must be specified. If neither is specified then the - * Batch service returns an error; if you are calling the REST API directly, - * the HTTP status code is 400 (Bad Request). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] - * For example, Canonical or MicrosoftWindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] - * For example, UbuntuServer or WindowsServer. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] - * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] - * A value of 'latest' can be specified to select the latest version of an - * image. If omitted, the default is 'latest'. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] - * This property is mutually exclusive with other ImageReference properties. - * The virtual machine image must be in the same region and subscription as the - * Azure Batch account. For more details, see - * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] - * The Batch node agent is a program that runs on each node in the pool, and - * provides the command-and-control interface between the node and the Batch - * service. There are different implementations of the node agent, known as - * SKUs, for different operating systems. You must specify a node agent SKU - * which matches the selected image reference. To get the list of supported - * node agent SKUs along with their list of verified image references, see the - * 'List supported node agent SKUs' operation. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] - * This property must not be specified if the imageReference property specifies - * a Linux OS image. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] - * If omitted, the default value is true. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] - * 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. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] - * This only applies to images that contain the Windows operating system, and - * should only be used when you hold valid on-premises licenses for the nodes - * which will be deployed. If omitted, no on-premises licensing discount is - * applied. Values are: - * - * Windows_Server - The on-premises license is for Windows Server. - * Windows_Client - The on-premises license is for Windows Client. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] - * If specified, setup is performed on each node in the pool to allow tasks to - * run in containers. All regular tasks and job manager tasks run on this pool - * must specify the containerSettings property, and all other tasks may specify - * it. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] - * This is the full image reference, as would be specified to "docker pull". An - * image will be sourced from the default Docker registry unless the image is - * fully qualified with an alternative registry. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] - * If any images must be downloaded from a private registry which requires - * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size of - * the compute nodes in the pool (the vmSize setting). - * @member {object} [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] - * Possible values include: 'spread', 'pack' - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies - * only to manual scaling; it has no effect when enableAutoScale is set to - * true. The default value is 15 minutes. The minimum value is 5 minutes. If - * you specify a value less than 5 minutes, the Batch service rejects the - * request with an error; if you are calling the REST API directly, the HTTP - * status code is 400 (Bad Request). - * @member {number} [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] - * This property must not be specified if enableAutoScale is set to true. If - * enableAutoScale is set to false, then you must set either - * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} - * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property - * must not be specified if enableAutoScale is set to true. If enableAutoScale - * is set to false, then you must set either targetDedicatedNodes, - * targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] This - * property must not be specified if enableAutoScale is set to false. It is - * required if enableAutoScale is set to true. The formula is checked for - * validity before the pool is created. If the formula is not valid, the Batch - * service rejects the request with detailed error information. - * @member {moment.duration} - * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The - * default value is 15 minutes. The minimum and maximum value are 5 minutes and - * 168 hours respectively. If you specify a value less than 5 minutes or - * greater than 168 hours, the Batch service rejects the request with an - * invalid property value error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] Enabling - * inter-node communication limits the maximum size of the pool due to - * deployment restrictions on the nodes of the pool. This may result in the - * pool not reaching its desired size. The default value is false. - * @member {object} [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This is - * of the form - * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. - * The virtual network must be in the same region and subscription as the Azure - * Batch account. The specified subnet should have enough free IP addresses to - * accommodate the number of nodes in the pool. If the subnet doesn't have - * enough free IP addresses, the pool will partially allocate compute nodes, - * and a resize error will occur. For pools created with - * virtualMachineConfiguration only ARM virtual networks - * ('Microsoft.Network/virtualNetworks') are supported, but for pools created - * with cloudServiceConfiguration both ARM and classic virtual networks are - * supported. For more details, see: - * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] - * Possible values include: 'none', 'job' - * @member {object} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] - * Pool endpoint configuration is only supported on pools with the - * virtualMachineConfiguration property. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] - * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum - * number of inbound NAT pools is exceeded the request fails with HTTP status - * code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} [poolInfo.autoPoolSpecification.pool.startTask.commandLine] - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in the - * command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should use - * a relative path (relative to the task working directory), or use the Batch - * provided environment variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When this - * is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR - * (the root of Azure Batch directories on the node) are mapped into the - * container, all task environment variables are mapped into the container, and - * the task command line is executed in the container. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] - * These additional options are supplied as arguments to the "docker create" - * command, in addition to those controlled by the Batch Service. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] - * This is the full image reference, as would be specified to "docker pull". If - * no tag is provided as part of the image name, the tag ":latest" is used as a - * default. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] - * This setting can be omitted if was already provided at pool creation. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] - * If omitted, the default is "docker.io". - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed - * under this element are located in the task's working directory. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, the - * task runs as a non-administrative user unique to the task. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {object} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] - * The default value is task. Possible values include: 'task', 'pool' - * @member {string} - * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} - * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The Batch - * service retries a task if its exit code is nonzero. Note that this value - * specifically controls the number of retries. The Batch service will try the - * task once, and may then retry up to this limit. For example, if the maximum - * retry count is 3, Batch tries the task up to 4 times (one initial try and 3 - * retries). If the maximum retry count is 0, the Batch service does not retry - * the task. If the maximum retry count is -1, the Batch service retries the - * task without limit. - * @member {boolean} - * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and - * the start task fails on a compute node, the Batch service retries the start - * task up to its maximum retry count (maxTaskRetryCount). If the task has - * still not completed successfully after all retries, then the Batch service - * marks the compute node unusable, and will not schedule tasks to it. This - * condition can be detected via the node state and failure info details. If - * false, the Batch service will not wait for the start task to complete. In - * this case, other tasks can start executing on the compute node while the - * start task is still running; and even if the start task fails, new tasks - * will continue to be scheduled on the node. The default is false. - * @member {array} [poolInfo.autoPoolSpecification.pool.certificateReferences] - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} - * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, pool - * creation will fail. The permitted licenses available on the pool are 'maya', - * 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch - * service does not assign any meaning to metadata; it is solely for the use of - * user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * job as metadata. If omitted, it takes the default value of an empty list; in - * effect, any existing metadata is deleted. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in the job are in the completed state. 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. Possible values include: 'noAction', - * 'terminateJob' */ export interface JobUpdateParameter { + /** + * @summary The priority of the job. + * @description Priority values can range from -1000 to 1000, with -1000 being the lowest + * priority and 1000 being the highest priority. If omitted, it is set to the default value 0. + */ priority?: number; + /** + * @summary The execution constraints for the job. + * @description If omitted, the constraints are cleared. + */ constraints?: JobConstraints; + /** + * @summary The pool on which the Batch service runs the job's tasks. + * @description You may change the pool for a job only when the job is disabled. The Update Job + * call will fail if you include the poolInfo element and the job is not disabled. If you specify + * an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be + * updated, and then only if the auto pool has a poolLifetimeOption of job. + */ poolInfo: PoolInformation; + /** + * @summary A list of name-value pairs associated with the job as metadata. + * @description If omitted, it takes the default value of an empty list; in effect, any existing + * metadata is deleted. + */ metadata?: MetadataItem[]; + /** + * @summary 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. + * Possible values include: 'noAction', 'terminateJob' + */ onAllTasksComplete?: string; } /** - * @class - * Initializes a new instance of the PoolEnableAutoScaleParameter class. - * @constructor * @summary Options for enabling automatic scaling on a pool. - * - * @member {string} [autoScaleFormula] The formula for the desired number of - * compute nodes in the pool. The formula is checked for validity before it is - * applied to the pool. If the formula is not valid, the Batch service rejects - * the request with detailed error information. For more information about - * specifying this formula, see Automatically scale compute nodes in an Azure - * Batch pool - * (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). - * @member {moment.duration} [autoScaleEvaluationInterval] The time interval at - * which to automatically adjust the pool size according to the autoscale - * formula. The default value is 15 minutes. The minimum and maximum value are - * 5 minutes and 168 hours respectively. If you specify a value less than 5 - * minutes or greater than 168 hours, the Batch service rejects the request - * with an invalid property value error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). If you specify a new - * interval, then the existing autoscale evaluation schedule will be stopped - * and a new autoscale evaluation schedule will be started, with its starting - * time being the time when this request was issued. */ export interface PoolEnableAutoScaleParameter { + /** + * @summary The formula for the desired number of compute nodes in the pool. + * @description The formula is checked for validity before it is applied to the pool. If the + * formula is not valid, the Batch service rejects the request with detailed error information. + * For more information about specifying this formula, see Automatically scale compute nodes in + * an Azure Batch pool + * (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). + */ autoScaleFormula?: string; + /** + * @summary The time interval at which to automatically adjust the pool size according to the + * autoscale formula. + * @description The default value is 15 minutes. The minimum and maximum value are 5 minutes and + * 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, + * the Batch service rejects the request with an invalid property value error; if you are calling + * the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new + * interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale + * evaluation schedule will be started, with its starting time being the time when this request + * was issued. + */ autoScaleEvaluationInterval?: moment.Duration; } /** - * @class - * Initializes a new instance of the PoolEvaluateAutoScaleParameter class. - * @constructor * @summary Options for evaluating an automatic scaling formula on a pool. - * - * @member {string} autoScaleFormula The formula for the desired number of - * compute nodes in the pool. The formula is validated and its results - * calculated, but it is not applied to the pool. To apply the formula to the - * pool, 'Enable automatic scaling on a pool'. For more information about - * specifying this formula, see Automatically scale compute nodes in an Azure - * Batch pool - * (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). */ export interface PoolEvaluateAutoScaleParameter { + /** + * @summary The formula for the desired number of compute nodes in the pool. + * @description The formula is validated and its results calculated, but it is not applied to the + * pool. To apply the formula to the pool, 'Enable automatic scaling on a pool'. For more + * information about specifying this formula, see Automatically scale compute nodes in an Azure + * Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). + */ autoScaleFormula: string; } /** - * @class - * Initializes a new instance of the PoolResizeParameter class. - * @constructor * @summary Options for changing the size of a pool. - * - * @member {number} [targetDedicatedNodes] The desired number of dedicated - * compute nodes in the pool. - * @member {number} [targetLowPriorityNodes] The desired number of low-priority - * compute nodes in the pool. - * @member {moment.duration} [resizeTimeout] The timeout for allocation of - * compute nodes to the pool or removal of compute nodes from the pool. The - * default value is 15 minutes. The minimum value is 5 minutes. If you specify - * a value less than 5 minutes, the Batch service returns an error; if you are - * calling the REST API directly, the HTTP status code is 400 (Bad Request). - * @member {string} [nodeDeallocationOption] Determines what to do with a node - * and its running task(s) if the pool size is decreasing. The default value is - * requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', - * 'retainedData' */ export interface PoolResizeParameter { + /** + * @summary The desired number of dedicated compute nodes in the pool. + */ targetDedicatedNodes?: number; + /** + * @summary The desired number of low-priority compute nodes in the pool. + */ targetLowPriorityNodes?: number; + /** + * @summary The timeout for allocation of compute nodes to the pool or removal of compute nodes + * from the pool. + * @description The default value is 15 minutes. The minimum value is 5 minutes. If you specify a + * value less than 5 minutes, the Batch service returns an error; if you are calling the REST API + * directly, the HTTP status code is 400 (Bad Request). + */ resizeTimeout?: moment.Duration; + /** + * @summary Determines what to do with a node and its running task(s) if the pool size is + * decreasing. + * @description The default value is requeue. Possible values include: 'requeue', 'terminate', + * 'taskCompletion', 'retainedData' + */ nodeDeallocationOption?: string; } /** - * @class - * Initializes a new instance of the PoolUpdatePropertiesParameter class. - * @constructor * @summary The set of changes to be made to a pool. - * - * @member {object} [startTask] A task to run on each compute node as it joins - * the pool. The task runs when the node is added to the pool or when the node - * is restarted. If this element is present, it overwrites any existing start - * task. If omitted, any existing start task is removed from the pool. - * @member {string} [startTask.commandLine] The command line does not run under - * a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure - * Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These - * additional options are supplied as arguments to the "docker create" command, - * in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [startTask.containerSettings.registry] This setting can be - * omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a - * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [startTask.userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically controls - * the number of retries. The Batch service will try the task once, and may - * then retry up to this limit. For example, if the maximum retry count is 3, - * Batch tries the task up to 4 times (one initial try and 3 retries). If the - * maximum retry count is 0, the Batch service does not retry the task. If the - * maximum retry count is -1, the Batch service retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task - * fails on a compute node, the Batch service retries the start task up to its - * maximum retry count (maxTaskRetryCount). If the task has still not completed - * successfully after all retries, then the Batch service marks the compute - * node unusable, and will not schedule tasks to it. This condition can be - * detected via the node state and failure info details. If false, the Batch - * service will not wait for the start task to complete. In this case, other - * tasks can start executing on the compute node while the start task is still - * running; and even if the start task fails, new tasks will continue to be - * scheduled on the node. The default is false. - * @member {array} certificateReferences A list of certificates to be installed - * on each compute node in the pool. This list replaces any existing - * certificate references configured on the pool. If you specify an empty - * collection, any existing certificate references are removed from the pool. - * For Windows compute nodes, the Batch service installs the certificates to - * the specified certificate store and location. 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. - * @member {array} applicationPackageReferences A list of application packages - * to be installed on each compute node in the pool. The list replaces any - * existing application package references on the pool. Changes to application - * package references affect all new compute nodes joining the pool, but do not - * affect compute nodes that are already in the pool until they are rebooted or - * reimaged. If omitted, or if you specify an empty collection, any existing - * application packages references are removed from the pool. - * @member {array} metadata A list of name-value pairs associated with the pool - * as metadata. This list replaces any existing metadata configured on the - * pool. If omitted, or if you specify an empty collection, any existing - * metadata is removed from the pool. */ export interface PoolUpdatePropertiesParameter { + /** + * @summary A task to run on each compute node as it joins the pool. The task runs when the node + * is added to the pool or when the node is restarted. + * @description If this element is present, it overwrites any existing start task. If omitted, + * any existing start task is removed from the pool. + */ startTask?: StartTask; + /** + * @summary A list of certificates to be installed on each compute node in the pool. + * @description This list replaces any existing certificate references configured on the pool. If + * you specify an empty collection, any existing certificate references are removed from the + * pool. For Windows compute nodes, the Batch service installs the certificates to the specified + * certificate store and location. 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. + */ certificateReferences: CertificateReference[]; + /** + * @summary A list of application packages to be installed on each compute node in the pool. + * @description The list replaces any existing application package references on the pool. + * Changes to application package references affect all new compute nodes joining the pool, but + * do not affect compute nodes that are already in the pool until they are rebooted or reimaged. + * If omitted, or if you specify an empty collection, any existing application packages + * references are removed from the pool. + */ applicationPackageReferences: ApplicationPackageReference[]; + /** + * @summary A list of name-value pairs associated with the pool as metadata. + * @description This list replaces any existing metadata configured on the pool. If omitted, or + * if you specify an empty collection, any existing metadata is removed from the pool. + */ metadata: MetadataItem[]; } /** - * @class - * Initializes a new instance of the PoolPatchParameter class. - * @constructor * @summary The set of changes to be made to a pool. - * - * @member {object} [startTask] A task to run on each compute node as it joins - * the pool. The task runs when the node is added to the pool or when the node - * is restarted. If this element is present, it overwrites any existing start - * task. If omitted, any existing start task is left unchanged. - * @member {string} [startTask.commandLine] The command line does not run under - * a shell, and therefore cannot take advantage of shell features such as - * environment variable expansion. If you want to take advantage of such - * features, you should invoke the shell in the command line, for example using - * "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the - * command line refers to file paths, it should use a relative path (relative - * to the task working directory), or use the Batch provided environment - * variable - * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure - * Batch directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These - * additional options are supplied as arguments to the "docker create" command, - * in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a default. - * @member {object} [startTask.containerSettings.registry] This setting can be - * omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a - * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {object} [startTask.userIdentity.autoUser] The userName and autoUser - * properties are mutually exclusive; you must specify one but not both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically controls - * the number of retries. The Batch service will try the task once, and may - * then retry up to this limit. For example, if the maximum retry count is 3, - * Batch tries the task up to 4 times (one initial try and 3 retries). If the - * maximum retry count is 0, the Batch service does not retry the task. If the - * maximum retry count is -1, the Batch service retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task - * fails on a compute node, the Batch service retries the start task up to its - * maximum retry count (maxTaskRetryCount). If the task has still not completed - * successfully after all retries, then the Batch service marks the compute - * node unusable, and will not schedule tasks to it. This condition can be - * detected via the node state and failure info details. If false, the Batch - * service will not wait for the start task to complete. In this case, other - * tasks can start executing on the compute node while the start task is still - * running; and even if the start task fails, new tasks will continue to be - * scheduled on the node. The default is false. - * @member {array} [certificateReferences] A list of certificates to be - * installed on each compute node in the pool. If this element is present, it - * replaces any existing certificate references configured on the pool. If - * omitted, any existing certificate references are left unchanged. For Windows - * compute nodes, the Batch service installs the certificates to the specified - * certificate store and location. 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. - * @member {array} [applicationPackageReferences] A list of application - * packages to be installed on each compute node in the pool. Changes to - * application package references affect all new compute nodes joining the - * pool, but do not affect compute nodes that are already in the pool until - * they are rebooted or reimaged. If this element is present, it replaces any - * existing application package references. If you specify an empty collection, - * then all application package references are removed from the pool. If - * omitted, any existing application package references are left unchanged. - * @member {array} [metadata] A list of name-value pairs associated with the - * pool as metadata. If this element is present, it replaces any existing - * metadata configured on the pool. If you specify an empty collection, any - * metadata is removed from the pool. If omitted, any existing metadata is left - * unchanged. */ export interface PoolPatchParameter { + /** + * @summary A task to run on each compute node as it joins the pool. The task runs when the node + * is added to the pool or when the node is restarted. + * @description If this element is present, it overwrites any existing start task. If omitted, + * any existing start task is left unchanged. + */ startTask?: StartTask; + /** + * @summary A list of certificates to be installed on each compute node in the pool. + * @description If this element is present, it replaces any existing certificate references + * configured on the pool. If omitted, any existing certificate references are left unchanged. + * For Windows compute nodes, the Batch service installs the certificates to the specified + * certificate store and location. 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. + */ certificateReferences?: CertificateReference[]; + /** + * @summary A list of application packages to be installed on each compute node in the pool. + * @description Changes to application package references affect all new compute nodes joining + * the pool, but do not affect compute nodes that are already in the pool until they are rebooted + * or reimaged. If this element is present, it replaces any existing application package + * references. If you specify an empty collection, then all application package references are + * removed from the pool. If omitted, any existing application package references are left + * unchanged. + */ applicationPackageReferences?: ApplicationPackageReference[]; + /** + * @summary A list of name-value pairs associated with the pool as metadata. + * @description If this element is present, it replaces any existing metadata configured on the + * pool. If you specify an empty collection, any metadata is removed from the pool. If omitted, + * any existing metadata is left unchanged. + */ metadata?: MetadataItem[]; } /** - * @class - * Initializes a new instance of the TaskUpdateParameter class. - * @constructor * @summary The set of changes to be made to a task. - * - * @member {object} [constraints] Constraints that apply to this task. If - * omitted, the task is given the default constraints. For multi-instance - * tasks, updating the retention time applies only to the primary task and not - * subtasks. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not - * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 days, - * i.e. the task directory will be retained for 7 days unless the compute node - * is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value - * specifically controls the number of retries for the task executable due to a - * nonzero exit code. The Batch service will try the task once, and may then - * retry up to this limit. For example, if the maximum retry count is 3, Batch - * tries the task up to 4 times (one initial try and 3 retries). If the maximum - * retry count is 0, the Batch service does not retry the task after the first - * attempt. If the maximum retry count is -1, the Batch service retries the - * task without limit. */ export interface TaskUpdateParameter { + /** + * @summary Constraints that apply to this task. + * @description If omitted, the task is given the default constraints. For multi-instance tasks, + * updating the retention time applies only to the primary task and not subtasks. + */ constraints?: TaskConstraints; } /** - * @class - * Initializes a new instance of the NodeUpdateUserParameter class. - * @constructor * @summary The set of changes to be made to a user account on a node. - * - * @member {string} [password] The password of the account. The password is - * required for Windows nodes (those created with 'cloudServiceConfiguration', - * or created with 'virtualMachineConfiguration' using a Windows image - * reference). For Linux compute nodes, the password can optionally be - * specified along with the sshPublicKey property. If omitted, any existing - * password is removed. - * @member {date} [expiryTime] The time at which the account should expire. If - * omitted, the default is 1 day from the current time. For Linux compute - * nodes, the expiryTime has a precision up to a day. - * @member {string} [sshPublicKey] The SSH public key that can be used for - * remote login to the compute node. The public key should be compatible with - * OpenSSH encoding and should be base 64 encoded. This property can be - * specified only for Linux nodes. If this is specified for a Windows node, - * then the Batch service rejects the request; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). If omitted, any - * existing SSH public key is removed. */ export interface NodeUpdateUserParameter { + /** + * @summary The password of the account. + * @description The password is required for Windows nodes (those created with + * 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows + * image reference). For Linux compute nodes, the password can optionally be specified along with + * the sshPublicKey property. If omitted, any existing password is removed. + */ password?: string; + /** + * @summary The time at which the account should expire. + * @description If omitted, the default is 1 day from the current time. For Linux compute nodes, + * the expiryTime has a precision up to a day. + */ expiryTime?: Date; + /** + * @summary The SSH public key that can be used for remote login to the compute node. + * @description The public key should be compatible with OpenSSH encoding and should be base 64 + * encoded. This property can be specified only for Linux nodes. If this is specified for a + * Windows node, then the Batch service rejects the request; if you are calling the REST API + * directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key + * is removed. + */ sshPublicKey?: string; } /** - * @class - * Initializes a new instance of the NodeRebootParameter class. - * @constructor * @summary Options for rebooting a compute node. - * - * @member {string} [nodeRebootOption] When to reboot the compute node and what - * to do with currently running tasks. The default value is requeue. Possible - * values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData' */ export interface NodeRebootParameter { + /** + * @summary When to reboot the compute node and what to do with currently running tasks. + * @description The default value is requeue. Possible values include: 'requeue', 'terminate', + * 'taskCompletion', 'retainedData' + */ nodeRebootOption?: string; } /** - * @class - * Initializes a new instance of the NodeReimageParameter class. - * @constructor * @summary Options for reimaging a compute node. - * - * @member {string} [nodeReimageOption] When to reimage the compute node and - * what to do with currently running tasks. The default value is requeue. - * Possible values include: 'requeue', 'terminate', 'taskCompletion', - * 'retainedData' */ export interface NodeReimageParameter { + /** + * @summary When to reimage the compute node and what to do with currently running tasks. + * @description The default value is requeue. Possible values include: 'requeue', 'terminate', + * 'taskCompletion', 'retainedData' + */ nodeReimageOption?: string; } /** - * @class - * Initializes a new instance of the NodeDisableSchedulingParameter class. - * @constructor * @summary Options for disabling scheduling on a compute node. - * - * @member {string} [nodeDisableSchedulingOption] What to do with currently - * running tasks when disabling task scheduling on the compute node. The - * default value is requeue. Possible values include: 'requeue', 'terminate', - * 'taskCompletion' */ export interface NodeDisableSchedulingParameter { + /** + * @summary What to do with currently running tasks when disabling task scheduling on the compute + * node. + * @description The default value is requeue. Possible values include: 'requeue', 'terminate', + * 'taskCompletion' + */ nodeDisableSchedulingOption?: string; } /** - * @class - * Initializes a new instance of the NodeRemoveParameter class. - * @constructor * @summary Options for removing compute nodes from a pool. - * - * @member {array} nodeList A list containing the IDs of the compute nodes to - * be removed from the specified pool. - * @member {moment.duration} [resizeTimeout] The timeout for removal of compute - * nodes to the pool. The default value is 15 minutes. The minimum value is 5 - * minutes. If you specify a value less than 5 minutes, the Batch service - * returns an error; if you are calling the REST API directly, the HTTP status - * code is 400 (Bad Request). - * @member {string} [nodeDeallocationOption] Determines what to do with a node - * and its running task(s) after it has been selected for deallocation. The - * default value is requeue. Possible values include: 'requeue', 'terminate', - * 'taskCompletion', 'retainedData' */ export interface NodeRemoveParameter { + /** + * @summary A list containing the IDs of the compute nodes to be removed from the specified pool. + */ nodeList: string[]; + /** + * @summary The timeout for removal of compute nodes to the pool. + * @description The default value is 15 minutes. The minimum value is 5 minutes. If you specify a + * value less than 5 minutes, the Batch service returns an error; if you are calling the REST API + * directly, the HTTP status code is 400 (Bad Request). + */ resizeTimeout?: moment.Duration; + /** + * @summary Determines what to do with a node and its running task(s) after it has been selected + * for deallocation. + * @description The default value is requeue. Possible values include: 'requeue', 'terminate', + * 'taskCompletion', 'retainedData' + */ nodeDeallocationOption?: string; } /** - * @class - * Initializes a new instance of the UploadBatchServiceLogsConfiguration class. - * @constructor - * @summary The Azure Batch service log files upload configuration for a - * compute node. - * - * @member {string} containerUrl The URL of the container within Azure Blob - * Storage to which to upload the Batch Service log file(s). The URL must - * include a Shared Access Signature (SAS) granting write permissions to the - * container. The SAS duration must allow enough time for the upload to finish. - * The start time for SAS is optional and recommended to not be specified. - * @member {date} startTime The start of the time range from which to upload - * Batch Service log file(s). Any log file containing a log message in the time - * range will be uploaded. This means that the operation might retrieve more - * logs than have been requested since the entire log file is always uploaded, - * but the operation should not retrieve fewer logs than have been requested. - * @member {date} [endTime] The end of the time range from which to upload - * Batch Service log file(s). Any log file containing a log message in the time - * range will be uploaded. This means that the operation might retrieve more - * logs than have been requested since the entire log file is always uploaded, - * but the operation should not retrieve fewer logs than have been requested. - * If omitted, the default is to upload all logs available after the startTime. + * @summary The Azure Batch service log files upload configuration for a compute node. */ export interface UploadBatchServiceLogsConfiguration { + /** + * @summary The URL of the container within Azure Blob Storage to which to upload the Batch + * Service log file(s). + * @description The URL must include a Shared Access Signature (SAS) granting write permissions + * to the container. The SAS duration must allow enough time for the upload to finish. The start + * time for SAS is optional and recommended to not be specified. + */ containerUrl: string; + /** + * @summary The start of the time range from which to upload Batch Service log file(s). + * @description Any log file containing a log message in the time range will be uploaded. This + * means that the operation might retrieve more logs than have been requested since the entire + * log file is always uploaded, but the operation should not retrieve fewer logs than have been + * requested. + */ startTime: Date; + /** + * @summary The end of the time range from which to upload Batch Service log file(s). + * @description Any log file containing a log message in the time range will be uploaded. This + * means that the operation might retrieve more logs than have been requested since the entire + * log file is always uploaded, but the operation should not retrieve fewer logs than have been + * requested. If omitted, the default is to upload all logs available after the startTime. + */ endTime?: Date; } /** - * @class - * Initializes a new instance of the UploadBatchServiceLogsResult class. - * @constructor - * @summary The result of uploading Batch service log files from a specific - * compute node. - * - * @member {string} virtualDirectoryName The virtual directory within Azure - * Blob Storage container to which the Batch Service log file(s) will be - * uploaded. The virtual directory name is part of the blob name for each log - * file uploaded, and it is built based poolId, nodeId and a unique identifier. - * @member {number} numberOfFilesUploaded The number of log files which will be - * uploaded. + * @summary The result of uploading Batch service log files from a specific compute node. */ export interface UploadBatchServiceLogsResult { + /** + * @summary The virtual directory within Azure Blob Storage container to which the Batch Service + * log file(s) will be uploaded. + * @description The virtual directory name is part of the blob name for each log file uploaded, + * and it is built based poolId, nodeId and a unique identifier. + */ virtualDirectoryName: string; + /** + * @summary The number of log files which will be uploaded. + */ numberOfFilesUploaded: number; } /** - * @class - * Initializes a new instance of the NodeCounts class. - * @constructor * @summary The number of nodes in each node state. - * - * @member {number} creating The number of nodes in the creating state. - * @member {number} idle The number of nodes in the idle state. - * @member {number} offline The number of nodes in the offline state. - * @member {number} preempted The number of nodes in the preempted state. - * @member {number} rebooting The count of nodes in the rebooting state. - * @member {number} reimaging The number of nodes in the reimaging state. - * @member {number} running The number of nodes in the running state. - * @member {number} starting The number of nodes in the starting state. - * @member {number} startTaskFailed The number of nodes in the startTaskFailed - * state. - * @member {number} leavingPool The number of nodes in the leavingPool state. - * @member {number} unknown The number of nodes in the unknown state. - * @member {number} unusable The number of nodes in the unusable state. - * @member {number} waitingForStartTask The number of nodes in the - * waitingForStartTask state. - * @member {number} total The total number of nodes. */ export interface NodeCounts { + /** + * @summary The number of nodes in the creating state. + */ creating: number; + /** + * @summary The number of nodes in the idle state. + */ idle: number; + /** + * @summary The number of nodes in the offline state. + */ offline: number; + /** + * @summary The number of nodes in the preempted state. + */ preempted: number; + /** + * @summary The count of nodes in the rebooting state. + */ rebooting: number; + /** + * @summary The number of nodes in the reimaging state. + */ reimaging: number; + /** + * @summary The number of nodes in the running state. + */ running: number; + /** + * @summary The number of nodes in the starting state. + */ starting: number; + /** + * @summary The number of nodes in the startTaskFailed state. + */ startTaskFailed: number; + /** + * @summary The number of nodes in the leavingPool state. + */ leavingPool: number; + /** + * @summary The number of nodes in the unknown state. + */ unknown: number; + /** + * @summary The number of nodes in the unusable state. + */ unusable: number; + /** + * @summary The number of nodes in the waitingForStartTask state. + */ waitingForStartTask: number; + /** + * @summary The total number of nodes. + */ total: number; } /** - * @class - * Initializes a new instance of the PoolNodeCounts class. - * @constructor * @summary The number of nodes in each state for a pool. - * - * @member {string} poolId The ID of the pool. - * @member {object} [dedicated] The number of dedicated nodes in each state. - * @member {number} [dedicated.creating] - * @member {number} [dedicated.idle] - * @member {number} [dedicated.offline] - * @member {number} [dedicated.preempted] - * @member {number} [dedicated.rebooting] - * @member {number} [dedicated.reimaging] - * @member {number} [dedicated.running] - * @member {number} [dedicated.starting] - * @member {number} [dedicated.startTaskFailed] - * @member {number} [dedicated.leavingPool] - * @member {number} [dedicated.unknown] - * @member {number} [dedicated.unusable] - * @member {number} [dedicated.waitingForStartTask] - * @member {number} [dedicated.total] - * @member {object} [lowPriority] The number of low priority nodes in each - * state. - * @member {number} [lowPriority.creating] - * @member {number} [lowPriority.idle] - * @member {number} [lowPriority.offline] - * @member {number} [lowPriority.preempted] - * @member {number} [lowPriority.rebooting] - * @member {number} [lowPriority.reimaging] - * @member {number} [lowPriority.running] - * @member {number} [lowPriority.starting] - * @member {number} [lowPriority.startTaskFailed] - * @member {number} [lowPriority.leavingPool] - * @member {number} [lowPriority.unknown] - * @member {number} [lowPriority.unusable] - * @member {number} [lowPriority.waitingForStartTask] - * @member {number} [lowPriority.total] */ export interface PoolNodeCounts { + /** + * @summary The ID of the pool. + */ poolId: string; + /** + * @summary The number of dedicated nodes in each state. + */ dedicated?: NodeCounts; + /** + * @summary The number of low priority nodes in each state. + */ lowPriority?: NodeCounts; } /** - * @class - * Initializes a new instance of the ApplicationListOptions class. - * @constructor * Additional parameters for list operation. - * - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 applications can be returned. Default value: - * 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ApplicationListOptions { + /** + * The maximum number of items to return in the response. A maximum of 1000 applications can be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ApplicationGetOptions class. - * @constructor * Additional parameters for get operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ApplicationGetOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolListUsageMetricsOptions class. - * @constructor * Additional parameters for listUsageMetrics operation. - * - * @member {date} [startTime] The earliest time from which to include metrics. - * This must be at least two and a half hours before the current time. If not - * specified this defaults to the start time of the last aggregation interval - * currently available. - * @member {date} [endTime] The latest time from which to include metrics. This - * must be at least two hours before the current time. If not specified this - * defaults to the end time of the last aggregation interval currently - * available. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 results will be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface PoolListUsageMetricsOptions { + /** + * The earliest time from which to include metrics. This must be at least two and a half hours + * before the current time. If not specified this defaults to the start time of the last + * aggregation interval currently available. + */ startTime?: Date; + /** + * The latest time from which to include metrics. This must be at least two hours before the + * current time. If not specified this defaults to the end time of the last aggregation interval + * currently available. + */ endTime?: Date; + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. + */ filter?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 results will be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolGetAllLifetimeStatisticsOptions class. - * @constructor * Additional parameters for getAllLifetimeStatistics operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface PoolGetAllLifetimeStatisticsOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolAddOptions class. - * @constructor * Additional parameters for add operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface PoolAddOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolListOptions class. - * @constructor * Additional parameters for list operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 pools can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface PoolListOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools. + */ filter?: string; + /** + * An OData $select clause. + */ select?: string; + /** + * An OData $expand clause. + */ expand?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 pools can be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolDeleteMethodOptions class. - * @constructor * Additional parameters for deleteMethod operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface PoolDeleteMethodOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the PoolExistsOptions class. - * @constructor * Additional parameters for exists operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface PoolExistsOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the PoolGetOptions class. - * @constructor * Additional parameters for get operation. - * - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface PoolGetOptions { + /** + * An OData $select clause. + */ select?: string; + /** + * An OData $expand clause. + */ expand?: string; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the PoolPatchOptions class. - * @constructor * Additional parameters for patch operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface PoolPatchOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the PoolDisableAutoScaleOptions class. - * @constructor * Additional parameters for disableAutoScale operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface PoolDisableAutoScaleOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolEnableAutoScaleOptions class. - * @constructor * Additional parameters for enableAutoScale operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface PoolEnableAutoScaleOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the PoolEvaluateAutoScaleOptions class. - * @constructor * Additional parameters for evaluateAutoScale operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface PoolEvaluateAutoScaleOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolResizeOptions class. - * @constructor * Additional parameters for resize operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface PoolResizeOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the PoolStopResizeOptions class. - * @constructor * Additional parameters for stopResize operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface PoolStopResizeOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the PoolUpdatePropertiesOptions class. - * @constructor * Additional parameters for updateProperties operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface PoolUpdatePropertiesOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolRemoveNodesOptions class. - * @constructor * Additional parameters for removeNodes operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface PoolRemoveNodesOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the AccountListNodeAgentSkusOptions class. - * @constructor * Additional parameters for listNodeAgentSkus operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 results will be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface AccountListNodeAgentSkusOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus. + */ filter?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 results will be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the AccountListPoolNodeCountsOptions class. - * @constructor * Additional parameters for listPoolNodeCounts operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch. - * @member {number} [maxResults] The maximum number of items to return in the - * response. Default value: 10 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface AccountListPoolNodeCountsOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch. + */ filter?: string; + /** + * The maximum number of items to return in the response. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobGetAllLifetimeStatisticsOptions class. - * @constructor * Additional parameters for getAllLifetimeStatistics operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobGetAllLifetimeStatisticsOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobDeleteMethodOptions class. - * @constructor * Additional parameters for deleteMethod operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobDeleteMethodOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobGetOptions class. - * @constructor * Additional parameters for get operation. - * - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobGetOptions { + /** + * An OData $select clause. + */ select?: string; + /** + * An OData $expand clause. + */ expand?: string; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobPatchOptions class. - * @constructor * Additional parameters for patch operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobPatchOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobUpdateOptions class. - * @constructor * Additional parameters for update operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobUpdateOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobDisableOptions class. - * @constructor * Additional parameters for disable operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobDisableOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobEnableOptions class. - * @constructor * Additional parameters for enable operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobEnableOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobTerminateOptions class. - * @constructor * Additional parameters for terminate operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobTerminateOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobAddOptions class. - * @constructor * Additional parameters for add operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobAddOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobListOptions class. - * @constructor * Additional parameters for list operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 jobs can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobListOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. + */ filter?: string; + /** + * An OData $select clause. + */ select?: string; + /** + * An OData $expand clause. + */ expand?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 jobs can be returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobListFromJobScheduleOptions class. - * @constructor * Additional parameters for listFromJobSchedule operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 jobs can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobListFromJobScheduleOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. + */ filter?: string; + /** + * An OData $select clause. + */ select?: string; + /** + * An OData $expand clause. + */ expand?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 jobs can be returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobListPreparationAndReleaseTaskStatusOptions class. - * @constructor * Additional parameters for listPreparationAndReleaseTaskStatus operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. - * @member {string} [select] An OData $select clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 tasks can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobListPreparationAndReleaseTaskStatusOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. + */ filter?: string; + /** + * An OData $select clause. + */ select?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 tasks can be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobGetTaskCountsOptions class. - * @constructor * Additional parameters for getTaskCounts operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobGetTaskCountsOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the CertificateAddOptions class. - * @constructor * Additional parameters for add operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface CertificateAddOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the CertificateListOptions class. - * @constructor * Additional parameters for list operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates. - * @member {string} [select] An OData $select clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 certificates can be returned. Default value: - * 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface CertificateListOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates. + */ filter?: string; + /** + * An OData $select clause. + */ select?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 certificates can be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the CertificateCancelDeletionOptions class. - * @constructor * Additional parameters for cancelDeletion operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface CertificateCancelDeletionOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the CertificateDeleteMethodOptions class. - * @constructor * Additional parameters for deleteMethod operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface CertificateDeleteMethodOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the CertificateGetOptions class. - * @constructor * Additional parameters for get operation. - * - * @member {string} [select] An OData $select clause. - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface CertificateGetOptions { + /** + * An OData $select clause. + */ select?: string; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the FileDeleteFromTaskOptions class. - * @constructor * Additional parameters for deleteFromTask operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface FileDeleteFromTaskOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the FileGetFromTaskOptions class. - * @constructor * Additional parameters for getFromTask operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ocpRange] The byte range to be retrieved. The default is - * to retrieve the entire file. The format is bytes=startRange-endRange. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface FileGetFromTaskOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * The byte range to be retrieved. The default is to retrieve the entire file. The format is + * bytes=startRange-endRange. + */ ocpRange?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the FileGetPropertiesFromTaskOptions class. - * @constructor * Additional parameters for getPropertiesFromTask operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface FileGetPropertiesFromTaskOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the FileDeleteFromComputeNodeOptions class. - * @constructor * Additional parameters for deleteFromComputeNode operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface FileDeleteFromComputeNodeOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the FileGetFromComputeNodeOptions class. - * @constructor * Additional parameters for getFromComputeNode operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ocpRange] The byte range to be retrieved. The default is - * to retrieve the entire file. The format is bytes=startRange-endRange. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface FileGetFromComputeNodeOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * The byte range to be retrieved. The default is to retrieve the entire file. The format is + * bytes=startRange-endRange. + */ ocpRange?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the FileGetPropertiesFromComputeNodeOptions class. - * @constructor * Additional parameters for getPropertiesFromComputeNode operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface FileGetPropertiesFromComputeNodeOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the FileListFromTaskOptions class. - * @constructor * Additional parameters for listFromTask operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 files can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface FileListFromTaskOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. + */ filter?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 files can be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the FileListFromComputeNodeOptions class. - * @constructor * Additional parameters for listFromComputeNode operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 files can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface FileListFromComputeNodeOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. + */ filter?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 files can be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleExistsOptions class. - * @constructor * Additional parameters for exists operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobScheduleExistsOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleDeleteMethodOptions class. - * @constructor * Additional parameters for deleteMethod operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobScheduleDeleteMethodOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleGetOptions class. - * @constructor * Additional parameters for get operation. - * - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobScheduleGetOptions { + /** + * An OData $select clause. + */ select?: string; + /** + * An OData $expand clause. + */ expand?: string; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobSchedulePatchOptions class. - * @constructor * Additional parameters for patch operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobSchedulePatchOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleUpdateOptions class. - * @constructor * Additional parameters for update operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobScheduleUpdateOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleDisableOptions class. - * @constructor * Additional parameters for disable operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobScheduleDisableOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleEnableOptions class. - * @constructor * Additional parameters for enable operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobScheduleEnableOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleTerminateOptions class. - * @constructor * Additional parameters for terminate operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface JobScheduleTerminateOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleAddOptions class. - * @constructor * Additional parameters for add operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobScheduleAddOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleListOptions class. - * @constructor * Additional parameters for list operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 job schedules can be returned. Default value: - * 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobScheduleListOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. + */ filter?: string; + /** + * An OData $select clause. + */ select?: string; + /** + * An OData $expand clause. + */ expand?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 job schedules can be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the TaskAddOptions class. - * @constructor * Additional parameters for add operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface TaskAddOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the TaskListOptions class. - * @constructor * Additional parameters for list operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 tasks can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface TaskListOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks. + */ filter?: string; + /** + * An OData $select clause. + */ select?: string; + /** + * An OData $expand clause. + */ expand?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 tasks can be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the TaskAddCollectionOptions class. - * @constructor * Additional parameters for addCollection operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface TaskAddCollectionOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the TaskDeleteMethodOptions class. - * @constructor * Additional parameters for deleteMethod operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface TaskDeleteMethodOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the TaskGetOptions class. - * @constructor * Additional parameters for get operation. - * - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface TaskGetOptions { + /** + * An OData $select clause. + */ select?: string; + /** + * An OData $expand clause. + */ expand?: string; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the TaskUpdateOptions class. - * @constructor * Additional parameters for update operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface TaskUpdateOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the TaskListSubtasksOptions class. - * @constructor * Additional parameters for listSubtasks operation. - * - * @member {string} [select] An OData $select clause. - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface TaskListSubtasksOptions { + /** + * An OData $select clause. + */ select?: string; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the TaskTerminateOptions class. - * @constructor * Additional parameters for terminate operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface TaskTerminateOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the TaskReactivateOptions class. - * @constructor * Additional parameters for reactivate operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of the - * resource known to the client. The operation will be performed only if the - * resource's current ETag on the service exactly matches the value specified - * by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version of - * the resource known to the client. The operation will be performed only if - * the resource's current ETag on the service does not match the value - * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has not been modified since the - * specified time. */ export interface TaskReactivateOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service exactly matches the value + * specified by the client. + */ ifMatch?: string; + /** + * An ETag value associated with the version of the resource known to the client. The operation + * will be performed only if the resource's current ETag on the service does not match the value + * specified by the client. + */ ifNoneMatch?: string; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has been modified since the + * specified time. + */ ifModifiedSince?: Date; + /** + * A timestamp indicating the last modified time of the resource known to the client. The + * operation will be performed only if the resource on the service has not been modified since + * the specified time. + */ ifUnmodifiedSince?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeAddUserOptions class. - * @constructor * Additional parameters for addUser operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeAddUserOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeDeleteUserOptions class. - * @constructor * Additional parameters for deleteUser operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeDeleteUserOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeUpdateUserOptions class. - * @constructor * Additional parameters for updateUser operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeUpdateUserOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeGetOptions class. - * @constructor * Additional parameters for get operation. - * - * @member {string} [select] An OData $select clause. - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeGetOptions { + /** + * An OData $select clause. + */ select?: string; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeRebootOptions class. - * @constructor * Additional parameters for reboot operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeRebootOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeReimageOptions class. - * @constructor * Additional parameters for reimage operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeReimageOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeDisableSchedulingOptions class. - * @constructor * Additional parameters for disableScheduling operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeDisableSchedulingOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeEnableSchedulingOptions class. - * @constructor * Additional parameters for enableScheduling operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeEnableSchedulingOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeGetRemoteLoginSettingsOptions class. - * @constructor * Additional parameters for getRemoteLoginSettings operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeGetRemoteLoginSettingsOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeGetRemoteDesktopOptions class. - * @constructor * Additional parameters for getRemoteDesktop operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeGetRemoteDesktopOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeUploadBatchServiceLogsOptions class. - * @constructor * Additional parameters for uploadBatchServiceLogs operation. - * - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeUploadBatchServiceLogsOptions { + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeListOptions class. - * @constructor * Additional parameters for list operation. - * - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see - * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. - * @member {string} [select] An OData $select clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 nodes can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend - * processing the request, in seconds. The default is 30 seconds. Default - * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeListOptions { + /** + * An OData $filter clause. For more information on constructing this filter, see + * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. + */ filter?: string; + /** + * An OData $select clause. + */ select?: string; + /** + * The maximum number of items to return in the response. A maximum of 1000 nodes can be + * returned. + */ maxResults?: number; + /** + * The maximum time that the server can spend processing the request, in seconds. The default is + * 30 seconds. + */ timeout?: number; + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ApplicationListNextOptions class. - * @constructor * Additional parameters for listNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ApplicationListNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolListUsageMetricsNextOptions class. - * @constructor * Additional parameters for listUsageMetricsNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface PoolListUsageMetricsNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the PoolListNextOptions class. - * @constructor * Additional parameters for listNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface PoolListNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the AccountListNodeAgentSkusNextOptions class. - * @constructor * Additional parameters for listNodeAgentSkusNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface AccountListNodeAgentSkusNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the AccountListPoolNodeCountsNextOptions class. - * @constructor * Additional parameters for listPoolNodeCountsNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface AccountListPoolNodeCountsNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobListNextOptions class. - * @constructor * Additional parameters for listNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobListNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobListFromJobScheduleNextOptions class. - * @constructor * Additional parameters for listFromJobScheduleNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobListFromJobScheduleNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobListPreparationAndReleaseTaskStatusNextOptions class. - * @constructor * Additional parameters for listPreparationAndReleaseTaskStatusNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobListPreparationAndReleaseTaskStatusNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the CertificateListNextOptions class. - * @constructor * Additional parameters for listNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface CertificateListNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the FileListFromTaskNextOptions class. - * @constructor * Additional parameters for listFromTaskNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface FileListFromTaskNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the FileListFromComputeNodeNextOptions class. - * @constructor * Additional parameters for listFromComputeNodeNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface FileListFromComputeNodeNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the JobScheduleListNextOptions class. - * @constructor * Additional parameters for listNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface JobScheduleListNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the TaskListNextOptions class. - * @constructor * Additional parameters for listNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface TaskListNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } /** - * @class - * Initializes a new instance of the ComputeNodeListNextOptions class. - * @constructor * Additional parameters for listNext operation. - * - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. - * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. */ export interface ComputeNodeListNextOptions { + /** + * The caller-generated request identity, in the form of a GUID with no decoration such as curly + * braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. + */ clientRequestId?: string; + /** + * Whether the server should return the client-request-id in the response. + */ returnClientRequestId?: boolean; + /** + * The time the request was issued. Client libraries typically set this to the current system + * clock time; set it explicitly if you are calling the REST API directly. + */ ocpDate?: Date; } - /** - * @class - * Initializes a new instance of the ApplicationListResult class. - * @constructor * @summary The result of listing the applications available in an account. - * - * @member {string} [odatanextLink] */ export interface ApplicationListResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the PoolListUsageMetricsResult class. - * @constructor * @summary The result of a listing the usage metrics for an account. - * - * @member {string} [odatanextLink] */ export interface PoolListUsageMetricsResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the CloudPoolListResult class. - * @constructor * @summary The result of listing the pools in an account. - * - * @member {string} [odatanextLink] */ export interface CloudPoolListResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the AccountListNodeAgentSkusResult class. - * @constructor * @summary The result of listing the supported node agent SKUs. - * - * @member {string} [odatanextLink] */ export interface AccountListNodeAgentSkusResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the PoolNodeCountsListResult class. - * @constructor * @summary The result of listing the node counts in the account. - * - * @member {string} [odatanextLink] */ export interface PoolNodeCountsListResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the CloudJobListResult class. - * @constructor * @summary The result of listing the jobs in an account. - * - * @member {string} [odatanextLink] */ export interface CloudJobListResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the CloudJobListPreparationAndReleaseTaskStatusResult class. - * @constructor - * @summary The result of listing the status of the Job Preparation and Job - * Release tasks for a job. - * - * @member {string} [odatanextLink] + * @summary The result of listing the status of the Job Preparation and Job Release tasks for a + * job. */ export interface CloudJobListPreparationAndReleaseTaskStatusResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the CertificateListResult class. - * @constructor * @summary The result of listing the certificates in the account. - * - * @member {string} [odatanextLink] */ export interface CertificateListResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the NodeFileListResult class. - * @constructor - * @summary The result of listing the files on a compute node, or the files - * associated with a task on a node. - * - * @member {string} [odatanextLink] + * @summary The result of listing the files on a compute node, or the files associated with a task + * on a node. */ export interface NodeFileListResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the CloudJobScheduleListResult class. - * @constructor * @summary The result of listing the job schedules in an account. - * - * @member {string} [odatanextLink] */ export interface CloudJobScheduleListResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the CloudTaskListResult class. - * @constructor * @summary The result of listing the tasks in a job. - * - * @member {string} [odatanextLink] */ export interface CloudTaskListResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the ComputeNodeListResult class. - * @constructor * @summary The result of listing the compute nodes in a pool. - * - * @member {string} [odatanextLink] */ export interface ComputeNodeListResult extends Array { + /** + * @summary The URL to get the next set of results. + */ odatanextLink?: string; } diff --git a/lib/services/batch/lib/models/jobAddOptions.js b/lib/services/batch/lib/models/jobAddOptions.js index 1915369717..dce4ce26f9 100644 --- a/lib/services/batch/lib/models/jobAddOptions.js +++ b/lib/services/batch/lib/models/jobAddOptions.js @@ -17,17 +17,17 @@ class JobAddOptions { /** * Create a JobAddOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobAddParameter.js b/lib/services/batch/lib/models/jobAddParameter.js index 24909fcbf7..21460d2f4d 100644 --- a/lib/services/batch/lib/models/jobAddParameter.js +++ b/lib/services/batch/lib/models/jobAddParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An Azure Batch job to add. * @@ -19,31 +17,31 @@ const models = require('./index'); class JobAddParameter { /** * Create a JobAddParameter. - * @member {string} id A string that uniquely identifies the job within the + * @property {string} id A string that uniquely identifies the job within the * account. The ID can contain any combination of alphanumeric characters * including hyphens and underscores, and cannot contain more than 64 * characters. The ID is case-preserving and case-insensitive (that is, you * may not have two IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the job. The display + * @property {string} [displayName] The display name for the job. The display * name need not be unique and can contain any Unicode characters up to a * maximum length of 1024. - * @member {number} [priority] The priority of the job. Priority values can + * @property {number} [priority] The priority of the job. Priority values can * range from -1000 to 1000, with -1000 being the lowest priority and 1000 * being the highest priority. The default value is 0. - * @member {object} [constraints] The execution constraints for the job. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does + * @property {object} [constraints] The execution constraints for the job. + * @property {moment.duration} [constraints.maxWallClockTime] If the job does * not complete within the time limit, the Batch service terminates it and * any tasks that are still running. In this case, the termination reason * will be MaxWallClockTimeExpiry. If this property is not specified, there * is no time limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries. The Batch service will try * each task once, and may then retry up to this limit. For example, if the * maximum retry count is 3, Batch tries a task up to 4 times (one initial * try and 3 retries). If the maximum retry count is 0, the Batch service * does not retry tasks. If the maximum retry count is -1, the Batch service * retries tasks without limit. The default value is 0 (no retries). - * @member {object} [jobManagerTask] Details of a Job Manager task to be + * @property {object} [jobManagerTask] Details of a Job Manager task to be * launched when the job is started. If the job does not specify a Job * Manager task, the user must explicitly add tasks to the job. If the job * does specify a Job Manager task, the Batch service creates the Job Manager @@ -56,12 +54,12 @@ class JobAddParameter { * actions are required for the job.) For example, a Job Manager task might * download a file specified as a parameter, analyze the contents of that * file and submit additional tasks based on those contents. - * @member {string} [jobManagerTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot + * @property {string} [jobManagerTask.id] The ID can contain any combination + * of alphanumeric characters including hyphens and underscores and cannot * contain more than 64 characters. - * @member {string} [jobManagerTask.displayName] It need not be unique and + * @property {string} [jobManagerTask.displayName] It need not be unique and * can contain any Unicode characters up to a maximum length of 1024. - * @member {string} [jobManagerTask.commandLine] The command line does not + * @property {string} [jobManagerTask.commandLine] The command line does not * run under a shell, and therefore cannot take advantage of shell features * such as environment variable expansion. If you want to take advantage of * such features, you should invoke the shell in the command line, for @@ -70,55 +68,55 @@ class JobAddParameter { * path (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobManagerTask.containerSettings] If the pool that will - * run this task has containerConfiguration set, this must be set as well. If - * the pool that will run this task doesn't have containerConfiguration set, - * this must not be set. When this is specified, all directories recursively - * below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on - * the node) are mapped into the container, all task environment variables - * are mapped into the container, and the task command line is executed in - * the container. - * @member {string} [jobManagerTask.containerSettings.containerRunOptions] + * @property {object} [jobManagerTask.containerSettings] If the pool that + * will run this task has containerConfiguration set, this must be set as + * well. If the pool that will run this task doesn't have + * containerConfiguration set, this must not be set. When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * Azure Batch directories on the node) are mapped into the container, all + * task environment variables are mapped into the container, and the task + * command line is executed in the container. + * @property {string} [jobManagerTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a + * @property {string} [jobManagerTask.containerSettings.imageName] This is + * the full image reference, as would be specified to "docker pull". If no + * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} + * @property {object} [jobManagerTask.containerSettings.registry] This + * setting can be omitted if was already provided at pool creation. + * @property {string} * [jobManagerTask.containerSettings.registry.registryServer] If omitted, the * default is "docker.io". - * @member {string} [jobManagerTask.containerSettings.registry.userName] - * @member {string} [jobManagerTask.containerSettings.registry.password] - * @member {array} [jobManagerTask.resourceFiles] Files listed under this + * @property {string} [jobManagerTask.containerSettings.registry.userName] + * @property {string} [jobManagerTask.containerSettings.registry.password] + * @property {array} [jobManagerTask.resourceFiles] Files listed under this * element are located in the task's working directory. There is a maximum * size for the list of resource files. When the max size is exceeded, the * request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobManagerTask.outputFiles] For multi-instance tasks, the - * files will only be uploaded from the compute node on which the primary + * @property {array} [jobManagerTask.outputFiles] For multi-instance tasks, + * the files will only be uploaded from the compute node on which the primary * task is executed. - * @member {array} [jobManagerTask.environmentSettings] - * @member {object} [jobManagerTask.constraints] - * @member {moment.duration} [jobManagerTask.constraints.maxWallClockTime] If - * this is not specified, there is no time limit on how long the task may + * @property {array} [jobManagerTask.environmentSettings] + * @property {object} [jobManagerTask.constraints] + * @property {moment.duration} [jobManagerTask.constraints.maxWallClockTime] + * If this is not specified, there is no time limit on how long the task may * run. - * @member {moment.duration} [jobManagerTask.constraints.retentionTime] The + * @property {moment.duration} [jobManagerTask.constraints.retentionTime] The * default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} [jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task + * @property {number} [jobManagerTask.constraints.maxTaskRetryCount] Note + * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task * once, and may then retry up to this limit. For example, if the maximum * retry count is 3, Batch tries the task up to 4 times (one initial try and * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobManagerTask.killJobOnCompletion] If true, when the + * @property {boolean} [jobManagerTask.killJobOnCompletion] If true, when the * Job Manager task completes, the Batch service marks the job as complete. * If any tasks are still running at this time (other than Job Release), * those tasks are terminated. If false, the completion of the Job Manager @@ -131,32 +129,33 @@ class JobAddParameter { * and using the Job Manager task only to create the tasks for the job (not * to monitor progress), then it is important to set killJobOnCompletion to * false. - * @member {object} [jobManagerTask.userIdentity] If omitted, the task runs + * @property {object} [jobManagerTask.userIdentity] If omitted, the task runs * as a non-administrative user unique to the task. - * @member {string} [jobManagerTask.userIdentity.userName] The userName and + * @property {string} [jobManagerTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [jobManagerTask.userIdentity.autoUser] The userName and + * @property {object} [jobManagerTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobManagerTask.runExclusive] If true, no other tasks + * @property {string} [jobManagerTask.userIdentity.autoUser.scope] The + * default value is task. Possible values include: 'task', 'pool' + * @property {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] + * The default value is nonAdmin. Possible values include: 'nonAdmin', + * 'admin' + * @property {boolean} [jobManagerTask.runExclusive] If true, no other tasks * will run on the same compute node for as long as the Job Manager is * running. If false, other tasks can run simultaneously with the Job Manager * on a compute node. The Job Manager task counts normally against the node's * concurrent task limit, so this is only relevant if the node allows * multiple concurrent tasks. The default value is true. - * @member {array} [jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the - * existing copy on the compute node is used. If a referenced application - * package cannot be installed, for example because the package has been - * deleted or because download failed, the task fails. - * @member {object} [jobManagerTask.authenticationTokenSettings] If this + * @property {array} [jobManagerTask.applicationPackageReferences] + * Application packages are downloaded and deployed to a shared directory, + * not the task working directory. Therefore, if a referenced package is + * already on the compute node, and is up to date, then it is not + * re-downloaded; the existing copy on the compute node is used. If a + * referenced application package cannot be installed, for example because + * the package has been deleted or because download failed, the task fails. + * @property {object} [jobManagerTask.authenticationTokenSettings] If this * property is set, the Batch service provides the task with an * authentication token which can be used to authenticate Batch service * operations without requiring an account access key. The token is provided @@ -164,18 +163,18 @@ class JobAddParameter { * that the task can carry out using the token depend on the settings. For * example, a task can request job permissions in order to add other tasks to * the job, or check the status of the job or of other tasks under the job. - * @member {array} [jobManagerTask.authenticationTokenSettings.access] The + * @property {array} [jobManagerTask.authenticationTokenSettings.access] The * authentication token grants access to a limited set of Batch service * operations. Currently the only supported value for the access property is * 'job', which grants access to all operations related to the job which * contains the task. - * @member {boolean} [jobManagerTask.allowLowPriorityNode] The default value - * is true. - * @member {object} [jobPreparationTask] The Job Preparation task. If a job + * @property {boolean} [jobManagerTask.allowLowPriorityNode] The default + * value is true. + * @property {object} [jobPreparationTask] The Job Preparation task. If a job * has a Job Preparation task, the Batch service will run the Job Preparation * task on a compute node before starting any tasks of that job on that * compute node. - * @member {string} [jobPreparationTask.id] The ID can contain any + * @property {string} [jobPreparationTask.id] The ID can contain any * combination of alphanumeric characters including hyphens and underscores * and cannot contain more than 64 characters. If you do not specify this * property, the Batch service assigns a default value of 'jobpreparation'. @@ -183,7 +182,7 @@ class JobAddParameter { * If you try to submit a task with the same id, the Batch service rejects * the request with error code TaskIdSameAsJobPreparationTask; if you are * calling the REST API directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobPreparationTask.commandLine] The command line does + * @property {string} [jobPreparationTask.commandLine] The command line does * not run under a shell, and therefore cannot take advantage of shell * features such as environment variable expansion. If you want to take * advantage of such features, you should invoke the shell in the command @@ -192,42 +191,44 @@ class JobAddParameter { * use a relative path (relative to the task working directory), or use the * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobPreparationTask.containerSettings] When this is + * @property {object} [jobPreparationTask.containerSettings] When this is * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR * (the root of Azure Batch directories on the node) are mapped into the * container, all task environment variables are mapped into the container, * and the task command line is executed in the container. - * @member {string} + * @property {string} * [jobPreparationTask.containerSettings.containerRunOptions] These * additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no + * @property {string} [jobPreparationTask.containerSettings.imageName] This + * is the full image reference, as would be specified to "docker pull". If no * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [jobPreparationTask.containerSettings.registry] This + * @property {object} [jobPreparationTask.containerSettings.registry] This * setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobPreparationTask.containerSettings.registry.registryServer] If omitted, * the default is "docker.io". - * @member {string} [jobPreparationTask.containerSettings.registry.userName] - * @member {string} [jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobPreparationTask.resourceFiles] Files listed under this - * element are located in the task's working directory. There is a maximum - * size for the list of resource files. When the max size is exceeded, the - * request will fail and the response error code will be + * @property {string} + * [jobPreparationTask.containerSettings.registry.userName] + * @property {string} + * [jobPreparationTask.containerSettings.registry.password] + * @property {array} [jobPreparationTask.resourceFiles] Files listed under + * this element are located in the task's working directory. There is a + * maximum size for the list of resource files. When the max size is + * exceeded, the request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobPreparationTask.environmentSettings] - * @member {object} [jobPreparationTask.constraints] - * @member {moment.duration} + * @property {array} [jobPreparationTask.environmentSettings] + * @property {object} [jobPreparationTask.constraints] + * @property {moment.duration} * [jobPreparationTask.constraints.maxWallClockTime] If this is not * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [jobPreparationTask.constraints.retentionTime] + * @property {moment.duration} [jobPreparationTask.constraints.retentionTime] * The default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note + * @property {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task * once, and may then retry up to this limit. For example, if the maximum @@ -235,10 +236,10 @@ class JobAddParameter { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobPreparationTask.waitForSuccess] If true and the Job - * Preparation task fails on a compute node, the Batch service retries the - * Job Preparation task up to its maximum retry count (as specified in the - * constraints element). If the task has still not completed successfully + * @property {boolean} [jobPreparationTask.waitForSuccess] If true and the + * Job Preparation task fails on a compute node, the Batch service retries + * the Job Preparation task up to its maximum retry count (as specified in + * the constraints element). If the task has still not completed successfully * after all retries, then the Batch service will not schedule tasks of the * job to the compute node. The compute node remains active and eligible to * run tasks of other jobs. If false, the Batch service will not wait for the @@ -246,42 +247,42 @@ class JobAddParameter { * start executing on the compute node while the Job Preparation task is * still running; and even if the Job Preparation task fails, new tasks will * continue to be scheduled on the node. The default value is true. - * @member {object} [jobPreparationTask.userIdentity] If omitted, the task + * @property {object} [jobPreparationTask.userIdentity] If omitted, the task * runs as a non-administrative user unique to the task on Windows nodes, or - * a a non-administrative user unique to the pool on Linux nodes. - * @member {string} [jobPreparationTask.userIdentity.userName] The userName + * a non-administrative user unique to the pool on Linux nodes. + * @property {string} [jobPreparationTask.userIdentity.userName] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {object} [jobPreparationTask.userIdentity.autoUser] The userName + * @property {object} [jobPreparationTask.userIdentity.autoUser] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {string} [jobPreparationTask.userIdentity.autoUser.scope] The + * @property {string} [jobPreparationTask.userIdentity.autoUser.scope] The * default value is task. Possible values include: 'task', 'pool' - * @member {string} [jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', - * 'admin' - * @member {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The + * @property {string} + * [jobPreparationTask.userIdentity.autoUser.elevationLevel] The default + * value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @property {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The * Job Preparation task is always rerun if a compute node is reimaged, or if * the Job Preparation task did not complete (e.g. because the reboot * occurred while the task was running). Therefore, you should always write a * Job Preparation task to be idempotent and to behave correctly if run * multiple times. The default value is true. - * @member {object} [jobReleaseTask] The Job Release task. A Job Release task - * cannot be specified without also specifying a Job Preparation task for the - * job. The Batch service runs the Job Release task on the compute nodes that - * have run the Job Preparation task. The primary purpose of the Job Release - * task is to undo changes to compute nodes made by the Job Preparation task. - * Example activities include deleting local files, or shutting down services - * that were started as part of job preparation. - * @member {string} [jobReleaseTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot + * @property {object} [jobReleaseTask] The Job Release task. A Job Release + * task cannot be specified without also specifying a Job Preparation task + * for the job. The Batch service runs the Job Release task on the compute + * nodes that have run the Job Preparation task. The primary purpose of the + * Job Release task is to undo changes to compute nodes made by the Job + * Preparation task. Example activities include deleting local files, or + * shutting down services that were started as part of job preparation. + * @property {string} [jobReleaseTask.id] The ID can contain any combination + * of alphanumeric characters including hyphens and underscores and cannot * contain more than 64 characters. If you do not specify this property, the * Batch service assigns a default value of 'jobrelease'. No other task in * the job can have the same ID as the Job Release task. If you try to submit * a task with the same id, the Batch service rejects the request with error * code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, * the HTTP status code is 409 (Conflict). - * @member {string} [jobReleaseTask.commandLine] The command line does not + * @property {string} [jobReleaseTask.commandLine] The command line does not * run under a shell, and therefore cannot take advantage of shell features * such as environment variable expansion. If you want to take advantage of * such features, you should invoke the shell in the command line, for @@ -290,59 +291,60 @@ class JobAddParameter { * path (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobReleaseTask.containerSettings] When this is + * @property {object} [jobReleaseTask.containerSettings] When this is * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR * (the root of Azure Batch directories on the node) are mapped into the * container, all task environment variables are mapped into the container, * and the task command line is executed in the container. - * @member {string} [jobReleaseTask.containerSettings.containerRunOptions] + * @property {string} [jobReleaseTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a + * @property {string} [jobReleaseTask.containerSettings.imageName] This is + * the full image reference, as would be specified to "docker pull". If no + * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} + * @property {object} [jobReleaseTask.containerSettings.registry] This + * setting can be omitted if was already provided at pool creation. + * @property {string} * [jobReleaseTask.containerSettings.registry.registryServer] If omitted, the * default is "docker.io". - * @member {string} [jobReleaseTask.containerSettings.registry.userName] - * @member {string} [jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobReleaseTask.resourceFiles] Files listed under this + * @property {string} [jobReleaseTask.containerSettings.registry.userName] + * @property {string} [jobReleaseTask.containerSettings.registry.password] + * @property {array} [jobReleaseTask.resourceFiles] Files listed under this * element are located in the task's working directory. - * @member {array} [jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobReleaseTask.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the + * @property {array} [jobReleaseTask.environmentSettings] + * @property {moment.duration} [jobReleaseTask.maxWallClockTime] + * @property {moment.duration} [jobReleaseTask.retentionTime] The default is + * 7 days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {object} [jobReleaseTask.userIdentity] If omitted, the task runs + * @property {object} [jobReleaseTask.userIdentity] If omitted, the task runs * as a non-administrative user unique to the task. - * @member {string} [jobReleaseTask.userIdentity.userName] The userName and + * @property {string} [jobReleaseTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [jobReleaseTask.userIdentity.autoUser] The userName and + * @property {object} [jobReleaseTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [commonEnvironmentSettings] The list of common environment - * variable settings. These environment variables are set for all tasks in - * the job (including the Job Manager, Job Preparation and Job Release - * tasks). Individual tasks can override an environment setting specified - * here by specifying the same setting name with a different value. - * @member {object} poolInfo The pool on which the Batch service runs the + * @property {string} [jobReleaseTask.userIdentity.autoUser.scope] The + * default value is task. Possible values include: 'task', 'pool' + * @property {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] + * The default value is nonAdmin. Possible values include: 'nonAdmin', + * 'admin' + * @property {array} [commonEnvironmentSettings] The list of common + * environment variable settings. These environment variables are set for all + * tasks in the job (including the Job Manager, Job Preparation and Job + * Release tasks). Individual tasks can override an environment setting + * specified here by specifying the same setting name with a different value. + * @property {object} poolInfo The pool on which the Batch service runs the * job's tasks. - * @member {string} [poolInfo.poolId] You must ensure that the pool + * @property {string} [poolInfo.poolId] You must ensure that the pool * referenced by this property exists. If the pool does not exist at the time * the Batch service tries to schedule a job, no tasks for the job will run * until you create a pool with that id. Note that the Batch service will not * reject the job request; it will simply not run tasks until the pool * exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation + * @property {object} [poolInfo.autoPoolSpecification] If auto pool creation * fails, the Batch service moves the job to a completed state, and the pool * creation error is set in the job's scheduling error property. The Batch * service manages the lifetime (both creation and, unless keepAlive is @@ -350,28 +352,28 @@ class JobAddParameter { * lifetime of the auto pool while the job is active will result in * unexpected behavior. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The + * @property {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The * Batch service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] + * @property {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the + * @property {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, + * the Batch service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The + * @property {object} [poolInfo.autoPoolSpecification.pool] + * @property {string} [poolInfo.autoPoolSpecification.pool.displayName] The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For + * @property {string} [poolInfo.autoPoolSpecification.pool.vmSize] For * information about available sizes of virtual machines in pools, see Choose * a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This * property must be specified if the pool needs to be created with Azure PaaS * VMs. This property and virtualMachineConfiguration are mutually exclusive @@ -380,7 +382,7 @@ class JobAddParameter { * directly, the HTTP status code is 400 (Bad Request). This property cannot * be specified if the Batch account was created with its poolAllocationMode * property set to 'UserSubscription'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] * Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -389,39 +391,39 @@ class JobAddParameter { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] * The default value is * which specifies the latest operating system version * for the specified OS family. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This * property must be specified if the pool needs to be created with Azure IaaS * VMs. This property and cloudServiceConfiguration are mutually exclusive * and one of the properties must be specified. If neither is specified then * the Batch service returns an error; if you are calling the REST API * directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -430,14 +432,14 @@ class JobAddParameter { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] * 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 @@ -449,7 +451,7 @@ class JobAddParameter { * 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. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] * This only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -458,71 +460,71 @@ class JobAddParameter { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size - * of the compute nodes in the pool (the vmSize setting). - * @member {object} + * @property {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] + * The default value is 1. The maximum value of this setting depends on the + * size of the compute nodes in the pool (the vmSize setting). + * @property {object} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] * Possible values include: 'spread', 'pack' - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies * only to manual scaling; it has no effect when enableAutoScale is set to * true. The default value is 15 minutes. The minimum value is 5 minutes. If * you specify a value less than 5 minutes, the Batch service rejects the * request with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is + * @property {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] + * If false, at least one of targetDedicateNodes and targetLowPriorityNodes + * must be specified. If true, the autoScaleFormula element is required. The + * pool automatically resizes according to the formula. The default value is * false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] + * @property {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] * This property must not be specified if enableAutoScale is set to false. It * is required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The * default value is 15 minutes. The minimum and maximum value are 5 minutes * and 168 hours respectively. If you specify a value less than 5 minutes or * greater than 168 hours, the Batch service rejects the request with an * invalid property value error; if you are calling the REST API directly, * the HTTP status code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] * Enabling inter-node communication limits the maximum size of the pool due * to deployment restrictions on the nodes of the pool. This may result in * the pool not reaching its desired size. The default value is false. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This * is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -536,20 +538,20 @@ class JobAddParameter { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} + * @property {object} [poolInfo.autoPoolSpecification.pool.startTask] + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.commandLine] The command * line does not run under a shell, and therefore cannot take advantage of * shell features such as environment variable expansion. If you want to take @@ -559,56 +561,56 @@ class JobAddParameter { * use a relative path (relative to the task working directory), or use the * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When * this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] * This is the full image reference, as would be specified to "docker pull". * If no tag is provided as part of the image name, the tag ":latest" is used * as a default. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] * This setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed * under this element are located in the task's working directory. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, * the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] * The default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The * Batch service retries a task if its exit code is nonzero. Note that this * value specifically controls the number of retries. The Batch service will @@ -617,7 +619,7 @@ class JobAddParameter { * initial try and 3 retries). If the maximum retry count is 0, the Batch * service does not retry the task. If the maximum retry count is -1, the * Batch service retries the task without limit. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and * the start task fails on a compute node, the Batch service retries the * start task up to its maximum retry count (maxTaskRetryCount). If the task @@ -629,7 +631,7 @@ class JobAddParameter { * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.certificateReferences] For Windows * compute nodes, the Batch service installs the certificates to the * specified certificate store and location. For Linux compute nodes, the @@ -639,42 +641,43 @@ class JobAddParameter { * '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. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch - * service application licenses. If a license is requested which is not - * supported, pool creation will fail. The permitted licenses available on - * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge - * applies for each application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch + * @property {array} + * [poolInfo.autoPoolSpecification.pool.applicationLicenses] The list of + * application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, + * pool creation will fail. The permitted licenses available on the pool are + * 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each + * application license added to the pool. + * @property {array} [poolInfo.autoPoolSpecification.pool.userAccounts] + * @property {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch * service does not assign any meaning to metadata; it is solely for the use * of user code. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in the job are in the completed state. 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. Possible values include: 'noAction', - * 'terminateJob' - * @member {string} [onTaskFailure] The action the Batch service should take - * when any task in the job fails. 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. Possible values include: 'noAction', + * @property {string} [onAllTasksComplete] The action the Batch service + * should take when all tasks in the job are in the completed state. 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. Possible values include: + * 'noAction', 'terminateJob' + * @property {string} [onTaskFailure] The action the Batch service should + * take when any task in the job fails. 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. Possible values include: 'noAction', * 'performExitOptionsJobAction' - * @member {array} [metadata] A list of name-value pairs associated with the - * job as metadata. The Batch service does not assign any meaning to + * @property {array} [metadata] A list of name-value pairs associated with + * the job as metadata. The Batch service does not assign any meaning to * metadata; it is solely for the use of user code. - * @member {boolean} [usesTaskDependencies] Whether tasks in the job can + * @property {boolean} [usesTaskDependencies] Whether tasks in the job can * define dependencies on each other. The default is false. - * @member {object} [networkConfiguration] The network configuration for the - * job. - * @member {string} [networkConfiguration.subnetId] This is only supported + * @property {object} [networkConfiguration] The network configuration for + * the job. + * @property {string} [networkConfiguration.subnetId] This is only supported * for jobs running on VirtualMachineConfiguration pools. This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the diff --git a/lib/services/batch/lib/models/jobConstraints.js b/lib/services/batch/lib/models/jobConstraints.js index 2a37224fa7..375361daaf 100644 --- a/lib/services/batch/lib/models/jobConstraints.js +++ b/lib/services/batch/lib/models/jobConstraints.js @@ -17,14 +17,14 @@ class JobConstraints { /** * Create a JobConstraints. - * @member {moment.duration} [maxWallClockTime] The maximum elapsed time that - * the job may run, measured from the time the job is created. If the job - * does not complete within the time limit, the Batch service terminates it - * and any tasks that are still running. In this case, the termination reason - * will be MaxWallClockTimeExpiry. If this property is not specified, there - * is no time limit on how long the job may run. - * @member {number} [maxTaskRetryCount] The maximum number of times each task - * may be retried. The Batch service retries a task if its exit code is + * @property {moment.duration} [maxWallClockTime] The maximum elapsed time + * that the job may run, measured from the time the job is created. If the + * job does not complete within the time limit, the Batch service terminates + * it and any tasks that are still running. In this case, the termination + * reason will be MaxWallClockTimeExpiry. If this property is not specified, + * there is no time limit on how long the job may run. + * @property {number} [maxTaskRetryCount] The maximum number of times each + * task may be retried. The Batch service retries a task if its exit code is * nonzero. Note that this value specifically controls the number of retries. * The Batch service will try each task once, and may then retry up to this * limit. For example, if the maximum retry count is 3, Batch tries a task up diff --git a/lib/services/batch/lib/models/jobDeleteMethodOptions.js b/lib/services/batch/lib/models/jobDeleteMethodOptions.js index 012c220dfc..d4f4b65f37 100644 --- a/lib/services/batch/lib/models/jobDeleteMethodOptions.js +++ b/lib/services/batch/lib/models/jobDeleteMethodOptions.js @@ -17,30 +17,30 @@ class JobDeleteMethodOptions { /** * Create a JobDeleteMethodOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobDisableOptions.js b/lib/services/batch/lib/models/jobDisableOptions.js index 7055ae8830..b98de43797 100644 --- a/lib/services/batch/lib/models/jobDisableOptions.js +++ b/lib/services/batch/lib/models/jobDisableOptions.js @@ -17,30 +17,30 @@ class JobDisableOptions { /** * Create a JobDisableOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobDisableParameter.js b/lib/services/batch/lib/models/jobDisableParameter.js index e71e2add18..8dc70d5722 100644 --- a/lib/services/batch/lib/models/jobDisableParameter.js +++ b/lib/services/batch/lib/models/jobDisableParameter.js @@ -17,8 +17,8 @@ class JobDisableParameter { /** * Create a JobDisableParameter. - * @member {string} disableTasks What to do with active tasks associated with - * the job. Possible values include: 'requeue', 'terminate', 'wait' + * @property {string} disableTasks What to do with active tasks associated + * with the job. Possible values include: 'requeue', 'terminate', 'wait' */ constructor() { } diff --git a/lib/services/batch/lib/models/jobEnableOptions.js b/lib/services/batch/lib/models/jobEnableOptions.js index f2e591ee34..b4f21f4a13 100644 --- a/lib/services/batch/lib/models/jobEnableOptions.js +++ b/lib/services/batch/lib/models/jobEnableOptions.js @@ -17,30 +17,30 @@ class JobEnableOptions { /** * Create a JobEnableOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobExecutionInformation.js b/lib/services/batch/lib/models/jobExecutionInformation.js index 62a3bd6b9b..db653da6be 100644 --- a/lib/services/batch/lib/models/jobExecutionInformation.js +++ b/lib/services/batch/lib/models/jobExecutionInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Contains information about the execution of a job in the Azure * Batch service. @@ -20,28 +18,28 @@ const models = require('./index'); class JobExecutionInformation { /** * Create a JobExecutionInformation. - * @member {date} startTime The start time of the job. This is the time at + * @property {date} startTime The start time of the job. This is the time at * which the job was created. - * @member {date} [endTime] The completion time of the job. This property is - * set only if the job is in the completed state. - * @member {string} [poolId] The ID of the pool to which this job is + * @property {date} [endTime] The completion time of the job. This property + * is set only if the job is in the completed state. + * @property {string} [poolId] The ID of the pool to which this job is * assigned. This element contains the actual pool where the job is assigned. * When you get job details from the service, they also contain a poolInfo * element, which contains the pool configuration data from when the job was * added or updated. That poolInfo element may also contain a poolId element. * If it does, the two IDs are the same. If it does not, it means the job ran * on an auto pool, and this property contains the ID of that auto pool. - * @member {object} [schedulingError] Details of any error encountered by the - * service in starting the job. This property is not set if there was no + * @property {object} [schedulingError] Details of any error encountered by + * the service in starting the job. This property is not set if there was no * error starting the job. - * @member {string} [schedulingError.category] Possible values include: + * @property {string} [schedulingError.category] Possible values include: * 'userError', 'serverError' - * @member {string} [schedulingError.code] - * @member {string} [schedulingError.message] - * @member {array} [schedulingError.details] - * @member {string} [terminateReason] A string describing the reason the job - * ended. 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: + * @property {string} [schedulingError.code] + * @property {string} [schedulingError.message] + * @property {array} [schedulingError.details] + * @property {string} [terminateReason] A string describing the reason the + * job ended. 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 diff --git a/lib/services/batch/lib/models/jobGetAllLifetimeStatisticsOptions.js b/lib/services/batch/lib/models/jobGetAllLifetimeStatisticsOptions.js index 322a89fa7b..e36d258b24 100644 --- a/lib/services/batch/lib/models/jobGetAllLifetimeStatisticsOptions.js +++ b/lib/services/batch/lib/models/jobGetAllLifetimeStatisticsOptions.js @@ -17,17 +17,17 @@ class JobGetAllLifetimeStatisticsOptions { /** * Create a JobGetAllLifetimeStatisticsOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobGetOptions.js b/lib/services/batch/lib/models/jobGetOptions.js index 53d6578f8d..8dd67e2a48 100644 --- a/lib/services/batch/lib/models/jobGetOptions.js +++ b/lib/services/batch/lib/models/jobGetOptions.js @@ -17,32 +17,32 @@ class JobGetOptions { /** * Create a JobGetOptions. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {string} [expand] An OData $expand clause. + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobGetTaskCountsOptions.js b/lib/services/batch/lib/models/jobGetTaskCountsOptions.js index c386d63246..4c5340b63f 100644 --- a/lib/services/batch/lib/models/jobGetTaskCountsOptions.js +++ b/lib/services/batch/lib/models/jobGetTaskCountsOptions.js @@ -17,17 +17,17 @@ class JobGetTaskCountsOptions { /** * Create a JobGetTaskCountsOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobListFromJobScheduleNextOptions.js b/lib/services/batch/lib/models/jobListFromJobScheduleNextOptions.js index a50c049993..e0b1d4881c 100644 --- a/lib/services/batch/lib/models/jobListFromJobScheduleNextOptions.js +++ b/lib/services/batch/lib/models/jobListFromJobScheduleNextOptions.js @@ -17,14 +17,14 @@ class JobListFromJobScheduleNextOptions { /** * Create a JobListFromJobScheduleNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobListFromJobScheduleOptions.js b/lib/services/batch/lib/models/jobListFromJobScheduleOptions.js index 4e67429d3e..336055b91d 100644 --- a/lib/services/batch/lib/models/jobListFromJobScheduleOptions.js +++ b/lib/services/batch/lib/models/jobListFromJobScheduleOptions.js @@ -17,24 +17,25 @@ class JobListFromJobScheduleOptions { /** * Create a JobListFromJobScheduleOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 jobs can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {string} [expand] An OData $expand clause. + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 jobs can be returned. Default value: 1000 + * . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobListNextOptions.js b/lib/services/batch/lib/models/jobListNextOptions.js index 61a4a799c7..6cfa395e83 100644 --- a/lib/services/batch/lib/models/jobListNextOptions.js +++ b/lib/services/batch/lib/models/jobListNextOptions.js @@ -17,14 +17,14 @@ class JobListNextOptions { /** * Create a JobListNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobListOptions.js b/lib/services/batch/lib/models/jobListOptions.js index cea40d985d..3b825f7a7c 100644 --- a/lib/services/batch/lib/models/jobListOptions.js +++ b/lib/services/batch/lib/models/jobListOptions.js @@ -17,24 +17,25 @@ class JobListOptions { /** * Create a JobListOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 jobs can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {string} [expand] An OData $expand clause. + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 jobs can be returned. Default value: 1000 + * . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobListPreparationAndReleaseTaskStatusNextOptions.js b/lib/services/batch/lib/models/jobListPreparationAndReleaseTaskStatusNextOptions.js index e75022e563..382c660403 100644 --- a/lib/services/batch/lib/models/jobListPreparationAndReleaseTaskStatusNextOptions.js +++ b/lib/services/batch/lib/models/jobListPreparationAndReleaseTaskStatusNextOptions.js @@ -17,14 +17,14 @@ class JobListPreparationAndReleaseTaskStatusNextOptions { /** * Create a JobListPreparationAndReleaseTaskStatusNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobListPreparationAndReleaseTaskStatusOptions.js b/lib/services/batch/lib/models/jobListPreparationAndReleaseTaskStatusOptions.js index 9f5f485062..5e2ca50511 100644 --- a/lib/services/batch/lib/models/jobListPreparationAndReleaseTaskStatusOptions.js +++ b/lib/services/batch/lib/models/jobListPreparationAndReleaseTaskStatusOptions.js @@ -17,23 +17,24 @@ class JobListPreparationAndReleaseTaskStatusOptions { /** * Create a JobListPreparationAndReleaseTaskStatusOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. - * @member {string} [select] An OData $select clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 tasks can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 tasks can be returned. Default value: 1000 + * . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobManagerTask.js b/lib/services/batch/lib/models/jobManagerTask.js index 3f02c2397f..3d1216bb30 100644 --- a/lib/services/batch/lib/models/jobManagerTask.js +++ b/lib/services/batch/lib/models/jobManagerTask.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Specifies details of a Job Manager task. * @@ -43,15 +41,15 @@ const models = require('./index'); class JobManagerTask { /** * Create a JobManagerTask. - * @member {string} id A string that uniquely identifies the Job Manager task - * within the job. The ID can contain any combination of alphanumeric + * @property {string} id A string that uniquely identifies the Job Manager + * task within the job. The ID can contain any combination of alphanumeric * characters including hyphens and underscores and cannot contain more than * 64 characters. - * @member {string} [displayName] The display name of the Job Manager task. + * @property {string} [displayName] The display name of the Job Manager task. * It need not be unique and can contain any Unicode characters up to a * maximum length of 1024. - * @member {string} commandLine The command line of the Job Manager task. The - * command line does not run under a shell, and therefore cannot take + * @property {string} commandLine The command line of the Job Manager task. + * The command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you * want to take advantage of such features, you should invoke the shell in * the command line, for example using "cmd /c MyCommand" in Windows or @@ -59,28 +57,28 @@ class JobManagerTask { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the Job Manager task runs. If the pool that will run this task has - * containerConfiguration set, this must be set as well. If the pool that + * @property {object} [containerSettings] The settings for the container + * under which the Job Manager task runs. If the pool that will run this task + * has containerConfiguration set, this must be set as well. If the pool that * will run this task doesn't have containerConfiguration set, this must not * be set. When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image + * @property {string} [containerSettings.containerRunOptions] These + * additional options are supplied as arguments to the "docker create" + * command, in addition to those controlled by the Batch Service. + * @property {string} [containerSettings.imageName] This is the full image * reference, as would be specified to "docker pull". If no tag is provided * as part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted - * if was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, + * @property {object} [containerSettings.registry] This setting can be + * omitted if was already provided at pool creation. + * @property {string} [containerSettings.registry.registryServer] If omitted, * the default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service + * @property {string} [containerSettings.registry.userName] + * @property {string} [containerSettings.registry.password] + * @property {array} [resourceFiles] A list of files that the Batch service * will download to the compute node before running the command line. Files * listed under this element are located in the task's working directory. * There is a maximum size for the list of resource files. When the max size @@ -88,20 +86,20 @@ class JobManagerTask { * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [outputFiles] A list of files that the Batch service will - * upload from the compute node after running the command line. For + * @property {array} [outputFiles] A list of files that the Batch service + * will upload from the compute node after running the command line. For * multi-instance tasks, the files will only be uploaded from the compute * node on which the primary task is executed. - * @member {array} [environmentSettings] A list of environment variable + * @property {array} [environmentSettings] A list of environment variable * settings for the Job Manager task. - * @member {object} [constraints] Constraints that apply to the Job Manager + * @property {object} [constraints] Constraints that apply to the Job Manager * task. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not + * @property {moment.duration} [constraints.maxWallClockTime] If this is not * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 + * @property {moment.duration} [constraints.retentionTime] The default is 7 * days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries for the task executable due to * a nonzero exit code. The Batch service will try the task once, and may * then retry up to this limit. For example, if the maximum retry count is 3, @@ -109,7 +107,7 @@ class JobManagerTask { * maximum retry count is 0, the Batch service does not retry the task after * the first attempt. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {boolean} [killJobOnCompletion] Whether completion of the Job + * @property {boolean} [killJobOnCompletion] Whether completion of the Job * Manager task signifies completion of the entire job. If true, when the Job * Manager task completes, the Batch service marks the job as complete. If * any tasks are still running at this time (other than Job Release), those @@ -123,25 +121,25 @@ class JobManagerTask { * and using the Job Manager task only to create the tasks for the job (not * to monitor progress), then it is important to set killJobOnCompletion to * false. - * @member {object} [userIdentity] The user identity under which the Job + * @property {object} [userIdentity] The user identity under which the Job * Manager task runs. If omitted, the task runs as a non-administrative user * unique to the task. - * @member {string} [userIdentity.userName] The userName and autoUser + * @property {string} [userIdentity.userName] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser + * @property {object} [userIdentity.autoUser] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value - * is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [runExclusive] Whether the Job Manager task requires + * @property {string} [userIdentity.autoUser.scope] The default value is + * task. Possible values include: 'task', 'pool' + * @property {string} [userIdentity.autoUser.elevationLevel] The default + * value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @property {boolean} [runExclusive] Whether the Job Manager task requires * exclusive use of the compute node where it runs. If true, no other tasks * will run on the same compute node for as long as the Job Manager is * running. If false, other tasks can run simultaneously with the Job Manager * on a compute node. The Job Manager task counts normally against the node's * concurrent task limit, so this is only relevant if the node allows * multiple concurrent tasks. The default value is true. - * @member {array} [applicationPackageReferences] A list of application + * @property {array} [applicationPackageReferences] A list of application * packages that the Batch service will deploy to the compute node before * running the command line. Application packages are downloaded and deployed * to a shared directory, not the task working directory. Therefore, if a @@ -149,7 +147,7 @@ class JobManagerTask { * it is not re-downloaded; the existing copy on the compute node is used. If * a referenced application package cannot be installed, for example because * the package has been deleted or because download failed, the task fails. - * @member {object} [authenticationTokenSettings] The settings for an + * @property {object} [authenticationTokenSettings] The settings for an * authentication token that the task can use to perform Batch service * operations. If this property is set, the Batch service provides the task * with an authentication token which can be used to authenticate Batch @@ -159,13 +157,13 @@ class JobManagerTask { * settings. For example, a task can request job permissions in order to add * other tasks to the job, or check the status of the job or of other tasks * under the job. - * @member {array} [authenticationTokenSettings.access] The authentication + * @property {array} [authenticationTokenSettings.access] The authentication * token grants access to a limited set of Batch service operations. * Currently the only supported value for the access property is 'job', which * grants access to all operations related to the job which contains the * task. - * @member {boolean} [allowLowPriorityNode] Whether the Job Manager task may - * run on a low-priority compute node. The default value is true. + * @property {boolean} [allowLowPriorityNode] Whether the Job Manager task + * may run on a low-priority compute node. The default value is true. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobNetworkConfiguration.js b/lib/services/batch/lib/models/jobNetworkConfiguration.js index 80050fde8b..dc3206aa61 100644 --- a/lib/services/batch/lib/models/jobNetworkConfiguration.js +++ b/lib/services/batch/lib/models/jobNetworkConfiguration.js @@ -17,7 +17,7 @@ class JobNetworkConfiguration { /** * Create a JobNetworkConfiguration. - * @member {string} subnetId The ARM resource identifier of the virtual + * @property {string} subnetId The ARM resource identifier of the virtual * network subnet which nodes running tasks from the job will join for the * duration of the task. This is only supported for jobs running on * VirtualMachineConfiguration pools. This is of the form diff --git a/lib/services/batch/lib/models/jobPatchOptions.js b/lib/services/batch/lib/models/jobPatchOptions.js index aa29b58b78..1100acd216 100644 --- a/lib/services/batch/lib/models/jobPatchOptions.js +++ b/lib/services/batch/lib/models/jobPatchOptions.js @@ -17,30 +17,30 @@ class JobPatchOptions { /** * Create a JobPatchOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobPatchParameter.js b/lib/services/batch/lib/models/jobPatchParameter.js index 0e33ef465d..536fafff19 100644 --- a/lib/services/batch/lib/models/jobPatchParameter.js +++ b/lib/services/batch/lib/models/jobPatchParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The set of changes to be made to a job. * @@ -19,47 +17,47 @@ const models = require('./index'); class JobPatchParameter { /** * Create a JobPatchParameter. - * @member {number} [priority] The priority of the job. Priority values can + * @property {number} [priority] The priority of the job. Priority values can * range from -1000 to 1000, with -1000 being the lowest priority and 1000 * being the highest priority. If omitted, the priority of the job is left * unchanged. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in the job are in the completed state. 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). - * Possible values include: 'noAction', 'terminateJob' - * @member {object} [constraints] The execution constraints for the job. If + * @property {string} [onAllTasksComplete] The action the Batch service + * should take when all tasks in the job are in the completed state. 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). Possible values include: 'noAction', 'terminateJob' + * @property {object} [constraints] The execution constraints for the job. If * omitted, the existing execution constraints are left unchanged. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does + * @property {moment.duration} [constraints.maxWallClockTime] If the job does * not complete within the time limit, the Batch service terminates it and * any tasks that are still running. In this case, the termination reason * will be MaxWallClockTimeExpiry. If this property is not specified, there * is no time limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries. The Batch service will try * each task once, and may then retry up to this limit. For example, if the * maximum retry count is 3, Batch tries a task up to 4 times (one initial * try and 3 retries). If the maximum retry count is 0, the Batch service * does not retry tasks. If the maximum retry count is -1, the Batch service * retries tasks without limit. The default value is 0 (no retries). - * @member {object} [poolInfo] The pool on which the Batch service runs the + * @property {object} [poolInfo] The pool on which the Batch service runs the * job's tasks. You may change the pool for a job only when the job is * disabled. The Patch Job call will fail if you include the poolInfo element * and the job is not disabled. If you specify an autoPoolSpecification * specification in the poolInfo, only the keepAlive property can be updated, * and then only if the auto pool has a poolLifetimeOption of job. If * omitted, the job continues to run on its current pool. - * @member {string} [poolInfo.poolId] You must ensure that the pool + * @property {string} [poolInfo.poolId] You must ensure that the pool * referenced by this property exists. If the pool does not exist at the time * the Batch service tries to schedule a job, no tasks for the job will run * until you create a pool with that id. Note that the Batch service will not * reject the job request; it will simply not run tasks until the pool * exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation + * @property {object} [poolInfo.autoPoolSpecification] If auto pool creation * fails, the Batch service moves the job to a completed state, and the pool * creation error is set in the job's scheduling error property. The Batch * service manages the lifetime (both creation and, unless keepAlive is @@ -67,28 +65,28 @@ class JobPatchParameter { * lifetime of the auto pool while the job is active will result in * unexpected behavior. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The + * @property {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The * Batch service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] + * @property {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the + * @property {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, + * the Batch service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The + * @property {object} [poolInfo.autoPoolSpecification.pool] + * @property {string} [poolInfo.autoPoolSpecification.pool.displayName] The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For + * @property {string} [poolInfo.autoPoolSpecification.pool.vmSize] For * information about available sizes of virtual machines in pools, see Choose * a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This * property must be specified if the pool needs to be created with Azure PaaS * VMs. This property and virtualMachineConfiguration are mutually exclusive @@ -97,7 +95,7 @@ class JobPatchParameter { * directly, the HTTP status code is 400 (Bad Request). This property cannot * be specified if the Batch account was created with its poolAllocationMode * property set to 'UserSubscription'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] * Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -106,39 +104,39 @@ class JobPatchParameter { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] * The default value is * which specifies the latest operating system version * for the specified OS family. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This * property must be specified if the pool needs to be created with Azure IaaS * VMs. This property and cloudServiceConfiguration are mutually exclusive * and one of the properties must be specified. If neither is specified then * the Batch service returns an error; if you are calling the REST API * directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -147,14 +145,14 @@ class JobPatchParameter { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] * 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 @@ -166,7 +164,7 @@ class JobPatchParameter { * 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. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] * This only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -175,71 +173,71 @@ class JobPatchParameter { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size - * of the compute nodes in the pool (the vmSize setting). - * @member {object} + * @property {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] + * The default value is 1. The maximum value of this setting depends on the + * size of the compute nodes in the pool (the vmSize setting). + * @property {object} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] * Possible values include: 'spread', 'pack' - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies * only to manual scaling; it has no effect when enableAutoScale is set to * true. The default value is 15 minutes. The minimum value is 5 minutes. If * you specify a value less than 5 minutes, the Batch service rejects the * request with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is + * @property {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] + * If false, at least one of targetDedicateNodes and targetLowPriorityNodes + * must be specified. If true, the autoScaleFormula element is required. The + * pool automatically resizes according to the formula. The default value is * false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] + * @property {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] * This property must not be specified if enableAutoScale is set to false. It * is required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The * default value is 15 minutes. The minimum and maximum value are 5 minutes * and 168 hours respectively. If you specify a value less than 5 minutes or * greater than 168 hours, the Batch service rejects the request with an * invalid property value error; if you are calling the REST API directly, * the HTTP status code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] * Enabling inter-node communication limits the maximum size of the pool due * to deployment restrictions on the nodes of the pool. This may result in * the pool not reaching its desired size. The default value is false. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This * is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -253,20 +251,20 @@ class JobPatchParameter { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} + * @property {object} [poolInfo.autoPoolSpecification.pool.startTask] + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.commandLine] The command * line does not run under a shell, and therefore cannot take advantage of * shell features such as environment variable expansion. If you want to take @@ -276,56 +274,56 @@ class JobPatchParameter { * use a relative path (relative to the task working directory), or use the * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When * this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] * This is the full image reference, as would be specified to "docker pull". * If no tag is provided as part of the image name, the tag ":latest" is used * as a default. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] * This setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed * under this element are located in the task's working directory. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, * the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] * The default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The * Batch service retries a task if its exit code is nonzero. Note that this * value specifically controls the number of retries. The Batch service will @@ -334,7 +332,7 @@ class JobPatchParameter { * initial try and 3 retries). If the maximum retry count is 0, the Batch * service does not retry the task. If the maximum retry count is -1, the * Batch service retries the task without limit. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and * the start task fails on a compute node, the Batch service retries the * start task up to its maximum retry count (maxTaskRetryCount). If the task @@ -346,7 +344,7 @@ class JobPatchParameter { * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.certificateReferences] For Windows * compute nodes, the Batch service installs the certificates to the * specified certificate store and location. For Linux compute nodes, the @@ -356,20 +354,22 @@ class JobPatchParameter { * '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. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch - * service application licenses. If a license is requested which is not - * supported, pool creation will fail. The permitted licenses available on - * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge - * applies for each application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch + * @property {array} + * [poolInfo.autoPoolSpecification.pool.applicationLicenses] The list of + * application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, + * pool creation will fail. The permitted licenses available on the pool are + * 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each + * application license added to the pool. + * @property {array} [poolInfo.autoPoolSpecification.pool.userAccounts] + * @property {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch * service does not assign any meaning to metadata; it is solely for the use * of user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * job as metadata. If omitted, the existing job metadata is left unchanged. + * @property {array} [metadata] A list of name-value pairs associated with + * the job as metadata. If omitted, the existing job metadata is left + * unchanged. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobPreparationAndReleaseTaskExecutionInformation.js b/lib/services/batch/lib/models/jobPreparationAndReleaseTaskExecutionInformation.js index 5dc22950fc..00ff87b074 100644 --- a/lib/services/batch/lib/models/jobPreparationAndReleaseTaskExecutionInformation.js +++ b/lib/services/batch/lib/models/jobPreparationAndReleaseTaskExecutionInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The status of the Job Preparation and Job Release tasks on a * compute node. @@ -20,101 +18,101 @@ const models = require('./index'); class JobPreparationAndReleaseTaskExecutionInformation { /** * Create a JobPreparationAndReleaseTaskExecutionInformation. - * @member {string} [poolId] The ID of the pool containing the compute node + * @property {string} [poolId] The ID of the pool containing the compute node * to which this entry refers. - * @member {string} [nodeId] The ID of the compute node to which this entry - * refers. - * @member {string} [nodeUrl] The URL of the compute node to which this entry + * @property {string} [nodeId] The ID of the compute node to which this entry * refers. - * @member {object} [jobPreparationTaskExecutionInfo] Information about the + * @property {string} [nodeUrl] The URL of the compute node to which this + * entry refers. + * @property {object} [jobPreparationTaskExecutionInfo] Information about the * execution status of the Job Preparation task on this compute node. - * @member {date} [jobPreparationTaskExecutionInfo.startTime] If the task has - * been restarted or retried, this is the most recent time at which the task - * started running. - * @member {date} [jobPreparationTaskExecutionInfo.endTime] This property is - * set only if the task is in the Completed state. - * @member {string} [jobPreparationTaskExecutionInfo.state] Possible values + * @property {date} [jobPreparationTaskExecutionInfo.startTime] If the task + * has been restarted or retried, this is the most recent time at which the + * task started running. + * @property {date} [jobPreparationTaskExecutionInfo.endTime] This property + * is set only if the task is in the Completed state. + * @property {string} [jobPreparationTaskExecutionInfo.state] Possible values * include: 'running', 'completed' - * @member {string} [jobPreparationTaskExecutionInfo.taskRootDirectory] - * @member {string} [jobPreparationTaskExecutionInfo.taskRootDirectoryUrl] - * @member {number} [jobPreparationTaskExecutionInfo.exitCode] This parameter - * is returned only if the task is in the completed state. The exit code for - * a process reflects the specific convention implemented by the application - * developer for that process. If you use the exit code value to make - * decisions in your code, be sure that you know the exit code convention - * used by the application process. Note that the exit code may also be - * generated by the compute node operating system, such as when a process is - * forcibly terminated. - * @member {object} [jobPreparationTaskExecutionInfo.containerInfo] This + * @property {string} [jobPreparationTaskExecutionInfo.taskRootDirectory] + * @property {string} [jobPreparationTaskExecutionInfo.taskRootDirectoryUrl] + * @property {number} [jobPreparationTaskExecutionInfo.exitCode] This + * parameter is returned only if the task is in the completed state. The exit + * code for a process reflects the specific convention implemented by the + * application developer for that process. If you use the exit code value to + * make decisions in your code, be sure that you know the exit code + * convention used by the application process. Note that the exit code may + * also be generated by the compute node operating system, such as when a + * process is forcibly terminated. + * @property {object} [jobPreparationTaskExecutionInfo.containerInfo] This * property is set only if the task runs in a container context. - * @member {string} + * @property {string} * [jobPreparationTaskExecutionInfo.containerInfo.containerId] - * @member {string} [jobPreparationTaskExecutionInfo.containerInfo.state] + * @property {string} [jobPreparationTaskExecutionInfo.containerInfo.state] * This is the state of the container according to the Docker service. It is * equivalent to the status field returned by "docker inspect". - * @member {string} [jobPreparationTaskExecutionInfo.containerInfo.error] + * @property {string} [jobPreparationTaskExecutionInfo.containerInfo.error] * This is the detailed error string from the Docker service, if available. * It is equivalent to the error field returned by "docker inspect". - * @member {object} [jobPreparationTaskExecutionInfo.failureInfo] This + * @property {object} [jobPreparationTaskExecutionInfo.failureInfo] This * property is set only if the task is in the completed state and encountered * a failure. - * @member {string} [jobPreparationTaskExecutionInfo.failureInfo.category] + * @property {string} [jobPreparationTaskExecutionInfo.failureInfo.category] * Possible values include: 'userError', 'serverError' - * @member {string} [jobPreparationTaskExecutionInfo.failureInfo.code] - * @member {string} [jobPreparationTaskExecutionInfo.failureInfo.message] - * @member {array} [jobPreparationTaskExecutionInfo.failureInfo.details] - * @member {number} [jobPreparationTaskExecutionInfo.retryCount] Task + * @property {string} [jobPreparationTaskExecutionInfo.failureInfo.code] + * @property {string} [jobPreparationTaskExecutionInfo.failureInfo.message] + * @property {array} [jobPreparationTaskExecutionInfo.failureInfo.details] + * @property {number} [jobPreparationTaskExecutionInfo.retryCount] Task * application failures (non-zero exit code) are retried, pre-processing * errors (the task could not be run) and file upload errors are not retried. * The Batch service will retry the task up to the limit specified by the * constraints. - * @member {date} [jobPreparationTaskExecutionInfo.lastRetryTime] This + * @property {date} [jobPreparationTaskExecutionInfo.lastRetryTime] This * property is set only if the task was retried (i.e. retryCount is nonzero). * If present, this is typically the same as startTime, but may be different * if the task has been restarted for reasons other than retry; for example, * if the compute node was rebooted during a retry, then the startTime is * updated but the lastRetryTime is not. - * @member {string} [jobPreparationTaskExecutionInfo.result] If the value is - * 'failed', then the details of the failure can be found in the failureInfo - * property. Possible values include: 'success', 'failure' - * @member {object} [jobReleaseTaskExecutionInfo] Information about the + * @property {string} [jobPreparationTaskExecutionInfo.result] If the value + * is 'failed', then the details of the failure can be found in the + * failureInfo property. Possible values include: 'success', 'failure' + * @property {object} [jobReleaseTaskExecutionInfo] Information about the * execution status of the Job Release task on this compute node. This * property is set only if the Job Release task has run on the node. - * @member {date} [jobReleaseTaskExecutionInfo.startTime] If the task has + * @property {date} [jobReleaseTaskExecutionInfo.startTime] If the task has * been restarted or retried, this is the most recent time at which the task * started running. - * @member {date} [jobReleaseTaskExecutionInfo.endTime] This property is set - * only if the task is in the Completed state. - * @member {string} [jobReleaseTaskExecutionInfo.state] Possible values + * @property {date} [jobReleaseTaskExecutionInfo.endTime] This property is + * set only if the task is in the Completed state. + * @property {string} [jobReleaseTaskExecutionInfo.state] Possible values * include: 'running', 'completed' - * @member {string} [jobReleaseTaskExecutionInfo.taskRootDirectory] - * @member {string} [jobReleaseTaskExecutionInfo.taskRootDirectoryUrl] - * @member {number} [jobReleaseTaskExecutionInfo.exitCode] This parameter is - * returned only if the task is in the completed state. The exit code for a - * process reflects the specific convention implemented by the application + * @property {string} [jobReleaseTaskExecutionInfo.taskRootDirectory] + * @property {string} [jobReleaseTaskExecutionInfo.taskRootDirectoryUrl] + * @property {number} [jobReleaseTaskExecutionInfo.exitCode] This parameter + * is returned only if the task is in the completed state. The exit code for + * a process reflects the specific convention implemented by the application * developer for that process. If you use the exit code value to make * decisions in your code, be sure that you know the exit code convention * used by the application process. Note that the exit code may also be * generated by the compute node operating system, such as when a process is * forcibly terminated. - * @member {object} [jobReleaseTaskExecutionInfo.containerInfo] This property - * is set only if the task runs in a container context. - * @member {string} [jobReleaseTaskExecutionInfo.containerInfo.containerId] - * @member {string} [jobReleaseTaskExecutionInfo.containerInfo.state] This is - * the state of the container according to the Docker service. It is + * @property {object} [jobReleaseTaskExecutionInfo.containerInfo] This + * property is set only if the task runs in a container context. + * @property {string} [jobReleaseTaskExecutionInfo.containerInfo.containerId] + * @property {string} [jobReleaseTaskExecutionInfo.containerInfo.state] This + * is the state of the container according to the Docker service. It is * equivalent to the status field returned by "docker inspect". - * @member {string} [jobReleaseTaskExecutionInfo.containerInfo.error] This is - * the detailed error string from the Docker service, if available. It is + * @property {string} [jobReleaseTaskExecutionInfo.containerInfo.error] This + * is the detailed error string from the Docker service, if available. It is * equivalent to the error field returned by "docker inspect". - * @member {object} [jobReleaseTaskExecutionInfo.failureInfo] This property + * @property {object} [jobReleaseTaskExecutionInfo.failureInfo] This property * is set only if the task is in the completed state and encountered a * failure. - * @member {string} [jobReleaseTaskExecutionInfo.failureInfo.category] + * @property {string} [jobReleaseTaskExecutionInfo.failureInfo.category] * Possible values include: 'userError', 'serverError' - * @member {string} [jobReleaseTaskExecutionInfo.failureInfo.code] - * @member {string} [jobReleaseTaskExecutionInfo.failureInfo.message] - * @member {array} [jobReleaseTaskExecutionInfo.failureInfo.details] - * @member {string} [jobReleaseTaskExecutionInfo.result] If the value is + * @property {string} [jobReleaseTaskExecutionInfo.failureInfo.code] + * @property {string} [jobReleaseTaskExecutionInfo.failureInfo.message] + * @property {array} [jobReleaseTaskExecutionInfo.failureInfo.details] + * @property {string} [jobReleaseTaskExecutionInfo.result] If the value is * 'failed', then the details of the failure can be found in the failureInfo * property. Possible values include: 'success', 'failure' */ diff --git a/lib/services/batch/lib/models/jobPreparationTask.js b/lib/services/batch/lib/models/jobPreparationTask.js index 976504e2ec..2dfaf47288 100644 --- a/lib/services/batch/lib/models/jobPreparationTask.js +++ b/lib/services/batch/lib/models/jobPreparationTask.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A Job Preparation task to run before any tasks of the job on any * given compute node. @@ -48,7 +46,7 @@ const models = require('./index'); class JobPreparationTask { /** * Create a JobPreparationTask. - * @member {string} [id] A string that uniquely identifies the Job + * @property {string} [id] A string that uniquely identifies the Job * Preparation task within the job. The ID can contain any combination of * alphanumeric characters including hyphens and underscores and cannot * contain more than 64 characters. If you do not specify this property, the @@ -57,34 +55,34 @@ class JobPreparationTask { * submit a task with the same id, the Batch service rejects the request with * error code TaskIdSameAsJobPreparationTask; if you are calling the REST API * directly, the HTTP status code is 409 (Conflict). - * @member {string} commandLine The command line of the Job Preparation task. - * The command line does not run under a shell, and therefore cannot take - * advantage of shell features such as environment variable expansion. If you - * want to take advantage of such features, you should invoke the shell in - * the command line, for example using "cmd /c MyCommand" in Windows or - * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, - * it should use a relative path (relative to the task working directory), or - * use the Batch provided environment variable + * @property {string} commandLine The command line of the Job Preparation + * task. The command line does not run under a shell, and therefore cannot + * take advantage of shell features such as environment variable expansion. + * If you want to take advantage of such features, you should invoke the + * shell in the command line, for example using "cmd /c MyCommand" in Windows + * or "/bin/sh -c MyCommand" in Linux. If the command line refers to file + * paths, it should use a relative path (relative to the task working + * directory), or use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the Job Preparation task runs. When this is specified, all + * @property {object} [containerSettings] The settings for the container + * under which the Job Preparation task runs. When this is specified, all * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image + * @property {string} [containerSettings.containerRunOptions] These + * additional options are supplied as arguments to the "docker create" + * command, in addition to those controlled by the Batch Service. + * @property {string} [containerSettings.imageName] This is the full image * reference, as would be specified to "docker pull". If no tag is provided * as part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted - * if was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, + * @property {object} [containerSettings.registry] This setting can be + * omitted if was already provided at pool creation. + * @property {string} [containerSettings.registry.registryServer] If omitted, * the default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service + * @property {string} [containerSettings.registry.userName] + * @property {string} [containerSettings.registry.password] + * @property {array} [resourceFiles] A list of files that the Batch service * will download to the compute node before running the command line. Files * listed under this element are located in the task's working directory. * There is a maximum size for the list of resource files. When the max size @@ -92,16 +90,16 @@ class JobPreparationTask { * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [environmentSettings] A list of environment variable + * @property {array} [environmentSettings] A list of environment variable * settings for the Job Preparation task. - * @member {object} [constraints] Constraints that apply to the Job + * @property {object} [constraints] Constraints that apply to the Job * Preparation task. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not + * @property {moment.duration} [constraints.maxWallClockTime] If this is not * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 + * @property {moment.duration} [constraints.retentionTime] The default is 7 * days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries for the task executable due to * a nonzero exit code. The Batch service will try the task once, and may * then retry up to this limit. For example, if the maximum retry count is 3, @@ -109,7 +107,7 @@ class JobPreparationTask { * maximum retry count is 0, the Batch service does not retry the task after * the first attempt. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {boolean} [waitForSuccess] Whether the Batch service should wait + * @property {boolean} [waitForSuccess] Whether the Batch service should wait * for the Job Preparation task to complete successfully before scheduling * any other tasks of the job on the compute node. A Job Preparation task has * completed successfully if it exits with exit code 0. If true and the Job @@ -123,19 +121,19 @@ class JobPreparationTask { * start executing on the compute node while the Job Preparation task is * still running; and even if the Job Preparation task fails, new tasks will * continue to be scheduled on the node. The default value is true. - * @member {object} [userIdentity] The user identity under which the Job + * @property {object} [userIdentity] The user identity under which the Job * Preparation task runs. If omitted, the task runs as a non-administrative - * user unique to the task on Windows nodes, or a a non-administrative user + * user unique to the task on Windows nodes, or a non-administrative user * unique to the pool on Linux nodes. - * @member {string} [userIdentity.userName] The userName and autoUser + * @property {string} [userIdentity.userName] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser + * @property {object} [userIdentity.autoUser] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value - * is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [rerunOnNodeRebootAfterSuccess] Whether the Batch + * @property {string} [userIdentity.autoUser.scope] The default value is + * task. Possible values include: 'task', 'pool' + * @property {string} [userIdentity.autoUser.elevationLevel] The default + * value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @property {boolean} [rerunOnNodeRebootAfterSuccess] Whether the Batch * service should rerun the Job Preparation task after a compute node * reboots. The Job Preparation task is always rerun if a compute node is * reimaged, or if the Job Preparation task did not complete (e.g. because diff --git a/lib/services/batch/lib/models/jobPreparationTaskExecutionInformation.js b/lib/services/batch/lib/models/jobPreparationTaskExecutionInformation.js index 0747e64942..1867ea0004 100644 --- a/lib/services/batch/lib/models/jobPreparationTaskExecutionInformation.js +++ b/lib/services/batch/lib/models/jobPreparationTaskExecutionInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Contains information about the execution of a Job Preparation task * on a compute node. @@ -20,61 +18,61 @@ const models = require('./index'); class JobPreparationTaskExecutionInformation { /** * Create a JobPreparationTaskExecutionInformation. - * @member {date} startTime The time at which the task started running. If + * @property {date} startTime The time at which the task started running. If * the task has been restarted or retried, this is the most recent time at * which the task started running. - * @member {date} [endTime] The time at which the Job Preparation task + * @property {date} [endTime] The time at which the Job Preparation task * completed. This property is set only if the task is in the Completed * state. - * @member {string} state The current state of the Job Preparation task on + * @property {string} state The current state of the Job Preparation task on * the compute node. Possible values include: 'running', 'completed' - * @member {string} [taskRootDirectory] The root directory of the Job + * @property {string} [taskRootDirectory] The root directory of the Job * Preparation task on the compute node. You can use this path to retrieve * files created by the task, such as log files. - * @member {string} [taskRootDirectoryUrl] The URL to the root directory of + * @property {string} [taskRootDirectoryUrl] The URL to the root directory of * the Job Preparation task on the compute node. - * @member {number} [exitCode] The exit code of the program specified on the - * task command line. This parameter is returned only if the task is in the - * completed state. The exit code for a process reflects the specific + * @property {number} [exitCode] The exit code of the program specified on + * the task command line. This parameter is returned only if the task is in + * the completed state. The exit code for a process reflects the specific * convention implemented by the application developer for that process. If * you use the exit code value to make decisions in your code, be sure that * you know the exit code convention used by the application process. Note * that the exit code may also be generated by the compute node operating * system, such as when a process is forcibly terminated. - * @member {object} [containerInfo] Information about the container under + * @property {object} [containerInfo] Information about the container under * which the task is executing. This property is set only if the task runs in * a container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string + * @property {string} [containerInfo.containerId] + * @property {string} [containerInfo.state] This is the state of the + * container according to the Docker service. It is equivalent to the status + * field returned by "docker inspect". + * @property {string} [containerInfo.error] This is the detailed error string * from the Docker service, if available. It is equivalent to the error field * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: + * @property {object} [failureInfo] Information describing the task failure, + * if any. This property is set only if the task is in the completed state + * and encountered a failure. + * @property {string} [failureInfo.category] Possible values include: * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {number} retryCount The number of times the task has been retried - * by the Batch service. Task application failures (non-zero exit code) are - * retried, pre-processing errors (the task could not be run) and file upload - * errors are not retried. The Batch service will retry the task up to the - * limit specified by the constraints. Task application failures (non-zero - * exit code) are retried, pre-processing errors (the task could not be run) - * and file upload errors are not retried. The Batch service will retry the - * task up to the limit specified by the constraints. - * @member {date} [lastRetryTime] The most recent time at which a retry of + * @property {string} [failureInfo.code] + * @property {string} [failureInfo.message] + * @property {array} [failureInfo.details] + * @property {number} retryCount The number of times the task has been + * retried by the Batch service. Task application failures (non-zero exit + * code) are retried, pre-processing errors (the task could not be run) and + * file upload errors are not retried. The Batch service will retry the task + * up to the limit specified by the constraints. Task application failures + * (non-zero exit code) are retried, pre-processing errors (the task could + * not be run) and file upload errors are not retried. The Batch service will + * retry the task up to the limit specified by the constraints. + * @property {date} [lastRetryTime] The most recent time at which a retry of * the Job Preparation task started running. This property is set only if the * task was retried (i.e. retryCount is nonzero). If present, this is * typically the same as startTime, but may be different if the task has been * restarted for reasons other than retry; for example, if the compute node * was rebooted during a retry, then the startTime is updated but the * lastRetryTime is not. - * @member {string} [result] The result of the task execution. If the value + * @property {string} [result] The result of the task execution. If the value * is 'failed', then the details of the failure can be found in the * failureInfo property. Possible values include: 'success', 'failure' */ diff --git a/lib/services/batch/lib/models/jobReleaseTask.js b/lib/services/batch/lib/models/jobReleaseTask.js index 95312c18ad..84898e6f15 100644 --- a/lib/services/batch/lib/models/jobReleaseTask.js +++ b/lib/services/batch/lib/models/jobReleaseTask.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A Job Release task to run on job completion on any compute node * where the job has run. @@ -37,7 +35,7 @@ const models = require('./index'); class JobReleaseTask { /** * Create a JobReleaseTask. - * @member {string} [id] A string that uniquely identifies the Job Release + * @property {string} [id] A string that uniquely identifies the Job Release * task within the job. The ID can contain any combination of alphanumeric * characters including hyphens and underscores and cannot contain more than * 64 characters. If you do not specify this property, the Batch service @@ -46,8 +44,8 @@ class JobReleaseTask { * same id, the Batch service rejects the request with error code * TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the * HTTP status code is 409 (Conflict). - * @member {string} commandLine The command line of the Job Release task. The - * command line does not run under a shell, and therefore cannot take + * @property {string} commandLine The command line of the Job Release task. + * The command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you * want to take advantage of such features, you should invoke the shell in * the command line, for example using "cmd /c MyCommand" in Windows or @@ -55,25 +53,25 @@ class JobReleaseTask { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the Job Release task runs. When this is specified, all directories - * recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch - * directories on the node) are mapped into the container, all task - * environment variables are mapped into the container, and the task command - * line is executed in the container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image + * @property {object} [containerSettings] The settings for the container + * under which the Job Release task runs. When this is specified, all + * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * Azure Batch directories on the node) are mapped into the container, all + * task environment variables are mapped into the container, and the task + * command line is executed in the container. + * @property {string} [containerSettings.containerRunOptions] These + * additional options are supplied as arguments to the "docker create" + * command, in addition to those controlled by the Batch Service. + * @property {string} [containerSettings.imageName] This is the full image * reference, as would be specified to "docker pull". If no tag is provided * as part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted - * if was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, + * @property {object} [containerSettings.registry] This setting can be + * omitted if was already provided at pool creation. + * @property {string} [containerSettings.registry.registryServer] If omitted, * the default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service + * @property {string} [containerSettings.registry.userName] + * @property {string} [containerSettings.registry.password] + * @property {array} [resourceFiles] A list of files that the Batch service * will download to the compute node before running the command line. There * is a maximum size for the list of resource files. When the max size is * exceeded, the request will fail and the response error code will be @@ -81,31 +79,31 @@ class JobReleaseTask { * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. Files listed under this * element are located in the task's working directory. - * @member {array} [environmentSettings] A list of environment variable + * @property {array} [environmentSettings] A list of environment variable * settings for the Job Release task. - * @member {moment.duration} [maxWallClockTime] The maximum elapsed time that - * the Job Release task may run on a given compute node, measured from the - * time the task starts. If the task does not complete within the time limit, - * the Batch service terminates it. The default value is 15 minutes. You may - * not specify a timeout longer than 15 minutes. If you do, the Batch service - * rejects it with an error; if you are calling the REST API directly, the - * HTTP status code is 400 (Bad Request). - * @member {moment.duration} [retentionTime] The minimum time to retain the + * @property {moment.duration} [maxWallClockTime] The maximum elapsed time + * that the Job Release task may run on a given compute node, measured from + * the time the task starts. If the task does not complete within the time + * limit, the Batch service terminates it. The default value is 15 minutes. + * You may not specify a timeout longer than 15 minutes. If you do, the Batch + * service rejects it with an error; if you are calling the REST API + * directly, the HTTP status code is 400 (Bad Request). + * @property {moment.duration} [retentionTime] The minimum time to retain the * task directory for the Job Release task on the compute node. After this * time, the Batch service may delete the task directory and all its * contents. The default is 7 days, i.e. the task directory will be retained * for 7 days unless the compute node is removed or the job is deleted. - * @member {object} [userIdentity] The user identity under which the Job + * @property {object} [userIdentity] The user identity under which the Job * Release task runs. If omitted, the task runs as a non-administrative user * unique to the task. - * @member {string} [userIdentity.userName] The userName and autoUser + * @property {string} [userIdentity.userName] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser + * @property {object} [userIdentity.autoUser] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value - * is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @property {string} [userIdentity.autoUser.scope] The default value is + * task. Possible values include: 'task', 'pool' + * @property {string} [userIdentity.autoUser.elevationLevel] The default + * value is nonAdmin. Possible values include: 'nonAdmin', 'admin' */ constructor() { } diff --git a/lib/services/batch/lib/models/jobReleaseTaskExecutionInformation.js b/lib/services/batch/lib/models/jobReleaseTaskExecutionInformation.js index b25161cfc5..c8fd27fac6 100644 --- a/lib/services/batch/lib/models/jobReleaseTaskExecutionInformation.js +++ b/lib/services/batch/lib/models/jobReleaseTaskExecutionInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Contains information about the execution of a Job Release task on a * compute node. @@ -20,45 +18,46 @@ const models = require('./index'); class JobReleaseTaskExecutionInformation { /** * Create a JobReleaseTaskExecutionInformation. - * @member {date} startTime The time at which the task started running. If + * @property {date} startTime The time at which the task started running. If * the task has been restarted or retried, this is the most recent time at * which the task started running. - * @member {date} [endTime] The time at which the Job Release task completed. - * This property is set only if the task is in the Completed state. - * @member {string} state The current state of the Job Release task on the + * @property {date} [endTime] The time at which the Job Release task + * completed. This property is set only if the task is in the Completed + * state. + * @property {string} state The current state of the Job Release task on the * compute node. Possible values include: 'running', 'completed' - * @member {string} [taskRootDirectory] The root directory of the Job Release - * task on the compute node. You can use this path to retrieve files created - * by the task, such as log files. - * @member {string} [taskRootDirectoryUrl] The URL to the root directory of + * @property {string} [taskRootDirectory] The root directory of the Job + * Release task on the compute node. You can use this path to retrieve files + * created by the task, such as log files. + * @property {string} [taskRootDirectoryUrl] The URL to the root directory of * the Job Release task on the compute node. - * @member {number} [exitCode] The exit code of the program specified on the - * task command line. This parameter is returned only if the task is in the - * completed state. The exit code for a process reflects the specific + * @property {number} [exitCode] The exit code of the program specified on + * the task command line. This parameter is returned only if the task is in + * the completed state. The exit code for a process reflects the specific * convention implemented by the application developer for that process. If * you use the exit code value to make decisions in your code, be sure that * you know the exit code convention used by the application process. Note * that the exit code may also be generated by the compute node operating * system, such as when a process is forcibly terminated. - * @member {object} [containerInfo] Information about the container under + * @property {object} [containerInfo] Information about the container under * which the task is executing. This property is set only if the task runs in * a container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string + * @property {string} [containerInfo.containerId] + * @property {string} [containerInfo.state] This is the state of the + * container according to the Docker service. It is equivalent to the status + * field returned by "docker inspect". + * @property {string} [containerInfo.error] This is the detailed error string * from the Docker service, if available. It is equivalent to the error field * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: + * @property {object} [failureInfo] Information describing the task failure, + * if any. This property is set only if the task is in the completed state + * and encountered a failure. + * @property {string} [failureInfo.category] Possible values include: * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {string} [result] The result of the task execution. If the value + * @property {string} [failureInfo.code] + * @property {string} [failureInfo.message] + * @property {array} [failureInfo.details] + * @property {string} [result] The result of the task execution. If the value * is 'failed', then the details of the failure can be found in the * failureInfo property. Possible values include: 'success', 'failure' */ diff --git a/lib/services/batch/lib/models/jobScheduleAddOptions.js b/lib/services/batch/lib/models/jobScheduleAddOptions.js index 3d0d1c6cf7..0ecbabc29f 100644 --- a/lib/services/batch/lib/models/jobScheduleAddOptions.js +++ b/lib/services/batch/lib/models/jobScheduleAddOptions.js @@ -17,17 +17,17 @@ class JobScheduleAddOptions { /** * Create a JobScheduleAddOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobScheduleAddParameter.js b/lib/services/batch/lib/models/jobScheduleAddParameter.js index 3c8ddb9dbc..4fbace4eea 100644 --- a/lib/services/batch/lib/models/jobScheduleAddParameter.js +++ b/lib/services/batch/lib/models/jobScheduleAddParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A job schedule that allows recurring jobs by specifying when to run * jobs and a specification used to create each job. @@ -20,22 +18,22 @@ const models = require('./index'); class JobScheduleAddParameter { /** * Create a JobScheduleAddParameter. - * @member {string} id A string that uniquely identifies the schedule within - * the account. The ID can contain any combination of alphanumeric characters - * including hyphens and underscores, and cannot contain more than 64 - * characters. The ID is case-preserving and case-insensitive (that is, you - * may not have two IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the schedule. The + * @property {string} id A string that uniquely identifies the schedule + * within the account. The ID can contain any combination of alphanumeric + * characters including hyphens and underscores, and cannot contain more than + * 64 characters. The ID is case-preserving and case-insensitive (that is, + * you may not have two IDs within an account that differ only by case). + * @property {string} [displayName] The display name for the schedule. The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {object} schedule The schedule according to which jobs will be + * @property {object} schedule The schedule according to which jobs will be * created. - * @member {date} [schedule.doNotRunUntil] If you do not specify a + * @property {date} [schedule.doNotRunUntil] If you do not specify a * doNotRunUntil time, the schedule becomes ready to create jobs immediately. - * @member {date} [schedule.doNotRunAfter] If you do not specify a + * @property {date} [schedule.doNotRunAfter] If you do not specify a * doNotRunAfter time, and you are creating a recurring job schedule, the job * schedule will remain active until you explicitly terminate it. - * @member {moment.duration} [schedule.startWindow] If a job is not created + * @property {moment.duration} [schedule.startWindow] If a job is not created * within the startWindow interval, then the 'opportunity' is lost; no job * will be created until the next recurrence of the schedule. If the schedule * is recurring, and the startWindow is longer than the recurrence interval, @@ -45,7 +43,7 @@ class JobScheduleAddParameter { * minute. If you specify a lower value, the Batch service rejects the * schedule with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {moment.duration} [schedule.recurrenceInterval] Because a job + * @property {moment.duration} [schedule.recurrenceInterval] Because a job * schedule can have at most one active job under it at any given time, if it * is time to create a new job under a job schedule, but the previous job is * still running, the Batch service will not create the new job until the @@ -61,44 +59,46 @@ class JobScheduleAddParameter { * minute. If you specify a lower value, the Batch service rejects the * schedule with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {object} jobSpecification The details of the jobs to be created on - * this schedule. - * @member {number} [jobSpecification.priority] Priority values can range + * @property {object} jobSpecification The details of the jobs to be created + * on this schedule. + * @property {number} [jobSpecification.priority] Priority values can range * from -1000 to 1000, with -1000 being the lowest priority and 1000 being * the highest priority. The default value is 0. This priority is used as the * default for all jobs under the job schedule. You can update a job's * priority after it has been created using by using the update job API. - * @member {string} [jobSpecification.displayName] The name need not be + * @property {string} [jobSpecification.displayName] The name need not be * unique and can contain any Unicode characters up to a maximum length of * 1024. - * @member {boolean} [jobSpecification.usesTaskDependencies] - * @member {string} [jobSpecification.onAllTasksComplete] 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 + * @property {boolean} [jobSpecification.usesTaskDependencies] + * @property {string} [jobSpecification.onAllTasksComplete] 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. Possible values include: 'noAction', * 'terminateJob' - * @member {string} [jobSpecification.onTaskFailure] The default is noaction. - * Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [jobSpecification.networkConfiguration] - * @member {string} [jobSpecification.networkConfiguration.subnetId] This is - * only supported for jobs running on VirtualMachineConfiguration pools. This - * is of the form + * @property {string} [jobSpecification.onTaskFailure] The default is + * noaction. Possible values include: 'noAction', + * 'performExitOptionsJobAction' + * @property {object} [jobSpecification.networkConfiguration] + * @property {string} [jobSpecification.networkConfiguration.subnetId] This + * is only supported for jobs running on VirtualMachineConfiguration pools. + * This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the * Azure Batch account. The specified subnet should have enough free IP * addresses to accommodate the number of nodes which will run tasks from the * job. For more details, see * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [jobSpecification.constraints] - * @member {moment.duration} [jobSpecification.constraints.maxWallClockTime] - * If the job does not complete within the time limit, the Batch service - * terminates it and any tasks that are still running. In this case, the - * termination reason will be MaxWallClockTimeExpiry. If this property is not - * specified, there is no time limit on how long the job may run. - * @member {number} [jobSpecification.constraints.maxTaskRetryCount] Note + * @property {object} [jobSpecification.constraints] + * @property {moment.duration} + * [jobSpecification.constraints.maxWallClockTime] If the job does not + * complete within the time limit, the Batch service terminates it and any + * tasks that are still running. In this case, the termination reason will be + * MaxWallClockTimeExpiry. If this property is not specified, there is no + * time limit on how long the job may run. + * @property {number} [jobSpecification.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries. The Batch * service will try each task once, and may then retry up to this limit. For * example, if the maximum retry count is 3, Batch tries a task up to 4 times @@ -106,27 +106,27 @@ class JobScheduleAddParameter { * Batch service does not retry tasks. If the maximum retry count is -1, the * Batch service retries tasks without limit. The default value is 0 (no * retries). - * @member {object} [jobSpecification.jobManagerTask] If the job does not + * @property {object} [jobSpecification.jobManagerTask] If the job does not * specify a Job Manager task, the user must explicitly add tasks to the job * using the Task API. If the job does specify a Job Manager task, the Batch * service creates the Job Manager task when the job is created, and will try * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobSpecification.jobManagerTask.id] The ID can contain + * @property {string} [jobSpecification.jobManagerTask.id] The ID can contain * any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. - * @member {string} [jobSpecification.jobManagerTask.displayName] It need not - * be unique and can contain any Unicode characters up to a maximum length of - * 1024. - * @member {string} [jobSpecification.jobManagerTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should - * use a relative path (relative to the task working directory), or use the - * Batch provided environment variable + * @property {string} [jobSpecification.jobManagerTask.displayName] It need + * not be unique and can contain any Unicode characters up to a maximum + * length of 1024. + * @property {string} [jobSpecification.jobManagerTask.commandLine] The + * command line does not run under a shell, and therefore cannot take + * advantage of shell features such as environment variable expansion. If you + * want to take advantage of such features, you should invoke the shell in + * the command line, for example using "cmd /c MyCommand" in Windows or + * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, + * it should use a relative path (relative to the task working directory), or + * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobManagerTask.containerSettings] If + * @property {object} [jobSpecification.jobManagerTask.containerSettings] If * the pool that will run this task has containerConfiguration set, this must * be set as well. If the pool that will run this task doesn't have * containerConfiguration set, this must not be set. When this is specified, @@ -134,45 +134,45 @@ class JobScheduleAddParameter { * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.imageName] This is the * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobManagerTask.containerSettings.registry] This setting * can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobManagerTask.resourceFiles] Files + * @property {array} [jobSpecification.jobManagerTask.resourceFiles] Files * listed under this element are located in the task's working directory. * There is a maximum size for the list of resource files. When the max size * is exceeded, the request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobSpecification.jobManagerTask.outputFiles] For + * @property {array} [jobSpecification.jobManagerTask.outputFiles] For * multi-instance tasks, the files will only be uploaded from the compute * node on which the primary task is executed. - * @member {array} [jobSpecification.jobManagerTask.environmentSettings] - * @member {object} [jobSpecification.jobManagerTask.constraints] - * @member {moment.duration} + * @property {array} [jobSpecification.jobManagerTask.environmentSettings] + * @property {object} [jobSpecification.jobManagerTask.constraints] + * @property {moment.duration} * [jobSpecification.jobManagerTask.constraints.maxWallClockTime] If this is * not specified, there is no time limit on how long the task may run. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.jobManagerTask.constraints.retentionTime] The default is * 7 days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {number} + * @property {number} * [jobSpecification.jobManagerTask.constraints.maxTaskRetryCount] Note that * this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task @@ -181,11 +181,11 @@ class JobScheduleAddParameter { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] If - * true, when the Job Manager task completes, the Batch service marks the job - * as complete. If any tasks are still running at this time (other than Job - * Release), those tasks are terminated. If false, the completion of the Job - * Manager task does not affect the job status. In this case, you should + * @property {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] + * If true, when the Job Manager task completes, the Batch service marks the + * job as complete. If any tasks are still running at this time (other than + * Job Release), those tasks are terminated. If false, the completion of the + * Job Manager task does not affect the job status. In this case, you should * either use the onAllTasksComplete attribute to terminate the job, or have * a client or user terminate the job explicitly. An example of this is if * the Job Manager creates a set of tasks but then takes no further role in @@ -194,27 +194,27 @@ class JobScheduleAddParameter { * and using the Job Manager task only to create the tasks for the job (not * to monitor progress), then it is important to set killJobOnCompletion to * false. - * @member {object} [jobSpecification.jobManagerTask.userIdentity] If + * @property {object} [jobSpecification.jobManagerTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobManagerTask.userIdentity.userName] + * @property {string} [jobSpecification.jobManagerTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] + * @property {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.userIdentity.autoUser.scope] The default * value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobSpecification.jobManagerTask.runExclusive] If true, - * no other tasks will run on the same compute node for as long as the Job - * Manager is running. If false, other tasks can run simultaneously with the - * Job Manager on a compute node. The Job Manager task counts normally + * @property {boolean} [jobSpecification.jobManagerTask.runExclusive] If + * true, no other tasks will run on the same compute node for as long as the + * Job Manager is running. If false, other tasks can run simultaneously with + * the Job Manager on a compute node. The Job Manager task counts normally * against the node's concurrent task limit, so this is only relevant if the * node allows multiple concurrent tasks. The default value is true. - * @member {array} + * @property {array} * [jobSpecification.jobManagerTask.applicationPackageReferences] Application * packages are downloaded and deployed to a shared directory, not the task * working directory. Therefore, if a referenced package is already on the @@ -222,7 +222,7 @@ class JobScheduleAddParameter { * existing copy on the compute node is used. If a referenced application * package cannot be installed, for example because the package has been * deleted or because download failed, the task fails. - * @member {object} + * @property {object} * [jobSpecification.jobManagerTask.authenticationTokenSettings] If this * property is set, the Batch service provides the task with an * authentication token which can be used to authenticate Batch service @@ -231,18 +231,19 @@ class JobScheduleAddParameter { * that the task can carry out using the token depend on the settings. For * example, a task can request job permissions in order to add other tasks to * the job, or check the status of the job or of other tasks under the job. - * @member {array} + * @property {array} * [jobSpecification.jobManagerTask.authenticationTokenSettings.access] The * authentication token grants access to a limited set of Batch service * operations. Currently the only supported value for the access property is * 'job', which grants access to all operations related to the job which * contains the task. - * @member {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] + * @property {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] * The default value is true. - * @member {object} [jobSpecification.jobPreparationTask] If a job has a Job - * Preparation task, the Batch service will run the Job Preparation task on a - * compute node before starting any tasks of that job on that compute node. - * @member {string} [jobSpecification.jobPreparationTask.id] The ID can + * @property {object} [jobSpecification.jobPreparationTask] If a job has a + * Job Preparation task, the Batch service will run the Job Preparation task + * on a compute node before starting any tasks of that job on that compute + * node. + * @property {string} [jobSpecification.jobPreparationTask.id] The ID can * contain any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. If you do not * specify this property, the Batch service assigns a default value of @@ -251,7 +252,7 @@ class JobScheduleAddParameter { * service rejects the request with error code * TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, * the HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobPreparationTask.commandLine] The + * @property {string} [jobSpecification.jobPreparationTask.commandLine] The * command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you * want to take advantage of such features, you should invoke the shell in @@ -260,48 +261,49 @@ class JobScheduleAddParameter { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobPreparationTask.containerSettings] + * @property {object} [jobSpecification.jobPreparationTask.containerSettings] * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.imageName] This is * the full image reference, as would be specified to "docker pull". If no * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobPreparationTask.containerSettings.registry] This * setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobPreparationTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles - * must be reduced in size. This can be achieved using .zip files, - * Application Packages, or Docker Containers. - * @member {array} [jobSpecification.jobPreparationTask.environmentSettings] - * @member {object} [jobSpecification.jobPreparationTask.constraints] - * @member {moment.duration} + * @property {array} [jobSpecification.jobPreparationTask.resourceFiles] + * Files listed under this element are located in the task's working + * directory. There is a maximum size for the list of resource files. When + * the max size is exceeded, the request will fail and the response error + * code will be RequestEntityTooLarge. If this occurs, the collection of + * ResourceFiles must be reduced in size. This can be achieved using .zip + * files, Application Packages, or Docker Containers. + * @property {array} + * [jobSpecification.jobPreparationTask.environmentSettings] + * @property {object} [jobSpecification.jobPreparationTask.constraints] + * @property {moment.duration} * [jobSpecification.jobPreparationTask.constraints.maxWallClockTime] If this * is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.jobPreparationTask.constraints.retentionTime] The * default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} + * @property {number} * [jobSpecification.jobPreparationTask.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task @@ -310,8 +312,8 @@ class JobScheduleAddParameter { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] If - * true and the Job Preparation task fails on a compute node, the Batch + * @property {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] + * If true and the Job Preparation task fails on a compute node, the Batch * service retries the Job Preparation task up to its maximum retry count (as * specified in the constraints element). If the task has still not completed * successfully after all retries, then the Batch service will not schedule @@ -322,40 +324,40 @@ class JobScheduleAddParameter { * Preparation task is still running; and even if the Job Preparation task * fails, new tasks will continue to be scheduled on the node. The default * value is true. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity] If + * @property {object} [jobSpecification.jobPreparationTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task on - * Windows nodes, or a a non-administrative user unique to the pool on Linux + * Windows nodes, or a non-administrative user unique to the pool on Linux * nodes. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.userName] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {object} + * @property {object} * [jobSpecification.jobPreparationTask.userIdentity.autoUser] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.autoUser.scope] The * default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {boolean} + * @property {boolean} * [jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] The * Job Preparation task is always rerun if a compute node is reimaged, or if * the Job Preparation task did not complete (e.g. because the reboot * occurred while the task was running). Therefore, you should always write a * Job Preparation task to be idempotent and to behave correctly if run * multiple times. The default value is true. - * @member {object} [jobSpecification.jobReleaseTask] The primary purpose of - * the Job Release task is to undo changes to compute nodes made by the Job - * Preparation task. Example activities include deleting local files, or + * @property {object} [jobSpecification.jobReleaseTask] The primary purpose + * of the Job Release task is to undo changes to compute nodes made by the + * Job Preparation task. Example activities include deleting local files, or * shutting down services that were started as part of job preparation. A Job * Release task cannot be specified without also specifying a Job Preparation * task for the job. The Batch service runs the Job Release task on the * compute nodes that have run the Job Preparation task. - * @member {string} [jobSpecification.jobReleaseTask.id] The ID can contain + * @property {string} [jobSpecification.jobReleaseTask.id] The ID can contain * any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. If you do not * specify this property, the Batch service assigns a default value of @@ -364,108 +366,109 @@ class JobScheduleAddParameter { * service rejects the request with error code TaskIdSameAsJobReleaseTask; if * you are calling the REST API directly, the HTTP status code is 409 * (Conflict). - * @member {string} [jobSpecification.jobReleaseTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should - * use a relative path (relative to the task working directory), or use the - * Batch provided environment variable + * @property {string} [jobSpecification.jobReleaseTask.commandLine] The + * command line does not run under a shell, and therefore cannot take + * advantage of shell features such as environment variable expansion. If you + * want to take advantage of such features, you should invoke the shell in + * the command line, for example using "cmd /c MyCommand" in Windows or + * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, + * it should use a relative path (relative to the task working directory), or + * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobReleaseTask.containerSettings] When - * this is specified, all directories recursively below the + * @property {object} [jobSpecification.jobReleaseTask.containerSettings] + * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.imageName] This is the * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobReleaseTask.containerSettings.registry] This setting * can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobReleaseTask.resourceFiles] Files + * @property {array} [jobSpecification.jobReleaseTask.resourceFiles] Files * listed under this element are located in the task's working directory. - * @member {array} [jobSpecification.jobReleaseTask.environmentSettings] - * @member {moment.duration} + * @property {array} [jobSpecification.jobReleaseTask.environmentSettings] + * @property {moment.duration} * [jobSpecification.jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobSpecification.jobReleaseTask.retentionTime] - * The default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity] If + * @property {moment.duration} + * [jobSpecification.jobReleaseTask.retentionTime] The default is 7 days, + * i.e. the task directory will be retained for 7 days unless the compute + * node is removed or the job is deleted. + * @property {object} [jobSpecification.jobReleaseTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobReleaseTask.userIdentity.userName] + * @property {string} [jobSpecification.jobReleaseTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] + * @property {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.userIdentity.autoUser.scope] The default * value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [jobSpecification.commonEnvironmentSettings] Individual + * @property {array} [jobSpecification.commonEnvironmentSettings] Individual * tasks can override an environment setting specified here by specifying the * same setting name with a different value. - * @member {object} [jobSpecification.poolInfo] - * @member {string} [jobSpecification.poolInfo.poolId] You must ensure that + * @property {object} [jobSpecification.poolInfo] + * @property {string} [jobSpecification.poolInfo.poolId] You must ensure that * the pool referenced by this property exists. If the pool does not exist at * the time the Batch service tries to schedule a job, no tasks for the job * will run until you create a pool with that id. Note that the Batch service * will not reject the job request; it will simply not run tasks until the * pool exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification] If auto - * pool creation fails, the Batch service moves the job to a completed state, - * and the pool creation error is set in the job's scheduling error property. - * The Batch service manages the lifetime (both creation and, unless - * keepAlive is specified, deletion) of the auto pool. Any user actions that - * affect the lifetime of the auto pool while the job is active will result - * in unexpected behavior. You must specify either the pool ID or the auto - * pool specification, but not both. - * @member {string} + * @property {object} [jobSpecification.poolInfo.autoPoolSpecification] If + * auto pool creation fails, the Batch service moves the job to a completed + * state, and the pool creation error is set in the job's scheduling error + * property. The Batch service manages the lifetime (both creation and, + * unless keepAlive is specified, deletion) of the auto pool. Any user + * actions that affect the lifetime of the auto pool while the job is active + * will result in unexpected behavior. You must specify either the pool ID or + * the auto pool specification, but not both. + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.autoPoolIdPrefix] The * Batch service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.poolLifetimeOption] * Possible values include: 'jobSchedule', 'job' - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.keepAlive] If false, the * Batch service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] - * @member {string} + * @property {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.displayName] The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.vmSize] For * information about available sizes of virtual machines in pools, see Choose * a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] * This property must be specified if the pool needs to be created with Azure * PaaS VMs. This property and virtualMachineConfiguration are mutually @@ -474,7 +477,7 @@ class JobScheduleAddParameter { * REST API directly, the HTTP status code is 400 (Bad Request). This * property cannot be specified if the Batch account was created with its * poolAllocationMode property set to 'UserSubscription'. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] * Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -483,39 +486,39 @@ class JobScheduleAddParameter { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] * The default value is * which specifies the latest operating system version * for the specified OS family. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] * This property must be specified if the pool needs to be created with Azure * IaaS VMs. This property and cloudServiceConfiguration are mutually * exclusive and one of the properties must be specified. If neither is * specified then the Batch service returns an error; if you are calling the * REST API directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -524,14 +527,14 @@ class JobScheduleAddParameter { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] * 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 @@ -543,7 +546,7 @@ class JobScheduleAddParameter { * 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. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] * This only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -552,74 +555,74 @@ class JobScheduleAddParameter { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The * default value is 1. The maximum value of this setting depends on the size * of the compute nodes in the pool (the vmSize setting). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] * Possible values include: 'spread', 'pack' - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.poolInfo.autoPoolSpecification.pool.resizeTimeout] This * timeout applies only to manual scaling; it has no effect when * enableAutoScale is set to true. The default value is 15 minutes. The * minimum value is 5 minutes. If you specify a value less than 5 minutes, * the Batch service rejects the request with an error; if you are calling * the REST API directly, the HTTP status code is 400 (Bad Request). - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] * This property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] * This property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableAutoScale] If * false, at least one of targetDedicateNodes and targetLowPriorityNodes must * be specified. If true, the autoScaleFormula element is required. The pool * automatically resizes according to the formula. The default value is * false. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleFormula] * This property must not be specified if enableAutoScale is set to false. It * is required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] * The default value is 15 minutes. The minimum and maximum value are 5 * minutes and 168 hours respectively. If you specify a value less than 5 * minutes or greater than 168 hours, the Batch service rejects the request * with an invalid property value error; if you are calling the REST API * directly, the HTTP status code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] * Enabling inter-node communication limits the maximum size of the pool due * to deployment restrictions on the nodes of the pool. This may result in * the pool not reaching its desired size. The default value is false. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] * This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -633,21 +636,21 @@ class JobScheduleAddParameter { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.commandLine] * The command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you @@ -657,57 +660,57 @@ class JobScheduleAddParameter { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings] * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] * This is the full image reference, as would be specified to "docker pull". * If no tag is provided as part of the image name, the tag ":latest" is used * as a default. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] * This setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] * Files listed under this element are located in the task's working * directory. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity] * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] * The default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] * The Batch service retries a task if its exit code is nonzero. Note that * this value specifically controls the number of retries. The Batch service @@ -716,7 +719,7 @@ class JobScheduleAddParameter { * initial try and 3 retries). If the maximum retry count is 0, the Batch * service does not retry the task. If the maximum retry count is -1, the * Batch service retries the task without limit. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] * If true and the start task fails on a compute node, the Batch service * retries the start task up to its maximum retry count (maxTaskRetryCount). @@ -728,7 +731,7 @@ class JobScheduleAddParameter { * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.certificateReferences] * For Windows compute nodes, the Batch service installs the certificates to * the specified certificate store and location. For Linux compute nodes, the @@ -738,25 +741,25 @@ class JobScheduleAddParameter { * '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. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationLicenses] * The list of application licenses must be a subset of available Batch * service application licenses. If a license is requested which is not * supported, pool creation will fail. The permitted licenses available on * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge * applies for each application license added to the pool. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.metadata] The Batch * service does not assign any meaning to metadata; it is solely for the use * of user code. - * @member {array} [jobSpecification.metadata] The Batch service does not + * @property {array} [jobSpecification.metadata] The Batch service does not * assign any meaning to metadata; it is solely for the use of user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * schedule as metadata. The Batch service does not assign any meaning to + * @property {array} [metadata] A list of name-value pairs associated with + * the schedule as metadata. The Batch service does not assign any meaning to * metadata; it is solely for the use of user code. */ constructor() { diff --git a/lib/services/batch/lib/models/jobScheduleDeleteMethodOptions.js b/lib/services/batch/lib/models/jobScheduleDeleteMethodOptions.js index 3251b10d0f..fa99df0767 100644 --- a/lib/services/batch/lib/models/jobScheduleDeleteMethodOptions.js +++ b/lib/services/batch/lib/models/jobScheduleDeleteMethodOptions.js @@ -17,30 +17,30 @@ class JobScheduleDeleteMethodOptions { /** * Create a JobScheduleDeleteMethodOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobScheduleDisableOptions.js b/lib/services/batch/lib/models/jobScheduleDisableOptions.js index cf98213ff0..042dc88068 100644 --- a/lib/services/batch/lib/models/jobScheduleDisableOptions.js +++ b/lib/services/batch/lib/models/jobScheduleDisableOptions.js @@ -17,30 +17,30 @@ class JobScheduleDisableOptions { /** * Create a JobScheduleDisableOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobScheduleEnableOptions.js b/lib/services/batch/lib/models/jobScheduleEnableOptions.js index d11aa87fe4..c8200fb2e1 100644 --- a/lib/services/batch/lib/models/jobScheduleEnableOptions.js +++ b/lib/services/batch/lib/models/jobScheduleEnableOptions.js @@ -17,30 +17,30 @@ class JobScheduleEnableOptions { /** * Create a JobScheduleEnableOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobScheduleExecutionInformation.js b/lib/services/batch/lib/models/jobScheduleExecutionInformation.js index 5c6362783e..140ffed152 100644 --- a/lib/services/batch/lib/models/jobScheduleExecutionInformation.js +++ b/lib/services/batch/lib/models/jobScheduleExecutionInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Contains information about jobs that have been and will be run * under a job schedule. @@ -20,17 +18,17 @@ const models = require('./index'); class JobScheduleExecutionInformation { /** * Create a JobScheduleExecutionInformation. - * @member {date} [nextRunTime] The next time at which a job will be created - * under this schedule. This property is meaningful only if the schedule is - * in the active state when the time comes around. For example, if the - * schedule is disabled, no job will be created at nextRunTime unless the job - * is enabled before then. - * @member {object} [recentJob] Information about the most recent job under + * @property {date} [nextRunTime] The next time at which a job will be + * created under this schedule. This property is meaningful only if the + * schedule is in the active state when the time comes around. For example, + * if the schedule is disabled, no job will be created at nextRunTime unless + * the job is enabled before then. + * @property {object} [recentJob] Information about the most recent job under * the job schedule. This property is present only if the at least one job * has run under the schedule. - * @member {string} [recentJob.id] - * @member {string} [recentJob.url] - * @member {date} [endTime] The time at which the schedule ended. This + * @property {string} [recentJob.id] + * @property {string} [recentJob.url] + * @property {date} [endTime] The time at which the schedule ended. This * property is set only if the job schedule is in the completed state. */ constructor() { diff --git a/lib/services/batch/lib/models/jobScheduleExistsOptions.js b/lib/services/batch/lib/models/jobScheduleExistsOptions.js index 36c0af909d..258e27354d 100644 --- a/lib/services/batch/lib/models/jobScheduleExistsOptions.js +++ b/lib/services/batch/lib/models/jobScheduleExistsOptions.js @@ -17,30 +17,30 @@ class JobScheduleExistsOptions { /** * Create a JobScheduleExistsOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobScheduleGetOptions.js b/lib/services/batch/lib/models/jobScheduleGetOptions.js index e3f5d603d2..b679b8a536 100644 --- a/lib/services/batch/lib/models/jobScheduleGetOptions.js +++ b/lib/services/batch/lib/models/jobScheduleGetOptions.js @@ -17,32 +17,32 @@ class JobScheduleGetOptions { /** * Create a JobScheduleGetOptions. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {string} [expand] An OData $expand clause. + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobScheduleListNextOptions.js b/lib/services/batch/lib/models/jobScheduleListNextOptions.js index 20343f1ab8..bae18a5b57 100644 --- a/lib/services/batch/lib/models/jobScheduleListNextOptions.js +++ b/lib/services/batch/lib/models/jobScheduleListNextOptions.js @@ -17,14 +17,14 @@ class JobScheduleListNextOptions { /** * Create a JobScheduleListNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobScheduleListOptions.js b/lib/services/batch/lib/models/jobScheduleListOptions.js index 585367064b..23d1c8aeff 100644 --- a/lib/services/batch/lib/models/jobScheduleListOptions.js +++ b/lib/services/batch/lib/models/jobScheduleListOptions.js @@ -17,25 +17,25 @@ class JobScheduleListOptions { /** * Create a JobScheduleListOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 job schedules can be returned. Default value: - * 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {string} [expand] An OData $expand clause. + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 job schedules can be returned. Default + * value: 1000 . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobSchedulePatchOptions.js b/lib/services/batch/lib/models/jobSchedulePatchOptions.js index 5d37cd4823..7d1d103559 100644 --- a/lib/services/batch/lib/models/jobSchedulePatchOptions.js +++ b/lib/services/batch/lib/models/jobSchedulePatchOptions.js @@ -17,30 +17,30 @@ class JobSchedulePatchOptions { /** * Create a JobSchedulePatchOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobSchedulePatchParameter.js b/lib/services/batch/lib/models/jobSchedulePatchParameter.js index d49fd56baf..c4e69bce4f 100644 --- a/lib/services/batch/lib/models/jobSchedulePatchParameter.js +++ b/lib/services/batch/lib/models/jobSchedulePatchParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The set of changes to be made to a job schedule. * @@ -19,15 +17,15 @@ const models = require('./index'); class JobSchedulePatchParameter { /** * Create a JobSchedulePatchParameter. - * @member {object} [schedule] The schedule according to which jobs will be + * @property {object} [schedule] The schedule according to which jobs will be * created. If you do not specify this element, the existing schedule is left * unchanged. - * @member {date} [schedule.doNotRunUntil] If you do not specify a + * @property {date} [schedule.doNotRunUntil] If you do not specify a * doNotRunUntil time, the schedule becomes ready to create jobs immediately. - * @member {date} [schedule.doNotRunAfter] If you do not specify a + * @property {date} [schedule.doNotRunAfter] If you do not specify a * doNotRunAfter time, and you are creating a recurring job schedule, the job * schedule will remain active until you explicitly terminate it. - * @member {moment.duration} [schedule.startWindow] If a job is not created + * @property {moment.duration} [schedule.startWindow] If a job is not created * within the startWindow interval, then the 'opportunity' is lost; no job * will be created until the next recurrence of the schedule. If the schedule * is recurring, and the startWindow is longer than the recurrence interval, @@ -37,7 +35,7 @@ class JobSchedulePatchParameter { * minute. If you specify a lower value, the Batch service rejects the * schedule with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {moment.duration} [schedule.recurrenceInterval] Because a job + * @property {moment.duration} [schedule.recurrenceInterval] Because a job * schedule can have at most one active job under it at any given time, if it * is time to create a new job under a job schedule, but the previous job is * still running, the Batch service will not create the new job until the @@ -53,46 +51,48 @@ class JobSchedulePatchParameter { * minute. If you specify a lower value, the Batch service rejects the * schedule with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {object} [jobSpecification] The details of the jobs to be created - * on this schedule. Updates affect only jobs that are started after the - * update has taken place. Any currently active job continues with the older - * specification. - * @member {number} [jobSpecification.priority] Priority values can range + * @property {object} [jobSpecification] The details of the jobs to be + * created on this schedule. Updates affect only jobs that are started after + * the update has taken place. Any currently active job continues with the + * older specification. + * @property {number} [jobSpecification.priority] Priority values can range * from -1000 to 1000, with -1000 being the lowest priority and 1000 being * the highest priority. The default value is 0. This priority is used as the * default for all jobs under the job schedule. You can update a job's * priority after it has been created using by using the update job API. - * @member {string} [jobSpecification.displayName] The name need not be + * @property {string} [jobSpecification.displayName] The name need not be * unique and can contain any Unicode characters up to a maximum length of * 1024. - * @member {boolean} [jobSpecification.usesTaskDependencies] - * @member {string} [jobSpecification.onAllTasksComplete] 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 + * @property {boolean} [jobSpecification.usesTaskDependencies] + * @property {string} [jobSpecification.onAllTasksComplete] 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. Possible values include: 'noAction', * 'terminateJob' - * @member {string} [jobSpecification.onTaskFailure] The default is noaction. - * Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [jobSpecification.networkConfiguration] - * @member {string} [jobSpecification.networkConfiguration.subnetId] This is - * only supported for jobs running on VirtualMachineConfiguration pools. This - * is of the form + * @property {string} [jobSpecification.onTaskFailure] The default is + * noaction. Possible values include: 'noAction', + * 'performExitOptionsJobAction' + * @property {object} [jobSpecification.networkConfiguration] + * @property {string} [jobSpecification.networkConfiguration.subnetId] This + * is only supported for jobs running on VirtualMachineConfiguration pools. + * This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the * Azure Batch account. The specified subnet should have enough free IP * addresses to accommodate the number of nodes which will run tasks from the * job. For more details, see * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [jobSpecification.constraints] - * @member {moment.duration} [jobSpecification.constraints.maxWallClockTime] - * If the job does not complete within the time limit, the Batch service - * terminates it and any tasks that are still running. In this case, the - * termination reason will be MaxWallClockTimeExpiry. If this property is not - * specified, there is no time limit on how long the job may run. - * @member {number} [jobSpecification.constraints.maxTaskRetryCount] Note + * @property {object} [jobSpecification.constraints] + * @property {moment.duration} + * [jobSpecification.constraints.maxWallClockTime] If the job does not + * complete within the time limit, the Batch service terminates it and any + * tasks that are still running. In this case, the termination reason will be + * MaxWallClockTimeExpiry. If this property is not specified, there is no + * time limit on how long the job may run. + * @property {number} [jobSpecification.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries. The Batch * service will try each task once, and may then retry up to this limit. For * example, if the maximum retry count is 3, Batch tries a task up to 4 times @@ -100,27 +100,27 @@ class JobSchedulePatchParameter { * Batch service does not retry tasks. If the maximum retry count is -1, the * Batch service retries tasks without limit. The default value is 0 (no * retries). - * @member {object} [jobSpecification.jobManagerTask] If the job does not + * @property {object} [jobSpecification.jobManagerTask] If the job does not * specify a Job Manager task, the user must explicitly add tasks to the job * using the Task API. If the job does specify a Job Manager task, the Batch * service creates the Job Manager task when the job is created, and will try * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobSpecification.jobManagerTask.id] The ID can contain + * @property {string} [jobSpecification.jobManagerTask.id] The ID can contain * any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. - * @member {string} [jobSpecification.jobManagerTask.displayName] It need not - * be unique and can contain any Unicode characters up to a maximum length of - * 1024. - * @member {string} [jobSpecification.jobManagerTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should - * use a relative path (relative to the task working directory), or use the - * Batch provided environment variable + * @property {string} [jobSpecification.jobManagerTask.displayName] It need + * not be unique and can contain any Unicode characters up to a maximum + * length of 1024. + * @property {string} [jobSpecification.jobManagerTask.commandLine] The + * command line does not run under a shell, and therefore cannot take + * advantage of shell features such as environment variable expansion. If you + * want to take advantage of such features, you should invoke the shell in + * the command line, for example using "cmd /c MyCommand" in Windows or + * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, + * it should use a relative path (relative to the task working directory), or + * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobManagerTask.containerSettings] If + * @property {object} [jobSpecification.jobManagerTask.containerSettings] If * the pool that will run this task has containerConfiguration set, this must * be set as well. If the pool that will run this task doesn't have * containerConfiguration set, this must not be set. When this is specified, @@ -128,45 +128,45 @@ class JobSchedulePatchParameter { * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.imageName] This is the * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobManagerTask.containerSettings.registry] This setting * can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobManagerTask.resourceFiles] Files + * @property {array} [jobSpecification.jobManagerTask.resourceFiles] Files * listed under this element are located in the task's working directory. * There is a maximum size for the list of resource files. When the max size * is exceeded, the request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobSpecification.jobManagerTask.outputFiles] For + * @property {array} [jobSpecification.jobManagerTask.outputFiles] For * multi-instance tasks, the files will only be uploaded from the compute * node on which the primary task is executed. - * @member {array} [jobSpecification.jobManagerTask.environmentSettings] - * @member {object} [jobSpecification.jobManagerTask.constraints] - * @member {moment.duration} + * @property {array} [jobSpecification.jobManagerTask.environmentSettings] + * @property {object} [jobSpecification.jobManagerTask.constraints] + * @property {moment.duration} * [jobSpecification.jobManagerTask.constraints.maxWallClockTime] If this is * not specified, there is no time limit on how long the task may run. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.jobManagerTask.constraints.retentionTime] The default is * 7 days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {number} + * @property {number} * [jobSpecification.jobManagerTask.constraints.maxTaskRetryCount] Note that * this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task @@ -175,11 +175,11 @@ class JobSchedulePatchParameter { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] If - * true, when the Job Manager task completes, the Batch service marks the job - * as complete. If any tasks are still running at this time (other than Job - * Release), those tasks are terminated. If false, the completion of the Job - * Manager task does not affect the job status. In this case, you should + * @property {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] + * If true, when the Job Manager task completes, the Batch service marks the + * job as complete. If any tasks are still running at this time (other than + * Job Release), those tasks are terminated. If false, the completion of the + * Job Manager task does not affect the job status. In this case, you should * either use the onAllTasksComplete attribute to terminate the job, or have * a client or user terminate the job explicitly. An example of this is if * the Job Manager creates a set of tasks but then takes no further role in @@ -188,27 +188,27 @@ class JobSchedulePatchParameter { * and using the Job Manager task only to create the tasks for the job (not * to monitor progress), then it is important to set killJobOnCompletion to * false. - * @member {object} [jobSpecification.jobManagerTask.userIdentity] If + * @property {object} [jobSpecification.jobManagerTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobManagerTask.userIdentity.userName] + * @property {string} [jobSpecification.jobManagerTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] + * @property {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.userIdentity.autoUser.scope] The default * value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobSpecification.jobManagerTask.runExclusive] If true, - * no other tasks will run on the same compute node for as long as the Job - * Manager is running. If false, other tasks can run simultaneously with the - * Job Manager on a compute node. The Job Manager task counts normally + * @property {boolean} [jobSpecification.jobManagerTask.runExclusive] If + * true, no other tasks will run on the same compute node for as long as the + * Job Manager is running. If false, other tasks can run simultaneously with + * the Job Manager on a compute node. The Job Manager task counts normally * against the node's concurrent task limit, so this is only relevant if the * node allows multiple concurrent tasks. The default value is true. - * @member {array} + * @property {array} * [jobSpecification.jobManagerTask.applicationPackageReferences] Application * packages are downloaded and deployed to a shared directory, not the task * working directory. Therefore, if a referenced package is already on the @@ -216,7 +216,7 @@ class JobSchedulePatchParameter { * existing copy on the compute node is used. If a referenced application * package cannot be installed, for example because the package has been * deleted or because download failed, the task fails. - * @member {object} + * @property {object} * [jobSpecification.jobManagerTask.authenticationTokenSettings] If this * property is set, the Batch service provides the task with an * authentication token which can be used to authenticate Batch service @@ -225,18 +225,19 @@ class JobSchedulePatchParameter { * that the task can carry out using the token depend on the settings. For * example, a task can request job permissions in order to add other tasks to * the job, or check the status of the job or of other tasks under the job. - * @member {array} + * @property {array} * [jobSpecification.jobManagerTask.authenticationTokenSettings.access] The * authentication token grants access to a limited set of Batch service * operations. Currently the only supported value for the access property is * 'job', which grants access to all operations related to the job which * contains the task. - * @member {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] + * @property {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] * The default value is true. - * @member {object} [jobSpecification.jobPreparationTask] If a job has a Job - * Preparation task, the Batch service will run the Job Preparation task on a - * compute node before starting any tasks of that job on that compute node. - * @member {string} [jobSpecification.jobPreparationTask.id] The ID can + * @property {object} [jobSpecification.jobPreparationTask] If a job has a + * Job Preparation task, the Batch service will run the Job Preparation task + * on a compute node before starting any tasks of that job on that compute + * node. + * @property {string} [jobSpecification.jobPreparationTask.id] The ID can * contain any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. If you do not * specify this property, the Batch service assigns a default value of @@ -245,7 +246,7 @@ class JobSchedulePatchParameter { * service rejects the request with error code * TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, * the HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobPreparationTask.commandLine] The + * @property {string} [jobSpecification.jobPreparationTask.commandLine] The * command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you * want to take advantage of such features, you should invoke the shell in @@ -254,48 +255,49 @@ class JobSchedulePatchParameter { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobPreparationTask.containerSettings] + * @property {object} [jobSpecification.jobPreparationTask.containerSettings] * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.imageName] This is * the full image reference, as would be specified to "docker pull". If no * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobPreparationTask.containerSettings.registry] This * setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobPreparationTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles - * must be reduced in size. This can be achieved using .zip files, - * Application Packages, or Docker Containers. - * @member {array} [jobSpecification.jobPreparationTask.environmentSettings] - * @member {object} [jobSpecification.jobPreparationTask.constraints] - * @member {moment.duration} + * @property {array} [jobSpecification.jobPreparationTask.resourceFiles] + * Files listed under this element are located in the task's working + * directory. There is a maximum size for the list of resource files. When + * the max size is exceeded, the request will fail and the response error + * code will be RequestEntityTooLarge. If this occurs, the collection of + * ResourceFiles must be reduced in size. This can be achieved using .zip + * files, Application Packages, or Docker Containers. + * @property {array} + * [jobSpecification.jobPreparationTask.environmentSettings] + * @property {object} [jobSpecification.jobPreparationTask.constraints] + * @property {moment.duration} * [jobSpecification.jobPreparationTask.constraints.maxWallClockTime] If this * is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.jobPreparationTask.constraints.retentionTime] The * default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} + * @property {number} * [jobSpecification.jobPreparationTask.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task @@ -304,8 +306,8 @@ class JobSchedulePatchParameter { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] If - * true and the Job Preparation task fails on a compute node, the Batch + * @property {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] + * If true and the Job Preparation task fails on a compute node, the Batch * service retries the Job Preparation task up to its maximum retry count (as * specified in the constraints element). If the task has still not completed * successfully after all retries, then the Batch service will not schedule @@ -316,40 +318,40 @@ class JobSchedulePatchParameter { * Preparation task is still running; and even if the Job Preparation task * fails, new tasks will continue to be scheduled on the node. The default * value is true. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity] If + * @property {object} [jobSpecification.jobPreparationTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task on - * Windows nodes, or a a non-administrative user unique to the pool on Linux + * Windows nodes, or a non-administrative user unique to the pool on Linux * nodes. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.userName] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {object} + * @property {object} * [jobSpecification.jobPreparationTask.userIdentity.autoUser] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.autoUser.scope] The * default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {boolean} + * @property {boolean} * [jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] The * Job Preparation task is always rerun if a compute node is reimaged, or if * the Job Preparation task did not complete (e.g. because the reboot * occurred while the task was running). Therefore, you should always write a * Job Preparation task to be idempotent and to behave correctly if run * multiple times. The default value is true. - * @member {object} [jobSpecification.jobReleaseTask] The primary purpose of - * the Job Release task is to undo changes to compute nodes made by the Job - * Preparation task. Example activities include deleting local files, or + * @property {object} [jobSpecification.jobReleaseTask] The primary purpose + * of the Job Release task is to undo changes to compute nodes made by the + * Job Preparation task. Example activities include deleting local files, or * shutting down services that were started as part of job preparation. A Job * Release task cannot be specified without also specifying a Job Preparation * task for the job. The Batch service runs the Job Release task on the * compute nodes that have run the Job Preparation task. - * @member {string} [jobSpecification.jobReleaseTask.id] The ID can contain + * @property {string} [jobSpecification.jobReleaseTask.id] The ID can contain * any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. If you do not * specify this property, the Batch service assigns a default value of @@ -358,108 +360,109 @@ class JobSchedulePatchParameter { * service rejects the request with error code TaskIdSameAsJobReleaseTask; if * you are calling the REST API directly, the HTTP status code is 409 * (Conflict). - * @member {string} [jobSpecification.jobReleaseTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should - * use a relative path (relative to the task working directory), or use the - * Batch provided environment variable + * @property {string} [jobSpecification.jobReleaseTask.commandLine] The + * command line does not run under a shell, and therefore cannot take + * advantage of shell features such as environment variable expansion. If you + * want to take advantage of such features, you should invoke the shell in + * the command line, for example using "cmd /c MyCommand" in Windows or + * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, + * it should use a relative path (relative to the task working directory), or + * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobReleaseTask.containerSettings] When - * this is specified, all directories recursively below the + * @property {object} [jobSpecification.jobReleaseTask.containerSettings] + * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.imageName] This is the * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobReleaseTask.containerSettings.registry] This setting * can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobReleaseTask.resourceFiles] Files + * @property {array} [jobSpecification.jobReleaseTask.resourceFiles] Files * listed under this element are located in the task's working directory. - * @member {array} [jobSpecification.jobReleaseTask.environmentSettings] - * @member {moment.duration} + * @property {array} [jobSpecification.jobReleaseTask.environmentSettings] + * @property {moment.duration} * [jobSpecification.jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobSpecification.jobReleaseTask.retentionTime] - * The default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity] If + * @property {moment.duration} + * [jobSpecification.jobReleaseTask.retentionTime] The default is 7 days, + * i.e. the task directory will be retained for 7 days unless the compute + * node is removed or the job is deleted. + * @property {object} [jobSpecification.jobReleaseTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobReleaseTask.userIdentity.userName] + * @property {string} [jobSpecification.jobReleaseTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] + * @property {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.userIdentity.autoUser.scope] The default * value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [jobSpecification.commonEnvironmentSettings] Individual + * @property {array} [jobSpecification.commonEnvironmentSettings] Individual * tasks can override an environment setting specified here by specifying the * same setting name with a different value. - * @member {object} [jobSpecification.poolInfo] - * @member {string} [jobSpecification.poolInfo.poolId] You must ensure that + * @property {object} [jobSpecification.poolInfo] + * @property {string} [jobSpecification.poolInfo.poolId] You must ensure that * the pool referenced by this property exists. If the pool does not exist at * the time the Batch service tries to schedule a job, no tasks for the job * will run until you create a pool with that id. Note that the Batch service * will not reject the job request; it will simply not run tasks until the * pool exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification] If auto - * pool creation fails, the Batch service moves the job to a completed state, - * and the pool creation error is set in the job's scheduling error property. - * The Batch service manages the lifetime (both creation and, unless - * keepAlive is specified, deletion) of the auto pool. Any user actions that - * affect the lifetime of the auto pool while the job is active will result - * in unexpected behavior. You must specify either the pool ID or the auto - * pool specification, but not both. - * @member {string} + * @property {object} [jobSpecification.poolInfo.autoPoolSpecification] If + * auto pool creation fails, the Batch service moves the job to a completed + * state, and the pool creation error is set in the job's scheduling error + * property. The Batch service manages the lifetime (both creation and, + * unless keepAlive is specified, deletion) of the auto pool. Any user + * actions that affect the lifetime of the auto pool while the job is active + * will result in unexpected behavior. You must specify either the pool ID or + * the auto pool specification, but not both. + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.autoPoolIdPrefix] The * Batch service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.poolLifetimeOption] * Possible values include: 'jobSchedule', 'job' - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.keepAlive] If false, the * Batch service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] - * @member {string} + * @property {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.displayName] The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.vmSize] For * information about available sizes of virtual machines in pools, see Choose * a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] * This property must be specified if the pool needs to be created with Azure * PaaS VMs. This property and virtualMachineConfiguration are mutually @@ -468,7 +471,7 @@ class JobSchedulePatchParameter { * REST API directly, the HTTP status code is 400 (Bad Request). This * property cannot be specified if the Batch account was created with its * poolAllocationMode property set to 'UserSubscription'. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] * Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -477,39 +480,39 @@ class JobSchedulePatchParameter { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] * The default value is * which specifies the latest operating system version * for the specified OS family. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] * This property must be specified if the pool needs to be created with Azure * IaaS VMs. This property and cloudServiceConfiguration are mutually * exclusive and one of the properties must be specified. If neither is * specified then the Batch service returns an error; if you are calling the * REST API directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -518,14 +521,14 @@ class JobSchedulePatchParameter { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] * 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 @@ -537,7 +540,7 @@ class JobSchedulePatchParameter { * 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. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] * This only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -546,74 +549,74 @@ class JobSchedulePatchParameter { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The * default value is 1. The maximum value of this setting depends on the size * of the compute nodes in the pool (the vmSize setting). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] * Possible values include: 'spread', 'pack' - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.poolInfo.autoPoolSpecification.pool.resizeTimeout] This * timeout applies only to manual scaling; it has no effect when * enableAutoScale is set to true. The default value is 15 minutes. The * minimum value is 5 minutes. If you specify a value less than 5 minutes, * the Batch service rejects the request with an error; if you are calling * the REST API directly, the HTTP status code is 400 (Bad Request). - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] * This property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] * This property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableAutoScale] If * false, at least one of targetDedicateNodes and targetLowPriorityNodes must * be specified. If true, the autoScaleFormula element is required. The pool * automatically resizes according to the formula. The default value is * false. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleFormula] * This property must not be specified if enableAutoScale is set to false. It * is required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] * The default value is 15 minutes. The minimum and maximum value are 5 * minutes and 168 hours respectively. If you specify a value less than 5 * minutes or greater than 168 hours, the Batch service rejects the request * with an invalid property value error; if you are calling the REST API * directly, the HTTP status code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] * Enabling inter-node communication limits the maximum size of the pool due * to deployment restrictions on the nodes of the pool. This may result in * the pool not reaching its desired size. The default value is false. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] * This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -627,21 +630,21 @@ class JobSchedulePatchParameter { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.commandLine] * The command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you @@ -651,57 +654,57 @@ class JobSchedulePatchParameter { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings] * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] * This is the full image reference, as would be specified to "docker pull". * If no tag is provided as part of the image name, the tag ":latest" is used * as a default. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] * This setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] * Files listed under this element are located in the task's working * directory. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity] * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] * The default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] * The Batch service retries a task if its exit code is nonzero. Note that * this value specifically controls the number of retries. The Batch service @@ -710,7 +713,7 @@ class JobSchedulePatchParameter { * initial try and 3 retries). If the maximum retry count is 0, the Batch * service does not retry the task. If the maximum retry count is -1, the * Batch service retries the task without limit. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] * If true and the start task fails on a compute node, the Batch service * retries the start task up to its maximum retry count (maxTaskRetryCount). @@ -722,7 +725,7 @@ class JobSchedulePatchParameter { * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.certificateReferences] * For Windows compute nodes, the Batch service installs the certificates to * the specified certificate store and location. For Linux compute nodes, the @@ -732,25 +735,25 @@ class JobSchedulePatchParameter { * '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. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationLicenses] * The list of application licenses must be a subset of available Batch * service application licenses. If a license is requested which is not * supported, pool creation will fail. The permitted licenses available on * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge * applies for each application license added to the pool. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.metadata] The Batch * service does not assign any meaning to metadata; it is solely for the use * of user code. - * @member {array} [jobSpecification.metadata] The Batch service does not + * @property {array} [jobSpecification.metadata] The Batch service does not * assign any meaning to metadata; it is solely for the use of user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * job schedule as metadata. If you do not specify this element, existing + * @property {array} [metadata] A list of name-value pairs associated with + * the job schedule as metadata. If you do not specify this element, existing * metadata is left unchanged. */ constructor() { diff --git a/lib/services/batch/lib/models/jobScheduleStatistics.js b/lib/services/batch/lib/models/jobScheduleStatistics.js index 983e09a825..003595ba7e 100644 --- a/lib/services/batch/lib/models/jobScheduleStatistics.js +++ b/lib/services/batch/lib/models/jobScheduleStatistics.js @@ -17,44 +17,44 @@ class JobScheduleStatistics { /** * Create a JobScheduleStatistics. - * @member {string} url The URL of the statistics. - * @member {date} startTime The start time of the time range covered by the + * @property {string} url The URL of the statistics. + * @property {date} startTime The start time of the time range covered by the * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last + * @property {date} lastUpdateTime The time at which the statistics were last * updated. All statistics are limited to the range between startTime and * lastUpdateTime. - * @member {moment.duration} userCPUTime The total user mode CPU time (summed - * across all cores and all compute nodes) consumed by all tasks in all jobs - * created under the schedule. - * @member {moment.duration} kernelCPUTime The total kernel mode CPU time + * @property {moment.duration} userCPUTime The total user mode CPU time * (summed across all cores and all compute nodes) consumed by all tasks in * all jobs created under the schedule. - * @member {moment.duration} wallClockTime The total wall clock time of all + * @property {moment.duration} kernelCPUTime The total kernel mode CPU time + * (summed across all cores and all compute nodes) consumed by all tasks in + * all jobs created under the schedule. + * @property {moment.duration} wallClockTime The total wall clock time of all * the tasks in all the jobs created under the schedule. The wall clock time * is the elapsed time from when the task started running on a compute node * to when it finished (or to the last time the statistics were updated, if * the task had not finished by then). If a task was retried, this includes * the wall clock time of all the task retries. - * @member {number} readIOps The total number of disk read operations made by - * all tasks in all jobs created under the schedule. - * @member {number} writeIOps The total number of disk write operations made + * @property {number} readIOps The total number of disk read operations made * by all tasks in all jobs created under the schedule. - * @member {number} readIOGiB The total gibibytes read from disk by all tasks - * in all jobs created under the schedule. - * @member {number} writeIOGiB The total gibibytes written to disk by all + * @property {number} writeIOps The total number of disk write operations + * made by all tasks in all jobs created under the schedule. + * @property {number} readIOGiB The total gibibytes read from disk by all + * tasks in all jobs created under the schedule. + * @property {number} writeIOGiB The total gibibytes written to disk by all * tasks in all jobs created under the schedule. - * @member {number} numSucceededTasks The total number of tasks successfully - * completed during the given time range in jobs created under the schedule. - * A task completes successfully if it returns exit code 0. - * @member {number} numFailedTasks The total number of tasks that failed + * @property {number} numSucceededTasks The total number of tasks + * successfully completed during the given time range in jobs created under + * the schedule. A task completes successfully if it returns exit code 0. + * @property {number} numFailedTasks The total number of tasks that failed * during the given time range in jobs created under the schedule. A task * fails if it exhausts its maximum retry count without returning exit code * 0. - * @member {number} numTaskRetries The total number of retries during the + * @property {number} numTaskRetries The total number of retries during the * given time range on all tasks in all jobs created under the schedule. - * @member {moment.duration} waitTime The total wait time of all tasks in all - * jobs created under the schedule. The wait time for a task is defined as - * the elapsed time between the creation of the task and the start of task + * @property {moment.duration} waitTime The total wait time of all tasks in + * all jobs created under the schedule. The wait time for a task is defined + * as the elapsed time between the creation of the task and the start of task * execution. (If the task is retried due to failures, the wait time is the * time to the most recent task execution.). This value is only reported in * the account lifetime statistics; it is not included in the job statistics. diff --git a/lib/services/batch/lib/models/jobScheduleTerminateOptions.js b/lib/services/batch/lib/models/jobScheduleTerminateOptions.js index d759b71a3a..b9fca9cf80 100644 --- a/lib/services/batch/lib/models/jobScheduleTerminateOptions.js +++ b/lib/services/batch/lib/models/jobScheduleTerminateOptions.js @@ -17,30 +17,30 @@ class JobScheduleTerminateOptions { /** * Create a JobScheduleTerminateOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobScheduleUpdateOptions.js b/lib/services/batch/lib/models/jobScheduleUpdateOptions.js index a5f2bbb7a5..b973dd1cf3 100644 --- a/lib/services/batch/lib/models/jobScheduleUpdateOptions.js +++ b/lib/services/batch/lib/models/jobScheduleUpdateOptions.js @@ -17,30 +17,30 @@ class JobScheduleUpdateOptions { /** * Create a JobScheduleUpdateOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobScheduleUpdateParameter.js b/lib/services/batch/lib/models/jobScheduleUpdateParameter.js index ad969add9f..687456a3c4 100644 --- a/lib/services/batch/lib/models/jobScheduleUpdateParameter.js +++ b/lib/services/batch/lib/models/jobScheduleUpdateParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The set of changes to be made to a job schedule. * @@ -19,15 +17,15 @@ const models = require('./index'); class JobScheduleUpdateParameter { /** * Create a JobScheduleUpdateParameter. - * @member {object} schedule The schedule according to which jobs will be + * @property {object} schedule The schedule according to which jobs will be * created. If you do not specify this element, it is equivalent to passing * the default schedule: that is, a single job scheduled to run immediately. - * @member {date} [schedule.doNotRunUntil] If you do not specify a + * @property {date} [schedule.doNotRunUntil] If you do not specify a * doNotRunUntil time, the schedule becomes ready to create jobs immediately. - * @member {date} [schedule.doNotRunAfter] If you do not specify a + * @property {date} [schedule.doNotRunAfter] If you do not specify a * doNotRunAfter time, and you are creating a recurring job schedule, the job * schedule will remain active until you explicitly terminate it. - * @member {moment.duration} [schedule.startWindow] If a job is not created + * @property {moment.duration} [schedule.startWindow] If a job is not created * within the startWindow interval, then the 'opportunity' is lost; no job * will be created until the next recurrence of the schedule. If the schedule * is recurring, and the startWindow is longer than the recurrence interval, @@ -37,7 +35,7 @@ class JobScheduleUpdateParameter { * minute. If you specify a lower value, the Batch service rejects the * schedule with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {moment.duration} [schedule.recurrenceInterval] Because a job + * @property {moment.duration} [schedule.recurrenceInterval] Because a job * schedule can have at most one active job under it at any given time, if it * is time to create a new job under a job schedule, but the previous job is * still running, the Batch service will not create the new job until the @@ -53,46 +51,48 @@ class JobScheduleUpdateParameter { * minute. If you specify a lower value, the Batch service rejects the * schedule with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {object} jobSpecification Details of the jobs to be created on + * @property {object} jobSpecification Details of the jobs to be created on * this schedule. Updates affect only jobs that are started after the update * has taken place. Any currently active job continues with the older * specification. - * @member {number} [jobSpecification.priority] Priority values can range + * @property {number} [jobSpecification.priority] Priority values can range * from -1000 to 1000, with -1000 being the lowest priority and 1000 being * the highest priority. The default value is 0. This priority is used as the * default for all jobs under the job schedule. You can update a job's * priority after it has been created using by using the update job API. - * @member {string} [jobSpecification.displayName] The name need not be + * @property {string} [jobSpecification.displayName] The name need not be * unique and can contain any Unicode characters up to a maximum length of * 1024. - * @member {boolean} [jobSpecification.usesTaskDependencies] - * @member {string} [jobSpecification.onAllTasksComplete] 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 + * @property {boolean} [jobSpecification.usesTaskDependencies] + * @property {string} [jobSpecification.onAllTasksComplete] 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. Possible values include: 'noAction', * 'terminateJob' - * @member {string} [jobSpecification.onTaskFailure] The default is noaction. - * Possible values include: 'noAction', 'performExitOptionsJobAction' - * @member {object} [jobSpecification.networkConfiguration] - * @member {string} [jobSpecification.networkConfiguration.subnetId] This is - * only supported for jobs running on VirtualMachineConfiguration pools. This - * is of the form + * @property {string} [jobSpecification.onTaskFailure] The default is + * noaction. Possible values include: 'noAction', + * 'performExitOptionsJobAction' + * @property {object} [jobSpecification.networkConfiguration] + * @property {string} [jobSpecification.networkConfiguration.subnetId] This + * is only supported for jobs running on VirtualMachineConfiguration pools. + * This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the * Azure Batch account. The specified subnet should have enough free IP * addresses to accommodate the number of nodes which will run tasks from the * job. For more details, see * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [jobSpecification.constraints] - * @member {moment.duration} [jobSpecification.constraints.maxWallClockTime] - * If the job does not complete within the time limit, the Batch service - * terminates it and any tasks that are still running. In this case, the - * termination reason will be MaxWallClockTimeExpiry. If this property is not - * specified, there is no time limit on how long the job may run. - * @member {number} [jobSpecification.constraints.maxTaskRetryCount] Note + * @property {object} [jobSpecification.constraints] + * @property {moment.duration} + * [jobSpecification.constraints.maxWallClockTime] If the job does not + * complete within the time limit, the Batch service terminates it and any + * tasks that are still running. In this case, the termination reason will be + * MaxWallClockTimeExpiry. If this property is not specified, there is no + * time limit on how long the job may run. + * @property {number} [jobSpecification.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries. The Batch * service will try each task once, and may then retry up to this limit. For * example, if the maximum retry count is 3, Batch tries a task up to 4 times @@ -100,27 +100,27 @@ class JobScheduleUpdateParameter { * Batch service does not retry tasks. If the maximum retry count is -1, the * Batch service retries tasks without limit. The default value is 0 (no * retries). - * @member {object} [jobSpecification.jobManagerTask] If the job does not + * @property {object} [jobSpecification.jobManagerTask] If the job does not * specify a Job Manager task, the user must explicitly add tasks to the job * using the Task API. If the job does specify a Job Manager task, the Batch * service creates the Job Manager task when the job is created, and will try * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobSpecification.jobManagerTask.id] The ID can contain + * @property {string} [jobSpecification.jobManagerTask.id] The ID can contain * any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. - * @member {string} [jobSpecification.jobManagerTask.displayName] It need not - * be unique and can contain any Unicode characters up to a maximum length of - * 1024. - * @member {string} [jobSpecification.jobManagerTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should - * use a relative path (relative to the task working directory), or use the - * Batch provided environment variable + * @property {string} [jobSpecification.jobManagerTask.displayName] It need + * not be unique and can contain any Unicode characters up to a maximum + * length of 1024. + * @property {string} [jobSpecification.jobManagerTask.commandLine] The + * command line does not run under a shell, and therefore cannot take + * advantage of shell features such as environment variable expansion. If you + * want to take advantage of such features, you should invoke the shell in + * the command line, for example using "cmd /c MyCommand" in Windows or + * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, + * it should use a relative path (relative to the task working directory), or + * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobManagerTask.containerSettings] If + * @property {object} [jobSpecification.jobManagerTask.containerSettings] If * the pool that will run this task has containerConfiguration set, this must * be set as well. If the pool that will run this task doesn't have * containerConfiguration set, this must not be set. When this is specified, @@ -128,45 +128,45 @@ class JobScheduleUpdateParameter { * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.imageName] This is the * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobManagerTask.containerSettings.registry] This setting * can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobManagerTask.resourceFiles] Files + * @property {array} [jobSpecification.jobManagerTask.resourceFiles] Files * listed under this element are located in the task's working directory. * There is a maximum size for the list of resource files. When the max size * is exceeded, the request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobSpecification.jobManagerTask.outputFiles] For + * @property {array} [jobSpecification.jobManagerTask.outputFiles] For * multi-instance tasks, the files will only be uploaded from the compute * node on which the primary task is executed. - * @member {array} [jobSpecification.jobManagerTask.environmentSettings] - * @member {object} [jobSpecification.jobManagerTask.constraints] - * @member {moment.duration} + * @property {array} [jobSpecification.jobManagerTask.environmentSettings] + * @property {object} [jobSpecification.jobManagerTask.constraints] + * @property {moment.duration} * [jobSpecification.jobManagerTask.constraints.maxWallClockTime] If this is * not specified, there is no time limit on how long the task may run. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.jobManagerTask.constraints.retentionTime] The default is * 7 days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {number} + * @property {number} * [jobSpecification.jobManagerTask.constraints.maxTaskRetryCount] Note that * this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task @@ -175,11 +175,11 @@ class JobScheduleUpdateParameter { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] If - * true, when the Job Manager task completes, the Batch service marks the job - * as complete. If any tasks are still running at this time (other than Job - * Release), those tasks are terminated. If false, the completion of the Job - * Manager task does not affect the job status. In this case, you should + * @property {boolean} [jobSpecification.jobManagerTask.killJobOnCompletion] + * If true, when the Job Manager task completes, the Batch service marks the + * job as complete. If any tasks are still running at this time (other than + * Job Release), those tasks are terminated. If false, the completion of the + * Job Manager task does not affect the job status. In this case, you should * either use the onAllTasksComplete attribute to terminate the job, or have * a client or user terminate the job explicitly. An example of this is if * the Job Manager creates a set of tasks but then takes no further role in @@ -188,27 +188,27 @@ class JobScheduleUpdateParameter { * and using the Job Manager task only to create the tasks for the job (not * to monitor progress), then it is important to set killJobOnCompletion to * false. - * @member {object} [jobSpecification.jobManagerTask.userIdentity] If + * @property {object} [jobSpecification.jobManagerTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobManagerTask.userIdentity.userName] + * @property {string} [jobSpecification.jobManagerTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] + * @property {object} [jobSpecification.jobManagerTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.userIdentity.autoUser.scope] The default * value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobManagerTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobSpecification.jobManagerTask.runExclusive] If true, - * no other tasks will run on the same compute node for as long as the Job - * Manager is running. If false, other tasks can run simultaneously with the - * Job Manager on a compute node. The Job Manager task counts normally + * @property {boolean} [jobSpecification.jobManagerTask.runExclusive] If + * true, no other tasks will run on the same compute node for as long as the + * Job Manager is running. If false, other tasks can run simultaneously with + * the Job Manager on a compute node. The Job Manager task counts normally * against the node's concurrent task limit, so this is only relevant if the * node allows multiple concurrent tasks. The default value is true. - * @member {array} + * @property {array} * [jobSpecification.jobManagerTask.applicationPackageReferences] Application * packages are downloaded and deployed to a shared directory, not the task * working directory. Therefore, if a referenced package is already on the @@ -216,7 +216,7 @@ class JobScheduleUpdateParameter { * existing copy on the compute node is used. If a referenced application * package cannot be installed, for example because the package has been * deleted or because download failed, the task fails. - * @member {object} + * @property {object} * [jobSpecification.jobManagerTask.authenticationTokenSettings] If this * property is set, the Batch service provides the task with an * authentication token which can be used to authenticate Batch service @@ -225,18 +225,19 @@ class JobScheduleUpdateParameter { * that the task can carry out using the token depend on the settings. For * example, a task can request job permissions in order to add other tasks to * the job, or check the status of the job or of other tasks under the job. - * @member {array} + * @property {array} * [jobSpecification.jobManagerTask.authenticationTokenSettings.access] The * authentication token grants access to a limited set of Batch service * operations. Currently the only supported value for the access property is * 'job', which grants access to all operations related to the job which * contains the task. - * @member {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] + * @property {boolean} [jobSpecification.jobManagerTask.allowLowPriorityNode] * The default value is true. - * @member {object} [jobSpecification.jobPreparationTask] If a job has a Job - * Preparation task, the Batch service will run the Job Preparation task on a - * compute node before starting any tasks of that job on that compute node. - * @member {string} [jobSpecification.jobPreparationTask.id] The ID can + * @property {object} [jobSpecification.jobPreparationTask] If a job has a + * Job Preparation task, the Batch service will run the Job Preparation task + * on a compute node before starting any tasks of that job on that compute + * node. + * @property {string} [jobSpecification.jobPreparationTask.id] The ID can * contain any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. If you do not * specify this property, the Batch service assigns a default value of @@ -245,7 +246,7 @@ class JobScheduleUpdateParameter { * service rejects the request with error code * TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, * the HTTP status code is 409 (Conflict). - * @member {string} [jobSpecification.jobPreparationTask.commandLine] The + * @property {string} [jobSpecification.jobPreparationTask.commandLine] The * command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you * want to take advantage of such features, you should invoke the shell in @@ -254,48 +255,49 @@ class JobScheduleUpdateParameter { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobPreparationTask.containerSettings] + * @property {object} [jobSpecification.jobPreparationTask.containerSettings] * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.imageName] This is * the full image reference, as would be specified to "docker pull". If no * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobPreparationTask.containerSettings.registry] This * setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobPreparationTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * There is a maximum size for the list of resource files. When the max size - * is exceeded, the request will fail and the response error code will be - * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles - * must be reduced in size. This can be achieved using .zip files, - * Application Packages, or Docker Containers. - * @member {array} [jobSpecification.jobPreparationTask.environmentSettings] - * @member {object} [jobSpecification.jobPreparationTask.constraints] - * @member {moment.duration} + * @property {array} [jobSpecification.jobPreparationTask.resourceFiles] + * Files listed under this element are located in the task's working + * directory. There is a maximum size for the list of resource files. When + * the max size is exceeded, the request will fail and the response error + * code will be RequestEntityTooLarge. If this occurs, the collection of + * ResourceFiles must be reduced in size. This can be achieved using .zip + * files, Application Packages, or Docker Containers. + * @property {array} + * [jobSpecification.jobPreparationTask.environmentSettings] + * @property {object} [jobSpecification.jobPreparationTask.constraints] + * @property {moment.duration} * [jobSpecification.jobPreparationTask.constraints.maxWallClockTime] If this * is not specified, there is no time limit on how long the task may run. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.jobPreparationTask.constraints.retentionTime] The * default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} + * @property {number} * [jobSpecification.jobPreparationTask.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task @@ -304,8 +306,8 @@ class JobScheduleUpdateParameter { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] If - * true and the Job Preparation task fails on a compute node, the Batch + * @property {boolean} [jobSpecification.jobPreparationTask.waitForSuccess] + * If true and the Job Preparation task fails on a compute node, the Batch * service retries the Job Preparation task up to its maximum retry count (as * specified in the constraints element). If the task has still not completed * successfully after all retries, then the Batch service will not schedule @@ -316,40 +318,40 @@ class JobScheduleUpdateParameter { * Preparation task is still running; and even if the Job Preparation task * fails, new tasks will continue to be scheduled on the node. The default * value is true. - * @member {object} [jobSpecification.jobPreparationTask.userIdentity] If + * @property {object} [jobSpecification.jobPreparationTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task on - * Windows nodes, or a a non-administrative user unique to the pool on Linux + * Windows nodes, or a non-administrative user unique to the pool on Linux * nodes. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.userName] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {object} + * @property {object} * [jobSpecification.jobPreparationTask.userIdentity.autoUser] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.autoUser.scope] The * default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobPreparationTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {boolean} + * @property {boolean} * [jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] The * Job Preparation task is always rerun if a compute node is reimaged, or if * the Job Preparation task did not complete (e.g. because the reboot * occurred while the task was running). Therefore, you should always write a * Job Preparation task to be idempotent and to behave correctly if run * multiple times. The default value is true. - * @member {object} [jobSpecification.jobReleaseTask] The primary purpose of - * the Job Release task is to undo changes to compute nodes made by the Job - * Preparation task. Example activities include deleting local files, or + * @property {object} [jobSpecification.jobReleaseTask] The primary purpose + * of the Job Release task is to undo changes to compute nodes made by the + * Job Preparation task. Example activities include deleting local files, or * shutting down services that were started as part of job preparation. A Job * Release task cannot be specified without also specifying a Job Preparation * task for the job. The Batch service runs the Job Release task on the * compute nodes that have run the Job Preparation task. - * @member {string} [jobSpecification.jobReleaseTask.id] The ID can contain + * @property {string} [jobSpecification.jobReleaseTask.id] The ID can contain * any combination of alphanumeric characters including hyphens and * underscores and cannot contain more than 64 characters. If you do not * specify this property, the Batch service assigns a default value of @@ -358,108 +360,109 @@ class JobScheduleUpdateParameter { * service rejects the request with error code TaskIdSameAsJobReleaseTask; if * you are calling the REST API directly, the HTTP status code is 409 * (Conflict). - * @member {string} [jobSpecification.jobReleaseTask.commandLine] The command - * line does not run under a shell, and therefore cannot take advantage of - * shell features such as environment variable expansion. If you want to take - * advantage of such features, you should invoke the shell in the command - * line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c - * MyCommand" in Linux. If the command line refers to file paths, it should - * use a relative path (relative to the task working directory), or use the - * Batch provided environment variable + * @property {string} [jobSpecification.jobReleaseTask.commandLine] The + * command line does not run under a shell, and therefore cannot take + * advantage of shell features such as environment variable expansion. If you + * want to take advantage of such features, you should invoke the shell in + * the command line, for example using "cmd /c MyCommand" in Windows or + * "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, + * it should use a relative path (relative to the task working directory), or + * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobSpecification.jobReleaseTask.containerSettings] When - * this is specified, all directories recursively below the + * @property {object} [jobSpecification.jobReleaseTask.containerSettings] + * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.imageName] This is the * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [jobSpecification.jobReleaseTask.containerSettings.registry] This setting * can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobSpecification.jobReleaseTask.resourceFiles] Files + * @property {array} [jobSpecification.jobReleaseTask.resourceFiles] Files * listed under this element are located in the task's working directory. - * @member {array} [jobSpecification.jobReleaseTask.environmentSettings] - * @member {moment.duration} + * @property {array} [jobSpecification.jobReleaseTask.environmentSettings] + * @property {moment.duration} * [jobSpecification.jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobSpecification.jobReleaseTask.retentionTime] - * The default is 7 days, i.e. the task directory will be retained for 7 days - * unless the compute node is removed or the job is deleted. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity] If + * @property {moment.duration} + * [jobSpecification.jobReleaseTask.retentionTime] The default is 7 days, + * i.e. the task directory will be retained for 7 days unless the compute + * node is removed or the job is deleted. + * @property {object} [jobSpecification.jobReleaseTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} [jobSpecification.jobReleaseTask.userIdentity.userName] + * @property {string} [jobSpecification.jobReleaseTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] + * @property {object} [jobSpecification.jobReleaseTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.userIdentity.autoUser.scope] The default * value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.jobReleaseTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [jobSpecification.commonEnvironmentSettings] Individual + * @property {array} [jobSpecification.commonEnvironmentSettings] Individual * tasks can override an environment setting specified here by specifying the * same setting name with a different value. - * @member {object} [jobSpecification.poolInfo] - * @member {string} [jobSpecification.poolInfo.poolId] You must ensure that + * @property {object} [jobSpecification.poolInfo] + * @property {string} [jobSpecification.poolInfo.poolId] You must ensure that * the pool referenced by this property exists. If the pool does not exist at * the time the Batch service tries to schedule a job, no tasks for the job * will run until you create a pool with that id. Note that the Batch service * will not reject the job request; it will simply not run tasks until the * pool exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification] If auto - * pool creation fails, the Batch service moves the job to a completed state, - * and the pool creation error is set in the job's scheduling error property. - * The Batch service manages the lifetime (both creation and, unless - * keepAlive is specified, deletion) of the auto pool. Any user actions that - * affect the lifetime of the auto pool while the job is active will result - * in unexpected behavior. You must specify either the pool ID or the auto - * pool specification, but not both. - * @member {string} + * @property {object} [jobSpecification.poolInfo.autoPoolSpecification] If + * auto pool creation fails, the Batch service moves the job to a completed + * state, and the pool creation error is set in the job's scheduling error + * property. The Batch service manages the lifetime (both creation and, + * unless keepAlive is specified, deletion) of the auto pool. Any user + * actions that affect the lifetime of the auto pool while the job is active + * will result in unexpected behavior. You must specify either the pool ID or + * the auto pool specification, but not both. + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.autoPoolIdPrefix] The * Batch service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.poolLifetimeOption] * Possible values include: 'jobSchedule', 'job' - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.keepAlive] If false, the * Batch service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] - * @member {string} + * @property {object} [jobSpecification.poolInfo.autoPoolSpecification.pool] + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.displayName] The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.vmSize] For * information about available sizes of virtual machines in pools, see Choose * a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] * This property must be specified if the pool needs to be created with Azure * PaaS VMs. This property and virtualMachineConfiguration are mutually @@ -468,7 +471,7 @@ class JobScheduleUpdateParameter { * REST API directly, the HTTP status code is 400 (Bad Request). This * property cannot be specified if the Batch account was created with its * poolAllocationMode property set to 'UserSubscription'. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] * Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -477,39 +480,39 @@ class JobScheduleUpdateParameter { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] * The default value is * which specifies the latest operating system version * for the specified OS family. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] * This property must be specified if the pool needs to be created with Azure * IaaS VMs. This property and cloudServiceConfiguration are mutually * exclusive and one of the properties must be specified. If neither is * specified then the Batch service returns an error; if you are calling the * REST API directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -518,14 +521,14 @@ class JobScheduleUpdateParameter { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] * 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 @@ -537,7 +540,7 @@ class JobScheduleUpdateParameter { * 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. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] * This only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -546,74 +549,74 @@ class JobScheduleUpdateParameter { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The * default value is 1. The maximum value of this setting depends on the size * of the compute nodes in the pool (the vmSize setting). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] * Possible values include: 'spread', 'pack' - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.poolInfo.autoPoolSpecification.pool.resizeTimeout] This * timeout applies only to manual scaling; it has no effect when * enableAutoScale is set to true. The default value is 15 minutes. The * minimum value is 5 minutes. If you specify a value less than 5 minutes, * the Batch service rejects the request with an error; if you are calling * the REST API directly, the HTTP status code is 400 (Bad Request). - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] * This property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] * This property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableAutoScale] If * false, at least one of targetDedicateNodes and targetLowPriorityNodes must * be specified. If true, the autoScaleFormula element is required. The pool * automatically resizes according to the formula. The default value is * false. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleFormula] * This property must not be specified if enableAutoScale is set to false. It * is required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [jobSpecification.poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] * The default value is 15 minutes. The minimum and maximum value are 5 * minutes and 168 hours respectively. If you specify a value less than 5 * minutes or greater than 168 hours, the Batch service rejects the request * with an invalid property value error; if you are calling the REST API * directly, the HTTP status code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] * Enabling inter-node communication limits the maximum size of the pool due * to deployment restrictions on the nodes of the pool. This may result in * the pool not reaching its desired size. The default value is false. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] * This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -627,21 +630,21 @@ class JobScheduleUpdateParameter { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.commandLine] * The command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you @@ -651,57 +654,57 @@ class JobScheduleUpdateParameter { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings] * When this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] * This is the full image reference, as would be specified to "docker pull". * If no tag is provided as part of the image name, the tag ":latest" is used * as a default. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] * This setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] * Files listed under this element are located in the task's working * directory. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity] * If omitted, the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {object} + * @property {object} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] * The userName and autoUser properties are mutually exclusive; you must * specify one but not both. - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] * The default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} + * @property {number} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] * The Batch service retries a task if its exit code is nonzero. Note that * this value specifically controls the number of retries. The Batch service @@ -710,7 +713,7 @@ class JobScheduleUpdateParameter { * initial try and 3 retries). If the maximum retry count is 0, the Batch * service does not retry the task. If the maximum retry count is -1, the * Batch service retries the task without limit. - * @member {boolean} + * @property {boolean} * [jobSpecification.poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] * If true and the start task fails on a compute node, the Batch service * retries the start task up to its maximum retry count (maxTaskRetryCount). @@ -722,7 +725,7 @@ class JobScheduleUpdateParameter { * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.certificateReferences] * For Windows compute nodes, the Batch service installs the certificates to * the specified certificate store and location. For Linux compute nodes, the @@ -732,26 +735,26 @@ class JobScheduleUpdateParameter { * '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. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.applicationLicenses] * The list of application licenses must be a subset of available Batch * service application licenses. If a license is requested which is not * supported, pool creation will fail. The permitted licenses available on * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge * applies for each application license added to the pool. - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} + * @property {array} * [jobSpecification.poolInfo.autoPoolSpecification.pool.metadata] The Batch * service does not assign any meaning to metadata; it is solely for the use * of user code. - * @member {array} [jobSpecification.metadata] The Batch service does not + * @property {array} [jobSpecification.metadata] The Batch service does not * assign any meaning to metadata; it is solely for the use of user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * job schedule as metadata. If you do not specify this element, it takes the - * default value of an empty list; in effect, any existing metadata is + * @property {array} [metadata] A list of name-value pairs associated with + * the job schedule as metadata. If you do not specify this element, it takes + * the default value of an empty list; in effect, any existing metadata is * deleted. */ constructor() { diff --git a/lib/services/batch/lib/models/jobSchedulingError.js b/lib/services/batch/lib/models/jobSchedulingError.js index b1c728439f..97c272dbfa 100644 --- a/lib/services/batch/lib/models/jobSchedulingError.js +++ b/lib/services/batch/lib/models/jobSchedulingError.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An error encountered by the Batch service when scheduling a job. * @@ -19,13 +17,13 @@ const models = require('./index'); class JobSchedulingError { /** * Create a JobSchedulingError. - * @member {string} category The category of the job scheduling error. + * @property {string} category The category of the job scheduling error. * Possible values include: 'userError', 'serverError' - * @member {string} [code] An identifier for the job scheduling error. Codes - * are invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the job scheduling error, - * intended to be suitable for display in a user interface. - * @member {array} [details] A list of additional error details related to + * @property {string} [code] An identifier for the job scheduling error. + * Codes are invariant and are intended to be consumed programmatically. + * @property {string} [message] A message describing the job scheduling + * error, intended to be suitable for display in a user interface. + * @property {array} [details] A list of additional error details related to * the scheduling error. */ constructor() { diff --git a/lib/services/batch/lib/models/jobSpecification.js b/lib/services/batch/lib/models/jobSpecification.js index 4c1a835db3..69b7571697 100644 --- a/lib/services/batch/lib/models/jobSpecification.js +++ b/lib/services/batch/lib/models/jobSpecification.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Specifies details of the jobs to be created on a schedule. * @@ -19,19 +17,19 @@ const models = require('./index'); class JobSpecification { /** * Create a JobSpecification. - * @member {number} [priority] The priority of jobs created under this + * @property {number} [priority] The priority of jobs created under this * schedule. Priority values can range from -1000 to 1000, with -1000 being * the lowest priority and 1000 being the highest priority. The default value * is 0. This priority is used as the default for all jobs under the job * schedule. You can update a job's priority after it has been created using * by using the update job API. - * @member {string} [displayName] The display name for jobs created under + * @property {string} [displayName] The display name for jobs created under * this schedule. The name need not be unique and can contain any Unicode * characters up to a maximum length of 1024. - * @member {boolean} [usesTaskDependencies] Whether tasks in the job can + * @property {boolean} [usesTaskDependencies] Whether tasks in the job can * define dependencies on each other. The default is false. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in a job created under this schedule are in the + * @property {string} [onAllTasksComplete] The action the Batch service + * should take when all tasks in a job created under this schedule are in the * completed state. 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 @@ -39,17 +37,17 @@ class JobSpecification { * update the job properties to set onAllTasksComplete to terminatejob once * you have finished adding tasks. The default is noaction. Possible values * include: 'noAction', 'terminateJob' - * @member {string} [onTaskFailure] The action the Batch service should take - * when any task fails in a job created under this schedule. A task is + * @property {string} [onTaskFailure] 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. The default is * noaction. Possible values include: 'noAction', * 'performExitOptionsJobAction' - * @member {object} [networkConfiguration] The network configuration for the - * job. - * @member {string} [networkConfiguration.subnetId] This is only supported + * @property {object} [networkConfiguration] The network configuration for + * the job. + * @property {string} [networkConfiguration.subnetId] This is only supported * for jobs running on VirtualMachineConfiguration pools. This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the @@ -57,32 +55,32 @@ class JobSpecification { * addresses to accommodate the number of nodes which will run tasks from the * job. For more details, see * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. - * @member {object} [constraints] The execution constraints for jobs created - * under this schedule. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does + * @property {object} [constraints] The execution constraints for jobs + * created under this schedule. + * @property {moment.duration} [constraints.maxWallClockTime] If the job does * not complete within the time limit, the Batch service terminates it and * any tasks that are still running. In this case, the termination reason * will be MaxWallClockTimeExpiry. If this property is not specified, there * is no time limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries. The Batch service will try * each task once, and may then retry up to this limit. For example, if the * maximum retry count is 3, Batch tries a task up to 4 times (one initial * try and 3 retries). If the maximum retry count is 0, the Batch service * does not retry tasks. If the maximum retry count is -1, the Batch service * retries tasks without limit. The default value is 0 (no retries). - * @member {object} [jobManagerTask] The details of a Job Manager task to be - * launched when a job is started under this schedule. If the job does not + * @property {object} [jobManagerTask] The details of a Job Manager task to + * be launched when a job is started under this schedule. If the job does not * specify a Job Manager task, the user must explicitly add tasks to the job * using the Task API. If the job does specify a Job Manager task, the Batch * service creates the Job Manager task when the job is created, and will try * to schedule the Job Manager task before scheduling other tasks in the job. - * @member {string} [jobManagerTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot + * @property {string} [jobManagerTask.id] The ID can contain any combination + * of alphanumeric characters including hyphens and underscores and cannot * contain more than 64 characters. - * @member {string} [jobManagerTask.displayName] It need not be unique and + * @property {string} [jobManagerTask.displayName] It need not be unique and * can contain any Unicode characters up to a maximum length of 1024. - * @member {string} [jobManagerTask.commandLine] The command line does not + * @property {string} [jobManagerTask.commandLine] The command line does not * run under a shell, and therefore cannot take advantage of shell features * such as environment variable expansion. If you want to take advantage of * such features, you should invoke the shell in the command line, for @@ -91,55 +89,55 @@ class JobSpecification { * path (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobManagerTask.containerSettings] If the pool that will - * run this task has containerConfiguration set, this must be set as well. If - * the pool that will run this task doesn't have containerConfiguration set, - * this must not be set. When this is specified, all directories recursively - * below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on - * the node) are mapped into the container, all task environment variables - * are mapped into the container, and the task command line is executed in - * the container. - * @member {string} [jobManagerTask.containerSettings.containerRunOptions] + * @property {object} [jobManagerTask.containerSettings] If the pool that + * will run this task has containerConfiguration set, this must be set as + * well. If the pool that will run this task doesn't have + * containerConfiguration set, this must not be set. When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * Azure Batch directories on the node) are mapped into the container, all + * task environment variables are mapped into the container, and the task + * command line is executed in the container. + * @property {string} [jobManagerTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [jobManagerTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a + * @property {string} [jobManagerTask.containerSettings.imageName] This is + * the full image reference, as would be specified to "docker pull". If no + * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [jobManagerTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} + * @property {object} [jobManagerTask.containerSettings.registry] This + * setting can be omitted if was already provided at pool creation. + * @property {string} * [jobManagerTask.containerSettings.registry.registryServer] If omitted, the * default is "docker.io". - * @member {string} [jobManagerTask.containerSettings.registry.userName] - * @member {string} [jobManagerTask.containerSettings.registry.password] - * @member {array} [jobManagerTask.resourceFiles] Files listed under this + * @property {string} [jobManagerTask.containerSettings.registry.userName] + * @property {string} [jobManagerTask.containerSettings.registry.password] + * @property {array} [jobManagerTask.resourceFiles] Files listed under this * element are located in the task's working directory. There is a maximum * size for the list of resource files. When the max size is exceeded, the * request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobManagerTask.outputFiles] For multi-instance tasks, the - * files will only be uploaded from the compute node on which the primary + * @property {array} [jobManagerTask.outputFiles] For multi-instance tasks, + * the files will only be uploaded from the compute node on which the primary * task is executed. - * @member {array} [jobManagerTask.environmentSettings] - * @member {object} [jobManagerTask.constraints] - * @member {moment.duration} [jobManagerTask.constraints.maxWallClockTime] If - * this is not specified, there is no time limit on how long the task may + * @property {array} [jobManagerTask.environmentSettings] + * @property {object} [jobManagerTask.constraints] + * @property {moment.duration} [jobManagerTask.constraints.maxWallClockTime] + * If this is not specified, there is no time limit on how long the task may * run. - * @member {moment.duration} [jobManagerTask.constraints.retentionTime] The + * @property {moment.duration} [jobManagerTask.constraints.retentionTime] The * default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} [jobManagerTask.constraints.maxTaskRetryCount] Note that - * this value specifically controls the number of retries for the task + * @property {number} [jobManagerTask.constraints.maxTaskRetryCount] Note + * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task * once, and may then retry up to this limit. For example, if the maximum * retry count is 3, Batch tries the task up to 4 times (one initial try and * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobManagerTask.killJobOnCompletion] If true, when the + * @property {boolean} [jobManagerTask.killJobOnCompletion] If true, when the * Job Manager task completes, the Batch service marks the job as complete. * If any tasks are still running at this time (other than Job Release), * those tasks are terminated. If false, the completion of the Job Manager @@ -152,32 +150,33 @@ class JobSpecification { * and using the Job Manager task only to create the tasks for the job (not * to monitor progress), then it is important to set killJobOnCompletion to * false. - * @member {object} [jobManagerTask.userIdentity] If omitted, the task runs + * @property {object} [jobManagerTask.userIdentity] If omitted, the task runs * as a non-administrative user unique to the task. - * @member {string} [jobManagerTask.userIdentity.userName] The userName and + * @property {string} [jobManagerTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [jobManagerTask.userIdentity.autoUser] The userName and + * @property {object} [jobManagerTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [jobManagerTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {boolean} [jobManagerTask.runExclusive] If true, no other tasks + * @property {string} [jobManagerTask.userIdentity.autoUser.scope] The + * default value is task. Possible values include: 'task', 'pool' + * @property {string} [jobManagerTask.userIdentity.autoUser.elevationLevel] + * The default value is nonAdmin. Possible values include: 'nonAdmin', + * 'admin' + * @property {boolean} [jobManagerTask.runExclusive] If true, no other tasks * will run on the same compute node for as long as the Job Manager is * running. If false, other tasks can run simultaneously with the Job Manager * on a compute node. The Job Manager task counts normally against the node's * concurrent task limit, so this is only relevant if the node allows * multiple concurrent tasks. The default value is true. - * @member {array} [jobManagerTask.applicationPackageReferences] Application - * packages are downloaded and deployed to a shared directory, not the task - * working directory. Therefore, if a referenced package is already on the - * compute node, and is up to date, then it is not re-downloaded; the - * existing copy on the compute node is used. If a referenced application - * package cannot be installed, for example because the package has been - * deleted or because download failed, the task fails. - * @member {object} [jobManagerTask.authenticationTokenSettings] If this + * @property {array} [jobManagerTask.applicationPackageReferences] + * Application packages are downloaded and deployed to a shared directory, + * not the task working directory. Therefore, if a referenced package is + * already on the compute node, and is up to date, then it is not + * re-downloaded; the existing copy on the compute node is used. If a + * referenced application package cannot be installed, for example because + * the package has been deleted or because download failed, the task fails. + * @property {object} [jobManagerTask.authenticationTokenSettings] If this * property is set, the Batch service provides the task with an * authentication token which can be used to authenticate Batch service * operations without requiring an account access key. The token is provided @@ -185,18 +184,18 @@ class JobSpecification { * that the task can carry out using the token depend on the settings. For * example, a task can request job permissions in order to add other tasks to * the job, or check the status of the job or of other tasks under the job. - * @member {array} [jobManagerTask.authenticationTokenSettings.access] The + * @property {array} [jobManagerTask.authenticationTokenSettings.access] The * authentication token grants access to a limited set of Batch service * operations. Currently the only supported value for the access property is * 'job', which grants access to all operations related to the job which * contains the task. - * @member {boolean} [jobManagerTask.allowLowPriorityNode] The default value - * is true. - * @member {object} [jobPreparationTask] The Job Preparation task for jobs + * @property {boolean} [jobManagerTask.allowLowPriorityNode] The default + * value is true. + * @property {object} [jobPreparationTask] The Job Preparation task for jobs * created under this schedule. If a job has a Job Preparation task, the * Batch service will run the Job Preparation task on a compute node before * starting any tasks of that job on that compute node. - * @member {string} [jobPreparationTask.id] The ID can contain any + * @property {string} [jobPreparationTask.id] The ID can contain any * combination of alphanumeric characters including hyphens and underscores * and cannot contain more than 64 characters. If you do not specify this * property, the Batch service assigns a default value of 'jobpreparation'. @@ -204,7 +203,7 @@ class JobSpecification { * If you try to submit a task with the same id, the Batch service rejects * the request with error code TaskIdSameAsJobPreparationTask; if you are * calling the REST API directly, the HTTP status code is 409 (Conflict). - * @member {string} [jobPreparationTask.commandLine] The command line does + * @property {string} [jobPreparationTask.commandLine] The command line does * not run under a shell, and therefore cannot take advantage of shell * features such as environment variable expansion. If you want to take * advantage of such features, you should invoke the shell in the command @@ -213,42 +212,44 @@ class JobSpecification { * use a relative path (relative to the task working directory), or use the * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobPreparationTask.containerSettings] When this is + * @property {object} [jobPreparationTask.containerSettings] When this is * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR * (the root of Azure Batch directories on the node) are mapped into the * container, all task environment variables are mapped into the container, * and the task command line is executed in the container. - * @member {string} + * @property {string} * [jobPreparationTask.containerSettings.containerRunOptions] These * additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [jobPreparationTask.containerSettings.imageName] This is - * the full image reference, as would be specified to "docker pull". If no + * @property {string} [jobPreparationTask.containerSettings.imageName] This + * is the full image reference, as would be specified to "docker pull". If no * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [jobPreparationTask.containerSettings.registry] This + * @property {object} [jobPreparationTask.containerSettings.registry] This * setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [jobPreparationTask.containerSettings.registry.registryServer] If omitted, * the default is "docker.io". - * @member {string} [jobPreparationTask.containerSettings.registry.userName] - * @member {string} [jobPreparationTask.containerSettings.registry.password] - * @member {array} [jobPreparationTask.resourceFiles] Files listed under this - * element are located in the task's working directory. There is a maximum - * size for the list of resource files. When the max size is exceeded, the - * request will fail and the response error code will be + * @property {string} + * [jobPreparationTask.containerSettings.registry.userName] + * @property {string} + * [jobPreparationTask.containerSettings.registry.password] + * @property {array} [jobPreparationTask.resourceFiles] Files listed under + * this element are located in the task's working directory. There is a + * maximum size for the list of resource files. When the max size is + * exceeded, the request will fail and the response error code will be * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [jobPreparationTask.environmentSettings] - * @member {object} [jobPreparationTask.constraints] - * @member {moment.duration} + * @property {array} [jobPreparationTask.environmentSettings] + * @property {object} [jobPreparationTask.constraints] + * @property {moment.duration} * [jobPreparationTask.constraints.maxWallClockTime] If this is not * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [jobPreparationTask.constraints.retentionTime] + * @property {moment.duration} [jobPreparationTask.constraints.retentionTime] * The default is 7 days, i.e. the task directory will be retained for 7 days * unless the compute node is removed or the job is deleted. - * @member {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note + * @property {number} [jobPreparationTask.constraints.maxTaskRetryCount] Note * that this value specifically controls the number of retries for the task * executable due to a nonzero exit code. The Batch service will try the task * once, and may then retry up to this limit. For example, if the maximum @@ -256,10 +257,10 @@ class JobSpecification { * 3 retries). If the maximum retry count is 0, the Batch service does not * retry the task after the first attempt. If the maximum retry count is -1, * the Batch service retries the task without limit. - * @member {boolean} [jobPreparationTask.waitForSuccess] If true and the Job - * Preparation task fails on a compute node, the Batch service retries the - * Job Preparation task up to its maximum retry count (as specified in the - * constraints element). If the task has still not completed successfully + * @property {boolean} [jobPreparationTask.waitForSuccess] If true and the + * Job Preparation task fails on a compute node, the Batch service retries + * the Job Preparation task up to its maximum retry count (as specified in + * the constraints element). If the task has still not completed successfully * after all retries, then the Batch service will not schedule tasks of the * job to the compute node. The compute node remains active and eligible to * run tasks of other jobs. If false, the Batch service will not wait for the @@ -267,27 +268,27 @@ class JobSpecification { * start executing on the compute node while the Job Preparation task is * still running; and even if the Job Preparation task fails, new tasks will * continue to be scheduled on the node. The default value is true. - * @member {object} [jobPreparationTask.userIdentity] If omitted, the task + * @property {object} [jobPreparationTask.userIdentity] If omitted, the task * runs as a non-administrative user unique to the task on Windows nodes, or - * a a non-administrative user unique to the pool on Linux nodes. - * @member {string} [jobPreparationTask.userIdentity.userName] The userName + * a non-administrative user unique to the pool on Linux nodes. + * @property {string} [jobPreparationTask.userIdentity.userName] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {object} [jobPreparationTask.userIdentity.autoUser] The userName + * @property {object} [jobPreparationTask.userIdentity.autoUser] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {string} [jobPreparationTask.userIdentity.autoUser.scope] The + * @property {string} [jobPreparationTask.userIdentity.autoUser.scope] The * default value is task. Possible values include: 'task', 'pool' - * @member {string} [jobPreparationTask.userIdentity.autoUser.elevationLevel] - * The default value is nonAdmin. Possible values include: 'nonAdmin', - * 'admin' - * @member {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The + * @property {string} + * [jobPreparationTask.userIdentity.autoUser.elevationLevel] The default + * value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @property {boolean} [jobPreparationTask.rerunOnNodeRebootAfterSuccess] The * Job Preparation task is always rerun if a compute node is reimaged, or if * the Job Preparation task did not complete (e.g. because the reboot * occurred while the task was running). Therefore, you should always write a * Job Preparation task to be idempotent and to behave correctly if run * multiple times. The default value is true. - * @member {object} [jobReleaseTask] The Job Release task for jobs created + * @property {object} [jobReleaseTask] The Job Release task for jobs created * under this schedule. The primary purpose of the Job Release task is to * undo changes to compute nodes made by the Job Preparation task. Example * activities include deleting local files, or shutting down services that @@ -295,15 +296,15 @@ class JobSpecification { * specified without also specifying a Job Preparation task for the job. The * Batch service runs the Job Release task on the compute nodes that have run * the Job Preparation task. - * @member {string} [jobReleaseTask.id] The ID can contain any combination of - * alphanumeric characters including hyphens and underscores and cannot + * @property {string} [jobReleaseTask.id] The ID can contain any combination + * of alphanumeric characters including hyphens and underscores and cannot * contain more than 64 characters. If you do not specify this property, the * Batch service assigns a default value of 'jobrelease'. No other task in * the job can have the same ID as the Job Release task. If you try to submit * a task with the same id, the Batch service rejects the request with error * code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, * the HTTP status code is 409 (Conflict). - * @member {string} [jobReleaseTask.commandLine] The command line does not + * @property {string} [jobReleaseTask.commandLine] The command line does not * run under a shell, and therefore cannot take advantage of shell features * such as environment variable expansion. If you want to take advantage of * such features, you should invoke the shell in the command line, for @@ -312,60 +313,61 @@ class JobSpecification { * path (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [jobReleaseTask.containerSettings] When this is + * @property {object} [jobReleaseTask.containerSettings] When this is * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR * (the root of Azure Batch directories on the node) are mapped into the * container, all task environment variables are mapped into the container, * and the task command line is executed in the container. - * @member {string} [jobReleaseTask.containerSettings.containerRunOptions] + * @property {string} [jobReleaseTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [jobReleaseTask.containerSettings.imageName] This is the - * full image reference, as would be specified to "docker pull". If no tag is - * provided as part of the image name, the tag ":latest" is used as a + * @property {string} [jobReleaseTask.containerSettings.imageName] This is + * the full image reference, as would be specified to "docker pull". If no + * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [jobReleaseTask.containerSettings.registry] This setting - * can be omitted if was already provided at pool creation. - * @member {string} + * @property {object} [jobReleaseTask.containerSettings.registry] This + * setting can be omitted if was already provided at pool creation. + * @property {string} * [jobReleaseTask.containerSettings.registry.registryServer] If omitted, the * default is "docker.io". - * @member {string} [jobReleaseTask.containerSettings.registry.userName] - * @member {string} [jobReleaseTask.containerSettings.registry.password] - * @member {array} [jobReleaseTask.resourceFiles] Files listed under this + * @property {string} [jobReleaseTask.containerSettings.registry.userName] + * @property {string} [jobReleaseTask.containerSettings.registry.password] + * @property {array} [jobReleaseTask.resourceFiles] Files listed under this * element are located in the task's working directory. - * @member {array} [jobReleaseTask.environmentSettings] - * @member {moment.duration} [jobReleaseTask.maxWallClockTime] - * @member {moment.duration} [jobReleaseTask.retentionTime] The default is 7 - * days, i.e. the task directory will be retained for 7 days unless the + * @property {array} [jobReleaseTask.environmentSettings] + * @property {moment.duration} [jobReleaseTask.maxWallClockTime] + * @property {moment.duration} [jobReleaseTask.retentionTime] The default is + * 7 days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {object} [jobReleaseTask.userIdentity] If omitted, the task runs + * @property {object} [jobReleaseTask.userIdentity] If omitted, the task runs * as a non-administrative user unique to the task. - * @member {string} [jobReleaseTask.userIdentity.userName] The userName and + * @property {string} [jobReleaseTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [jobReleaseTask.userIdentity.autoUser] The userName and + * @property {object} [jobReleaseTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [jobReleaseTask.userIdentity.autoUser.scope] The default - * value is task. Possible values include: 'task', 'pool' - * @member {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] The - * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {array} [commonEnvironmentSettings] A list of common environment + * @property {string} [jobReleaseTask.userIdentity.autoUser.scope] The + * default value is task. Possible values include: 'task', 'pool' + * @property {string} [jobReleaseTask.userIdentity.autoUser.elevationLevel] + * The default value is nonAdmin. Possible values include: 'nonAdmin', + * 'admin' + * @property {array} [commonEnvironmentSettings] A list of common environment * variable settings. These environment variables are set for all tasks in * jobs created under this schedule (including the Job Manager, Job * Preparation and Job Release tasks). Individual tasks can override an * environment setting specified here by specifying the same setting name * with a different value. - * @member {object} poolInfo The pool on which the Batch service runs the + * @property {object} poolInfo The pool on which the Batch service runs the * tasks of jobs created under this schedule. - * @member {string} [poolInfo.poolId] You must ensure that the pool + * @property {string} [poolInfo.poolId] You must ensure that the pool * referenced by this property exists. If the pool does not exist at the time * the Batch service tries to schedule a job, no tasks for the job will run * until you create a pool with that id. Note that the Batch service will not * reject the job request; it will simply not run tasks until the pool * exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation + * @property {object} [poolInfo.autoPoolSpecification] If auto pool creation * fails, the Batch service moves the job to a completed state, and the pool * creation error is set in the job's scheduling error property. The Batch * service manages the lifetime (both creation and, unless keepAlive is @@ -373,28 +375,28 @@ class JobSpecification { * lifetime of the auto pool while the job is active will result in * unexpected behavior. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The + * @property {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The * Batch service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] + * @property {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the + * @property {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, + * the Batch service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The + * @property {object} [poolInfo.autoPoolSpecification.pool] + * @property {string} [poolInfo.autoPoolSpecification.pool.displayName] The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For + * @property {string} [poolInfo.autoPoolSpecification.pool.vmSize] For * information about available sizes of virtual machines in pools, see Choose * a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This * property must be specified if the pool needs to be created with Azure PaaS * VMs. This property and virtualMachineConfiguration are mutually exclusive @@ -403,7 +405,7 @@ class JobSpecification { * directly, the HTTP status code is 400 (Bad Request). This property cannot * be specified if the Batch account was created with its poolAllocationMode * property set to 'UserSubscription'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] * Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -412,39 +414,39 @@ class JobSpecification { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] * The default value is * which specifies the latest operating system version * for the specified OS family. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This * property must be specified if the pool needs to be created with Azure IaaS * VMs. This property and cloudServiceConfiguration are mutually exclusive * and one of the properties must be specified. If neither is specified then * the Batch service returns an error; if you are calling the REST API * directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -453,14 +455,14 @@ class JobSpecification { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] * 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 @@ -472,7 +474,7 @@ class JobSpecification { * 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. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] * This only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -481,71 +483,71 @@ class JobSpecification { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size - * of the compute nodes in the pool (the vmSize setting). - * @member {object} + * @property {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] + * The default value is 1. The maximum value of this setting depends on the + * size of the compute nodes in the pool (the vmSize setting). + * @property {object} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] * Possible values include: 'spread', 'pack' - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies * only to manual scaling; it has no effect when enableAutoScale is set to * true. The default value is 15 minutes. The minimum value is 5 minutes. If * you specify a value less than 5 minutes, the Batch service rejects the * request with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is + * @property {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] + * If false, at least one of targetDedicateNodes and targetLowPriorityNodes + * must be specified. If true, the autoScaleFormula element is required. The + * pool automatically resizes according to the formula. The default value is * false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] + * @property {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] * This property must not be specified if enableAutoScale is set to false. It * is required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The * default value is 15 minutes. The minimum and maximum value are 5 minutes * and 168 hours respectively. If you specify a value less than 5 minutes or * greater than 168 hours, the Batch service rejects the request with an * invalid property value error; if you are calling the REST API directly, * the HTTP status code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] * Enabling inter-node communication limits the maximum size of the pool due * to deployment restrictions on the nodes of the pool. This may result in * the pool not reaching its desired size. The default value is false. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This * is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -559,20 +561,20 @@ class JobSpecification { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} + * @property {object} [poolInfo.autoPoolSpecification.pool.startTask] + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.commandLine] The command * line does not run under a shell, and therefore cannot take advantage of * shell features such as environment variable expansion. If you want to take @@ -582,56 +584,56 @@ class JobSpecification { * use a relative path (relative to the task working directory), or use the * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When * this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] * This is the full image reference, as would be specified to "docker pull". * If no tag is provided as part of the image name, the tag ":latest" is used * as a default. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] * This setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed * under this element are located in the task's working directory. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, * the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] * The default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The * Batch service retries a task if its exit code is nonzero. Note that this * value specifically controls the number of retries. The Batch service will @@ -640,7 +642,7 @@ class JobSpecification { * initial try and 3 retries). If the maximum retry count is 0, the Batch * service does not retry the task. If the maximum retry count is -1, the * Batch service retries the task without limit. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and * the start task fails on a compute node, the Batch service retries the * start task up to its maximum retry count (maxTaskRetryCount). If the task @@ -652,7 +654,7 @@ class JobSpecification { * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.certificateReferences] For Windows * compute nodes, the Batch service installs the certificates to the * specified certificate store and location. For Linux compute nodes, the @@ -662,21 +664,22 @@ class JobSpecification { * '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. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch - * service application licenses. If a license is requested which is not - * supported, pool creation will fail. The permitted licenses available on - * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge - * applies for each application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch + * @property {array} + * [poolInfo.autoPoolSpecification.pool.applicationLicenses] The list of + * application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, + * pool creation will fail. The permitted licenses available on the pool are + * 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each + * application license added to the pool. + * @property {array} [poolInfo.autoPoolSpecification.pool.userAccounts] + * @property {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch * service does not assign any meaning to metadata; it is solely for the use * of user code. - * @member {array} [metadata] A list of name-value pairs associated with each - * job created under this schedule as metadata. The Batch service does not - * assign any meaning to metadata; it is solely for the use of user code. + * @property {array} [metadata] A list of name-value pairs associated with + * each job created under this schedule as metadata. The Batch service does + * not assign any meaning to metadata; it is solely for the use of user code. */ constructor() { } diff --git a/lib/services/batch/lib/models/jobStatistics.js b/lib/services/batch/lib/models/jobStatistics.js index 3ed96f8a36..c8395325dc 100644 --- a/lib/services/batch/lib/models/jobStatistics.js +++ b/lib/services/batch/lib/models/jobStatistics.js @@ -17,42 +17,43 @@ class JobStatistics { /** * Create a JobStatistics. - * @member {string} url The URL of the statistics. - * @member {date} startTime The start time of the time range covered by the + * @property {string} url The URL of the statistics. + * @property {date} startTime The start time of the time range covered by the * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last + * @property {date} lastUpdateTime The time at which the statistics were last * updated. All statistics are limited to the range between startTime and * lastUpdateTime. - * @member {moment.duration} userCPUTime The total user mode CPU time (summed - * across all cores and all compute nodes) consumed by all tasks in the job. - * @member {moment.duration} kernelCPUTime The total kernel mode CPU time + * @property {moment.duration} userCPUTime The total user mode CPU time * (summed across all cores and all compute nodes) consumed by all tasks in * the job. - * @member {moment.duration} wallClockTime The total wall clock time of all + * @property {moment.duration} kernelCPUTime The total kernel mode CPU time + * (summed across all cores and all compute nodes) consumed by all tasks in + * the job. + * @property {moment.duration} wallClockTime The total wall clock time of all * tasks in the job. The wall clock time is the elapsed time from when the * task started running on a compute node to when it finished (or to the last * time the statistics were updated, if the task had not finished by then). * If a task was retried, this includes the wall clock time of all the task * retries. - * @member {number} readIOps The total number of disk read operations made by - * all tasks in the job. - * @member {number} writeIOps The total number of disk write operations made + * @property {number} readIOps The total number of disk read operations made * by all tasks in the job. - * @member {number} readIOGiB The total amount of data in GiB read from disk - * by all tasks in the job. - * @member {number} writeIOGiB The total amount of data in GiB written to + * @property {number} writeIOps The total number of disk write operations + * made by all tasks in the job. + * @property {number} readIOGiB The total amount of data in GiB read from + * disk by all tasks in the job. + * @property {number} writeIOGiB The total amount of data in GiB written to * disk by all tasks in the job. - * @member {number} numSucceededTasks The total number of tasks successfully - * completed in the job during the given time range. A task completes - * successfully if it returns exit code 0. - * @member {number} numFailedTasks The total number of tasks in the job that - * failed during the given time range. A task fails if it exhausts its + * @property {number} numSucceededTasks The total number of tasks + * successfully completed in the job during the given time range. A task + * completes successfully if it returns exit code 0. + * @property {number} numFailedTasks The total number of tasks in the job + * that failed during the given time range. A task fails if it exhausts its * maximum retry count without returning exit code 0. - * @member {number} numTaskRetries The total number of retries on all the + * @property {number} numTaskRetries The total number of retries on all the * tasks in the job during the given time range. - * @member {moment.duration} waitTime The total wait time of all tasks in the - * job. The wait time for a task is defined as the elapsed time between the - * creation of the task and the start of task execution. (If the task is + * @property {moment.duration} waitTime The total wait time of all tasks in + * the job. The wait time for a task is defined as the elapsed time between + * the creation of the task and the start of task execution. (If the task is * retried due to failures, the wait time is the time to the most recent task * execution.) This value is only reported in the account lifetime * statistics; it is not included in the job statistics. diff --git a/lib/services/batch/lib/models/jobTerminateOptions.js b/lib/services/batch/lib/models/jobTerminateOptions.js index 659a98e0c9..947726af24 100644 --- a/lib/services/batch/lib/models/jobTerminateOptions.js +++ b/lib/services/batch/lib/models/jobTerminateOptions.js @@ -17,30 +17,30 @@ class JobTerminateOptions { /** * Create a JobTerminateOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobTerminateParameter.js b/lib/services/batch/lib/models/jobTerminateParameter.js index 3ac9460e51..4451b7e0f9 100644 --- a/lib/services/batch/lib/models/jobTerminateParameter.js +++ b/lib/services/batch/lib/models/jobTerminateParameter.js @@ -17,7 +17,7 @@ class JobTerminateParameter { /** * Create a JobTerminateParameter. - * @member {string} [terminateReason] The text you want to appear as the + * @property {string} [terminateReason] The text you want to appear as the * job's TerminateReason. The default is 'UserTerminate'. */ constructor() { diff --git a/lib/services/batch/lib/models/jobUpdateOptions.js b/lib/services/batch/lib/models/jobUpdateOptions.js index 81ae8f0dfd..fdba898a6f 100644 --- a/lib/services/batch/lib/models/jobUpdateOptions.js +++ b/lib/services/batch/lib/models/jobUpdateOptions.js @@ -17,30 +17,30 @@ class JobUpdateOptions { /** * Create a JobUpdateOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/jobUpdateParameter.js b/lib/services/batch/lib/models/jobUpdateParameter.js index ea09e8648a..d91a7b13d1 100644 --- a/lib/services/batch/lib/models/jobUpdateParameter.js +++ b/lib/services/batch/lib/models/jobUpdateParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The set of changes to be made to a job. * @@ -19,38 +17,38 @@ const models = require('./index'); class JobUpdateParameter { /** * Create a JobUpdateParameter. - * @member {number} [priority] The priority of the job. Priority values can + * @property {number} [priority] The priority of the job. Priority values can * range from -1000 to 1000, with -1000 being the lowest priority and 1000 * being the highest priority. If omitted, it is set to the default value 0. - * @member {object} [constraints] The execution constraints for the job. If + * @property {object} [constraints] The execution constraints for the job. If * omitted, the constraints are cleared. - * @member {moment.duration} [constraints.maxWallClockTime] If the job does + * @property {moment.duration} [constraints.maxWallClockTime] If the job does * not complete within the time limit, the Batch service terminates it and * any tasks that are still running. In this case, the termination reason * will be MaxWallClockTimeExpiry. If this property is not specified, there * is no time limit on how long the job may run. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries. The Batch service will try * each task once, and may then retry up to this limit. For example, if the * maximum retry count is 3, Batch tries a task up to 4 times (one initial * try and 3 retries). If the maximum retry count is 0, the Batch service * does not retry tasks. If the maximum retry count is -1, the Batch service * retries tasks without limit. The default value is 0 (no retries). - * @member {object} poolInfo The pool on which the Batch service runs the + * @property {object} poolInfo The pool on which the Batch service runs the * job's tasks. You may change the pool for a job only when the job is * disabled. The Update Job call will fail if you include the poolInfo * element and the job is not disabled. If you specify an * autoPoolSpecification specification in the poolInfo, only the keepAlive * property can be updated, and then only if the auto pool has a * poolLifetimeOption of job. - * @member {string} [poolInfo.poolId] You must ensure that the pool + * @property {string} [poolInfo.poolId] You must ensure that the pool * referenced by this property exists. If the pool does not exist at the time * the Batch service tries to schedule a job, no tasks for the job will run * until you create a pool with that id. Note that the Batch service will not * reject the job request; it will simply not run tasks until the pool * exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [poolInfo.autoPoolSpecification] If auto pool creation + * @property {object} [poolInfo.autoPoolSpecification] If auto pool creation * fails, the Batch service moves the job to a completed state, and the pool * creation error is set in the job's scheduling error property. The Batch * service manages the lifetime (both creation and, unless keepAlive is @@ -58,28 +56,28 @@ class JobUpdateParameter { * lifetime of the auto pool while the job is active will result in * unexpected behavior. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The + * @property {string} [poolInfo.autoPoolSpecification.autoPoolIdPrefix] The * Batch service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] + * @property {string} [poolInfo.autoPoolSpecification.poolLifetimeOption] * Possible values include: 'jobSchedule', 'job' - * @member {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, the - * Batch service deletes the pool once its lifetime (as determined by the + * @property {boolean} [poolInfo.autoPoolSpecification.keepAlive] If false, + * the Batch service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [poolInfo.autoPoolSpecification.pool] - * @member {string} [poolInfo.autoPoolSpecification.pool.displayName] The + * @property {object} [poolInfo.autoPoolSpecification.pool] + * @property {string} [poolInfo.autoPoolSpecification.pool.displayName] The * display name need not be unique and can contain any Unicode characters up * to a maximum length of 1024. - * @member {string} [poolInfo.autoPoolSpecification.pool.vmSize] For + * @property {string} [poolInfo.autoPoolSpecification.pool.vmSize] For * information about available sizes of virtual machines in pools, see Choose * a VM size for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration] This * property must be specified if the pool needs to be created with Azure PaaS * VMs. This property and virtualMachineConfiguration are mutually exclusive @@ -88,7 +86,7 @@ class JobUpdateParameter { * directly, the HTTP status code is 400 (Bad Request). This property cannot * be specified if the Batch account was created with its poolAllocationMode * property set to 'UserSubscription'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] * Possible values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -97,39 +95,39 @@ class JobUpdateParameter { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] * The default value is * which specifies the latest operating system version * for the specified OS family. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration] This * property must be specified if the pool needs to be created with Azure IaaS * VMs. This property and cloudServiceConfiguration are mutually exclusive * and one of the properties must be specified. If neither is specified then * the Batch service returns an error; if you are calling the REST API * directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -138,14 +136,14 @@ class JobUpdateParameter { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] * 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 @@ -157,7 +155,7 @@ class JobUpdateParameter { * 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. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] * This only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -166,71 +164,71 @@ class JobUpdateParameter { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] The - * default value is 1. The maximum value of this setting depends on the size - * of the compute nodes in the pool (the vmSize setting). - * @member {object} + * @property {number} [poolInfo.autoPoolSpecification.pool.maxTasksPerNode] + * The default value is 1. The maximum value of this setting depends on the + * size of the compute nodes in the pool (the vmSize setting). + * @property {object} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] * Possible values include: 'spread', 'pack' - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.resizeTimeout] This timeout applies * only to manual scaling; it has no effect when enableAutoScale is set to * true. The default value is 15 minutes. The minimum value is 5 minutes. If * you specify a value less than 5 minutes, the Batch service rejects the * request with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetDedicatedNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.targetLowPriorityNodes] This property * must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] If - * false, at least one of targetDedicateNodes and targetLowPriorityNodes must - * be specified. If true, the autoScaleFormula element is required. The pool - * automatically resizes according to the formula. The default value is + * @property {boolean} [poolInfo.autoPoolSpecification.pool.enableAutoScale] + * If false, at least one of targetDedicateNodes and targetLowPriorityNodes + * must be specified. If true, the autoScaleFormula element is required. The + * pool automatically resizes according to the formula. The default value is * false. - * @member {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] + * @property {string} [poolInfo.autoPoolSpecification.pool.autoScaleFormula] * This property must not be specified if enableAutoScale is set to false. It * is required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [poolInfo.autoPoolSpecification.pool.autoScaleEvaluationInterval] The * default value is 15 minutes. The minimum and maximum value are 5 minutes * and 168 hours respectively. If you specify a value less than 5 minutes or * greater than 168 hours, the Batch service rejects the request with an * invalid property value error; if you are calling the REST API directly, * the HTTP status code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.enableInterNodeCommunication] * Enabling inter-node communication limits the maximum size of the pool due * to deployment restrictions on the nodes of the pool. This may result in * the pool not reaching its desired size. The default value is false. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.subnetId] This * is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -244,20 +242,20 @@ class JobUpdateParameter { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} [poolInfo.autoPoolSpecification.pool.startTask] - * @member {string} + * @property {object} [poolInfo.autoPoolSpecification.pool.startTask] + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.commandLine] The command * line does not run under a shell, and therefore cannot take advantage of * shell features such as environment variable expansion. If you want to take @@ -267,56 +265,56 @@ class JobUpdateParameter { * use a relative path (relative to the task working directory), or use the * Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings] When * this is specified, all directories recursively below the * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.imageName] * This is the full image reference, as would be specified to "docker pull". * If no tag is provided as part of the image name, the tag ":latest" is used * as a default. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry] * This setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.resourceFiles] Files listed * under this element are located in the task's working directory. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity] If omitted, * the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.userName] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {object} + * @property {object} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser] The * userName and autoUser properties are mutually exclusive; you must specify * one but not both. - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] * The default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [poolInfo.autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} + * @property {number} * [poolInfo.autoPoolSpecification.pool.startTask.maxTaskRetryCount] The * Batch service retries a task if its exit code is nonzero. Note that this * value specifically controls the number of retries. The Batch service will @@ -325,7 +323,7 @@ class JobUpdateParameter { * initial try and 3 retries). If the maximum retry count is 0, the Batch * service does not retry the task. If the maximum retry count is -1, the * Batch service retries the task without limit. - * @member {boolean} + * @property {boolean} * [poolInfo.autoPoolSpecification.pool.startTask.waitForSuccess] If true and * the start task fails on a compute node, the Batch service retries the * start task up to its maximum retry count (maxTaskRetryCount). If the task @@ -337,7 +335,7 @@ class JobUpdateParameter { * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.certificateReferences] For Windows * compute nodes, the Batch service installs the certificates to the * specified certificate store and location. For Linux compute nodes, the @@ -347,26 +345,27 @@ class JobUpdateParameter { * '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. - * @member {array} + * @property {array} * [poolInfo.autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [poolInfo.autoPoolSpecification.pool.applicationLicenses] - * The list of application licenses must be a subset of available Batch - * service application licenses. If a license is requested which is not - * supported, pool creation will fail. The permitted licenses available on - * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge - * applies for each application license added to the pool. - * @member {array} [poolInfo.autoPoolSpecification.pool.userAccounts] - * @member {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch + * @property {array} + * [poolInfo.autoPoolSpecification.pool.applicationLicenses] The list of + * application licenses must be a subset of available Batch service + * application licenses. If a license is requested which is not supported, + * pool creation will fail. The permitted licenses available on the pool are + * 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each + * application license added to the pool. + * @property {array} [poolInfo.autoPoolSpecification.pool.userAccounts] + * @property {array} [poolInfo.autoPoolSpecification.pool.metadata] The Batch * service does not assign any meaning to metadata; it is solely for the use * of user code. - * @member {array} [metadata] A list of name-value pairs associated with the - * job as metadata. If omitted, it takes the default value of an empty list; - * in effect, any existing metadata is deleted. - * @member {string} [onAllTasksComplete] The action the Batch service should - * take when all tasks in the job are in the completed state. 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 + * @property {array} [metadata] A list of name-value pairs associated with + * the job as metadata. If omitted, it takes the default value of an empty + * list; in effect, any existing metadata is deleted. + * @property {string} [onAllTasksComplete] The action the Batch service + * should take when all tasks in the job are in the completed state. 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 diff --git a/lib/services/batch/lib/models/linuxUserConfiguration.js b/lib/services/batch/lib/models/linuxUserConfiguration.js index d2503e63c1..6b536da646 100644 --- a/lib/services/batch/lib/models/linuxUserConfiguration.js +++ b/lib/services/batch/lib/models/linuxUserConfiguration.js @@ -17,20 +17,21 @@ class LinuxUserConfiguration { /** * Create a LinuxUserConfiguration. - * @member {number} [uid] The user ID of the user account. The uid and gid + * @property {number} [uid] The user ID of the user account. The uid and gid * properties must be specified together or not at all. If not specified the * underlying operating system picks the uid. - * @member {number} [gid] The group ID for the user account. The uid and gid - * properties must be specified together or not at all. If not specified the - * underlying operating system picks the gid. - * @member {string} [sshPrivateKey] The SSH private key for the user account. - * The private key must not be password protected. The private key is used to - * automatically configure asymmetric-key based authentication for SSH - * between nodes in a Linux pool when the pool's enableInterNodeCommunication - * property is true (it is ignored if enableInterNodeCommunication is false). - * It does this by placing the key pair into the user's .ssh directory. If - * not specified, password-less SSH is not configured between nodes (no - * modification of the user's .ssh directory is done). + * @property {number} [gid] The group ID for the user account. The uid and + * gid properties must be specified together or not at all. If not specified + * the underlying operating system picks the gid. + * @property {string} [sshPrivateKey] The SSH private key for the user + * account. The private key must not be password protected. The private key + * is used to automatically configure asymmetric-key based authentication for + * SSH between nodes in a Linux pool when the pool's + * enableInterNodeCommunication property is true (it is ignored if + * enableInterNodeCommunication is false). It does this by placing the key + * pair into the user's .ssh directory. If not specified, password-less SSH + * is not configured between nodes (no modification of the user's .ssh + * directory is done). */ constructor() { } diff --git a/lib/services/batch/lib/models/metadataItem.js b/lib/services/batch/lib/models/metadataItem.js index 0fe646020e..558d39b90f 100644 --- a/lib/services/batch/lib/models/metadataItem.js +++ b/lib/services/batch/lib/models/metadataItem.js @@ -20,8 +20,8 @@ class MetadataItem { /** * Create a MetadataItem. - * @member {string} name The name of the metadata item. - * @member {string} value The value of the metadata item. + * @property {string} name The name of the metadata item. + * @property {string} value The value of the metadata item. */ constructor() { } diff --git a/lib/services/batch/lib/models/multiInstanceSettings.js b/lib/services/batch/lib/models/multiInstanceSettings.js index 0e7d821923..1e90a4d91a 100644 --- a/lib/services/batch/lib/models/multiInstanceSettings.js +++ b/lib/services/batch/lib/models/multiInstanceSettings.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Settings which specify how to run a multi-instance task. * @@ -21,14 +19,14 @@ const models = require('./index'); class MultiInstanceSettings { /** * Create a MultiInstanceSettings. - * @member {number} [numberOfInstances] The number of compute nodes required - * by the task. If omitted, the default is 1. - * @member {string} coordinationCommandLine The command line to run on all + * @property {number} [numberOfInstances] The number of compute nodes + * required by the task. If omitted, the default is 1. + * @property {string} coordinationCommandLine The command line to run on all * the compute nodes to enable them to coordinate when the primary runs the * main task command. A typical coordination command line launches a * background service and verifies that the service is ready to process * inter-node messages. - * @member {array} [commonResourceFiles] A list of files that the Batch + * @property {array} [commonResourceFiles] A list of files that the Batch * service will download before running the coordination command line. The * difference between common resource files and task resource files is that * common resource files are downloaded for all subtasks including the diff --git a/lib/services/batch/lib/models/nameValuePair.js b/lib/services/batch/lib/models/nameValuePair.js index 55627a4252..2b825146ba 100644 --- a/lib/services/batch/lib/models/nameValuePair.js +++ b/lib/services/batch/lib/models/nameValuePair.js @@ -17,8 +17,8 @@ class NameValuePair { /** * Create a NameValuePair. - * @member {string} [name] The name in the name-value pair. - * @member {string} [value] The value in the name-value pair. + * @property {string} [name] The name in the name-value pair. + * @property {string} [value] The value in the name-value pair. */ constructor() { } diff --git a/lib/services/batch/lib/models/networkConfiguration.js b/lib/services/batch/lib/models/networkConfiguration.js index 3d0e8b999c..5428452926 100644 --- a/lib/services/batch/lib/models/networkConfiguration.js +++ b/lib/services/batch/lib/models/networkConfiguration.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * The network configuration for a pool. * @@ -19,7 +17,7 @@ const models = require('./index'); class NetworkConfiguration { /** * Create a NetworkConfiguration. - * @member {string} [subnetId] The ARM resource identifier of the virtual + * @property {string} [subnetId] The ARM resource identifier of the virtual * network subnet which the compute nodes of the pool will join. This is of * the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -33,14 +31,14 @@ class NetworkConfiguration { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [dynamicVNetAssignmentScope] The scope of dynamic vnet + * @property {string} [dynamicVNetAssignmentScope] The scope of dynamic vnet * assignment. Possible values include: 'none', 'job' - * @member {object} [endpointConfiguration] The configuration for endpoints + * @property {object} [endpointConfiguration] The configuration for endpoints * on compute nodes in the Batch pool. Pool endpoint configuration is only * supported on pools with the virtualMachineConfiguration property. - * @member {array} [endpointConfiguration.inboundNATPools] The maximum number - * of inbound NAT pools per Batch pool is 5. If the maximum number of inbound - * NAT pools is exceeded the request fails with HTTP status code 400. + * @property {array} [endpointConfiguration.inboundNATPools] The maximum + * number of inbound NAT pools per Batch pool is 5. If the maximum number of + * inbound NAT pools is exceeded the request fails with HTTP status code 400. */ constructor() { } diff --git a/lib/services/batch/lib/models/networkSecurityGroupRule.js b/lib/services/batch/lib/models/networkSecurityGroupRule.js index 55df0e3cea..f599bda9ee 100644 --- a/lib/services/batch/lib/models/networkSecurityGroupRule.js +++ b/lib/services/batch/lib/models/networkSecurityGroupRule.js @@ -17,16 +17,16 @@ class NetworkSecurityGroupRule { /** * Create a NetworkSecurityGroupRule. - * @member {number} priority The priority for this rule. Priorities within a - * pool must be unique and are evaluated in order of priority. The lower the - * number the higher the priority. For example, rules could be specified with - * order numbers of 150, 250, and 350. The rule with the order number of 150 - * takes precedence over the rule that has an order of 250. Allowed + * @property {number} priority The priority for this rule. Priorities within + * a pool must be unique and are evaluated in order of priority. The lower + * the number the higher the priority. For example, rules could be specified + * with order numbers of 150, 250, and 350. The rule with the order number of + * 150 takes precedence over the rule that has an order of 250. Allowed * priorities are 150 to 3500. If any reserved or duplicate values are * provided the request fails with HTTP status code 400. - * @member {string} access The action that should be taken for a specified IP - * address, subnet range or tag. Possible values include: 'allow', 'deny' - * @member {string} sourceAddressPrefix The source address prefix or tag to + * @property {string} access The action that should be taken for a specified + * IP address, subnet range or tag. Possible values include: 'allow', 'deny' + * @property {string} sourceAddressPrefix The source address prefix or tag to * match for the rule. Valid values are a single IP address (i.e. * 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all * addresses). If any other values are provided the request fails with HTTP diff --git a/lib/services/batch/lib/models/nodeAgentInformation.js b/lib/services/batch/lib/models/nodeAgentInformation.js index 856114d4e2..3961e68610 100644 --- a/lib/services/batch/lib/models/nodeAgentInformation.js +++ b/lib/services/batch/lib/models/nodeAgentInformation.js @@ -20,12 +20,12 @@ class NodeAgentInformation { /** * Create a NodeAgentInformation. - * @member {string} version The version of the Batch node agent running on + * @property {string} version The version of the Batch node agent running on * the compute node. This version number can be checked against the node * agent release notes located at * https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. - * @member {date} lastUpdateTime The time when the node agent was updated on - * the compute node. This is the most recent time that the node agent was + * @property {date} lastUpdateTime The time when the node agent was updated + * on the compute node. This is the most recent time that the node agent was * updated to a new version. */ constructor() { diff --git a/lib/services/batch/lib/models/nodeAgentSku.js b/lib/services/batch/lib/models/nodeAgentSku.js index ce408bc8b9..0b89df37eb 100644 --- a/lib/services/batch/lib/models/nodeAgentSku.js +++ b/lib/services/batch/lib/models/nodeAgentSku.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A node agent SKU supported by the Batch service. * @@ -24,11 +22,11 @@ const models = require('./index'); class NodeAgentSku { /** * Create a NodeAgentSku. - * @member {string} [id] The ID of the node agent SKU. - * @member {array} [verifiedImageReferences] The list of Azure Marketplace + * @property {string} [id] The ID of the node agent SKU. + * @property {array} [verifiedImageReferences] The list of Azure Marketplace * images verified to be compatible with this node agent SKU. This collection * is not exhaustive (the node agent may be compatible with other images). - * @member {string} [osType] The type of operating system (e.g. Windows or + * @property {string} [osType] The type of operating system (e.g. Windows or * Linux) compatible with the node agent SKU. Possible values include: * 'linux', 'windows' */ diff --git a/lib/services/batch/lib/models/nodeCounts.js b/lib/services/batch/lib/models/nodeCounts.js index 7534829ea7..8e3692e0f6 100644 --- a/lib/services/batch/lib/models/nodeCounts.js +++ b/lib/services/batch/lib/models/nodeCounts.js @@ -17,22 +17,23 @@ class NodeCounts { /** * Create a NodeCounts. - * @member {number} creating The number of nodes in the creating state. - * @member {number} idle The number of nodes in the idle state. - * @member {number} offline The number of nodes in the offline state. - * @member {number} preempted The number of nodes in the preempted state. - * @member {number} rebooting The count of nodes in the rebooting state. - * @member {number} reimaging The number of nodes in the reimaging state. - * @member {number} running The number of nodes in the running state. - * @member {number} starting The number of nodes in the starting state. - * @member {number} startTaskFailed The number of nodes in the + * @property {number} creating The number of nodes in the creating state. + * @property {number} idle The number of nodes in the idle state. + * @property {number} offline The number of nodes in the offline state. + * @property {number} preempted The number of nodes in the preempted state. + * @property {number} rebooting The count of nodes in the rebooting state. + * @property {number} reimaging The number of nodes in the reimaging state. + * @property {number} running The number of nodes in the running state. + * @property {number} starting The number of nodes in the starting state. + * @property {number} startTaskFailed The number of nodes in the * startTaskFailed state. - * @member {number} leavingPool The number of nodes in the leavingPool state. - * @member {number} unknown The number of nodes in the unknown state. - * @member {number} unusable The number of nodes in the unusable state. - * @member {number} waitingForStartTask The number of nodes in the + * @property {number} leavingPool The number of nodes in the leavingPool + * state. + * @property {number} unknown The number of nodes in the unknown state. + * @property {number} unusable The number of nodes in the unusable state. + * @property {number} waitingForStartTask The number of nodes in the * waitingForStartTask state. - * @member {number} total The total number of nodes. + * @property {number} total The total number of nodes. */ constructor() { } diff --git a/lib/services/batch/lib/models/nodeDisableSchedulingParameter.js b/lib/services/batch/lib/models/nodeDisableSchedulingParameter.js index 47a2aa2e54..3c29531036 100644 --- a/lib/services/batch/lib/models/nodeDisableSchedulingParameter.js +++ b/lib/services/batch/lib/models/nodeDisableSchedulingParameter.js @@ -17,7 +17,7 @@ class NodeDisableSchedulingParameter { /** * Create a NodeDisableSchedulingParameter. - * @member {string} [nodeDisableSchedulingOption] What to do with currently + * @property {string} [nodeDisableSchedulingOption] What to do with currently * running tasks when disabling task scheduling on the compute node. The * default value is requeue. Possible values include: 'requeue', 'terminate', * 'taskCompletion' diff --git a/lib/services/batch/lib/models/nodeFile.js b/lib/services/batch/lib/models/nodeFile.js index 471c3fe365..5bbe0357f3 100644 --- a/lib/services/batch/lib/models/nodeFile.js +++ b/lib/services/batch/lib/models/nodeFile.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Information about a file or directory on a compute node. * @@ -19,17 +17,18 @@ const models = require('./index'); class NodeFile { /** * Create a NodeFile. - * @member {string} [name] The file path. - * @member {string} [url] The URL of the file. - * @member {boolean} [isDirectory] Whether the object represents a directory. - * @member {object} [properties] The file properties. - * @member {date} [properties.creationTime] The creation time is not returned + * @property {string} [name] The file path. + * @property {string} [url] The URL of the file. + * @property {boolean} [isDirectory] Whether the object represents a + * directory. + * @property {object} [properties] The file properties. + * @property {date} [properties.creationTime] The creation time is not + * returned for files on Linux compute nodes. + * @property {date} [properties.lastModified] + * @property {number} [properties.contentLength] + * @property {string} [properties.contentType] + * @property {string} [properties.fileMode] The file mode is returned only * for files on Linux compute nodes. - * @member {date} [properties.lastModified] - * @member {number} [properties.contentLength] - * @member {string} [properties.contentType] - * @member {string} [properties.fileMode] The file mode is returned only for - * files on Linux compute nodes. */ constructor() { } diff --git a/lib/services/batch/lib/models/nodeFileListResult.js b/lib/services/batch/lib/models/nodeFileListResult.js index f9749f0e0a..162be9c91d 100644 --- a/lib/services/batch/lib/models/nodeFileListResult.js +++ b/lib/services/batch/lib/models/nodeFileListResult.js @@ -17,7 +17,7 @@ class NodeFileListResult extends Array { /** * Create a NodeFileListResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/nodeRebootParameter.js b/lib/services/batch/lib/models/nodeRebootParameter.js index 7ffb2c0ba3..b40247a184 100644 --- a/lib/services/batch/lib/models/nodeRebootParameter.js +++ b/lib/services/batch/lib/models/nodeRebootParameter.js @@ -17,7 +17,7 @@ class NodeRebootParameter { /** * Create a NodeRebootParameter. - * @member {string} [nodeRebootOption] When to reboot the compute node and + * @property {string} [nodeRebootOption] When to reboot the compute node and * what to do with currently running tasks. The default value is requeue. * Possible values include: 'requeue', 'terminate', 'taskCompletion', * 'retainedData' diff --git a/lib/services/batch/lib/models/nodeReimageParameter.js b/lib/services/batch/lib/models/nodeReimageParameter.js index 959aa60ac1..8d272c8b50 100644 --- a/lib/services/batch/lib/models/nodeReimageParameter.js +++ b/lib/services/batch/lib/models/nodeReimageParameter.js @@ -17,8 +17,8 @@ class NodeReimageParameter { /** * Create a NodeReimageParameter. - * @member {string} [nodeReimageOption] When to reimage the compute node and - * what to do with currently running tasks. The default value is requeue. + * @property {string} [nodeReimageOption] When to reimage the compute node + * and what to do with currently running tasks. The default value is requeue. * Possible values include: 'requeue', 'terminate', 'taskCompletion', * 'retainedData' */ diff --git a/lib/services/batch/lib/models/nodeRemoveParameter.js b/lib/services/batch/lib/models/nodeRemoveParameter.js index b29aec72bf..23c12fd24f 100644 --- a/lib/services/batch/lib/models/nodeRemoveParameter.js +++ b/lib/services/batch/lib/models/nodeRemoveParameter.js @@ -17,14 +17,14 @@ class NodeRemoveParameter { /** * Create a NodeRemoveParameter. - * @member {array} nodeList A list containing the IDs of the compute nodes to - * be removed from the specified pool. - * @member {moment.duration} [resizeTimeout] The timeout for removal of + * @property {array} nodeList A list containing the IDs of the compute nodes + * to be removed from the specified pool. + * @property {moment.duration} [resizeTimeout] The timeout for removal of * compute nodes to the pool. The default value is 15 minutes. The minimum * value is 5 minutes. If you specify a value less than 5 minutes, the Batch * service returns an error; if you are calling the REST API directly, the * HTTP status code is 400 (Bad Request). - * @member {string} [nodeDeallocationOption] Determines what to do with a + * @property {string} [nodeDeallocationOption] Determines what to do with a * node and its running task(s) after it has been selected for deallocation. * The default value is requeue. Possible values include: 'requeue', * 'terminate', 'taskCompletion', 'retainedData' diff --git a/lib/services/batch/lib/models/nodeUpdateUserParameter.js b/lib/services/batch/lib/models/nodeUpdateUserParameter.js index ad56736000..c2645a3806 100644 --- a/lib/services/batch/lib/models/nodeUpdateUserParameter.js +++ b/lib/services/batch/lib/models/nodeUpdateUserParameter.js @@ -17,16 +17,16 @@ class NodeUpdateUserParameter { /** * Create a NodeUpdateUserParameter. - * @member {string} [password] The password of the account. The password is + * @property {string} [password] The password of the account. The password is * required for Windows nodes (those created with * 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' * using a Windows image reference). For Linux compute nodes, the password * can optionally be specified along with the sshPublicKey property. If * omitted, any existing password is removed. - * @member {date} [expiryTime] The time at which the account should expire. + * @property {date} [expiryTime] The time at which the account should expire. * If omitted, the default is 1 day from the current time. For Linux compute * nodes, the expiryTime has a precision up to a day. - * @member {string} [sshPublicKey] The SSH public key that can be used for + * @property {string} [sshPublicKey] The SSH public key that can be used for * remote login to the compute node. The public key should be compatible with * OpenSSH encoding and should be base 64 encoded. This property can be * specified only for Linux nodes. If this is specified for a Windows node, diff --git a/lib/services/batch/lib/models/outputFile.js b/lib/services/batch/lib/models/outputFile.js index f0fadfb08d..26ae059a9b 100644 --- a/lib/services/batch/lib/models/outputFile.js +++ b/lib/services/batch/lib/models/outputFile.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A specification for uploading files from an Azure Batch node to * another location after the Batch service has finished executing the task @@ -21,8 +19,8 @@ const models = require('./index'); class OutputFile { /** * Create a OutputFile. - * @member {string} filePattern A pattern indicating which file(s) to upload. - * Both relative and absolute paths are supported. Relative paths are + * @property {string} filePattern A pattern indicating which file(s) to + * upload. Both relative and absolute paths are supported. Relative paths are * relative to the task working directory. The following wildcards are * supported: * matches 0 or more characters (for example pattern abc* would * match abc or abcdef), ** matches any directory, ? matches any single @@ -38,21 +36,21 @@ class OutputFile { * Note that both \ and / are treated as directory separators on Windows, but * only / is on Linux. Environment variables (%var% on Windows or $var on * Linux) are expanded prior to the pattern being applied. - * @member {object} destination The destination for the output file(s). - * @member {object} [destination.container] - * @member {string} [destination.container.path] If filePattern refers to a + * @property {object} destination The destination for the output file(s). + * @property {object} [destination.container] + * @property {string} [destination.container.path] If filePattern refers to a * specific file (i.e. contains no wildcards), then path is the name of the * blob to which to upload that file. If filePattern contains one or more * wildcards (and therefore may match multiple files), then path is the name * of the blob virtual directory (which is prepended to each blob name) to * which to upload the file(s). If omitted, file(s) are uploaded to the root * of the container with a blob name matching their file name. - * @member {string} [destination.container.containerUrl] The URL must include - * a Shared Access Signature (SAS) granting write permissions to the + * @property {string} [destination.container.containerUrl] The URL must + * include a Shared Access Signature (SAS) granting write permissions to the * container. - * @member {object} uploadOptions Additional options for the upload + * @property {object} uploadOptions Additional options for the upload * operation, including under what conditions to perform the upload. - * @member {string} [uploadOptions.uploadCondition] The default is + * @property {string} [uploadOptions.uploadCondition] The default is * taskcompletion. Possible values include: 'taskSuccess', 'taskFailure', * 'taskCompletion' */ diff --git a/lib/services/batch/lib/models/outputFileBlobContainerDestination.js b/lib/services/batch/lib/models/outputFileBlobContainerDestination.js index 03483a49cd..6b54459a15 100644 --- a/lib/services/batch/lib/models/outputFileBlobContainerDestination.js +++ b/lib/services/batch/lib/models/outputFileBlobContainerDestination.js @@ -18,7 +18,7 @@ class OutputFileBlobContainerDestination { /** * Create a OutputFileBlobContainerDestination. - * @member {string} [path] The destination blob or virtual directory within + * @property {string} [path] The destination blob or virtual directory within * the Azure Storage container. If filePattern refers to a specific file * (i.e. contains no wildcards), then path is the name of the blob to which * to upload that file. If filePattern contains one or more wildcards (and @@ -26,7 +26,7 @@ class OutputFileBlobContainerDestination { * virtual directory (which is prepended to each blob name) to which to * upload the file(s). If omitted, file(s) are uploaded to the root of the * container with a blob name matching their file name. - * @member {string} containerUrl The URL of the container within Azure Blob + * @property {string} containerUrl The URL of the container within Azure Blob * Storage to which to upload the file(s). The URL must include a Shared * Access Signature (SAS) granting write permissions to the container. */ diff --git a/lib/services/batch/lib/models/outputFileDestination.js b/lib/services/batch/lib/models/outputFileDestination.js index 2b88374e32..f8691e3a36 100644 --- a/lib/services/batch/lib/models/outputFileDestination.js +++ b/lib/services/batch/lib/models/outputFileDestination.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The destination to which a file should be uploaded. * @@ -19,16 +17,16 @@ const models = require('./index'); class OutputFileDestination { /** * Create a OutputFileDestination. - * @member {object} [container] A location in Azure blob storage to which + * @property {object} [container] A location in Azure blob storage to which * files are uploaded. - * @member {string} [container.path] If filePattern refers to a specific file - * (i.e. contains no wildcards), then path is the name of the blob to which - * to upload that file. If filePattern contains one or more wildcards (and - * therefore may match multiple files), then path is the name of the blob - * virtual directory (which is prepended to each blob name) to which to + * @property {string} [container.path] If filePattern refers to a specific + * file (i.e. contains no wildcards), then path is the name of the blob to + * which to upload that file. If filePattern contains one or more wildcards + * (and therefore may match multiple files), then path is the name of the + * blob virtual directory (which is prepended to each blob name) to which to * upload the file(s). If omitted, file(s) are uploaded to the root of the * container with a blob name matching their file name. - * @member {string} [container.containerUrl] The URL must include a Shared + * @property {string} [container.containerUrl] The URL must include a Shared * Access Signature (SAS) granting write permissions to the container. */ constructor() { diff --git a/lib/services/batch/lib/models/outputFileUploadOptions.js b/lib/services/batch/lib/models/outputFileUploadOptions.js index f13155b8af..ff61eb5103 100644 --- a/lib/services/batch/lib/models/outputFileUploadOptions.js +++ b/lib/services/batch/lib/models/outputFileUploadOptions.js @@ -18,7 +18,7 @@ class OutputFileUploadOptions { /** * Create a OutputFileUploadOptions. - * @member {string} uploadCondition The conditions under which the task + * @property {string} uploadCondition The conditions under which the task * output file or set of files should be uploaded. The default is * taskcompletion. Possible values include: 'taskSuccess', 'taskFailure', * 'taskCompletion' diff --git a/lib/services/batch/lib/models/poolAddOptions.js b/lib/services/batch/lib/models/poolAddOptions.js index d8286dcc24..ae9e825c61 100644 --- a/lib/services/batch/lib/models/poolAddOptions.js +++ b/lib/services/batch/lib/models/poolAddOptions.js @@ -17,17 +17,17 @@ class PoolAddOptions { /** * Create a PoolAddOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolAddParameter.js b/lib/services/batch/lib/models/poolAddParameter.js index af6c2117d8..d607fea9c7 100644 --- a/lib/services/batch/lib/models/poolAddParameter.js +++ b/lib/services/batch/lib/models/poolAddParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A pool in the Azure Batch service to add. * @@ -19,15 +17,15 @@ const models = require('./index'); class PoolAddParameter { /** * Create a PoolAddParameter. - * @member {string} id A string that uniquely identifies the pool within the - * account. The ID can contain any combination of alphanumeric characters + * @property {string} id A string that uniquely identifies the pool within + * the account. The ID can contain any combination of alphanumeric characters * including hyphens and underscores, and cannot contain more than 64 * characters. The ID is case-preserving and case-insensitive (that is, you * may not have two pool IDs within an account that differ only by case). - * @member {string} [displayName] The display name for the pool. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. - * @member {string} vmSize The size of virtual machines in the pool. All + * @property {string} [displayName] The display name for the pool. The + * display name need not be unique and can contain any Unicode characters up + * to a maximum length of 1024. + * @property {string} vmSize The size of virtual machines in the pool. All * virtual machines in a pool are the same size. For information about * available sizes of virtual machines for Cloud Services pools (pools * created with cloudServiceConfiguration), see Sizes for Cloud Services @@ -41,41 +39,42 @@ class PoolAddParameter { * (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). * Batch supports all Azure VM sizes except STANDARD_A0 and those with * premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). - * @member {object} [cloudServiceConfiguration] The cloud service + * @property {object} [cloudServiceConfiguration] The cloud service * configuration for the pool. This property and virtualMachineConfiguration * are mutually exclusive and one of the properties must be specified. This * property cannot be specified if the Batch account was created with its * poolAllocationMode property set to 'UserSubscription'. - * @member {string} [cloudServiceConfiguration.osFamily] Possible values are: + * @property {string} [cloudServiceConfiguration.osFamily] Possible values + * are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. * 3 - OS Family 3, equivalent to Windows Server 2012. * 4 - OS Family 4, equivalent to Windows Server 2012 R2. * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [cloudServiceConfiguration.osVersion] The default value + * @property {string} [cloudServiceConfiguration.osVersion] The default value * is * which specifies the latest operating system version for the specified * OS family. - * @member {object} [virtualMachineConfiguration] The virtual machine + * @property {object} [virtualMachineConfiguration] The virtual machine * configuration for the pool. This property and cloudServiceConfiguration * are mutually exclusive and one of the properties must be specified. - * @member {object} [virtualMachineConfiguration.imageReference] - * @member {string} [virtualMachineConfiguration.imageReference.publisher] + * @property {object} [virtualMachineConfiguration.imageReference] + * @property {string} [virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.offer] For + * @property {string} [virtualMachineConfiguration.imageReference.offer] For * example, UbuntuServer or WindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.sku] For + * @property {string} [virtualMachineConfiguration.imageReference.sku] For * example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [virtualMachineConfiguration.imageReference.version] A + * @property {string} [virtualMachineConfiguration.imageReference.version] A * value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [virtualMachineConfiguration.imageReference.virtualMachineImageId] This * property is mutually exclusive with other ImageReference properties. The * virtual machine image must be in the same region and subscription as the * Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch + * @property {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch * node agent is a program that runs on each node in the pool, and provides * the command-and-control interface between the node and the Batch service. * There are different implementations of the node agent, known as SKUs, for @@ -83,14 +82,14 @@ class PoolAddParameter { * matches the selected image reference. To get the list of supported node * agent SKUs along with their list of verified image references, see the * 'List supported node agent SKUs' operation. - * @member {object} [virtualMachineConfiguration.windowsConfiguration] This + * @property {object} [virtualMachineConfiguration.windowsConfiguration] This * property must not be specified if the imageReference property specifies a * Linux OS image. - * @member {boolean} + * @property {boolean} * [virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} [virtualMachineConfiguration.dataDisks] This property must - * be specified if the compute nodes in the pool need to have empty data + * @property {array} [virtualMachineConfiguration.dataDisks] 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 @@ -100,7 +99,7 @@ class PoolAddParameter { * 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. - * @member {string} [virtualMachineConfiguration.licenseType] This only + * @property {string} [virtualMachineConfiguration.licenseType] This only * applies to images that contain the Windows operating system, and should * only be used when you hold valid on-premises licenses for the nodes which * will be deployed. If omitted, no on-premises licensing discount is @@ -108,41 +107,41 @@ class PoolAddParameter { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [virtualMachineConfiguration.containerConfiguration] If + * @property {object} [virtualMachineConfiguration.containerConfiguration] If * specified, setup is performed on each node in the pool to allow tasks to * run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {moment.duration} [resizeTimeout] The timeout for allocation of + * @property {moment.duration} [resizeTimeout] The timeout for allocation of * compute nodes to the pool. This timeout applies only to manual scaling; it * has no effect when enableAutoScale is set to true. The default value is 15 * minutes. The minimum value is 5 minutes. If you specify a value less than * 5 minutes, the Batch service returns an error; if you are calling the REST * API directly, the HTTP status code is 400 (Bad Request). - * @member {number} [targetDedicatedNodes] The desired number of dedicated + * @property {number} [targetDedicatedNodes] The desired number of dedicated * compute nodes in the pool. This property must not be specified if * enableAutoScale is set to true. If enableAutoScale is set to false, then * you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} [targetLowPriorityNodes] The desired number of + * @property {number} [targetLowPriorityNodes] The desired number of * low-priority compute nodes in the pool. This property must not be * specified if enableAutoScale is set to true. If enableAutoScale is set to * false, then you must set either targetDedicatedNodes, * targetLowPriorityNodes, or both. - * @member {boolean} [enableAutoScale] Whether the pool size should + * @property {boolean} [enableAutoScale] Whether the pool size should * automatically adjust over time. If false, at least one of * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, * the autoScaleFormula property is required and the pool automatically * resizes according to the formula. The default value is false. - * @member {string} [autoScaleFormula] A formula for the desired number of + * @property {string} [autoScaleFormula] A formula for the desired number of * compute nodes in the pool. This property must not be specified if * enableAutoScale is set to false. It is required if enableAutoScale is set * to true. The formula is checked for validity before the pool is created. @@ -150,21 +149,21 @@ class PoolAddParameter { * detailed error information. For more information about specifying this * formula, see 'Automatically scale compute nodes in an Azure Batch pool' * (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/). - * @member {moment.duration} [autoScaleEvaluationInterval] The time interval - * at which to automatically adjust the pool size according to the autoscale - * formula. The default value is 15 minutes. The minimum and maximum value - * are 5 minutes and 168 hours respectively. If you specify a value less than - * 5 minutes or greater than 168 hours, the Batch service returns an error; - * if you are calling the REST API directly, the HTTP status code is 400 (Bad - * Request). - * @member {boolean} [enableInterNodeCommunication] Whether the pool permits - * direct communication between nodes. Enabling inter-node communication - * limits the maximum size of the pool due to deployment restrictions on the - * nodes of the pool. This may result in the pool not reaching its desired - * size. The default value is false. - * @member {object} [networkConfiguration] The network configuration for the - * pool. - * @member {string} [networkConfiguration.subnetId] This is of the form + * @property {moment.duration} [autoScaleEvaluationInterval] The time + * interval at which to automatically adjust the pool size according to the + * autoscale formula. The default value is 15 minutes. The minimum and + * maximum value are 5 minutes and 168 hours respectively. If you specify a + * value less than 5 minutes or greater than 168 hours, the Batch service + * returns an error; if you are calling the REST API directly, the HTTP + * status code is 400 (Bad Request). + * @property {boolean} [enableInterNodeCommunication] Whether the pool + * permits direct communication between nodes. Enabling inter-node + * communication limits the maximum size of the pool due to deployment + * restrictions on the nodes of the pool. This may result in the pool not + * reaching its desired size. The default value is false. + * @property {object} [networkConfiguration] The network configuration for + * the pool. + * @property {string} [networkConfiguration.subnetId] This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the * Azure Batch account. The specified subnet should have enough free IP @@ -176,19 +175,19 @@ class PoolAddParameter { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [networkConfiguration.dynamicVNetAssignmentScope] + * @property {string} [networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} [networkConfiguration.endpointConfiguration] Pool + * @property {object} [networkConfiguration.endpointConfiguration] Pool * endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [networkConfiguration.endpointConfiguration.inboundNATPools] The maximum * number of inbound NAT pools per Batch pool is 5. If the maximum number of * inbound NAT pools is exceeded the request fails with HTTP status code 400. - * @member {object} [startTask] A task specified to run on each compute node - * as it joins the pool. The task runs when the node is added to the pool or - * when the node is restarted. - * @member {string} [startTask.commandLine] The command line does not run + * @property {object} [startTask] A task specified to run on each compute + * node as it joins the pool. The task runs when the node is added to the + * pool or when the node is restarted. + * @property {string} [startTask.commandLine] The command line does not run * under a shell, and therefore cannot take advantage of shell features such * as environment variable expansion. If you want to take advantage of such * features, you should invoke the shell in the command line, for example @@ -197,48 +196,48 @@ class PoolAddParameter { * (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * @property {object} [startTask.containerSettings] When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These + * @property {string} [startTask.containerSettings.containerRunOptions] These * additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is + * @property {string} [startTask.containerSettings.imageName] This is the + * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [startTask.containerSettings.registry] This setting can + * @property {object} [startTask.containerSettings.registry] This setting can * be omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a + * @property {string} [startTask.containerSettings.registry.registryServer] + * If omitted, the default is "docker.io". + * @property {string} [startTask.containerSettings.registry.userName] + * @property {string} [startTask.containerSettings.registry.password] + * @property {array} [startTask.resourceFiles] Files listed under this + * element are located in the task's working directory. + * @property {array} [startTask.environmentSettings] + * @property {object} [startTask.userIdentity] If omitted, the task runs as a * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and + * @property {string} [startTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [startTask.userIdentity.autoUser] The userName and + * @property {object} [startTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The + * @property {string} [startTask.userIdentity.autoUser.scope] The default + * value is task. Possible values include: 'task', 'pool' + * @property {string} [startTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically + * @property {number} [startTask.maxTaskRetryCount] The Batch service retries + * a task if its exit code is nonzero. Note that this value specifically * controls the number of retries. The Batch service will try the task once, * and may then retry up to this limit. For example, if the maximum retry * count is 3, Batch tries the task up to 4 times (one initial try and 3 * retries). If the maximum retry count is 0, the Batch service does not * retry the task. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task + * @property {boolean} [startTask.waitForSuccess] If true and the start task * fails on a compute node, the Batch service retries the start task up to * its maximum retry count (maxTaskRetryCount). If the task has still not * completed successfully after all retries, then the Batch service marks the @@ -248,7 +247,7 @@ class PoolAddParameter { * other tasks can start executing on the compute node while the start task * is still running; and even if the start task fails, new tasks will * continue to be scheduled on the node. The default is false. - * @member {array} [certificateReferences] The list of certificates to be + * @property {array} [certificateReferences] The list of certificates to be * installed on each compute node in the pool. For Windows compute nodes, the * Batch service installs the certificates to the specified certificate store * and location. For Linux compute nodes, the certificates are stored in a @@ -257,25 +256,25 @@ class PoolAddParameter { * 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. - * @member {array} [applicationPackageReferences] The list of application + * @property {array} [applicationPackageReferences] The list of application * packages to be installed on each compute node in the pool. - * @member {array} [applicationLicenses] The list of application licenses the - * Batch service will make available on each compute node in the pool. The - * list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, - * pool creation will fail. - * @member {number} [maxTasksPerNode] The maximum number of tasks that can + * @property {array} [applicationLicenses] The list of application licenses + * the Batch service will make available on each compute node in the pool. + * The list of application licenses must be a subset of available Batch + * service application licenses. If a license is requested which is not + * supported, pool creation will fail. + * @property {number} [maxTasksPerNode] The maximum number of tasks that can * run concurrently on a single compute node in the pool. The default value * is 1. The maximum value of this setting depends on the size of the compute * nodes in the pool (the vmSize setting). - * @member {object} [taskSchedulingPolicy] How tasks are distributed across + * @property {object} [taskSchedulingPolicy] How tasks are distributed across * compute nodes in a pool. - * @member {string} [taskSchedulingPolicy.nodeFillType] Possible values + * @property {string} [taskSchedulingPolicy.nodeFillType] Possible values * include: 'spread', 'pack' - * @member {array} [userAccounts] The list of user accounts to be created on - * each node in the pool. - * @member {array} [metadata] A list of name-value pairs associated with the - * pool as metadata. The Batch service does not assign any meaning to + * @property {array} [userAccounts] The list of user accounts to be created + * on each node in the pool. + * @property {array} [metadata] A list of name-value pairs associated with + * the pool as metadata. The Batch service does not assign any meaning to * metadata; it is solely for the use of user code. */ constructor() { diff --git a/lib/services/batch/lib/models/poolDeleteMethodOptions.js b/lib/services/batch/lib/models/poolDeleteMethodOptions.js index 1d6ab3602c..92e7e7d8e3 100644 --- a/lib/services/batch/lib/models/poolDeleteMethodOptions.js +++ b/lib/services/batch/lib/models/poolDeleteMethodOptions.js @@ -17,30 +17,30 @@ class PoolDeleteMethodOptions { /** * Create a PoolDeleteMethodOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/poolDisableAutoScaleOptions.js b/lib/services/batch/lib/models/poolDisableAutoScaleOptions.js index 68f0734e05..cfdaecb635 100644 --- a/lib/services/batch/lib/models/poolDisableAutoScaleOptions.js +++ b/lib/services/batch/lib/models/poolDisableAutoScaleOptions.js @@ -17,17 +17,17 @@ class PoolDisableAutoScaleOptions { /** * Create a PoolDisableAutoScaleOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolEnableAutoScaleOptions.js b/lib/services/batch/lib/models/poolEnableAutoScaleOptions.js index f6bb97ce82..9ef22243d5 100644 --- a/lib/services/batch/lib/models/poolEnableAutoScaleOptions.js +++ b/lib/services/batch/lib/models/poolEnableAutoScaleOptions.js @@ -17,30 +17,30 @@ class PoolEnableAutoScaleOptions { /** * Create a PoolEnableAutoScaleOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/poolEnableAutoScaleParameter.js b/lib/services/batch/lib/models/poolEnableAutoScaleParameter.js index 5615177772..4fed08da9c 100644 --- a/lib/services/batch/lib/models/poolEnableAutoScaleParameter.js +++ b/lib/services/batch/lib/models/poolEnableAutoScaleParameter.js @@ -17,23 +17,24 @@ class PoolEnableAutoScaleParameter { /** * Create a PoolEnableAutoScaleParameter. - * @member {string} [autoScaleFormula] The formula for the desired number of - * compute nodes in the pool. The formula is checked for validity before it - * is applied to the pool. If the formula is not valid, the Batch service + * @property {string} [autoScaleFormula] The formula for the desired number + * of compute nodes in the pool. The formula is checked for validity before + * it is applied to the pool. If the formula is not valid, the Batch service * rejects the request with detailed error information. For more information * about specifying this formula, see Automatically scale compute nodes in an * Azure Batch pool * (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling). - * @member {moment.duration} [autoScaleEvaluationInterval] The time interval - * at which to automatically adjust the pool size according to the autoscale - * formula. The default value is 15 minutes. The minimum and maximum value - * are 5 minutes and 168 hours respectively. If you specify a value less than - * 5 minutes or greater than 168 hours, the Batch service rejects the request - * with an invalid property value error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). If you specify a new - * interval, then the existing autoscale evaluation schedule will be stopped - * and a new autoscale evaluation schedule will be started, with its starting - * time being the time when this request was issued. + * @property {moment.duration} [autoScaleEvaluationInterval] The time + * interval at which to automatically adjust the pool size according to the + * autoscale formula. The default value is 15 minutes. The minimum and + * maximum value are 5 minutes and 168 hours respectively. If you specify a + * value less than 5 minutes or greater than 168 hours, the Batch service + * rejects the request with an invalid property value error; if you are + * calling the REST API directly, the HTTP status code is 400 (Bad Request). + * If you specify a new interval, then the existing autoscale evaluation + * schedule will be stopped and a new autoscale evaluation schedule will be + * started, with its starting time being the time when this request was + * issued. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolEndpointConfiguration.js b/lib/services/batch/lib/models/poolEndpointConfiguration.js index 5814a23828..809700cf74 100644 --- a/lib/services/batch/lib/models/poolEndpointConfiguration.js +++ b/lib/services/batch/lib/models/poolEndpointConfiguration.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The endpoint configuration for a pool. * @@ -19,7 +17,7 @@ const models = require('./index'); class PoolEndpointConfiguration { /** * Create a PoolEndpointConfiguration. - * @member {array} inboundNATPools A list of inbound NAT pools that can be + * @property {array} inboundNATPools A list of inbound NAT pools that can be * used to address specific ports on an individual compute node externally. * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with diff --git a/lib/services/batch/lib/models/poolEvaluateAutoScaleOptions.js b/lib/services/batch/lib/models/poolEvaluateAutoScaleOptions.js index 8f1c4e3a95..6e161dc1f3 100644 --- a/lib/services/batch/lib/models/poolEvaluateAutoScaleOptions.js +++ b/lib/services/batch/lib/models/poolEvaluateAutoScaleOptions.js @@ -17,17 +17,17 @@ class PoolEvaluateAutoScaleOptions { /** * Create a PoolEvaluateAutoScaleOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolEvaluateAutoScaleParameter.js b/lib/services/batch/lib/models/poolEvaluateAutoScaleParameter.js index e046d952ae..d3298e239a 100644 --- a/lib/services/batch/lib/models/poolEvaluateAutoScaleParameter.js +++ b/lib/services/batch/lib/models/poolEvaluateAutoScaleParameter.js @@ -17,7 +17,7 @@ class PoolEvaluateAutoScaleParameter { /** * Create a PoolEvaluateAutoScaleParameter. - * @member {string} autoScaleFormula The formula for the desired number of + * @property {string} autoScaleFormula The formula for the desired number of * compute nodes in the pool. The formula is validated and its results * calculated, but it is not applied to the pool. To apply the formula to the * pool, 'Enable automatic scaling on a pool'. For more information about diff --git a/lib/services/batch/lib/models/poolExistsOptions.js b/lib/services/batch/lib/models/poolExistsOptions.js index d5de79c03f..817f773190 100644 --- a/lib/services/batch/lib/models/poolExistsOptions.js +++ b/lib/services/batch/lib/models/poolExistsOptions.js @@ -17,30 +17,30 @@ class PoolExistsOptions { /** * Create a PoolExistsOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/poolGetAllLifetimeStatisticsOptions.js b/lib/services/batch/lib/models/poolGetAllLifetimeStatisticsOptions.js index 52793ee72e..560aaecd5a 100644 --- a/lib/services/batch/lib/models/poolGetAllLifetimeStatisticsOptions.js +++ b/lib/services/batch/lib/models/poolGetAllLifetimeStatisticsOptions.js @@ -17,17 +17,17 @@ class PoolGetAllLifetimeStatisticsOptions { /** * Create a PoolGetAllLifetimeStatisticsOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolGetOptions.js b/lib/services/batch/lib/models/poolGetOptions.js index 9dfd40cad3..8f5027c51d 100644 --- a/lib/services/batch/lib/models/poolGetOptions.js +++ b/lib/services/batch/lib/models/poolGetOptions.js @@ -17,32 +17,32 @@ class PoolGetOptions { /** * Create a PoolGetOptions. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {string} [expand] An OData $expand clause. + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/poolInformation.js b/lib/services/batch/lib/models/poolInformation.js index 1928801954..bf76f08e2c 100644 --- a/lib/services/batch/lib/models/poolInformation.js +++ b/lib/services/batch/lib/models/poolInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Specifies how a job should be assigned to a pool. * @@ -19,15 +17,15 @@ const models = require('./index'); class PoolInformation { /** * Create a PoolInformation. - * @member {string} [poolId] The ID of an existing pool. All the tasks of the - * job will run on the specified pool. You must ensure that the pool + * @property {string} [poolId] The ID of an existing pool. All the tasks of + * the job will run on the specified pool. You must ensure that the pool * referenced by this property exists. If the pool does not exist at the time * the Batch service tries to schedule a job, no tasks for the job will run * until you create a pool with that id. Note that the Batch service will not * reject the job request; it will simply not run tasks until the pool * exists. You must specify either the pool ID or the auto pool * specification, but not both. - * @member {object} [autoPoolSpecification] Characteristics for a temporary + * @property {object} [autoPoolSpecification] Characteristics for a temporary * 'auto pool'. The Batch service will create this auto pool when the job is * submitted. If auto pool creation fails, the Batch service moves the job to * a completed state, and the pool creation error is set in the job's @@ -36,28 +34,28 @@ class PoolInformation { * Any user actions that affect the lifetime of the auto pool while the job * is active will result in unexpected behavior. You must specify either the * pool ID or the auto pool specification, but not both. - * @member {string} [autoPoolSpecification.autoPoolIdPrefix] The Batch + * @property {string} [autoPoolSpecification.autoPoolIdPrefix] The Batch * service assigns each auto pool a unique identifier on creation. To * distinguish between pools created for different purposes, you can specify * this element to add a prefix to the ID that is assigned. The prefix can be * up to 20 characters long. - * @member {string} [autoPoolSpecification.poolLifetimeOption] Possible + * @property {string} [autoPoolSpecification.poolLifetimeOption] Possible * values include: 'jobSchedule', 'job' - * @member {boolean} [autoPoolSpecification.keepAlive] If false, the Batch + * @property {boolean} [autoPoolSpecification.keepAlive] If false, the Batch * service deletes the pool once its lifetime (as determined by the * poolLifetimeOption setting) expires; that is, when the job or job schedule * completes. If true, the Batch service does not delete the pool * automatically. It is up to the user to delete auto pools created with this * option. - * @member {object} [autoPoolSpecification.pool] - * @member {string} [autoPoolSpecification.pool.displayName] The display name - * need not be unique and can contain any Unicode characters up to a maximum - * length of 1024. - * @member {string} [autoPoolSpecification.pool.vmSize] For information about - * available sizes of virtual machines in pools, see Choose a VM size for - * compute nodes in an Azure Batch pool + * @property {object} [autoPoolSpecification.pool] + * @property {string} [autoPoolSpecification.pool.displayName] The display + * name need not be unique and can contain any Unicode characters up to a + * maximum length of 1024. + * @property {string} [autoPoolSpecification.pool.vmSize] For information + * about available sizes of virtual machines in pools, see Choose a VM size + * for compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} [autoPoolSpecification.pool.cloudServiceConfiguration] + * @property {object} [autoPoolSpecification.pool.cloudServiceConfiguration] * This property must be specified if the pool needs to be created with Azure * PaaS VMs. This property and virtualMachineConfiguration are mutually * exclusive and one of the properties must be specified. If neither is @@ -65,7 +63,7 @@ class PoolInformation { * REST API directly, the HTTP status code is 400 (Bad Request). This * property cannot be specified if the Batch account was created with its * poolAllocationMode property set to 'UserSubscription'. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.cloudServiceConfiguration.osFamily] Possible * values are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. @@ -74,38 +72,39 @@ class PoolInformation { * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} + * @property {string} * [autoPoolSpecification.pool.cloudServiceConfiguration.osVersion] The * default value is * which specifies the latest operating system version for * the specified OS family. - * @member {object} [autoPoolSpecification.pool.virtualMachineConfiguration] - * This property must be specified if the pool needs to be created with Azure - * IaaS VMs. This property and cloudServiceConfiguration are mutually - * exclusive and one of the properties must be specified. If neither is - * specified then the Batch service returns an error; if you are calling the - * REST API directly, the HTTP status code is 400 (Bad Request). - * @member {object} + * @property {object} + * [autoPoolSpecification.pool.virtualMachineConfiguration] This property + * must be specified if the pool needs to be created with Azure IaaS VMs. + * This property and cloudServiceConfiguration are mutually exclusive and one + * of the properties must be specified. If neither is specified then the + * Batch service returns an error; if you are calling the REST API directly, + * the HTTP status code is 400 (Bad Request). + * @property {object} * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference] - * @member {string} + * @property {string} * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.offer] * For example, UbuntuServer or WindowsServer. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.sku] * For example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.version] * A value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.virtualMachineConfiguration.imageReference.virtualMachineImageId] * This property is mutually exclusive with other ImageReference properties. * The virtual machine image must be in the same region and subscription as * the Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.virtualMachineConfiguration.nodeAgentSKUId] * The Batch node agent is a program that runs on each node in the pool, and * provides the command-and-control interface between the node and the Batch @@ -114,14 +113,14 @@ class PoolInformation { * which matches the selected image reference. To get the list of supported * node agent SKUs along with their list of verified image references, see * the 'List supported node agent SKUs' operation. - * @member {object} + * @property {object} * [autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration] * This property must not be specified if the imageReference property * specifies a Linux OS image. - * @member {boolean} + * @property {boolean} * [autoPoolSpecification.pool.virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} + * @property {array} * [autoPoolSpecification.pool.virtualMachineConfiguration.dataDisks] 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 @@ -133,7 +132,7 @@ class PoolInformation { * 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. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.virtualMachineConfiguration.licenseType] This * only applies to images that contain the Windows operating system, and * should only be used when you hold valid on-premises licenses for the nodes @@ -142,66 +141,66 @@ class PoolInformation { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} + * @property {object} * [autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration] * If specified, setup is performed on each node in the pool to allow tasks * to run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [autoPoolSpecification.pool.virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} [autoPoolSpecification.pool.maxTasksPerNode] The default - * value is 1. The maximum value of this setting depends on the size of the - * compute nodes in the pool (the vmSize setting). - * @member {object} [autoPoolSpecification.pool.taskSchedulingPolicy] - * @member {string} + * @property {number} [autoPoolSpecification.pool.maxTasksPerNode] The + * default value is 1. The maximum value of this setting depends on the size + * of the compute nodes in the pool (the vmSize setting). + * @property {object} [autoPoolSpecification.pool.taskSchedulingPolicy] + * @property {string} * [autoPoolSpecification.pool.taskSchedulingPolicy.nodeFillType] Possible * values include: 'spread', 'pack' - * @member {moment.duration} [autoPoolSpecification.pool.resizeTimeout] This - * timeout applies only to manual scaling; it has no effect when + * @property {moment.duration} [autoPoolSpecification.pool.resizeTimeout] + * This timeout applies only to manual scaling; it has no effect when * enableAutoScale is set to true. The default value is 15 minutes. The * minimum value is 5 minutes. If you specify a value less than 5 minutes, * the Batch service rejects the request with an error; if you are calling * the REST API directly, the HTTP status code is 400 (Bad Request). - * @member {number} [autoPoolSpecification.pool.targetDedicatedNodes] This + * @property {number} [autoPoolSpecification.pool.targetDedicatedNodes] This * property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} [autoPoolSpecification.pool.targetLowPriorityNodes] This - * property must not be specified if enableAutoScale is set to true. If + * @property {number} [autoPoolSpecification.pool.targetLowPriorityNodes] + * This property must not be specified if enableAutoScale is set to true. If * enableAutoScale is set to false, then you must set either * targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {boolean} [autoPoolSpecification.pool.enableAutoScale] If false, + * @property {boolean} [autoPoolSpecification.pool.enableAutoScale] If false, * at least one of targetDedicateNodes and targetLowPriorityNodes must be * specified. If true, the autoScaleFormula element is required. The pool * automatically resizes according to the formula. The default value is * false. - * @member {string} [autoPoolSpecification.pool.autoScaleFormula] This + * @property {string} [autoPoolSpecification.pool.autoScaleFormula] This * property must not be specified if enableAutoScale is set to false. It is * required if enableAutoScale is set to true. The formula is checked for * validity before the pool is created. If the formula is not valid, the * Batch service rejects the request with detailed error information. - * @member {moment.duration} + * @property {moment.duration} * [autoPoolSpecification.pool.autoScaleEvaluationInterval] The default value * is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours * respectively. If you specify a value less than 5 minutes or greater than * 168 hours, the Batch service rejects the request with an invalid property * value error; if you are calling the REST API directly, the HTTP status * code is 400 (Bad Request). - * @member {boolean} + * @property {boolean} * [autoPoolSpecification.pool.enableInterNodeCommunication] Enabling * inter-node communication limits the maximum size of the pool due to * deployment restrictions on the nodes of the pool. This may result in the * pool not reaching its desired size. The default value is false. - * @member {object} [autoPoolSpecification.pool.networkConfiguration] - * @member {string} + * @property {object} [autoPoolSpecification.pool.networkConfiguration] + * @property {string} * [autoPoolSpecification.pool.networkConfiguration.subnetId] This is of the * form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. @@ -215,20 +214,20 @@ class PoolInformation { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} + * @property {string} * [autoPoolSpecification.pool.networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} + * @property {object} * [autoPoolSpecification.pool.networkConfiguration.endpointConfiguration] * Pool endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [autoPoolSpecification.pool.networkConfiguration.endpointConfiguration.inboundNATPools] * The maximum number of inbound NAT pools per Batch pool is 5. If the * maximum number of inbound NAT pools is exceeded the request fails with * HTTP status code 400. - * @member {object} [autoPoolSpecification.pool.startTask] - * @member {string} [autoPoolSpecification.pool.startTask.commandLine] The + * @property {object} [autoPoolSpecification.pool.startTask] + * @property {string} [autoPoolSpecification.pool.startTask.commandLine] The * command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you * want to take advantage of such features, you should invoke the shell in @@ -237,71 +236,74 @@ class PoolInformation { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [autoPoolSpecification.pool.startTask.containerSettings] - * When this is specified, all directories recursively below the - * AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) - * are mapped into the container, all task environment variables are mapped - * into the container, and the task command line is executed in the - * container. - * @member {string} + * @property {object} + * [autoPoolSpecification.pool.startTask.containerSettings] When this is + * specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR + * (the root of Azure Batch directories on the node) are mapped into the + * container, all task environment variables are mapped into the container, + * and the task command line is executed in the container. + * @property {string} * [autoPoolSpecification.pool.startTask.containerSettings.containerRunOptions] * These additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.startTask.containerSettings.imageName] This is * the full image reference, as would be specified to "docker pull". If no * tag is provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} + * @property {object} * [autoPoolSpecification.pool.startTask.containerSettings.registry] This * setting can be omitted if was already provided at pool creation. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.startTask.containerSettings.registry.registryServer] * If omitted, the default is "docker.io". - * @member {string} + * @property {string} * [autoPoolSpecification.pool.startTask.containerSettings.registry.userName] - * @member {string} + * @property {string} * [autoPoolSpecification.pool.startTask.containerSettings.registry.password] - * @member {array} [autoPoolSpecification.pool.startTask.resourceFiles] Files - * listed under this element are located in the task's working directory. - * @member {array} [autoPoolSpecification.pool.startTask.environmentSettings] - * @member {object} [autoPoolSpecification.pool.startTask.userIdentity] If + * @property {array} [autoPoolSpecification.pool.startTask.resourceFiles] + * Files listed under this element are located in the task's working + * directory. + * @property {array} + * [autoPoolSpecification.pool.startTask.environmentSettings] + * @property {object} [autoPoolSpecification.pool.startTask.userIdentity] If * omitted, the task runs as a non-administrative user unique to the task. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.startTask.userIdentity.userName] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {object} + * @property {object} * [autoPoolSpecification.pool.startTask.userIdentity.autoUser] The userName * and autoUser properties are mutually exclusive; you must specify one but * not both. - * @member {string} + * @property {string} * [autoPoolSpecification.pool.startTask.userIdentity.autoUser.scope] The * default value is task. Possible values include: 'task', 'pool' - * @member {string} + * @property {string} * [autoPoolSpecification.pool.startTask.userIdentity.autoUser.elevationLevel] * The default value is nonAdmin. Possible values include: 'nonAdmin', * 'admin' - * @member {number} [autoPoolSpecification.pool.startTask.maxTaskRetryCount] - * The Batch service retries a task if its exit code is nonzero. Note that - * this value specifically controls the number of retries. The Batch service - * will try the task once, and may then retry up to this limit. For example, - * if the maximum retry count is 3, Batch tries the task up to 4 times (one - * initial try and 3 retries). If the maximum retry count is 0, the Batch - * service does not retry the task. If the maximum retry count is -1, the - * Batch service retries the task without limit. - * @member {boolean} [autoPoolSpecification.pool.startTask.waitForSuccess] If - * true and the start task fails on a compute node, the Batch service retries - * the start task up to its maximum retry count (maxTaskRetryCount). If the - * task has still not completed successfully after all retries, then the - * Batch service marks the compute node unusable, and will not schedule tasks - * to it. This condition can be detected via the node state and failure info - * details. If false, the Batch service will not wait for the start task to - * complete. In this case, other tasks can start executing on the compute + * @property {number} + * [autoPoolSpecification.pool.startTask.maxTaskRetryCount] The Batch service + * retries a task if its exit code is nonzero. Note that this value + * specifically controls the number of retries. The Batch service will try + * the task once, and may then retry up to this limit. For example, if the + * maximum retry count is 3, Batch tries the task up to 4 times (one initial + * try and 3 retries). If the maximum retry count is 0, the Batch service + * does not retry the task. If the maximum retry count is -1, the Batch + * service retries the task without limit. + * @property {boolean} [autoPoolSpecification.pool.startTask.waitForSuccess] + * If true and the start task fails on a compute node, the Batch service + * retries the start task up to its maximum retry count (maxTaskRetryCount). + * If the task has still not completed successfully after all retries, then + * the Batch service marks the compute node unusable, and will not schedule + * tasks to it. This condition can be detected via the node state and failure + * info details. If false, the Batch service will not wait for the start task + * to complete. In this case, other tasks can start executing on the compute * node while the start task is still running; and even if the start task * fails, new tasks will continue to be scheduled on the node. The default is * false. - * @member {array} [autoPoolSpecification.pool.certificateReferences] For + * @property {array} [autoPoolSpecification.pool.certificateReferences] For * Windows compute nodes, the Batch service installs the certificates to the * specified certificate store and location. For Linux compute nodes, the * certificates are stored in a directory inside the task working directory @@ -310,15 +312,16 @@ class PoolInformation { * '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. - * @member {array} [autoPoolSpecification.pool.applicationPackageReferences] - * @member {array} [autoPoolSpecification.pool.applicationLicenses] The list - * of application licenses must be a subset of available Batch service + * @property {array} + * [autoPoolSpecification.pool.applicationPackageReferences] + * @property {array} [autoPoolSpecification.pool.applicationLicenses] The + * list of application licenses must be a subset of available Batch service * application licenses. If a license is requested which is not supported, * pool creation will fail. The permitted licenses available on the pool are * 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each * application license added to the pool. - * @member {array} [autoPoolSpecification.pool.userAccounts] - * @member {array} [autoPoolSpecification.pool.metadata] The Batch service + * @property {array} [autoPoolSpecification.pool.userAccounts] + * @property {array} [autoPoolSpecification.pool.metadata] The Batch service * does not assign any meaning to metadata; it is solely for the use of user * code. */ diff --git a/lib/services/batch/lib/models/poolListNextOptions.js b/lib/services/batch/lib/models/poolListNextOptions.js index 88c829c9f9..fedcd7809a 100644 --- a/lib/services/batch/lib/models/poolListNextOptions.js +++ b/lib/services/batch/lib/models/poolListNextOptions.js @@ -17,14 +17,14 @@ class PoolListNextOptions { /** * Create a PoolListNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolListOptions.js b/lib/services/batch/lib/models/poolListOptions.js index d7eb3dcf41..c11a86b09d 100644 --- a/lib/services/batch/lib/models/poolListOptions.js +++ b/lib/services/batch/lib/models/poolListOptions.js @@ -17,24 +17,25 @@ class PoolListOptions { /** * Create a PoolListOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 pools can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {string} [expand] An OData $expand clause. + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 pools can be returned. Default value: 1000 + * . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolListUsageMetricsNextOptions.js b/lib/services/batch/lib/models/poolListUsageMetricsNextOptions.js index c691864dc8..05ac4bcbf5 100644 --- a/lib/services/batch/lib/models/poolListUsageMetricsNextOptions.js +++ b/lib/services/batch/lib/models/poolListUsageMetricsNextOptions.js @@ -17,14 +17,14 @@ class PoolListUsageMetricsNextOptions { /** * Create a PoolListUsageMetricsNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolListUsageMetricsOptions.js b/lib/services/batch/lib/models/poolListUsageMetricsOptions.js index 87bf5dc9c8..7bea12c4bd 100644 --- a/lib/services/batch/lib/models/poolListUsageMetricsOptions.js +++ b/lib/services/batch/lib/models/poolListUsageMetricsOptions.js @@ -17,31 +17,31 @@ class PoolListUsageMetricsOptions { /** * Create a PoolListUsageMetricsOptions. - * @member {date} [startTime] The earliest time from which to include + * @property {date} [startTime] The earliest time from which to include * metrics. This must be at least two and a half hours before the current * time. If not specified this defaults to the start time of the last * aggregation interval currently available. - * @member {date} [endTime] The latest time from which to include metrics. + * @property {date} [endTime] The latest time from which to include metrics. * This must be at least two hours before the current time. If not specified * this defaults to the end time of the last aggregation interval currently * available. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 results will be returned. Default value: 1000 - * . - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 results will be returned. Default value: + * 1000 . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolListUsageMetricsResult.js b/lib/services/batch/lib/models/poolListUsageMetricsResult.js index 6fad3b4acc..4f943e50a3 100644 --- a/lib/services/batch/lib/models/poolListUsageMetricsResult.js +++ b/lib/services/batch/lib/models/poolListUsageMetricsResult.js @@ -16,7 +16,7 @@ class PoolListUsageMetricsResult extends Array { /** * Create a PoolListUsageMetricsResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/poolNodeCounts.js b/lib/services/batch/lib/models/poolNodeCounts.js index 7300bb01d2..36c9432ac6 100644 --- a/lib/services/batch/lib/models/poolNodeCounts.js +++ b/lib/services/batch/lib/models/poolNodeCounts.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The number of nodes in each state for a pool. * @@ -19,38 +17,39 @@ const models = require('./index'); class PoolNodeCounts { /** * Create a PoolNodeCounts. - * @member {string} poolId The ID of the pool. - * @member {object} [dedicated] The number of dedicated nodes in each state. - * @member {number} [dedicated.creating] - * @member {number} [dedicated.idle] - * @member {number} [dedicated.offline] - * @member {number} [dedicated.preempted] - * @member {number} [dedicated.rebooting] - * @member {number} [dedicated.reimaging] - * @member {number} [dedicated.running] - * @member {number} [dedicated.starting] - * @member {number} [dedicated.startTaskFailed] - * @member {number} [dedicated.leavingPool] - * @member {number} [dedicated.unknown] - * @member {number} [dedicated.unusable] - * @member {number} [dedicated.waitingForStartTask] - * @member {number} [dedicated.total] - * @member {object} [lowPriority] The number of low priority nodes in each + * @property {string} poolId The ID of the pool. + * @property {object} [dedicated] The number of dedicated nodes in each + * state. + * @property {number} [dedicated.creating] + * @property {number} [dedicated.idle] + * @property {number} [dedicated.offline] + * @property {number} [dedicated.preempted] + * @property {number} [dedicated.rebooting] + * @property {number} [dedicated.reimaging] + * @property {number} [dedicated.running] + * @property {number} [dedicated.starting] + * @property {number} [dedicated.startTaskFailed] + * @property {number} [dedicated.leavingPool] + * @property {number} [dedicated.unknown] + * @property {number} [dedicated.unusable] + * @property {number} [dedicated.waitingForStartTask] + * @property {number} [dedicated.total] + * @property {object} [lowPriority] The number of low priority nodes in each * state. - * @member {number} [lowPriority.creating] - * @member {number} [lowPriority.idle] - * @member {number} [lowPriority.offline] - * @member {number} [lowPriority.preempted] - * @member {number} [lowPriority.rebooting] - * @member {number} [lowPriority.reimaging] - * @member {number} [lowPriority.running] - * @member {number} [lowPriority.starting] - * @member {number} [lowPriority.startTaskFailed] - * @member {number} [lowPriority.leavingPool] - * @member {number} [lowPriority.unknown] - * @member {number} [lowPriority.unusable] - * @member {number} [lowPriority.waitingForStartTask] - * @member {number} [lowPriority.total] + * @property {number} [lowPriority.creating] + * @property {number} [lowPriority.idle] + * @property {number} [lowPriority.offline] + * @property {number} [lowPriority.preempted] + * @property {number} [lowPriority.rebooting] + * @property {number} [lowPriority.reimaging] + * @property {number} [lowPriority.running] + * @property {number} [lowPriority.starting] + * @property {number} [lowPriority.startTaskFailed] + * @property {number} [lowPriority.leavingPool] + * @property {number} [lowPriority.unknown] + * @property {number} [lowPriority.unusable] + * @property {number} [lowPriority.waitingForStartTask] + * @property {number} [lowPriority.total] */ constructor() { } diff --git a/lib/services/batch/lib/models/poolNodeCountsListResult.js b/lib/services/batch/lib/models/poolNodeCountsListResult.js index bf0e8a80e2..76dc179402 100644 --- a/lib/services/batch/lib/models/poolNodeCountsListResult.js +++ b/lib/services/batch/lib/models/poolNodeCountsListResult.js @@ -16,7 +16,7 @@ class PoolNodeCountsListResult extends Array { /** * Create a PoolNodeCountsListResult. - * @member {string} [odatanextLink] + * @property {string} [odatanextLink] */ constructor() { super(); diff --git a/lib/services/batch/lib/models/poolPatchOptions.js b/lib/services/batch/lib/models/poolPatchOptions.js index d2d9b7c084..4c951575e4 100644 --- a/lib/services/batch/lib/models/poolPatchOptions.js +++ b/lib/services/batch/lib/models/poolPatchOptions.js @@ -17,30 +17,30 @@ class PoolPatchOptions { /** * Create a PoolPatchOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/poolPatchParameter.js b/lib/services/batch/lib/models/poolPatchParameter.js index 38c8d702a3..0d54a1c683 100644 --- a/lib/services/batch/lib/models/poolPatchParameter.js +++ b/lib/services/batch/lib/models/poolPatchParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The set of changes to be made to a pool. * @@ -19,12 +17,12 @@ const models = require('./index'); class PoolPatchParameter { /** * Create a PoolPatchParameter. - * @member {object} [startTask] A task to run on each compute node as it + * @property {object} [startTask] A task to run on each compute node as it * joins the pool. The task runs when the node is added to the pool or when * the node is restarted. If this element is present, it overwrites any * existing start task. If omitted, any existing start task is left * unchanged. - * @member {string} [startTask.commandLine] The command line does not run + * @property {string} [startTask.commandLine] The command line does not run * under a shell, and therefore cannot take advantage of shell features such * as environment variable expansion. If you want to take advantage of such * features, you should invoke the shell in the command line, for example @@ -33,48 +31,48 @@ class PoolPatchParameter { * (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * @property {object} [startTask.containerSettings] When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These + * @property {string} [startTask.containerSettings.containerRunOptions] These * additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is + * @property {string} [startTask.containerSettings.imageName] This is the + * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [startTask.containerSettings.registry] This setting can + * @property {object} [startTask.containerSettings.registry] This setting can * be omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a + * @property {string} [startTask.containerSettings.registry.registryServer] + * If omitted, the default is "docker.io". + * @property {string} [startTask.containerSettings.registry.userName] + * @property {string} [startTask.containerSettings.registry.password] + * @property {array} [startTask.resourceFiles] Files listed under this + * element are located in the task's working directory. + * @property {array} [startTask.environmentSettings] + * @property {object} [startTask.userIdentity] If omitted, the task runs as a * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and + * @property {string} [startTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [startTask.userIdentity.autoUser] The userName and + * @property {object} [startTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The + * @property {string} [startTask.userIdentity.autoUser.scope] The default + * value is task. Possible values include: 'task', 'pool' + * @property {string} [startTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically + * @property {number} [startTask.maxTaskRetryCount] The Batch service retries + * a task if its exit code is nonzero. Note that this value specifically * controls the number of retries. The Batch service will try the task once, * and may then retry up to this limit. For example, if the maximum retry * count is 3, Batch tries the task up to 4 times (one initial try and 3 * retries). If the maximum retry count is 0, the Batch service does not * retry the task. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task + * @property {boolean} [startTask.waitForSuccess] If true and the start task * fails on a compute node, the Batch service retries the start task up to * its maximum retry count (maxTaskRetryCount). If the task has still not * completed successfully after all retries, then the Batch service marks the @@ -84,7 +82,7 @@ class PoolPatchParameter { * other tasks can start executing on the compute node while the start task * is still running; and even if the start task fails, new tasks will * continue to be scheduled on the node. The default is false. - * @member {array} [certificateReferences] A list of certificates to be + * @property {array} [certificateReferences] A list of certificates to be * installed on each compute node in the pool. If this element is present, it * replaces any existing certificate references configured on the pool. If * omitted, any existing certificate references are left unchanged. For @@ -96,7 +94,7 @@ class PoolPatchParameter { * '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. - * @member {array} [applicationPackageReferences] A list of application + * @property {array} [applicationPackageReferences] A list of application * packages to be installed on each compute node in the pool. Changes to * application package references affect all new compute nodes joining the * pool, but do not affect compute nodes that are already in the pool until @@ -105,8 +103,8 @@ class PoolPatchParameter { * collection, then all application package references are removed from the * pool. If omitted, any existing application package references are left * unchanged. - * @member {array} [metadata] A list of name-value pairs associated with the - * pool as metadata. If this element is present, it replaces any existing + * @property {array} [metadata] A list of name-value pairs associated with + * the pool as metadata. If this element is present, it replaces any existing * metadata configured on the pool. If you specify an empty collection, any * metadata is removed from the pool. If omitted, any existing metadata is * left unchanged. diff --git a/lib/services/batch/lib/models/poolRemoveNodesOptions.js b/lib/services/batch/lib/models/poolRemoveNodesOptions.js index c07873d743..ce4e80d9f1 100644 --- a/lib/services/batch/lib/models/poolRemoveNodesOptions.js +++ b/lib/services/batch/lib/models/poolRemoveNodesOptions.js @@ -17,30 +17,30 @@ class PoolRemoveNodesOptions { /** * Create a PoolRemoveNodesOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/poolResizeOptions.js b/lib/services/batch/lib/models/poolResizeOptions.js index 8bb813275c..f428a3726f 100644 --- a/lib/services/batch/lib/models/poolResizeOptions.js +++ b/lib/services/batch/lib/models/poolResizeOptions.js @@ -17,30 +17,30 @@ class PoolResizeOptions { /** * Create a PoolResizeOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/poolResizeParameter.js b/lib/services/batch/lib/models/poolResizeParameter.js index 9be305930d..5c8f1a67be 100644 --- a/lib/services/batch/lib/models/poolResizeParameter.js +++ b/lib/services/batch/lib/models/poolResizeParameter.js @@ -17,17 +17,17 @@ class PoolResizeParameter { /** * Create a PoolResizeParameter. - * @member {number} [targetDedicatedNodes] The desired number of dedicated + * @property {number} [targetDedicatedNodes] The desired number of dedicated * compute nodes in the pool. - * @member {number} [targetLowPriorityNodes] The desired number of + * @property {number} [targetLowPriorityNodes] The desired number of * low-priority compute nodes in the pool. - * @member {moment.duration} [resizeTimeout] The timeout for allocation of + * @property {moment.duration} [resizeTimeout] The timeout for allocation of * compute nodes to the pool or removal of compute nodes from the pool. The * default value is 15 minutes. The minimum value is 5 minutes. If you * specify a value less than 5 minutes, the Batch service returns an error; * if you are calling the REST API directly, the HTTP status code is 400 (Bad * Request). - * @member {string} [nodeDeallocationOption] Determines what to do with a + * @property {string} [nodeDeallocationOption] Determines what to do with a * node and its running task(s) if the pool size is decreasing. The default * value is requeue. Possible values include: 'requeue', 'terminate', * 'taskCompletion', 'retainedData' diff --git a/lib/services/batch/lib/models/poolSpecification.js b/lib/services/batch/lib/models/poolSpecification.js index baa852ebec..299281b0c7 100644 --- a/lib/services/batch/lib/models/poolSpecification.js +++ b/lib/services/batch/lib/models/poolSpecification.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Specification for creating a new pool. * @@ -19,15 +17,15 @@ const models = require('./index'); class PoolSpecification { /** * Create a PoolSpecification. - * @member {string} [displayName] The display name for the pool. The display - * name need not be unique and can contain any Unicode characters up to a - * maximum length of 1024. - * @member {string} vmSize The size of the virtual machines in the pool. All - * virtual machines in a pool are the same size. For information about + * @property {string} [displayName] The display name for the pool. The + * display name need not be unique and can contain any Unicode characters up + * to a maximum length of 1024. + * @property {string} vmSize The size of the virtual machines in the pool. + * All virtual machines in a pool are the same size. For information about * available sizes of virtual machines in pools, see Choose a VM size for * compute nodes in an Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {object} [cloudServiceConfiguration] The cloud service + * @property {object} [cloudServiceConfiguration] The cloud service * configuration for the pool. This property must be specified if the pool * needs to be created with Azure PaaS VMs. This property and * virtualMachineConfiguration are mutually exclusive and one of the @@ -36,40 +34,41 @@ class PoolSpecification { * HTTP status code is 400 (Bad Request). This property cannot be specified * if the Batch account was created with its poolAllocationMode property set * to 'UserSubscription'. - * @member {string} [cloudServiceConfiguration.osFamily] Possible values are: + * @property {string} [cloudServiceConfiguration.osFamily] Possible values + * are: * 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. * 3 - OS Family 3, equivalent to Windows Server 2012. * 4 - OS Family 4, equivalent to Windows Server 2012 R2. * 5 - OS Family 5, equivalent to Windows Server 2016. For more information, * see Azure Guest OS Releases * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). - * @member {string} [cloudServiceConfiguration.osVersion] The default value + * @property {string} [cloudServiceConfiguration.osVersion] The default value * is * which specifies the latest operating system version for the specified * OS family. - * @member {object} [virtualMachineConfiguration] The virtual machine + * @property {object} [virtualMachineConfiguration] The virtual machine * configuration for the pool. This property must be specified if the pool * needs to be created with Azure IaaS VMs. This property and * cloudServiceConfiguration are mutually exclusive and one of the properties * must be specified. If neither is specified then the Batch service returns * an error; if you are calling the REST API directly, the HTTP status code * is 400 (Bad Request). - * @member {object} [virtualMachineConfiguration.imageReference] - * @member {string} [virtualMachineConfiguration.imageReference.publisher] + * @property {object} [virtualMachineConfiguration.imageReference] + * @property {string} [virtualMachineConfiguration.imageReference.publisher] * For example, Canonical or MicrosoftWindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.offer] For + * @property {string} [virtualMachineConfiguration.imageReference.offer] For * example, UbuntuServer or WindowsServer. - * @member {string} [virtualMachineConfiguration.imageReference.sku] For + * @property {string} [virtualMachineConfiguration.imageReference.sku] For * example, 14.04.0-LTS or 2012-R2-Datacenter. - * @member {string} [virtualMachineConfiguration.imageReference.version] A + * @property {string} [virtualMachineConfiguration.imageReference.version] A * value of 'latest' can be specified to select the latest version of an * image. If omitted, the default is 'latest'. - * @member {string} + * @property {string} * [virtualMachineConfiguration.imageReference.virtualMachineImageId] This * property is mutually exclusive with other ImageReference properties. The * virtual machine image must be in the same region and subscription as the * Azure Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch + * @property {string} [virtualMachineConfiguration.nodeAgentSKUId] The Batch * node agent is a program that runs on each node in the pool, and provides * the command-and-control interface between the node and the Batch service. * There are different implementations of the node agent, known as SKUs, for @@ -77,14 +76,14 @@ class PoolSpecification { * matches the selected image reference. To get the list of supported node * agent SKUs along with their list of verified image references, see the * 'List supported node agent SKUs' operation. - * @member {object} [virtualMachineConfiguration.windowsConfiguration] This + * @property {object} [virtualMachineConfiguration.windowsConfiguration] This * property must not be specified if the imageReference property specifies a * Linux OS image. - * @member {boolean} + * @property {boolean} * [virtualMachineConfiguration.windowsConfiguration.enableAutomaticUpdates] * If omitted, the default value is true. - * @member {array} [virtualMachineConfiguration.dataDisks] This property must - * be specified if the compute nodes in the pool need to have empty data + * @property {array} [virtualMachineConfiguration.dataDisks] 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 @@ -94,7 +93,7 @@ class PoolSpecification { * 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. - * @member {string} [virtualMachineConfiguration.licenseType] This only + * @property {string} [virtualMachineConfiguration.licenseType] This only * applies to images that contain the Windows operating system, and should * only be used when you hold valid on-premises licenses for the nodes which * will be deployed. If omitted, no on-premises licensing discount is @@ -102,69 +101,69 @@ class PoolSpecification { * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [virtualMachineConfiguration.containerConfiguration] If + * @property {object} [virtualMachineConfiguration.containerConfiguration] If * specified, setup is performed on each node in the pool to allow tasks to * run in containers. All regular tasks and job manager tasks run on this * pool must specify the containerSettings property, and all other tasks may * specify it. - * @member {array} + * @property {array} * [virtualMachineConfiguration.containerConfiguration.containerImageNames] * This is the full image reference, as would be specified to "docker pull". * An image will be sourced from the default Docker registry unless the image * is fully qualified with an alternative registry. - * @member {array} + * @property {array} * [virtualMachineConfiguration.containerConfiguration.containerRegistries] * If any images must be downloaded from a private registry which requires * credentials, then those credentials must be provided here. - * @member {number} [maxTasksPerNode] The maximum number of tasks that can + * @property {number} [maxTasksPerNode] The maximum number of tasks that can * run concurrently on a single compute node in the pool. The default value * is 1. The maximum value of this setting depends on the size of the compute * nodes in the pool (the vmSize setting). - * @member {object} [taskSchedulingPolicy] How tasks are distributed across + * @property {object} [taskSchedulingPolicy] How tasks are distributed across * compute nodes in a pool. - * @member {string} [taskSchedulingPolicy.nodeFillType] Possible values + * @property {string} [taskSchedulingPolicy.nodeFillType] Possible values * include: 'spread', 'pack' - * @member {moment.duration} [resizeTimeout] The timeout for allocation of + * @property {moment.duration} [resizeTimeout] The timeout for allocation of * compute nodes to the pool. This timeout applies only to manual scaling; it * has no effect when enableAutoScale is set to true. The default value is 15 * minutes. The minimum value is 5 minutes. If you specify a value less than * 5 minutes, the Batch service rejects the request with an error; if you are * calling the REST API directly, the HTTP status code is 400 (Bad Request). - * @member {number} [targetDedicatedNodes] The desired number of dedicated + * @property {number} [targetDedicatedNodes] The desired number of dedicated * compute nodes in the pool. This property must not be specified if * enableAutoScale is set to true. If enableAutoScale is set to false, then * you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. - * @member {number} [targetLowPriorityNodes] The desired number of + * @property {number} [targetLowPriorityNodes] The desired number of * low-priority compute nodes in the pool. This property must not be * specified if enableAutoScale is set to true. If enableAutoScale is set to * false, then you must set either targetDedicatedNodes, * targetLowPriorityNodes, or both. - * @member {boolean} [enableAutoScale] Whether the pool size should + * @property {boolean} [enableAutoScale] Whether the pool size should * automatically adjust over time. If false, at least one of * targetDedicateNodes and targetLowPriorityNodes must be specified. If true, * the autoScaleFormula element is required. The pool automatically resizes * according to the formula. The default value is false. - * @member {string} [autoScaleFormula] The formula for the desired number of - * compute nodes in the pool. This property must not be specified if + * @property {string} [autoScaleFormula] The formula for the desired number + * of compute nodes in the pool. This property must not be specified if * enableAutoScale is set to false. It is required if enableAutoScale is set * to true. The formula is checked for validity before the pool is created. * If the formula is not valid, the Batch service rejects the request with * detailed error information. - * @member {moment.duration} [autoScaleEvaluationInterval] The time interval - * at which to automatically adjust the pool size according to the autoscale - * formula. The default value is 15 minutes. The minimum and maximum value - * are 5 minutes and 168 hours respectively. If you specify a value less than - * 5 minutes or greater than 168 hours, the Batch service rejects the request - * with an invalid property value error; if you are calling the REST API - * directly, the HTTP status code is 400 (Bad Request). - * @member {boolean} [enableInterNodeCommunication] Whether the pool permits - * direct communication between nodes. Enabling inter-node communication - * limits the maximum size of the pool due to deployment restrictions on the - * nodes of the pool. This may result in the pool not reaching its desired - * size. The default value is false. - * @member {object} [networkConfiguration] The network configuration for the - * pool. - * @member {string} [networkConfiguration.subnetId] This is of the form + * @property {moment.duration} [autoScaleEvaluationInterval] The time + * interval at which to automatically adjust the pool size according to the + * autoscale formula. The default value is 15 minutes. The minimum and + * maximum value are 5 minutes and 168 hours respectively. If you specify a + * value less than 5 minutes or greater than 168 hours, the Batch service + * rejects the request with an invalid property value error; if you are + * calling the REST API directly, the HTTP status code is 400 (Bad Request). + * @property {boolean} [enableInterNodeCommunication] Whether the pool + * permits direct communication between nodes. Enabling inter-node + * communication limits the maximum size of the pool due to deployment + * restrictions on the nodes of the pool. This may result in the pool not + * reaching its desired size. The default value is false. + * @property {object} [networkConfiguration] The network configuration for + * the pool. + * @property {string} [networkConfiguration.subnetId] This is of the form * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. * The virtual network must be in the same region and subscription as the * Azure Batch account. The specified subnet should have enough free IP @@ -176,19 +175,19 @@ class PoolSpecification { * with cloudServiceConfiguration both ARM and classic virtual networks are * supported. For more details, see: * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration - * @member {string} [networkConfiguration.dynamicVNetAssignmentScope] + * @property {string} [networkConfiguration.dynamicVNetAssignmentScope] * Possible values include: 'none', 'job' - * @member {object} [networkConfiguration.endpointConfiguration] Pool + * @property {object} [networkConfiguration.endpointConfiguration] Pool * endpoint configuration is only supported on pools with the * virtualMachineConfiguration property. - * @member {array} + * @property {array} * [networkConfiguration.endpointConfiguration.inboundNATPools] The maximum * number of inbound NAT pools per Batch pool is 5. If the maximum number of * inbound NAT pools is exceeded the request fails with HTTP status code 400. - * @member {object} [startTask] A task to run on each compute node as it + * @property {object} [startTask] A task to run on each compute node as it * joins the pool. The task runs when the node is added to the pool or when * the node is restarted. - * @member {string} [startTask.commandLine] The command line does not run + * @property {string} [startTask.commandLine] The command line does not run * under a shell, and therefore cannot take advantage of shell features such * as environment variable expansion. If you want to take advantage of such * features, you should invoke the shell in the command line, for example @@ -197,48 +196,48 @@ class PoolSpecification { * (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * @property {object} [startTask.containerSettings] When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These + * @property {string} [startTask.containerSettings.containerRunOptions] These * additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is + * @property {string} [startTask.containerSettings.imageName] This is the + * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [startTask.containerSettings.registry] This setting can + * @property {object} [startTask.containerSettings.registry] This setting can * be omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a + * @property {string} [startTask.containerSettings.registry.registryServer] + * If omitted, the default is "docker.io". + * @property {string} [startTask.containerSettings.registry.userName] + * @property {string} [startTask.containerSettings.registry.password] + * @property {array} [startTask.resourceFiles] Files listed under this + * element are located in the task's working directory. + * @property {array} [startTask.environmentSettings] + * @property {object} [startTask.userIdentity] If omitted, the task runs as a * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and + * @property {string} [startTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [startTask.userIdentity.autoUser] The userName and + * @property {object} [startTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The + * @property {string} [startTask.userIdentity.autoUser.scope] The default + * value is task. Possible values include: 'task', 'pool' + * @property {string} [startTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically + * @property {number} [startTask.maxTaskRetryCount] The Batch service retries + * a task if its exit code is nonzero. Note that this value specifically * controls the number of retries. The Batch service will try the task once, * and may then retry up to this limit. For example, if the maximum retry * count is 3, Batch tries the task up to 4 times (one initial try and 3 * retries). If the maximum retry count is 0, the Batch service does not * retry the task. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task + * @property {boolean} [startTask.waitForSuccess] If true and the start task * fails on a compute node, the Batch service retries the start task up to * its maximum retry count (maxTaskRetryCount). If the task has still not * completed successfully after all retries, then the Batch service marks the @@ -248,7 +247,7 @@ class PoolSpecification { * other tasks can start executing on the compute node while the start task * is still running; and even if the start task fails, new tasks will * continue to be scheduled on the node. The default is false. - * @member {array} [certificateReferences] A list of certificates to be + * @property {array} [certificateReferences] A list of certificates to be * installed on each compute node in the pool. For Windows compute nodes, the * Batch service installs the certificates to the specified certificate store * and location. For Linux compute nodes, the certificates are stored in a @@ -257,19 +256,19 @@ class PoolSpecification { * 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. - * @member {array} [applicationPackageReferences] The list of application + * @property {array} [applicationPackageReferences] The list of application * packages to be installed on each compute node in the pool. - * @member {array} [applicationLicenses] The list of application licenses the - * Batch service will make available on each compute node in the pool. The - * list of application licenses must be a subset of available Batch service - * application licenses. If a license is requested which is not supported, - * pool creation will fail. The permitted licenses available on the pool are - * 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each - * application license added to the pool. - * @member {array} [userAccounts] The list of user accounts to be created on - * each node in the pool. - * @member {array} [metadata] A list of name-value pairs associated with the - * pool as metadata. The Batch service does not assign any meaning to + * @property {array} [applicationLicenses] The list of application licenses + * the Batch service will make available on each compute node in the pool. + * The list of application licenses must be a subset of available Batch + * service application licenses. If a license is requested which is not + * supported, pool creation will fail. The permitted licenses available on + * the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge + * applies for each application license added to the pool. + * @property {array} [userAccounts] The list of user accounts to be created + * on each node in the pool. + * @property {array} [metadata] A list of name-value pairs associated with + * the pool as metadata. The Batch service does not assign any meaning to * metadata; it is solely for the use of user code. */ constructor() { diff --git a/lib/services/batch/lib/models/poolStatistics.js b/lib/services/batch/lib/models/poolStatistics.js index 6efdecf2f6..274753a105 100644 --- a/lib/services/batch/lib/models/poolStatistics.js +++ b/lib/services/batch/lib/models/poolStatistics.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Contains utilization and resource usage statistics for the lifetime * of a pool. @@ -20,32 +18,32 @@ const models = require('./index'); class PoolStatistics { /** * Create a PoolStatistics. - * @member {string} url The URL for the statistics. - * @member {date} startTime The start time of the time range covered by the + * @property {string} url The URL for the statistics. + * @property {date} startTime The start time of the time range covered by the * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last + * @property {date} lastUpdateTime The time at which the statistics were last * updated. All statistics are limited to the range between startTime and * lastUpdateTime. - * @member {object} [usageStats] Statistics related to pool usage, such as + * @property {object} [usageStats] Statistics related to pool usage, such as * the amount of core-time used. - * @member {date} [usageStats.startTime] - * @member {date} [usageStats.lastUpdateTime] - * @member {moment.duration} [usageStats.dedicatedCoreTime] - * @member {object} [resourceStats] Statistics related to resource + * @property {date} [usageStats.startTime] + * @property {date} [usageStats.lastUpdateTime] + * @property {moment.duration} [usageStats.dedicatedCoreTime] + * @property {object} [resourceStats] Statistics related to resource * consumption by compute nodes in the pool. - * @member {date} [resourceStats.startTime] - * @member {date} [resourceStats.lastUpdateTime] - * @member {number} [resourceStats.avgCPUPercentage] - * @member {number} [resourceStats.avgMemoryGiB] - * @member {number} [resourceStats.peakMemoryGiB] - * @member {number} [resourceStats.avgDiskGiB] - * @member {number} [resourceStats.peakDiskGiB] - * @member {number} [resourceStats.diskReadIOps] - * @member {number} [resourceStats.diskWriteIOps] - * @member {number} [resourceStats.diskReadGiB] - * @member {number} [resourceStats.diskWriteGiB] - * @member {number} [resourceStats.networkReadGiB] - * @member {number} [resourceStats.networkWriteGiB] + * @property {date} [resourceStats.startTime] + * @property {date} [resourceStats.lastUpdateTime] + * @property {number} [resourceStats.avgCPUPercentage] + * @property {number} [resourceStats.avgMemoryGiB] + * @property {number} [resourceStats.peakMemoryGiB] + * @property {number} [resourceStats.avgDiskGiB] + * @property {number} [resourceStats.peakDiskGiB] + * @property {number} [resourceStats.diskReadIOps] + * @property {number} [resourceStats.diskWriteIOps] + * @property {number} [resourceStats.diskReadGiB] + * @property {number} [resourceStats.diskWriteGiB] + * @property {number} [resourceStats.networkReadGiB] + * @property {number} [resourceStats.networkWriteGiB] */ constructor() { } diff --git a/lib/services/batch/lib/models/poolStopResizeOptions.js b/lib/services/batch/lib/models/poolStopResizeOptions.js index 0f778a7c1b..9413d62675 100644 --- a/lib/services/batch/lib/models/poolStopResizeOptions.js +++ b/lib/services/batch/lib/models/poolStopResizeOptions.js @@ -17,30 +17,30 @@ class PoolStopResizeOptions { /** * Create a PoolStopResizeOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/poolUpdatePropertiesOptions.js b/lib/services/batch/lib/models/poolUpdatePropertiesOptions.js index ccbfa2e7b6..8cf5152e04 100644 --- a/lib/services/batch/lib/models/poolUpdatePropertiesOptions.js +++ b/lib/services/batch/lib/models/poolUpdatePropertiesOptions.js @@ -17,17 +17,17 @@ class PoolUpdatePropertiesOptions { /** * Create a PoolUpdatePropertiesOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/poolUpdatePropertiesParameter.js b/lib/services/batch/lib/models/poolUpdatePropertiesParameter.js index abe5b5b04f..8311291e16 100644 --- a/lib/services/batch/lib/models/poolUpdatePropertiesParameter.js +++ b/lib/services/batch/lib/models/poolUpdatePropertiesParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The set of changes to be made to a pool. * @@ -19,12 +17,12 @@ const models = require('./index'); class PoolUpdatePropertiesParameter { /** * Create a PoolUpdatePropertiesParameter. - * @member {object} [startTask] A task to run on each compute node as it + * @property {object} [startTask] A task to run on each compute node as it * joins the pool. The task runs when the node is added to the pool or when * the node is restarted. If this element is present, it overwrites any * existing start task. If omitted, any existing start task is removed from * the pool. - * @member {string} [startTask.commandLine] The command line does not run + * @property {string} [startTask.commandLine] The command line does not run * under a shell, and therefore cannot take advantage of shell features such * as environment variable expansion. If you want to take advantage of such * features, you should invoke the shell in the command line, for example @@ -33,48 +31,48 @@ class PoolUpdatePropertiesParameter { * (relative to the task working directory), or use the Batch provided * environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [startTask.containerSettings] When this is specified, all - * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of + * @property {object} [startTask.containerSettings] When this is specified, + * all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of * Azure Batch directories on the node) are mapped into the container, all * task environment variables are mapped into the container, and the task * command line is executed in the container. - * @member {string} [startTask.containerSettings.containerRunOptions] These + * @property {string} [startTask.containerSettings.containerRunOptions] These * additional options are supplied as arguments to the "docker create" * command, in addition to those controlled by the Batch Service. - * @member {string} [startTask.containerSettings.imageName] This is the full - * image reference, as would be specified to "docker pull". If no tag is + * @property {string} [startTask.containerSettings.imageName] This is the + * full image reference, as would be specified to "docker pull". If no tag is * provided as part of the image name, the tag ":latest" is used as a * default. - * @member {object} [startTask.containerSettings.registry] This setting can + * @property {object} [startTask.containerSettings.registry] This setting can * be omitted if was already provided at pool creation. - * @member {string} [startTask.containerSettings.registry.registryServer] If - * omitted, the default is "docker.io". - * @member {string} [startTask.containerSettings.registry.userName] - * @member {string} [startTask.containerSettings.registry.password] - * @member {array} [startTask.resourceFiles] Files listed under this element - * are located in the task's working directory. - * @member {array} [startTask.environmentSettings] - * @member {object} [startTask.userIdentity] If omitted, the task runs as a + * @property {string} [startTask.containerSettings.registry.registryServer] + * If omitted, the default is "docker.io". + * @property {string} [startTask.containerSettings.registry.userName] + * @property {string} [startTask.containerSettings.registry.password] + * @property {array} [startTask.resourceFiles] Files listed under this + * element are located in the task's working directory. + * @property {array} [startTask.environmentSettings] + * @property {object} [startTask.userIdentity] If omitted, the task runs as a * non-administrative user unique to the task. - * @member {string} [startTask.userIdentity.userName] The userName and + * @property {string} [startTask.userIdentity.userName] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {object} [startTask.userIdentity.autoUser] The userName and + * @property {object} [startTask.userIdentity.autoUser] The userName and * autoUser properties are mutually exclusive; you must specify one but not * both. - * @member {string} [startTask.userIdentity.autoUser.scope] The default value - * is task. Possible values include: 'task', 'pool' - * @member {string} [startTask.userIdentity.autoUser.elevationLevel] The + * @property {string} [startTask.userIdentity.autoUser.scope] The default + * value is task. Possible values include: 'task', 'pool' + * @property {string} [startTask.userIdentity.autoUser.elevationLevel] The * default value is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [startTask.maxTaskRetryCount] The Batch service retries a - * task if its exit code is nonzero. Note that this value specifically + * @property {number} [startTask.maxTaskRetryCount] The Batch service retries + * a task if its exit code is nonzero. Note that this value specifically * controls the number of retries. The Batch service will try the task once, * and may then retry up to this limit. For example, if the maximum retry * count is 3, Batch tries the task up to 4 times (one initial try and 3 * retries). If the maximum retry count is 0, the Batch service does not * retry the task. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {boolean} [startTask.waitForSuccess] If true and the start task + * @property {boolean} [startTask.waitForSuccess] If true and the start task * fails on a compute node, the Batch service retries the start task up to * its maximum retry count (maxTaskRetryCount). If the task has still not * completed successfully after all retries, then the Batch service marks the @@ -84,7 +82,7 @@ class PoolUpdatePropertiesParameter { * other tasks can start executing on the compute node while the start task * is still running; and even if the start task fails, new tasks will * continue to be scheduled on the node. The default is false. - * @member {array} certificateReferences A list of certificates to be + * @property {array} certificateReferences A list of certificates to be * installed on each compute node in the pool. This list replaces any * existing certificate references configured on the pool. If you specify an * empty collection, any existing certificate references are removed from the @@ -96,7 +94,7 @@ class PoolUpdatePropertiesParameter { * 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. - * @member {array} applicationPackageReferences A list of application + * @property {array} applicationPackageReferences A list of application * packages to be installed on each compute node in the pool. The list * replaces any existing application package references on the pool. Changes * to application package references affect all new compute nodes joining the @@ -104,7 +102,7 @@ class PoolUpdatePropertiesParameter { * they are rebooted or reimaged. If omitted, or if you specify an empty * collection, any existing application packages references are removed from * the pool. - * @member {array} metadata A list of name-value pairs associated with the + * @property {array} metadata A list of name-value pairs associated with the * pool as metadata. This list replaces any existing metadata configured on * the pool. If omitted, or if you specify an empty collection, any existing * metadata is removed from the pool. diff --git a/lib/services/batch/lib/models/poolUsageMetrics.js b/lib/services/batch/lib/models/poolUsageMetrics.js index f68746a7e5..92f0f89bf3 100644 --- a/lib/services/batch/lib/models/poolUsageMetrics.js +++ b/lib/services/batch/lib/models/poolUsageMetrics.js @@ -17,18 +17,18 @@ class PoolUsageMetrics { /** * Create a PoolUsageMetrics. - * @member {string} poolId The ID of the pool whose metrics are aggregated in - * this entry. - * @member {date} startTime The start time of the aggregation interval + * @property {string} poolId The ID of the pool whose metrics are aggregated + * in this entry. + * @property {date} startTime The start time of the aggregation interval * covered by this entry. - * @member {date} endTime The end time of the aggregation interval covered by - * this entry. - * @member {string} vmSize The size of virtual machines in the pool. All VMs - * in a pool are the same size. For information about available sizes of + * @property {date} endTime The end time of the aggregation interval covered + * by this entry. + * @property {string} vmSize The size of virtual machines in the pool. All + * VMs in a pool are the same size. For information about available sizes of * virtual machines in pools, see Choose a VM size for compute nodes in an * Azure Batch pool * (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). - * @member {number} totalCoreHours The total core hours used in the pool + * @property {number} totalCoreHours The total core hours used in the pool * during this aggregation interval. */ constructor() { diff --git a/lib/services/batch/lib/models/recentJob.js b/lib/services/batch/lib/models/recentJob.js index 5337d9f157..b9b000040e 100644 --- a/lib/services/batch/lib/models/recentJob.js +++ b/lib/services/batch/lib/models/recentJob.js @@ -18,8 +18,8 @@ class RecentJob { /** * Create a RecentJob. - * @member {string} [id] The ID of the job. - * @member {string} [url] The URL of the job. + * @property {string} [id] The ID of the job. + * @property {string} [url] The URL of the job. */ constructor() { } diff --git a/lib/services/batch/lib/models/resizeError.js b/lib/services/batch/lib/models/resizeError.js index f0e4bc3148..6a6011ee31 100644 --- a/lib/services/batch/lib/models/resizeError.js +++ b/lib/services/batch/lib/models/resizeError.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An error that occurred when resizing a pool. * @@ -19,12 +17,12 @@ const models = require('./index'); class ResizeError { /** * Create a ResizeError. - * @member {string} [code] An identifier for the pool resize error. Codes are - * invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the pool resize error, + * @property {string} [code] An identifier for the pool resize error. Codes + * are invariant and are intended to be consumed programmatically. + * @property {string} [message] A message describing the pool resize error, * intended to be suitable for display in a user interface. - * @member {array} [values] A list of additional error details related to the - * pool resize error. + * @property {array} [values] A list of additional error details related to + * the pool resize error. */ constructor() { } diff --git a/lib/services/batch/lib/models/resourceFile.js b/lib/services/batch/lib/models/resourceFile.js index 48abd31572..d2270be23b 100644 --- a/lib/services/batch/lib/models/resourceFile.js +++ b/lib/services/batch/lib/models/resourceFile.js @@ -17,11 +17,11 @@ class ResourceFile { /** * Create a ResourceFile. - * @member {string} [autoStorageContainerName] The storage container name in - * the auto storage account. The autoStorageContainerName, + * @property {string} [autoStorageContainerName] The storage container name + * in the auto storage account. The autoStorageContainerName, * storageContainerUrl and httpUrl properties are mutually exclusive and one * of them must be specified. - * @member {string} [storageContainerUrl] The URL of the blob container + * @property {string} [storageContainerUrl] The URL of the blob container * within Azure Blob Storage. The autoStorageContainerName, * storageContainerUrl and httpUrl properties are mutually exclusive and one * of them must be specified. This URL must be readable and listable using @@ -30,7 +30,7 @@ class ResourceFile { * to get such a URL for a container in Azure storage: include a Shared * Access Signature (SAS) granting read permissions on the container, or set * the ACL for the container to allow public access. - * @member {string} [httpUrl] The URL of the file to download. The + * @property {string} [httpUrl] The URL of the file to download. The * autoStorageContainerName, storageContainerUrl and httpUrl properties are * mutually exclusive and one of them must be specified. If the URL points to * Azure Blob Storage, it must be readable using anonymous access; that is, @@ -38,13 +38,13 @@ class ResourceFile { * blob. There are two ways to get such a URL for a blob in Azure storage: * include a Shared Access Signature (SAS) granting read permissions on the * blob, or set the ACL for the blob or its container to allow public access. - * @member {string} [blobPrefix] The blob prefix to use when downloading + * @property {string} [blobPrefix] The blob prefix to use when downloading * blobs from an Azure Storage container. Only the blobs whose names begin * with the specified prefix will be downloaded. The property is valid only * when autoStorageContainerName or storageContainerUrl is used. This prefix * can be a partial filename or a subdirectory. If a prefix is not specified, * all the files in the container will be downloaded. - * @member {string} [filePath] The location on the compute node to which to + * @property {string} [filePath] The location on the compute node to which to * download the file(s), relative to the task's working directory. If the * httpUrl property is specified, the filePath is required and describes the * path which the file will be downloaded to, including the filename. @@ -55,7 +55,7 @@ class ResourceFile { * and appended to the specified filePath directory. The specified relative * path cannot break out of the task's working directory (for example by * using '..'). - * @member {string} [fileMode] The file permission mode attribute in octal + * @property {string} [fileMode] The file permission mode attribute in octal * format. This property applies only to files being downloaded to Linux * compute nodes. It will be ignored if it is specified for a resourceFile * which will be downloaded to a Windows node. If this property is not diff --git a/lib/services/batch/lib/models/resourceStatistics.js b/lib/services/batch/lib/models/resourceStatistics.js index 5493605713..2103a09afd 100644 --- a/lib/services/batch/lib/models/resourceStatistics.js +++ b/lib/services/batch/lib/models/resourceStatistics.js @@ -18,32 +18,32 @@ class ResourceStatistics { /** * Create a ResourceStatistics. - * @member {date} startTime The start time of the time range covered by the + * @property {date} startTime The start time of the time range covered by the * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last + * @property {date} lastUpdateTime The time at which the statistics were last * updated. All statistics are limited to the range between startTime and * lastUpdateTime. - * @member {number} avgCPUPercentage The average CPU usage across all nodes + * @property {number} avgCPUPercentage The average CPU usage across all nodes * in the pool (percentage per node). - * @member {number} avgMemoryGiB The average memory usage in GiB across all + * @property {number} avgMemoryGiB The average memory usage in GiB across all * nodes in the pool. - * @member {number} peakMemoryGiB The peak memory usage in GiB across all + * @property {number} peakMemoryGiB The peak memory usage in GiB across all * nodes in the pool. - * @member {number} avgDiskGiB The average used disk space in GiB across all + * @property {number} avgDiskGiB The average used disk space in GiB across + * all nodes in the pool. + * @property {number} peakDiskGiB The peak used disk space in GiB across all * nodes in the pool. - * @member {number} peakDiskGiB The peak used disk space in GiB across all - * nodes in the pool. - * @member {number} diskReadIOps The total number of disk read operations - * across all nodes in the pool. - * @member {number} diskWriteIOps The total number of disk write operations + * @property {number} diskReadIOps The total number of disk read operations * across all nodes in the pool. - * @member {number} diskReadGiB The total amount of data in GiB of disk reads + * @property {number} diskWriteIOps The total number of disk write operations * across all nodes in the pool. - * @member {number} diskWriteGiB The total amount of data in GiB of disk - * writes across all nodes in the pool. - * @member {number} networkReadGiB The total amount of data in GiB of network + * @property {number} diskReadGiB The total amount of data in GiB of disk * reads across all nodes in the pool. - * @member {number} networkWriteGiB The total amount of data in GiB of + * @property {number} diskWriteGiB The total amount of data in GiB of disk + * writes across all nodes in the pool. + * @property {number} networkReadGiB The total amount of data in GiB of + * network reads across all nodes in the pool. + * @property {number} networkWriteGiB The total amount of data in GiB of * network writes across all nodes in the pool. */ constructor() { diff --git a/lib/services/batch/lib/models/schedule.js b/lib/services/batch/lib/models/schedule.js index 12b133e4e1..087477bf30 100644 --- a/lib/services/batch/lib/models/schedule.js +++ b/lib/services/batch/lib/models/schedule.js @@ -17,16 +17,16 @@ class Schedule { /** * Create a Schedule. - * @member {date} [doNotRunUntil] The earliest time at which any job may be + * @property {date} [doNotRunUntil] The earliest time at which any job may be * created under this job schedule. If you do not specify a doNotRunUntil * time, the schedule becomes ready to create jobs immediately. - * @member {date} [doNotRunAfter] A time after which no job will be created + * @property {date} [doNotRunAfter] A time after which no job will be created * under this job schedule. The schedule will move to the completed state as * soon as this deadline is past and there is no active job under this job * schedule. If you do not specify a doNotRunAfter time, and you are creating * a recurring job schedule, the job schedule will remain active until you * explicitly terminate it. - * @member {moment.duration} [startWindow] The time interval, starting from + * @property {moment.duration} [startWindow] The time interval, starting from * the time at which the schedule indicates a job should be created, within * which a job must be created. If a job is not created within the * startWindow interval, then the 'opportunity' is lost; no job will be @@ -38,7 +38,7 @@ class Schedule { * minute. If you specify a lower value, the Batch service rejects the * schedule with an error; if you are calling the REST API directly, the HTTP * status code is 400 (Bad Request). - * @member {moment.duration} [recurrenceInterval] The time interval between + * @property {moment.duration} [recurrenceInterval] The time interval between * the start times of two successive jobs under the job schedule. A job * schedule can have at most one active job under it at any given time. * Because a job schedule can have at most one active job under it at any diff --git a/lib/services/batch/lib/models/startTask.js b/lib/services/batch/lib/models/startTask.js index 109d8b27f5..8ac47f4533 100644 --- a/lib/services/batch/lib/models/startTask.js +++ b/lib/services/batch/lib/models/startTask.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A task which is run when a compute node joins a pool in the Azure * Batch service, or when the compute node is rebooted or reimaged. @@ -31,7 +29,7 @@ const models = require('./index'); class StartTask { /** * Create a StartTask. - * @member {string} commandLine The command line of the start task. The + * @property {string} commandLine The command line of the start task. The * command line does not run under a shell, and therefore cannot take * advantage of shell features such as environment variable expansion. If you * want to take advantage of such features, you should invoke the shell in @@ -40,25 +38,25 @@ class StartTask { * it should use a relative path (relative to the task working directory), or * use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the start task runs. When this is specified, all directories + * @property {object} [containerSettings] The settings for the container + * under which the start task runs. When this is specified, all directories * recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch * directories on the node) are mapped into the container, all task * environment variables are mapped into the container, and the task command * line is executed in the container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image + * @property {string} [containerSettings.containerRunOptions] These + * additional options are supplied as arguments to the "docker create" + * command, in addition to those controlled by the Batch Service. + * @property {string} [containerSettings.imageName] This is the full image * reference, as would be specified to "docker pull". If no tag is provided * as part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted - * if was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, + * @property {object} [containerSettings.registry] This setting can be + * omitted if was already provided at pool creation. + * @property {string} [containerSettings.registry.registryServer] If omitted, * the default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {array} [resourceFiles] A list of files that the Batch service + * @property {string} [containerSettings.registry.userName] + * @property {string} [containerSettings.registry.password] + * @property {array} [resourceFiles] A list of files that the Batch service * will download to the compute node before running the command line. There * is a maximum size for the list of resource files. When the max size is * exceeded, the request will fail and the response error code will be @@ -66,28 +64,28 @@ class StartTask { * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. Files listed under this * element are located in the task's working directory. - * @member {array} [environmentSettings] A list of environment variable + * @property {array} [environmentSettings] A list of environment variable * settings for the start task. - * @member {object} [userIdentity] The user identity under which the start + * @property {object} [userIdentity] The user identity under which the start * task runs. If omitted, the task runs as a non-administrative user unique * to the task. - * @member {string} [userIdentity.userName] The userName and autoUser + * @property {string} [userIdentity.userName] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser + * @property {object} [userIdentity.autoUser] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value - * is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {number} [maxTaskRetryCount] The maximum number of times the task - * may be retried. The Batch service retries a task if its exit code is + * @property {string} [userIdentity.autoUser.scope] The default value is + * task. Possible values include: 'task', 'pool' + * @property {string} [userIdentity.autoUser.elevationLevel] The default + * value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @property {number} [maxTaskRetryCount] The maximum number of times the + * task may be retried. The Batch service retries a task if its exit code is * nonzero. Note that this value specifically controls the number of retries. * The Batch service will try the task once, and may then retry up to this * limit. For example, if the maximum retry count is 3, Batch tries the task * up to 4 times (one initial try and 3 retries). If the maximum retry count * is 0, the Batch service does not retry the task. If the maximum retry * count is -1, the Batch service retries the task without limit. - * @member {boolean} [waitForSuccess] Whether the Batch service should wait + * @property {boolean} [waitForSuccess] Whether the Batch service should wait * for the start task to complete successfully (that is, to exit with exit * code 0) before scheduling any tasks on the compute node. If true and the * start task fails on a compute node, the Batch service retries the start diff --git a/lib/services/batch/lib/models/startTaskInformation.js b/lib/services/batch/lib/models/startTaskInformation.js index d580d2ee24..cecee4340c 100644 --- a/lib/services/batch/lib/models/startTaskInformation.js +++ b/lib/services/batch/lib/models/startTaskInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Information about a start task running on a compute node. * @@ -19,55 +17,56 @@ const models = require('./index'); class StartTaskInformation { /** * Create a StartTaskInformation. - * @member {string} state The state of the start task on the compute node. + * @property {string} state The state of the start task on the compute node. * Possible values include: 'running', 'completed' - * @member {date} startTime The time at which the start task started running. - * This value is reset every time the task is restarted or retried (that is, - * this is the most recent time at which the start task started running). - * @member {date} [endTime] The time at which the start task stopped running. - * This is the end time of the most recent run of the start task, if that run - * has completed (even if that run failed and a retry is pending). This - * element is not present if the start task is currently running. - * @member {number} [exitCode] The exit code of the program specified on the - * start task command line. This property is set only if the start task is in - * the completed state. In general, the exit code for a process reflects the - * specific convention implemented by the application developer for that - * process. If you use the exit code value to make decisions in your code, be - * sure that you know the exit code convention used by the application - * process. However, if the Batch service terminates the start task (due to - * timeout, or user termination via the API) you may see an operating - * system-defined exit code. - * @member {object} [containerInfo] Information about the container under + * @property {date} startTime The time at which the start task started + * running. This value is reset every time the task is restarted or retried + * (that is, this is the most recent time at which the start task started + * running). + * @property {date} [endTime] The time at which the start task stopped + * running. This is the end time of the most recent run of the start task, if + * that run has completed (even if that run failed and a retry is pending). + * This element is not present if the start task is currently running. + * @property {number} [exitCode] The exit code of the program specified on + * the start task command line. This property is set only if the start task + * is in the completed state. In general, the exit code for a process + * reflects the specific convention implemented by the application developer + * for that process. If you use the exit code value to make decisions in your + * code, be sure that you know the exit code convention used by the + * application process. However, if the Batch service terminates the start + * task (due to timeout, or user termination via the API) you may see an + * operating system-defined exit code. + * @property {object} [containerInfo] Information about the container under * which the task is executing. This property is set only if the task runs in * a container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string + * @property {string} [containerInfo.containerId] + * @property {string} [containerInfo.state] This is the state of the + * container according to the Docker service. It is equivalent to the status + * field returned by "docker inspect". + * @property {string} [containerInfo.error] This is the detailed error string * from the Docker service, if available. It is equivalent to the error field * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: + * @property {object} [failureInfo] Information describing the task failure, + * if any. This property is set only if the task is in the completed state + * and encountered a failure. + * @property {string} [failureInfo.category] Possible values include: * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {number} retryCount The number of times the task has been retried - * by the Batch service. Task application failures (non-zero exit code) are - * retried, pre-processing errors (the task could not be run) and file upload - * errors are not retried. The Batch service will retry the task up to the - * limit specified by the constraints. - * @member {date} [lastRetryTime] The most recent time at which a retry of + * @property {string} [failureInfo.code] + * @property {string} [failureInfo.message] + * @property {array} [failureInfo.details] + * @property {number} retryCount The number of times the task has been + * retried by the Batch service. Task application failures (non-zero exit + * code) are retried, pre-processing errors (the task could not be run) and + * file upload errors are not retried. The Batch service will retry the task + * up to the limit specified by the constraints. + * @property {date} [lastRetryTime] The most recent time at which a retry of * the task started running. This element is present only if the task was * retried (i.e. retryCount is nonzero). If present, this is typically the * same as startTime, but may be different if the task has been restarted for * reasons other than retry; for example, if the compute node was rebooted * during a retry, then the startTime is updated but the lastRetryTime is * not. - * @member {string} [result] The result of the task execution. If the value + * @property {string} [result] The result of the task execution. If the value * is 'failed', then the details of the failure can be found in the * failureInfo property. Possible values include: 'success', 'failure' */ diff --git a/lib/services/batch/lib/models/subtaskInformation.js b/lib/services/batch/lib/models/subtaskInformation.js index 1cc06e9533..7f1c42603f 100644 --- a/lib/services/batch/lib/models/subtaskInformation.js +++ b/lib/services/batch/lib/models/subtaskInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Information about an Azure Batch subtask. * @@ -19,58 +17,58 @@ const models = require('./index'); class SubtaskInformation { /** * Create a SubtaskInformation. - * @member {number} [id] The ID of the subtask. - * @member {object} [nodeInfo] Information about the compute node on which + * @property {number} [id] The ID of the subtask. + * @property {object} [nodeInfo] Information about the compute node on which * the subtask ran. - * @member {string} [nodeInfo.affinityId] - * @member {string} [nodeInfo.nodeUrl] - * @member {string} [nodeInfo.poolId] - * @member {string} [nodeInfo.nodeId] - * @member {string} [nodeInfo.taskRootDirectory] - * @member {string} [nodeInfo.taskRootDirectoryUrl] - * @member {date} [startTime] The time at which the subtask started running. - * If the subtask has been restarted or retried, this is the most recent time - * at which the subtask started running. - * @member {date} [endTime] The time at which the subtask completed. This + * @property {string} [nodeInfo.affinityId] + * @property {string} [nodeInfo.nodeUrl] + * @property {string} [nodeInfo.poolId] + * @property {string} [nodeInfo.nodeId] + * @property {string} [nodeInfo.taskRootDirectory] + * @property {string} [nodeInfo.taskRootDirectoryUrl] + * @property {date} [startTime] The time at which the subtask started + * running. If the subtask has been restarted or retried, this is the most + * recent time at which the subtask started running. + * @property {date} [endTime] The time at which the subtask completed. This * property is set only if the subtask is in the Completed state. - * @member {number} [exitCode] The exit code of the program specified on the - * subtask command line. This property is set only if the subtask is in the - * completed state. In general, the exit code for a process reflects the + * @property {number} [exitCode] The exit code of the program specified on + * the subtask command line. This property is set only if the subtask is in + * the completed state. In general, the exit code for a process reflects the * specific convention implemented by the application developer for that * process. If you use the exit code value to make decisions in your code, be * sure that you know the exit code convention used by the application * process. However, if the Batch service terminates the subtask (due to * timeout, or user termination via the API) you may see an operating * system-defined exit code. - * @member {object} [containerInfo] Information about the container under + * @property {object} [containerInfo] Information about the container under * which the task is executing. This property is set only if the task runs in * a container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string + * @property {string} [containerInfo.containerId] + * @property {string} [containerInfo.state] This is the state of the + * container according to the Docker service. It is equivalent to the status + * field returned by "docker inspect". + * @property {string} [containerInfo.error] This is the detailed error string * from the Docker service, if available. It is equivalent to the error field * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: + * @property {object} [failureInfo] Information describing the task failure, + * if any. This property is set only if the task is in the completed state + * and encountered a failure. + * @property {string} [failureInfo.category] Possible values include: * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {string} [state] The current state of the subtask. Possible values - * include: 'preparing', 'running', 'completed' - * @member {date} [stateTransitionTime] The time at which the subtask entered - * its current state. - * @member {string} [previousState] The previous state of the subtask. This + * @property {string} [failureInfo.code] + * @property {string} [failureInfo.message] + * @property {array} [failureInfo.details] + * @property {string} [state] The current state of the subtask. Possible + * values include: 'preparing', 'running', 'completed' + * @property {date} [stateTransitionTime] The time at which the subtask + * entered its current state. + * @property {string} [previousState] The previous state of the subtask. This * property is not set if the subtask is in its initial running state. * Possible values include: 'preparing', 'running', 'completed' - * @member {date} [previousStateTransitionTime] The time at which the subtask - * entered its previous state. This property is not set if the subtask is in - * its initial running state. - * @member {string} [result] The result of the task execution. If the value + * @property {date} [previousStateTransitionTime] The time at which the + * subtask entered its previous state. This property is not set if the + * subtask is in its initial running state. + * @property {string} [result] The result of the task execution. If the value * is 'failed', then the details of the failure can be found in the * failureInfo property. Possible values include: 'success', 'failure' */ diff --git a/lib/services/batch/lib/models/taskAddCollectionOptions.js b/lib/services/batch/lib/models/taskAddCollectionOptions.js index c6353afeb9..a56c8ab5cb 100644 --- a/lib/services/batch/lib/models/taskAddCollectionOptions.js +++ b/lib/services/batch/lib/models/taskAddCollectionOptions.js @@ -17,17 +17,17 @@ class TaskAddCollectionOptions { /** * Create a TaskAddCollectionOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/taskAddCollectionParameter.js b/lib/services/batch/lib/models/taskAddCollectionParameter.js index c89ee18f1c..0e9cf814d2 100644 --- a/lib/services/batch/lib/models/taskAddCollectionParameter.js +++ b/lib/services/batch/lib/models/taskAddCollectionParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary A collection of Azure Batch tasks to add. * @@ -19,8 +17,8 @@ const models = require('./index'); class TaskAddCollectionParameter { /** * Create a TaskAddCollectionParameter. - * @member {array} value The collection of tasks to add. The maximum count of - * tasks is 100. The total serialized size of this collection must be less + * @property {array} value The collection of tasks to add. The maximum count + * of tasks is 100. The total serialized size of this collection must be less * than 1MB. If it is greater than 1MB (for example if each task has 100's of * resource files or environment variables), the request will fail with code * 'RequestBodyTooLarge' and should be retried again with fewer tasks. diff --git a/lib/services/batch/lib/models/taskAddCollectionResult.js b/lib/services/batch/lib/models/taskAddCollectionResult.js index b982a283ab..6e607f38ce 100644 --- a/lib/services/batch/lib/models/taskAddCollectionResult.js +++ b/lib/services/batch/lib/models/taskAddCollectionResult.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The result of adding a collection of tasks to a job. * @@ -19,7 +17,8 @@ const models = require('./index'); class TaskAddCollectionResult { /** * Create a TaskAddCollectionResult. - * @member {array} [value] The results of the add task collection operation. + * @property {array} [value] The results of the add task collection + * operation. */ constructor() { } diff --git a/lib/services/batch/lib/models/taskAddOptions.js b/lib/services/batch/lib/models/taskAddOptions.js index 0337f50a17..40059f0b24 100644 --- a/lib/services/batch/lib/models/taskAddOptions.js +++ b/lib/services/batch/lib/models/taskAddOptions.js @@ -17,17 +17,17 @@ class TaskAddOptions { /** * Create a TaskAddOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/taskAddParameter.js b/lib/services/batch/lib/models/taskAddParameter.js index 020552af5d..993ac708a8 100644 --- a/lib/services/batch/lib/models/taskAddParameter.js +++ b/lib/services/batch/lib/models/taskAddParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary An Azure Batch task to add. * @@ -30,15 +28,15 @@ const models = require('./index'); class TaskAddParameter { /** * Create a TaskAddParameter. - * @member {string} id A string that uniquely identifies the task within the - * job. The ID can contain any combination of alphanumeric characters + * @property {string} id A string that uniquely identifies the task within + * the job. The ID can contain any combination of alphanumeric characters * including hyphens and underscores, and cannot contain more than 64 * characters. The ID is case-preserving and case-insensitive (that is, you * may not have two IDs within a job that differ only by case). - * @member {string} [displayName] A display name for the task. The display + * @property {string} [displayName] A display name for the task. The display * name need not be unique and can contain any Unicode characters up to a * maximum length of 1024. - * @member {string} commandLine The command line of the task. For + * @property {string} commandLine The command line of the task. For * multi-instance tasks, the command line is executed as the primary task, * after the primary task and all subtasks have finished executing the * coordination command line. The command line does not run under a shell, @@ -49,8 +47,8 @@ class TaskAddParameter { * line refers to file paths, it should use a relative path (relative to the * task working directory), or use the Batch provided environment variable * (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). - * @member {object} [containerSettings] The settings for the container under - * which the task runs. If the pool that will run this task has + * @property {object} [containerSettings] The settings for the container + * under which the task runs. If the pool that will run this task has * containerConfiguration set, this must be set as well. If the pool that * will run this task doesn't have containerConfiguration set, this must not * be set. When this is specified, all directories recursively below the @@ -58,76 +56,76 @@ class TaskAddParameter { * are mapped into the container, all task environment variables are mapped * into the container, and the task command line is executed in the * container. - * @member {string} [containerSettings.containerRunOptions] These additional - * options are supplied as arguments to the "docker create" command, in - * addition to those controlled by the Batch Service. - * @member {string} [containerSettings.imageName] This is the full image + * @property {string} [containerSettings.containerRunOptions] These + * additional options are supplied as arguments to the "docker create" + * command, in addition to those controlled by the Batch Service. + * @property {string} [containerSettings.imageName] This is the full image * reference, as would be specified to "docker pull". If no tag is provided * as part of the image name, the tag ":latest" is used as a default. - * @member {object} [containerSettings.registry] This setting can be omitted - * if was already provided at pool creation. - * @member {string} [containerSettings.registry.registryServer] If omitted, + * @property {object} [containerSettings.registry] This setting can be + * omitted if was already provided at pool creation. + * @property {string} [containerSettings.registry.registryServer] If omitted, * the default is "docker.io". - * @member {string} [containerSettings.registry.userName] - * @member {string} [containerSettings.registry.password] - * @member {object} [exitConditions] How the Batch service should respond + * @property {string} [containerSettings.registry.userName] + * @property {string} [containerSettings.registry.password] + * @property {object} [exitConditions] How the Batch service should respond * when the task completes. - * @member {array} [exitConditions.exitCodes] - * @member {array} [exitConditions.exitCodeRanges] - * @member {object} [exitConditions.preProcessingError] - * @member {string} [exitConditions.preProcessingError.jobAction] 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). Possible values include: 'none', 'disable', - * 'terminate' - * @member {string} [exitConditions.preProcessingError.dependencyAction] The - * default is 'satisfy' for exit code 0, and 'block' for all other exit + * @property {array} [exitConditions.exitCodes] + * @property {array} [exitConditions.exitCodeRanges] + * @property {object} [exitConditions.preProcessingError] + * @property {string} [exitConditions.preProcessingError.jobAction] 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). Possible values + * include: 'none', 'disable', 'terminate' + * @property {string} [exitConditions.preProcessingError.dependencyAction] + * 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). * Possible values include: 'satisfy', 'block' - * @member {object} [exitConditions.fileUploadError] If the task exited with - * an exit code that was specified via exitCodes or exitCodeRanges, and then - * encountered a file upload error, then the action specified by the exit - * code takes precedence. - * @member {string} [exitConditions.fileUploadError.jobAction] 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 + * @property {object} [exitConditions.fileUploadError] If the task exited + * with an exit code that was specified via exitCodes or exitCodeRanges, and + * then encountered a file upload error, then the action specified by the + * exit code takes precedence. + * @property {string} [exitConditions.fileUploadError.jobAction] 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). Possible values include: 'none', 'disable', * 'terminate' - * @member {string} [exitConditions.fileUploadError.dependencyAction] The + * @property {string} [exitConditions.fileUploadError.dependencyAction] 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). * Possible values include: 'satisfy', 'block' - * @member {object} [exitConditions.default] This value is used if the task + * @property {object} [exitConditions.default] This value is used if the task * exits with any nonzero exit code not listed in the exitCodes or * exitCodeRanges collection, with a pre-processing error if the * preProcessingError property is not present, or with a file upload error if * the fileUploadError property is not present. If you want non-default * behavior on exit code 0, you must list it explicitly using the exitCodes * or exitCodeRanges collection. - * @member {string} [exitConditions.default.jobAction] The default is none + * @property {string} [exitConditions.default.jobAction] 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). Possible values include: 'none', 'disable', 'terminate' - * @member {string} [exitConditions.default.dependencyAction] 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). Possible values - * include: 'satisfy', 'block' - * @member {array} [resourceFiles] A list of files that the Batch service + * @property {string} [exitConditions.default.dependencyAction] 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). Possible + * values include: 'satisfy', 'block' + * @property {array} [resourceFiles] A list of files that the Batch service * will download to the compute node before running the command line. For * multi-instance tasks, the resource files will only be downloaded to the * compute node on which the primary task is executed. There is a maximum @@ -136,29 +134,29 @@ class TaskAddParameter { * RequestEntityTooLarge. If this occurs, the collection of ResourceFiles * must be reduced in size. This can be achieved using .zip files, * Application Packages, or Docker Containers. - * @member {array} [outputFiles] A list of files that the Batch service will - * upload from the compute node after running the command line. For + * @property {array} [outputFiles] A list of files that the Batch service + * will upload from the compute node after running the command line. For * multi-instance tasks, the files will only be uploaded from the compute * node on which the primary task is executed. - * @member {array} [environmentSettings] A list of environment variable + * @property {array} [environmentSettings] A list of environment variable * settings for the task. - * @member {object} [affinityInfo] A locality hint that can be used by the + * @property {object} [affinityInfo] A locality hint that can be used by the * Batch service to select a compute node on which to start the new task. - * @member {string} [affinityInfo.affinityId] You can pass the affinityId of - * a compute node to indicate that this task needs to run on that compute + * @property {string} [affinityInfo.affinityId] You can pass the affinityId + * of a compute node to indicate that this task needs to run on that compute * node. Note that this is just a soft affinity. If the target node is busy * or unavailable at the time the task is scheduled, then the task will be * scheduled elsewhere. - * @member {object} [constraints] The execution constraints that apply to + * @property {object} [constraints] The execution constraints that apply to * this task. If you do not specify constraints, the maxTaskRetryCount is the * maxTaskRetryCount specified for the job, the maxWallClockTime is infinite, * and the retentionTime is 7 days. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not + * @property {moment.duration} [constraints.maxWallClockTime] If this is not * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 + * @property {moment.duration} [constraints.retentionTime] The default is 7 * days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries for the task executable due to * a nonzero exit code. The Batch service will try the task once, and may * then retry up to this limit. For example, if the maximum retry count is 3, @@ -166,49 +164,49 @@ class TaskAddParameter { * maximum retry count is 0, the Batch service does not retry the task after * the first attempt. If the maximum retry count is -1, the Batch service * retries the task without limit. - * @member {object} [userIdentity] The user identity under which the task + * @property {object} [userIdentity] The user identity under which the task * runs. If omitted, the task runs as a non-administrative user unique to the * task. - * @member {string} [userIdentity.userName] The userName and autoUser + * @property {string} [userIdentity.userName] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {object} [userIdentity.autoUser] The userName and autoUser + * @property {object} [userIdentity.autoUser] The userName and autoUser * properties are mutually exclusive; you must specify one but not both. - * @member {string} [userIdentity.autoUser.scope] The default value is task. - * Possible values include: 'task', 'pool' - * @member {string} [userIdentity.autoUser.elevationLevel] The default value - * is nonAdmin. Possible values include: 'nonAdmin', 'admin' - * @member {object} [multiInstanceSettings] An object that indicates that the - * task is a multi-instance task, and contains information about how to run - * the multi-instance task. - * @member {number} [multiInstanceSettings.numberOfInstances] If omitted, the - * default is 1. - * @member {string} [multiInstanceSettings.coordinationCommandLine] A typical - * coordination command line launches a background service and verifies that - * the service is ready to process inter-node messages. - * @member {array} [multiInstanceSettings.commonResourceFiles] The difference - * between common resource files and task resource files is that common - * resource files are downloaded for all subtasks including the primary, - * whereas task resource files are downloaded only for the primary. Also note - * that these resource files are not downloaded to the task working + * @property {string} [userIdentity.autoUser.scope] The default value is + * task. Possible values include: 'task', 'pool' + * @property {string} [userIdentity.autoUser.elevationLevel] The default + * value is nonAdmin. Possible values include: 'nonAdmin', 'admin' + * @property {object} [multiInstanceSettings] An object that indicates that + * the task is a multi-instance task, and contains information about how to + * run the multi-instance task. + * @property {number} [multiInstanceSettings.numberOfInstances] If omitted, + * the default is 1. + * @property {string} [multiInstanceSettings.coordinationCommandLine] A + * typical coordination command line launches a background service and + * verifies that the service is ready to process inter-node messages. + * @property {array} [multiInstanceSettings.commonResourceFiles] The + * difference between common resource files and task resource files is that + * common resource files are downloaded for all subtasks including the + * primary, whereas task resource files are downloaded only for the primary. + * Also note that these resource files are not downloaded to the task working * directory, but instead are downloaded to the task root directory (one * directory above the working directory). There is a maximum size for the * list of resource files. When the max size is exceeded, the request will * fail and the response error code will be RequestEntityTooLarge. If this * occurs, the collection of ResourceFiles must be reduced in size. This can * be achieved using .zip files, Application Packages, or Docker Containers. - * @member {object} [dependsOn] The tasks that this task depends on. This + * @property {object} [dependsOn] The tasks that this task depends on. This * task will not be scheduled until all tasks that it depends on have * completed successfully. If any of those tasks fail and exhaust their retry * counts, this task will never be scheduled. If the job does not have * usesTaskDependencies set to true, and this element is present, the request * fails with error code TaskDependenciesNotSpecifiedOnJob. - * @member {array} [dependsOn.taskIds] The taskIds collection is limited to + * @property {array} [dependsOn.taskIds] The taskIds collection is limited to * 64000 characters total (i.e. the combined length of all task IDs). If the * taskIds collection exceeds the maximum length, the Add Task request fails * with error code TaskDependencyListTooLong. In this case consider using * task ID ranges instead. - * @member {array} [dependsOn.taskIdRanges] - * @member {array} [applicationPackageReferences] A list of application + * @property {array} [dependsOn.taskIdRanges] + * @property {array} [applicationPackageReferences] A list of application * packages that the Batch service will deploy to the compute node before * running the command line. Application packages are downloaded and deployed * to a shared directory, not the task working directory. Therefore, if a @@ -216,7 +214,7 @@ class TaskAddParameter { * it is not re-downloaded; the existing copy on the compute node is used. If * a referenced application package cannot be installed, for example because * the package has been deleted or because download failed, the task fails. - * @member {object} [authenticationTokenSettings] The settings for an + * @property {object} [authenticationTokenSettings] The settings for an * authentication token that the task can use to perform Batch service * operations. If this property is set, the Batch service provides the task * with an authentication token which can be used to authenticate Batch @@ -226,7 +224,7 @@ class TaskAddParameter { * settings. For example, a task can request job permissions in order to add * other tasks to the job, or check the status of the job or of other tasks * under the job. - * @member {array} [authenticationTokenSettings.access] The authentication + * @property {array} [authenticationTokenSettings.access] The authentication * token grants access to a limited set of Batch service operations. * Currently the only supported value for the access property is 'job', which * grants access to all operations related to the job which contains the diff --git a/lib/services/batch/lib/models/taskAddResult.js b/lib/services/batch/lib/models/taskAddResult.js index b1bfb3c506..c1fdc9578c 100644 --- a/lib/services/batch/lib/models/taskAddResult.js +++ b/lib/services/batch/lib/models/taskAddResult.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Result for a single task added as part of an add task collection * operation. @@ -20,24 +18,24 @@ const models = require('./index'); class TaskAddResult { /** * Create a TaskAddResult. - * @member {string} status The status of the add task request. Possible + * @property {string} status The status of the add task request. Possible * values include: 'success', 'clientError', 'serverError' - * @member {string} taskId The ID of the task for which this is the result. - * @member {string} [eTag] The ETag of the task, if the task was successfully - * added. You can use this to detect whether the task has changed between - * requests. In particular, you can be pass the ETag with an Update Task - * request to specify that your changes should take effect only if nobody - * else has modified the job in the meantime. - * @member {date} [lastModified] The last modified time of the task. - * @member {string} [location] The URL of the task, if the task was + * @property {string} taskId The ID of the task for which this is the result. + * @property {string} [eTag] The ETag of the task, if the task was + * successfully added. You can use this to detect whether the task has + * changed between requests. In particular, you can be pass the ETag with an + * Update Task request to specify that your changes should take effect only + * if nobody else has modified the job in the meantime. + * @property {date} [lastModified] The last modified time of the task. + * @property {string} [location] The URL of the task, if the task was * successfully added. - * @member {object} [error] The error encountered while attempting to add the - * task. - * @member {string} [error.code] - * @member {object} [error.message] - * @member {string} [error.message.lang] - * @member {string} [error.message.value] - * @member {array} [error.values] + * @property {object} [error] The error encountered while attempting to add + * the task. + * @property {string} [error.code] + * @property {object} [error.message] + * @property {string} [error.message.lang] + * @property {string} [error.message.value] + * @property {array} [error.values] */ constructor() { } diff --git a/lib/services/batch/lib/models/taskConstraints.js b/lib/services/batch/lib/models/taskConstraints.js index d4374b8b00..30c377cc3c 100644 --- a/lib/services/batch/lib/models/taskConstraints.js +++ b/lib/services/batch/lib/models/taskConstraints.js @@ -17,19 +17,19 @@ class TaskConstraints { /** * Create a TaskConstraints. - * @member {moment.duration} [maxWallClockTime] The maximum elapsed time that - * the task may run, measured from the time the task starts. If the task does - * not complete within the time limit, the Batch service terminates it. If - * this is not specified, there is no time limit on how long the task may + * @property {moment.duration} [maxWallClockTime] The maximum elapsed time + * that the task may run, measured from the time the task starts. If the task + * does not complete within the time limit, the Batch service terminates it. + * If this is not specified, there is no time limit on how long the task may * run. - * @member {moment.duration} [retentionTime] The minimum time to retain the + * @property {moment.duration} [retentionTime] The minimum time to retain the * task directory on the compute node where it ran, from the time it * completes execution. After this time, the Batch service may delete the * task directory and all its contents. The default is 7 days, i.e. the task * directory will be retained for 7 days unless the compute node is removed * or the job is deleted. - * @member {number} [maxTaskRetryCount] The maximum number of times the task - * may be retried. The Batch service retries a task if its exit code is + * @property {number} [maxTaskRetryCount] The maximum number of times the + * task may be retried. The Batch service retries a task if its exit code is * nonzero. Note that this value specifically controls the number of retries * for the task executable due to a nonzero exit code. The Batch service will * try the task once, and may then retry up to this limit. For example, if diff --git a/lib/services/batch/lib/models/taskContainerExecutionInformation.js b/lib/services/batch/lib/models/taskContainerExecutionInformation.js index 79bc9cfe58..da0b4bb6d8 100644 --- a/lib/services/batch/lib/models/taskContainerExecutionInformation.js +++ b/lib/services/batch/lib/models/taskContainerExecutionInformation.js @@ -17,11 +17,11 @@ class TaskContainerExecutionInformation { /** * Create a TaskContainerExecutionInformation. - * @member {string} [containerId] The ID of the container. - * @member {string} [state] The state of the container. This is the state of - * the container according to the Docker service. It is equivalent to the + * @property {string} [containerId] The ID of the container. + * @property {string} [state] The state of the container. This is the state + * of the container according to the Docker service. It is equivalent to the * status field returned by "docker inspect". - * @member {string} [error] Detailed error information about the container. + * @property {string} [error] Detailed error information about the container. * This is the detailed error string from the Docker service, if available. * It is equivalent to the error field returned by "docker inspect". */ diff --git a/lib/services/batch/lib/models/taskContainerSettings.js b/lib/services/batch/lib/models/taskContainerSettings.js index 23f2f437f8..de541b7429 100644 --- a/lib/services/batch/lib/models/taskContainerSettings.js +++ b/lib/services/batch/lib/models/taskContainerSettings.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The container settings for a task. * @@ -19,21 +17,21 @@ const models = require('./index'); class TaskContainerSettings { /** * Create a TaskContainerSettings. - * @member {string} [containerRunOptions] Additional options to the container - * create command. These additional options are supplied as arguments to the - * "docker create" command, in addition to those controlled by the Batch - * Service. - * @member {string} imageName The image to use to create the container in + * @property {string} [containerRunOptions] Additional options to the + * container create command. These additional options are supplied as + * arguments to the "docker create" command, in addition to those controlled + * by the Batch Service. + * @property {string} imageName The image to use to create the container in * which the task will run. This is the full image reference, as would be * specified to "docker pull". If no tag is provided as part of the image * name, the tag ":latest" is used as a default. - * @member {object} [registry] The private registry which contains the + * @property {object} [registry] The private registry which contains the * container image. This setting can be omitted if was already provided at * pool creation. - * @member {string} [registry.registryServer] If omitted, the default is + * @property {string} [registry.registryServer] If omitted, the default is * "docker.io". - * @member {string} [registry.userName] - * @member {string} [registry.password] + * @property {string} [registry.userName] + * @property {string} [registry.password] */ constructor() { } diff --git a/lib/services/batch/lib/models/taskCounts.js b/lib/services/batch/lib/models/taskCounts.js index 58c4615272..d9198361ec 100644 --- a/lib/services/batch/lib/models/taskCounts.js +++ b/lib/services/batch/lib/models/taskCounts.js @@ -17,14 +17,14 @@ class TaskCounts { /** * Create a TaskCounts. - * @member {number} active The number of tasks in the active state. - * @member {number} running The number of tasks in the running or preparing + * @property {number} active The number of tasks in the active state. + * @property {number} running The number of tasks in the running or preparing * state. - * @member {number} completed The number of tasks in the completed state. - * @member {number} succeeded The number of tasks which succeeded. A task + * @property {number} completed The number of tasks in the completed state. + * @property {number} succeeded The number of tasks which succeeded. A task * succeeds if its result (found in the executionInfo property) is 'success'. - * @member {number} failed The number of tasks which failed. A task fails if - * its result (found in the executionInfo property) is 'failure'. + * @property {number} failed The number of tasks which failed. A task fails + * if its result (found in the executionInfo property) is 'failure'. */ constructor() { } diff --git a/lib/services/batch/lib/models/taskDeleteMethodOptions.js b/lib/services/batch/lib/models/taskDeleteMethodOptions.js index 5f5e69a3e2..026367371e 100644 --- a/lib/services/batch/lib/models/taskDeleteMethodOptions.js +++ b/lib/services/batch/lib/models/taskDeleteMethodOptions.js @@ -17,30 +17,30 @@ class TaskDeleteMethodOptions { /** * Create a TaskDeleteMethodOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/taskDependencies.js b/lib/services/batch/lib/models/taskDependencies.js index abf0195dfd..4202aa1905 100644 --- a/lib/services/batch/lib/models/taskDependencies.js +++ b/lib/services/batch/lib/models/taskDependencies.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Specifies any dependencies of a task. Any task that is explicitly * specified or within a dependency range must complete before the dependant @@ -21,14 +19,14 @@ const models = require('./index'); class TaskDependencies { /** * Create a TaskDependencies. - * @member {array} [taskIds] The list of task IDs that this task depends on. - * All tasks in this list must complete successfully before the dependent + * @property {array} [taskIds] The list of task IDs that this task depends + * on. All tasks in this list must complete successfully before the dependent * task can be scheduled. The taskIds collection is limited to 64000 * characters total (i.e. the combined length of all task IDs). If the * taskIds collection exceeds the maximum length, the Add Task request fails * with error code TaskDependencyListTooLong. In this case consider using * task ID ranges instead. - * @member {array} [taskIdRanges] The list of task ID ranges that this task + * @property {array} [taskIdRanges] The list of task ID ranges that this task * depends on. All tasks in all ranges must complete successfully before the * dependent task can be scheduled. */ diff --git a/lib/services/batch/lib/models/taskExecutionInformation.js b/lib/services/batch/lib/models/taskExecutionInformation.js index 864f46aafb..52b8731934 100644 --- a/lib/services/batch/lib/models/taskExecutionInformation.js +++ b/lib/services/batch/lib/models/taskExecutionInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Information about the execution of a task. * @@ -19,17 +17,17 @@ const models = require('./index'); class TaskExecutionInformation { /** * Create a TaskExecutionInformation. - * @member {date} [startTime] The time at which the task started running. + * @property {date} [startTime] The time at which the task started running. * 'Running' corresponds to the running state, so if the task specifies * resource files or application packages, then the start time reflects the * time at which the task started downloading or deploying these. If the task * has been restarted or retried, this is the most recent time at which the * task started running. This property is present only for tasks that are in * the running or completed state. - * @member {date} [endTime] The time at which the task completed. This + * @property {date} [endTime] The time at which the task completed. This * property is set only if the task is in the Completed state. - * @member {number} [exitCode] The exit code of the program specified on the - * task command line. This property is set only if the task is in the + * @property {number} [exitCode] The exit code of the program specified on + * the task command line. This property is set only if the task is in the * completed state. In general, the exit code for a process reflects the * specific convention implemented by the application developer for that * process. If you use the exit code value to make decisions in your code, be @@ -37,46 +35,46 @@ class TaskExecutionInformation { * process. However, if the Batch service terminates the task (due to * timeout, or user termination via the API) you may see an operating * system-defined exit code. - * @member {object} [containerInfo] Information about the container under + * @property {object} [containerInfo] Information about the container under * which the task is executing. This property is set only if the task runs in * a container context. - * @member {string} [containerInfo.containerId] - * @member {string} [containerInfo.state] This is the state of the container - * according to the Docker service. It is equivalent to the status field - * returned by "docker inspect". - * @member {string} [containerInfo.error] This is the detailed error string + * @property {string} [containerInfo.containerId] + * @property {string} [containerInfo.state] This is the state of the + * container according to the Docker service. It is equivalent to the status + * field returned by "docker inspect". + * @property {string} [containerInfo.error] This is the detailed error string * from the Docker service, if available. It is equivalent to the error field * returned by "docker inspect". - * @member {object} [failureInfo] Information describing the task failure, if - * any. This property is set only if the task is in the completed state and - * encountered a failure. - * @member {string} [failureInfo.category] Possible values include: + * @property {object} [failureInfo] Information describing the task failure, + * if any. This property is set only if the task is in the completed state + * and encountered a failure. + * @property {string} [failureInfo.category] Possible values include: * 'userError', 'serverError' - * @member {string} [failureInfo.code] - * @member {string} [failureInfo.message] - * @member {array} [failureInfo.details] - * @member {number} retryCount The number of times the task has been retried - * by the Batch service. Task application failures (non-zero exit code) are - * retried, pre-processing errors (the task could not be run) and file upload - * errors are not retried. The Batch service will retry the task up to the - * limit specified by the constraints. - * @member {date} [lastRetryTime] The most recent time at which a retry of + * @property {string} [failureInfo.code] + * @property {string} [failureInfo.message] + * @property {array} [failureInfo.details] + * @property {number} retryCount The number of times the task has been + * retried by the Batch service. Task application failures (non-zero exit + * code) are retried, pre-processing errors (the task could not be run) and + * file upload errors are not retried. The Batch service will retry the task + * up to the limit specified by the constraints. + * @property {date} [lastRetryTime] The most recent time at which a retry of * the task started running. This element is present only if the task was * retried (i.e. retryCount is nonzero). If present, this is typically the * same as startTime, but may be different if the task has been restarted for * reasons other than retry; for example, if the compute node was rebooted * during a retry, then the startTime is updated but the lastRetryTime is * not. - * @member {number} requeueCount The number of times the task has been + * @property {number} requeueCount The number of times the task has been * requeued by the Batch service as the result of a user request. When the * user removes nodes from a pool (by resizing/shrinking the pool) or when * the job is being disabled, the user can specify that running tasks on the * nodes be requeued for execution. This count tracks how many times the task * has been requeued for these reasons. - * @member {date} [lastRequeueTime] The most recent time at which the task + * @property {date} [lastRequeueTime] The most recent time at which the task * has been requeued by the Batch service as the result of a user request. * This property is set only if the requeueCount is nonzero. - * @member {string} [result] The result of the task execution. If the value + * @property {string} [result] The result of the task execution. If the value * is 'failed', then the details of the failure can be found in the * failureInfo property. Possible values include: 'success', 'failure' */ diff --git a/lib/services/batch/lib/models/taskFailureInformation.js b/lib/services/batch/lib/models/taskFailureInformation.js index 999f4d80d9..a96e96a322 100644 --- a/lib/services/batch/lib/models/taskFailureInformation.js +++ b/lib/services/batch/lib/models/taskFailureInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Information about a task failure. * @@ -19,13 +17,13 @@ const models = require('./index'); class TaskFailureInformation { /** * Create a TaskFailureInformation. - * @member {string} category The category of the task error. Possible values - * include: 'userError', 'serverError' - * @member {string} [code] An identifier for the task error. Codes are + * @property {string} category The category of the task error. Possible + * values include: 'userError', 'serverError' + * @property {string} [code] An identifier for the task error. Codes are * invariant and are intended to be consumed programmatically. - * @member {string} [message] A message describing the task error, intended + * @property {string} [message] A message describing the task error, intended * to be suitable for display in a user interface. - * @member {array} [details] A list of additional details related to the + * @property {array} [details] A list of additional details related to the * error. */ constructor() { diff --git a/lib/services/batch/lib/models/taskGetOptions.js b/lib/services/batch/lib/models/taskGetOptions.js index 04df01ddfb..095bbee50d 100644 --- a/lib/services/batch/lib/models/taskGetOptions.js +++ b/lib/services/batch/lib/models/taskGetOptions.js @@ -17,32 +17,32 @@ class TaskGetOptions { /** * Create a TaskGetOptions. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {string} [expand] An OData $expand clause. + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/taskIdRange.js b/lib/services/batch/lib/models/taskIdRange.js index 7c1a449b17..bd227e8e88 100644 --- a/lib/services/batch/lib/models/taskIdRange.js +++ b/lib/services/batch/lib/models/taskIdRange.js @@ -22,8 +22,8 @@ class TaskIdRange { /** * Create a TaskIdRange. - * @member {number} start The first task ID in the range. - * @member {number} end The last task ID in the range. + * @property {number} start The first task ID in the range. + * @property {number} end The last task ID in the range. */ constructor() { } diff --git a/lib/services/batch/lib/models/taskInformation.js b/lib/services/batch/lib/models/taskInformation.js index 03c8f0dd68..b89641e10e 100644 --- a/lib/services/batch/lib/models/taskInformation.js +++ b/lib/services/batch/lib/models/taskInformation.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Information about a task running on a compute node. * @@ -19,68 +17,68 @@ const models = require('./index'); class TaskInformation { /** * Create a TaskInformation. - * @member {string} [taskUrl] The URL of the task. - * @member {string} [jobId] The ID of the job to which the task belongs. - * @member {string} [taskId] The ID of the task. - * @member {number} [subtaskId] The ID of the subtask if the task is a + * @property {string} [taskUrl] The URL of the task. + * @property {string} [jobId] The ID of the job to which the task belongs. + * @property {string} [taskId] The ID of the task. + * @property {number} [subtaskId] The ID of the subtask if the task is a * multi-instance task. - * @member {string} taskState The current state of the task. Possible values - * include: 'active', 'preparing', 'running', 'completed' - * @member {object} [executionInfo] Information about the execution of the + * @property {string} taskState The current state of the task. Possible + * values include: 'active', 'preparing', 'running', 'completed' + * @property {object} [executionInfo] Information about the execution of the * task. - * @member {date} [executionInfo.startTime] 'Running' corresponds to the + * @property {date} [executionInfo.startTime] 'Running' corresponds to the * running state, so if the task specifies resource files or application * packages, then the start time reflects the time at which the task started * downloading or deploying these. If the task has been restarted or retried, * this is the most recent time at which the task started running. This * property is present only for tasks that are in the running or completed * state. - * @member {date} [executionInfo.endTime] This property is set only if the + * @property {date} [executionInfo.endTime] This property is set only if the * task is in the Completed state. - * @member {number} [executionInfo.exitCode] This property is set only if the - * task is in the completed state. In general, the exit code for a process - * reflects the specific convention implemented by the application developer - * for that process. If you use the exit code value to make decisions in your - * code, be sure that you know the exit code convention used by the - * application process. However, if the Batch service terminates the task - * (due to timeout, or user termination via the API) you may see an operating - * system-defined exit code. - * @member {object} [executionInfo.containerInfo] This property is set only + * @property {number} [executionInfo.exitCode] This property is set only if + * the task is in the completed state. In general, the exit code for a + * process reflects the specific convention implemented by the application + * developer for that process. If you use the exit code value to make + * decisions in your code, be sure that you know the exit code convention + * used by the application process. However, if the Batch service terminates + * the task (due to timeout, or user termination via the API) you may see an + * operating system-defined exit code. + * @property {object} [executionInfo.containerInfo] This property is set only * if the task runs in a container context. - * @member {string} [executionInfo.containerInfo.containerId] - * @member {string} [executionInfo.containerInfo.state] This is the state of - * the container according to the Docker service. It is equivalent to the + * @property {string} [executionInfo.containerInfo.containerId] + * @property {string} [executionInfo.containerInfo.state] This is the state + * of the container according to the Docker service. It is equivalent to the * status field returned by "docker inspect". - * @member {string} [executionInfo.containerInfo.error] This is the detailed - * error string from the Docker service, if available. It is equivalent to - * the error field returned by "docker inspect". - * @member {object} [executionInfo.failureInfo] This property is set only if - * the task is in the completed state and encountered a failure. - * @member {string} [executionInfo.failureInfo.category] Possible values + * @property {string} [executionInfo.containerInfo.error] This is the + * detailed error string from the Docker service, if available. It is + * equivalent to the error field returned by "docker inspect". + * @property {object} [executionInfo.failureInfo] This property is set only + * if the task is in the completed state and encountered a failure. + * @property {string} [executionInfo.failureInfo.category] Possible values * include: 'userError', 'serverError' - * @member {string} [executionInfo.failureInfo.code] - * @member {string} [executionInfo.failureInfo.message] - * @member {array} [executionInfo.failureInfo.details] - * @member {number} [executionInfo.retryCount] Task application failures + * @property {string} [executionInfo.failureInfo.code] + * @property {string} [executionInfo.failureInfo.message] + * @property {array} [executionInfo.failureInfo.details] + * @property {number} [executionInfo.retryCount] Task application failures * (non-zero exit code) are retried, pre-processing errors (the task could * not be run) and file upload errors are not retried. The Batch service will * retry the task up to the limit specified by the constraints. - * @member {date} [executionInfo.lastRetryTime] This element is present only - * if the task was retried (i.e. retryCount is nonzero). If present, this is - * typically the same as startTime, but may be different if the task has been - * restarted for reasons other than retry; for example, if the compute node - * was rebooted during a retry, then the startTime is updated but the - * lastRetryTime is not. - * @member {number} [executionInfo.requeueCount] When the user removes nodes - * from a pool (by resizing/shrinking the pool) or when the job is being - * disabled, the user can specify that running tasks on the nodes be requeued - * for execution. This count tracks how many times the task has been requeued - * for these reasons. - * @member {date} [executionInfo.lastRequeueTime] This property is set only + * @property {date} [executionInfo.lastRetryTime] This element is present + * only if the task was retried (i.e. retryCount is nonzero). If present, + * this is typically the same as startTime, but may be different if the task + * has been restarted for reasons other than retry; for example, if the + * compute node was rebooted during a retry, then the startTime is updated + * but the lastRetryTime is not. + * @property {number} [executionInfo.requeueCount] When the user removes + * nodes from a pool (by resizing/shrinking the pool) or when the job is + * being disabled, the user can specify that running tasks on the nodes be + * requeued for execution. This count tracks how many times the task has been + * requeued for these reasons. + * @property {date} [executionInfo.lastRequeueTime] This property is set only * if the requeueCount is nonzero. - * @member {string} [executionInfo.result] If the value is 'failed', then the - * details of the failure can be found in the failureInfo property. Possible - * values include: 'success', 'failure' + * @property {string} [executionInfo.result] If the value is 'failed', then + * the details of the failure can be found in the failureInfo property. + * Possible values include: 'success', 'failure' */ constructor() { } diff --git a/lib/services/batch/lib/models/taskListNextOptions.js b/lib/services/batch/lib/models/taskListNextOptions.js index fec6f1ca36..cdfbfed43e 100644 --- a/lib/services/batch/lib/models/taskListNextOptions.js +++ b/lib/services/batch/lib/models/taskListNextOptions.js @@ -17,14 +17,14 @@ class TaskListNextOptions { /** * Create a TaskListNextOptions. - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/taskListOptions.js b/lib/services/batch/lib/models/taskListOptions.js index 1fb9ebe505..823fd09c60 100644 --- a/lib/services/batch/lib/models/taskListOptions.js +++ b/lib/services/batch/lib/models/taskListOptions.js @@ -17,24 +17,25 @@ class TaskListOptions { /** * Create a TaskListOptions. - * @member {string} [filter] An OData $filter clause. For more information on - * constructing this filter, see + * @property {string} [filter] An OData $filter clause. For more information + * on constructing this filter, see * https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks. - * @member {string} [select] An OData $select clause. - * @member {string} [expand] An OData $expand clause. - * @member {number} [maxResults] The maximum number of items to return in the - * response. A maximum of 1000 tasks can be returned. Default value: 1000 . - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {string} [expand] An OData $expand clause. + * @property {number} [maxResults] The maximum number of items to return in + * the response. A maximum of 1000 tasks can be returned. Default value: 1000 + * . + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/taskListSubtasksOptions.js b/lib/services/batch/lib/models/taskListSubtasksOptions.js index f713a5a93c..edc1cf92b8 100644 --- a/lib/services/batch/lib/models/taskListSubtasksOptions.js +++ b/lib/services/batch/lib/models/taskListSubtasksOptions.js @@ -17,18 +17,18 @@ class TaskListSubtasksOptions { /** * Create a TaskListSubtasksOptions. - * @member {string} [select] An OData $select clause. - * @member {number} [timeout] The maximum time that the server can spend + * @property {string} [select] An OData $select clause. + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. */ constructor() { } diff --git a/lib/services/batch/lib/models/taskReactivateOptions.js b/lib/services/batch/lib/models/taskReactivateOptions.js index 036de99c23..6b8a746c80 100644 --- a/lib/services/batch/lib/models/taskReactivateOptions.js +++ b/lib/services/batch/lib/models/taskReactivateOptions.js @@ -17,30 +17,30 @@ class TaskReactivateOptions { /** * Create a TaskReactivateOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/taskSchedulingPolicy.js b/lib/services/batch/lib/models/taskSchedulingPolicy.js index 36c3895eeb..087552a74a 100644 --- a/lib/services/batch/lib/models/taskSchedulingPolicy.js +++ b/lib/services/batch/lib/models/taskSchedulingPolicy.js @@ -17,7 +17,7 @@ class TaskSchedulingPolicy { /** * Create a TaskSchedulingPolicy. - * @member {string} nodeFillType How tasks are distributed across compute + * @property {string} nodeFillType How tasks are distributed across compute * nodes in a pool. Possible values include: 'spread', 'pack' */ constructor() { diff --git a/lib/services/batch/lib/models/taskStatistics.js b/lib/services/batch/lib/models/taskStatistics.js index 32e9c4292f..aa16cb29c5 100644 --- a/lib/services/batch/lib/models/taskStatistics.js +++ b/lib/services/batch/lib/models/taskStatistics.js @@ -17,30 +17,31 @@ class TaskStatistics { /** * Create a TaskStatistics. - * @member {string} url The URL of the statistics. - * @member {date} startTime The start time of the time range covered by the + * @property {string} url The URL of the statistics. + * @property {date} startTime The start time of the time range covered by the * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last + * @property {date} lastUpdateTime The time at which the statistics were last * updated. All statistics are limited to the range between startTime and * lastUpdateTime. - * @member {moment.duration} userCPUTime The total user mode CPU time (summed - * across all cores and all compute nodes) consumed by the task. - * @member {moment.duration} kernelCPUTime The total kernel mode CPU time + * @property {moment.duration} userCPUTime The total user mode CPU time * (summed across all cores and all compute nodes) consumed by the task. - * @member {moment.duration} wallClockTime The total wall clock time of the + * @property {moment.duration} kernelCPUTime The total kernel mode CPU time + * (summed across all cores and all compute nodes) consumed by the task. + * @property {moment.duration} wallClockTime The total wall clock time of the * task. The wall clock time is the elapsed time from when the task started * running on a compute node to when it finished (or to the last time the * statistics were updated, if the task had not finished by then). If the * task was retried, this includes the wall clock time of all the task * retries. - * @member {number} readIOps The total number of disk read operations made by - * the task. - * @member {number} writeIOps The total number of disk write operations made + * @property {number} readIOps The total number of disk read operations made * by the task. - * @member {number} readIOGiB The total gibibytes read from disk by the task. - * @member {number} writeIOGiB The total gibibytes written to disk by the + * @property {number} writeIOps The total number of disk write operations + * made by the task. + * @property {number} readIOGiB The total gibibytes read from disk by the + * task. + * @property {number} writeIOGiB The total gibibytes written to disk by the * task. - * @member {moment.duration} waitTime The total wait time of the task. The + * @property {moment.duration} waitTime The total wait time of the task. The * wait time for a task is defined as the elapsed time between the creation * of the task and the start of task execution. (If the task is retried due * to failures, the wait time is the time to the most recent task diff --git a/lib/services/batch/lib/models/taskTerminateOptions.js b/lib/services/batch/lib/models/taskTerminateOptions.js index 1ce24cae76..c7bba7d85d 100644 --- a/lib/services/batch/lib/models/taskTerminateOptions.js +++ b/lib/services/batch/lib/models/taskTerminateOptions.js @@ -17,30 +17,30 @@ class TaskTerminateOptions { /** * Create a TaskTerminateOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/taskUpdateOptions.js b/lib/services/batch/lib/models/taskUpdateOptions.js index 02028775f9..da5ee6920c 100644 --- a/lib/services/batch/lib/models/taskUpdateOptions.js +++ b/lib/services/batch/lib/models/taskUpdateOptions.js @@ -17,30 +17,30 @@ class TaskUpdateOptions { /** * Create a TaskUpdateOptions. - * @member {number} [timeout] The maximum time that the server can spend + * @property {number} [timeout] The maximum time that the server can spend * processing the request, in seconds. The default is 30 seconds. Default * value: 30 . - * @member {uuid} [clientRequestId] The caller-generated request identity, in - * the form of a GUID with no decoration such as curly braces, e.g. + * @property {uuid} [clientRequestId] The caller-generated request identity, + * in the form of a GUID with no decoration such as curly braces, e.g. * 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. - * @member {boolean} [returnClientRequestId] Whether the server should return - * the client-request-id in the response. Default value: false . - * @member {date} [ocpDate] The time the request was issued. Client libraries - * typically set this to the current system clock time; set it explicitly if - * you are calling the REST API directly. - * @member {string} [ifMatch] An ETag value associated with the version of + * @property {boolean} [returnClientRequestId] Whether the server should + * return the client-request-id in the response. Default value: false . + * @property {date} [ocpDate] The time the request was issued. Client + * libraries typically set this to the current system clock time; set it + * explicitly if you are calling the REST API directly. + * @property {string} [ifMatch] An ETag value associated with the version of * the resource known to the client. The operation will be performed only if * the resource's current ETag on the service exactly matches the value * specified by the client. - * @member {string} [ifNoneMatch] An ETag value associated with the version + * @property {string} [ifNoneMatch] An ETag value associated with the version * of the resource known to the client. The operation will be performed only * if the resource's current ETag on the service does not match the value * specified by the client. - * @member {date} [ifModifiedSince] A timestamp indicating the last modified - * time of the resource known to the client. The operation will be performed - * only if the resource on the service has been modified since the specified - * time. - * @member {date} [ifUnmodifiedSince] A timestamp indicating the last + * @property {date} [ifModifiedSince] A timestamp indicating the last + * modified time of the resource known to the client. The operation will be + * performed only if the resource on the service has been modified since the + * specified time. + * @property {date} [ifUnmodifiedSince] A timestamp indicating the last * modified time of the resource known to the client. The operation will be * performed only if the resource on the service has not been modified since * the specified time. diff --git a/lib/services/batch/lib/models/taskUpdateParameter.js b/lib/services/batch/lib/models/taskUpdateParameter.js index dd7a2f6260..ea9e747fb4 100644 --- a/lib/services/batch/lib/models/taskUpdateParameter.js +++ b/lib/services/batch/lib/models/taskUpdateParameter.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The set of changes to be made to a task. * @@ -19,16 +17,16 @@ const models = require('./index'); class TaskUpdateParameter { /** * Create a TaskUpdateParameter. - * @member {object} [constraints] Constraints that apply to this task. If + * @property {object} [constraints] Constraints that apply to this task. If * omitted, the task is given the default constraints. For multi-instance * tasks, updating the retention time applies only to the primary task and * not subtasks. - * @member {moment.duration} [constraints.maxWallClockTime] If this is not + * @property {moment.duration} [constraints.maxWallClockTime] If this is not * specified, there is no time limit on how long the task may run. - * @member {moment.duration} [constraints.retentionTime] The default is 7 + * @property {moment.duration} [constraints.retentionTime] The default is 7 * days, i.e. the task directory will be retained for 7 days unless the * compute node is removed or the job is deleted. - * @member {number} [constraints.maxTaskRetryCount] Note that this value + * @property {number} [constraints.maxTaskRetryCount] Note that this value * specifically controls the number of retries for the task executable due to * a nonzero exit code. The Batch service will try the task once, and may * then retry up to this limit. For example, if the maximum retry count is 3, diff --git a/lib/services/batch/lib/models/uploadBatchServiceLogsConfiguration.js b/lib/services/batch/lib/models/uploadBatchServiceLogsConfiguration.js index 0aee453a77..f4086b610d 100644 --- a/lib/services/batch/lib/models/uploadBatchServiceLogsConfiguration.js +++ b/lib/services/batch/lib/models/uploadBatchServiceLogsConfiguration.js @@ -18,19 +18,19 @@ class UploadBatchServiceLogsConfiguration { /** * Create a UploadBatchServiceLogsConfiguration. - * @member {string} containerUrl The URL of the container within Azure Blob + * @property {string} containerUrl The URL of the container within Azure Blob * Storage to which to upload the Batch Service log file(s). The URL must * include a Shared Access Signature (SAS) granting write permissions to the * container. The SAS duration must allow enough time for the upload to * finish. The start time for SAS is optional and recommended to not be * specified. - * @member {date} startTime The start of the time range from which to upload - * Batch Service log file(s). Any log file containing a log message in the - * time range will be uploaded. This means that the operation might retrieve - * more logs than have been requested since the entire log file is always - * uploaded, but the operation should not retrieve fewer logs than have been - * requested. - * @member {date} [endTime] The end of the time range from which to upload + * @property {date} startTime The start of the time range from which to + * upload Batch Service log file(s). Any log file containing a log message in + * the time range will be uploaded. This means that the operation might + * retrieve more logs than have been requested since the entire log file is + * always uploaded, but the operation should not retrieve fewer logs than + * have been requested. + * @property {date} [endTime] The end of the time range from which to upload * Batch Service log file(s). Any log file containing a log message in the * time range will be uploaded. This means that the operation might retrieve * more logs than have been requested since the entire log file is always diff --git a/lib/services/batch/lib/models/uploadBatchServiceLogsResult.js b/lib/services/batch/lib/models/uploadBatchServiceLogsResult.js index b12897b792..557a0c0042 100644 --- a/lib/services/batch/lib/models/uploadBatchServiceLogsResult.js +++ b/lib/services/batch/lib/models/uploadBatchServiceLogsResult.js @@ -18,13 +18,13 @@ class UploadBatchServiceLogsResult { /** * Create a UploadBatchServiceLogsResult. - * @member {string} virtualDirectoryName The virtual directory within Azure + * @property {string} virtualDirectoryName The virtual directory within Azure * Blob Storage container to which the Batch Service log file(s) will be * uploaded. The virtual directory name is part of the blob name for each log * file uploaded, and it is built based poolId, nodeId and a unique * identifier. - * @member {number} numberOfFilesUploaded The number of log files which will - * be uploaded. + * @property {number} numberOfFilesUploaded The number of log files which + * will be uploaded. */ constructor() { } diff --git a/lib/services/batch/lib/models/usageStatistics.js b/lib/services/batch/lib/models/usageStatistics.js index 97d430bfe2..273a26c43f 100644 --- a/lib/services/batch/lib/models/usageStatistics.js +++ b/lib/services/batch/lib/models/usageStatistics.js @@ -17,13 +17,13 @@ class UsageStatistics { /** * Create a UsageStatistics. - * @member {date} startTime The start time of the time range covered by the + * @property {date} startTime The start time of the time range covered by the * statistics. - * @member {date} lastUpdateTime The time at which the statistics were last + * @property {date} lastUpdateTime The time at which the statistics were last * updated. All statistics are limited to the range between startTime and * lastUpdateTime. - * @member {moment.duration} dedicatedCoreTime The aggregated wall-clock time - * of the dedicated compute node cores being part of the pool. + * @property {moment.duration} dedicatedCoreTime The aggregated wall-clock + * time of the dedicated compute node cores being part of the pool. */ constructor() { } diff --git a/lib/services/batch/lib/models/userAccount.js b/lib/services/batch/lib/models/userAccount.js index 734c35853a..c952d2e283 100644 --- a/lib/services/batch/lib/models/userAccount.js +++ b/lib/services/batch/lib/models/userAccount.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary Properties used to create a user used to execute tasks on an Azure * Batch node. @@ -20,22 +18,22 @@ const models = require('./index'); class UserAccount { /** * Create a UserAccount. - * @member {string} name The name of the user account. - * @member {string} password The password for the user account. - * @member {string} [elevationLevel] The elevation level of the user account. - * The default value is nonAdmin. Possible values include: 'nonAdmin', - * 'admin' - * @member {object} [linuxUserConfiguration] The Linux-specific user + * @property {string} name The name of the user account. + * @property {string} password The password for the user account. + * @property {string} [elevationLevel] The elevation level of the user + * account. The default value is nonAdmin. Possible values include: + * 'nonAdmin', 'admin' + * @property {object} [linuxUserConfiguration] The Linux-specific user * configuration for the user account. This property is ignored if specified * on a Windows pool. If not specified, the user is created with the default * options. - * @member {number} [linuxUserConfiguration.uid] The uid and gid properties + * @property {number} [linuxUserConfiguration.uid] The uid and gid properties * must be specified together or not at all. If not specified the underlying * operating system picks the uid. - * @member {number} [linuxUserConfiguration.gid] The uid and gid properties + * @property {number} [linuxUserConfiguration.gid] The uid and gid properties * must be specified together or not at all. If not specified the underlying * operating system picks the gid. - * @member {string} [linuxUserConfiguration.sshPrivateKey] The private key + * @property {string} [linuxUserConfiguration.sshPrivateKey] The private key * must not be password protected. The private key is used to automatically * configure asymmetric-key based authentication for SSH between nodes in a * Linux pool when the pool's enableInterNodeCommunication property is true @@ -43,11 +41,11 @@ class UserAccount { * placing the key pair into the user's .ssh directory. If not specified, * password-less SSH is not configured between nodes (no modification of the * user's .ssh directory is done). - * @member {object} [windowsUserConfiguration] The Windows-specific user + * @property {object} [windowsUserConfiguration] The Windows-specific user * configuration for the user account. This property can only be specified if * the user is on a Windows pool. If not specified and on a Windows pool, the * user is created with the default options. - * @member {string} [windowsUserConfiguration.loginMode] The default value + * @property {string} [windowsUserConfiguration.loginMode] The default value * for VirtualMachineConfiguration pools is batch and for * CloudServiceConfiguration pools is interactive. Possible values include: * 'batch', 'interactive' diff --git a/lib/services/batch/lib/models/userIdentity.js b/lib/services/batch/lib/models/userIdentity.js index 4946e8ea0f..d3037d4617 100644 --- a/lib/services/batch/lib/models/userIdentity.js +++ b/lib/services/batch/lib/models/userIdentity.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The definition of the user identity under which the task is run. * @@ -21,16 +19,16 @@ const models = require('./index'); class UserIdentity { /** * Create a UserIdentity. - * @member {string} [userName] The name of the user identity under which the - * task is run. The userName and autoUser properties are mutually exclusive; - * you must specify one but not both. - * @member {object} [autoUser] The auto user under which the task is run. The - * userName and autoUser properties are mutually exclusive; you must specify - * one but not both. - * @member {string} [autoUser.scope] The default value is task. Possible + * @property {string} [userName] The name of the user identity under which + * the task is run. The userName and autoUser properties are mutually + * exclusive; you must specify one but not both. + * @property {object} [autoUser] The auto user under which the task is run. + * The userName and autoUser properties are mutually exclusive; you must + * specify one but not both. + * @property {string} [autoUser.scope] The default value is task. Possible * values include: 'task', 'pool' - * @member {string} [autoUser.elevationLevel] The default value is nonAdmin. - * Possible values include: 'nonAdmin', 'admin' + * @property {string} [autoUser.elevationLevel] The default value is + * nonAdmin. Possible values include: 'nonAdmin', 'admin' */ constructor() { } diff --git a/lib/services/batch/lib/models/virtualMachineConfiguration.js b/lib/services/batch/lib/models/virtualMachineConfiguration.js index a7c1edf4b5..07b120072b 100644 --- a/lib/services/batch/lib/models/virtualMachineConfiguration.js +++ b/lib/services/batch/lib/models/virtualMachineConfiguration.js @@ -10,8 +10,6 @@ 'use strict'; -const models = require('./index'); - /** * @summary The configuration for compute nodes in a pool based on the Azure * Virtual Machines infrastructure. @@ -20,23 +18,23 @@ const models = require('./index'); class VirtualMachineConfiguration { /** * Create a VirtualMachineConfiguration. - * @member {object} imageReference A reference to the Azure Virtual Machines - * Marketplace image or the custom Virtual Machine image to use. - * @member {string} [imageReference.publisher] For example, Canonical or + * @property {object} imageReference A reference to the Azure Virtual + * Machines Marketplace image or the custom Virtual Machine image to use. + * @property {string} [imageReference.publisher] For example, Canonical or * MicrosoftWindowsServer. - * @member {string} [imageReference.offer] For example, UbuntuServer or + * @property {string} [imageReference.offer] For example, UbuntuServer or * WindowsServer. - * @member {string} [imageReference.sku] For example, 14.04.0-LTS or + * @property {string} [imageReference.sku] For example, 14.04.0-LTS or * 2012-R2-Datacenter. - * @member {string} [imageReference.version] A value of 'latest' can be + * @property {string} [imageReference.version] A value of 'latest' can be * specified to select the latest version of an image. If omitted, the * default is 'latest'. - * @member {string} [imageReference.virtualMachineImageId] This property is + * @property {string} [imageReference.virtualMachineImageId] This property is * mutually exclusive with other ImageReference properties. The virtual * machine image must be in the same region and subscription as the Azure * Batch account. For more details, see * https://docs.microsoft.com/azure/batch/batch-custom-images. - * @member {string} nodeAgentSKUId The SKU of the Batch node agent to be + * @property {string} nodeAgentSKUId The SKU of the Batch node agent to be * provisioned on compute nodes in the pool. The Batch node agent is a * program that runs on each node in the pool, and provides the * command-and-control interface between the node and the Batch service. @@ -45,12 +43,12 @@ class VirtualMachineConfiguration { * matches the selected image reference. To get the list of supported node * agent SKUs along with their list of verified image references, see the * 'List supported node agent SKUs' operation. - * @member {object} [windowsConfiguration] Windows operating system settings - * on the virtual machine. This property must not be specified if the - * imageReference property specifies a Linux OS image. - * @member {boolean} [windowsConfiguration.enableAutomaticUpdates] If + * @property {object} [windowsConfiguration] Windows operating system + * settings on the virtual machine. This property must not be specified if + * the imageReference property specifies a Linux OS image. + * @property {boolean} [windowsConfiguration.enableAutomaticUpdates] If * omitted, the default value is true. - * @member {array} [dataDisks] The configuration for data disks attached to + * @property {array} [dataDisks] The configuration for data disks attached to * the comptue nodes in the pool. 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 @@ -61,26 +59,26 @@ class VirtualMachineConfiguration { * 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. - * @member {string} [licenseType] The type of on-premises license to be used - * when deploying the operating system. This only applies to images that + * @property {string} [licenseType] The type of on-premises license to be + * used when deploying the operating system. This only applies to images that * contain the Windows operating system, and should only be used when you * hold valid on-premises licenses for the nodes which will be deployed. If * omitted, no on-premises licensing discount is applied. Values are: * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. - * @member {object} [containerConfiguration] The container configuration for - * the pool. If specified, setup is performed on each node in the pool to + * @property {object} [containerConfiguration] The container configuration + * for the pool. If specified, setup is performed on each node in the pool to * allow tasks to run in containers. All regular tasks and job manager tasks * run on this pool must specify the containerSettings property, and all * other tasks may specify it. - * @member {array} [containerConfiguration.containerImageNames] This is the + * @property {array} [containerConfiguration.containerImageNames] This is the * full image reference, as would be specified to "docker pull". An image * will be sourced from the default Docker registry unless the image is fully * qualified with an alternative registry. - * @member {array} [containerConfiguration.containerRegistries] If any images - * must be downloaded from a private registry which requires credentials, - * then those credentials must be provided here. + * @property {array} [containerConfiguration.containerRegistries] If any + * images must be downloaded from a private registry which requires + * credentials, then those credentials must be provided here. */ constructor() { } diff --git a/lib/services/batch/lib/models/windowsConfiguration.js b/lib/services/batch/lib/models/windowsConfiguration.js index de0f02fcf1..f2b8a975e9 100644 --- a/lib/services/batch/lib/models/windowsConfiguration.js +++ b/lib/services/batch/lib/models/windowsConfiguration.js @@ -17,7 +17,7 @@ class WindowsConfiguration { /** * Create a WindowsConfiguration. - * @member {boolean} [enableAutomaticUpdates] Whether automatic updates are + * @property {boolean} [enableAutomaticUpdates] Whether automatic updates are * enabled on the virtual machine. If omitted, the default value is true. */ constructor() { diff --git a/lib/services/batch/lib/models/windowsUserConfiguration.js b/lib/services/batch/lib/models/windowsUserConfiguration.js index 85f900af4c..0d9b328acc 100644 --- a/lib/services/batch/lib/models/windowsUserConfiguration.js +++ b/lib/services/batch/lib/models/windowsUserConfiguration.js @@ -17,7 +17,7 @@ class WindowsUserConfiguration { /** * Create a WindowsUserConfiguration. - * @member {string} [loginMode] The login mode for the user. The default + * @property {string} [loginMode] The login mode for the user. The default * value for VirtualMachineConfiguration pools is batch and for * CloudServiceConfiguration pools is interactive. Possible values include: * 'batch', 'interactive' diff --git a/lib/services/batch/lib/operations/computeNodeOperations.js b/lib/services/batch/lib/operations/computeNodeOperations.js index b19f896cd3..cee9255ecb 100644 --- a/lib/services/batch/lib/operations/computeNodeOperations.js +++ b/lib/services/batch/lib/operations/computeNodeOperations.js @@ -468,7 +468,7 @@ function _deleteUser(poolId, nodeId, userName, options, callback) { * @summary Updates the password and expiration time of a user account on the * specified compute node. * - * This operation replaces of all the updateable properties of the account. For + * This operation replaces of all the updatable properties of the account. For * example, if the expiryTime element is not specified, the current value is * replaced with the default value, not left unmodified. You can update a user * account on a node only when it is in the idle or running state. @@ -3316,7 +3316,7 @@ class ComputeNodeOperations { * @summary Updates the password and expiration time of a user account on the * specified compute node. * - * This operation replaces of all the updateable properties of the account. For + * This operation replaces of all the updatable properties of the account. For * example, if the expiryTime element is not specified, the current value is * replaced with the default value, not left unmodified. You can update a user * account on a node only when it is in the idle or running state. @@ -3398,7 +3398,7 @@ class ComputeNodeOperations { * @summary Updates the password and expiration time of a user account on the * specified compute node. * - * This operation replaces of all the updateable properties of the account. For + * This operation replaces of all the updatable properties of the account. For * example, if the expiryTime element is not specified, the current value is * replaced with the default value, not left unmodified. You can update a user * account on a node only when it is in the idle or running state. diff --git a/lib/services/batch/lib/operations/index.d.ts b/lib/services/batch/lib/operations/index.d.ts index 949bb6b22f..6c71a4ee62 100644 --- a/lib/services/batch/lib/operations/index.d.ts +++ b/lib/services/batch/lib/operations/index.d.ts @@ -3092,7 +3092,7 @@ export interface Pool { /** * @summary Updates the properties of the specified pool. * - * This fully replaces all the updateable properties of the pool. For example, + * This fully replaces all the updatable properties of the pool. For example, * if the pool has a start task associated with it and if start task is not * specified with this request, then the Batch service will remove the existing * start task. @@ -3276,7 +3276,7 @@ export interface Pool { /** * @summary Updates the properties of the specified pool. * - * This fully replaces all the updateable properties of the pool. For example, + * This fully replaces all the updatable properties of the pool. For example, * if the pool has a start task associated with it and if start task is not * specified with this request, then the Batch service will remove the existing * start task. @@ -5797,8 +5797,8 @@ export interface Job { /** * @summary Updates the properties of the specified job. * - * This fully replaces all the updateable properties of the job. For example, - * if the job has constraints associated with it and if constraints is not + * This fully replaces all the updatable properties of the job. For example, if + * the job has constraints associated with it and if constraints is not * specified with this request, then the Batch service will remove the existing * constraints. * @@ -6370,8 +6370,8 @@ export interface Job { /** * @summary Updates the properties of the specified job. * - * This fully replaces all the updateable properties of the job. For example, - * if the job has constraints associated with it and if constraints is not + * This fully replaces all the updatable properties of the job. For example, if + * the job has constraints associated with it and if constraints is not * specified with this request, then the Batch service will remove the existing * constraints. * @@ -7662,7 +7662,7 @@ export interface Job { * * @param {object} [job.jobPreparationTask.userIdentity] The user identity * under which the Job Preparation task runs. If omitted, the task runs as a - * non-administrative user unique to the task on Windows nodes, or a a + * non-administrative user unique to the task on Windows nodes, or a * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} [job.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -8512,7 +8512,7 @@ export interface Job { * * @param {object} [job.jobPreparationTask.userIdentity] The user identity * under which the Job Preparation task runs. If omitted, the task runs as a - * non-administrative user unique to the task on Windows nodes, or a a + * non-administrative user unique to the task on Windows nodes, or a * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} [job.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -12564,7 +12564,7 @@ export interface JobSchedule { * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -13563,7 +13563,7 @@ export interface JobSchedule { * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -14205,7 +14205,7 @@ export interface JobSchedule { /** * @summary Updates the properties of the specified job schedule. * - * This fully replaces all the updateable properties of the job schedule. For + * This fully replaces all the updatable properties of the job schedule. For * example, if the schedule property is not specified with this request, then * the Batch service will remove the existing schedule. Changes to a job * schedule only impact jobs created by the schedule after the update has taken @@ -14582,7 +14582,7 @@ export interface JobSchedule { * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -15210,7 +15210,7 @@ export interface JobSchedule { /** * @summary Updates the properties of the specified job schedule. * - * This fully replaces all the updateable properties of the job schedule. For + * This fully replaces all the updatable properties of the job schedule. For * example, if the schedule property is not specified with this request, then * the Batch service will remove the existing schedule. Changes to a job * schedule only impact jobs created by the schedule after the update has taken @@ -15587,7 +15587,7 @@ export interface JobSchedule { * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -16996,7 +16996,7 @@ export interface JobSchedule { * [cloudJobSchedule.jobSpecification.jobPreparationTask.userIdentity] The user * identity under which the Job Preparation task runs. If omitted, the task * runs as a non-administrative user unique to the task on Windows nodes, or a - * a non-administrative user unique to the pool on Linux nodes. + * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [cloudJobSchedule.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -17960,7 +17960,7 @@ export interface JobSchedule { * [cloudJobSchedule.jobSpecification.jobPreparationTask.userIdentity] The user * identity under which the Job Preparation task runs. If omitted, the task * runs as a non-administrative user unique to the task on Windows nodes, or a - * a non-administrative user unique to the pool on Linux nodes. + * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [cloudJobSchedule.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -20905,7 +20905,7 @@ export interface ComputeNodeOperations { * @summary Updates the password and expiration time of a user account on the * specified compute node. * - * This operation replaces of all the updateable properties of the account. For + * This operation replaces of all the updatable properties of the account. For * example, if the expiryTime element is not specified, the current value is * replaced with the default value, not left unmodified. You can update a user * account on a node only when it is in the idle or running state. @@ -20975,7 +20975,7 @@ export interface ComputeNodeOperations { * @summary Updates the password and expiration time of a user account on the * specified compute node. * - * This operation replaces of all the updateable properties of the account. For + * This operation replaces of all the updatable properties of the account. For * example, if the expiryTime element is not specified, the current value is * replaced with the default value, not left unmodified. You can update a user * account on a node only when it is in the idle or running state. diff --git a/lib/services/batch/lib/operations/job.js b/lib/services/batch/lib/operations/job.js index b05389a887..fdbb2f0216 100644 --- a/lib/services/batch/lib/operations/job.js +++ b/lib/services/batch/lib/operations/job.js @@ -1581,8 +1581,8 @@ function _patch(jobId, jobPatchParameter, options, callback) { /** * @summary Updates the properties of the specified job. * - * This fully replaces all the updateable properties of the job. For example, - * if the job has constraints associated with it and if constraints is not + * This fully replaces all the updatable properties of the job. For example, if + * the job has constraints associated with it and if constraints is not * specified with this request, then the Batch service will remove the existing * constraints. * @@ -3475,7 +3475,7 @@ function _terminate(jobId, options, callback) { * * @param {object} [job.jobPreparationTask.userIdentity] The user identity * under which the Job Preparation task runs. If omitted, the task runs as a - * non-administrative user unique to the task on Windows nodes, or a a + * non-administrative user unique to the task on Windows nodes, or a * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} [job.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -7492,8 +7492,8 @@ class Job { /** * @summary Updates the properties of the specified job. * - * This fully replaces all the updateable properties of the job. For example, - * if the job has constraints associated with it and if constraints is not + * This fully replaces all the updatable properties of the job. For example, if + * the job has constraints associated with it and if constraints is not * specified with this request, then the Batch service will remove the existing * constraints. * @@ -8077,8 +8077,8 @@ class Job { /** * @summary Updates the properties of the specified job. * - * This fully replaces all the updateable properties of the job. For example, - * if the job has constraints associated with it and if constraints is not + * This fully replaces all the updatable properties of the job. For example, if + * the job has constraints associated with it and if constraints is not * specified with this request, then the Batch service will remove the existing * constraints. * @@ -9465,7 +9465,7 @@ class Job { * * @param {object} [job.jobPreparationTask.userIdentity] The user identity * under which the Job Preparation task runs. If omitted, the task runs as a - * non-administrative user unique to the task on Windows nodes, or a a + * non-administrative user unique to the task on Windows nodes, or a * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} [job.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -10327,7 +10327,7 @@ class Job { * * @param {object} [job.jobPreparationTask.userIdentity] The user identity * under which the Job Preparation task runs. If omitted, the task runs as a - * non-administrative user unique to the task on Windows nodes, or a a + * non-administrative user unique to the task on Windows nodes, or a * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} [job.jobPreparationTask.rerunOnNodeRebootAfterSuccess] diff --git a/lib/services/batch/lib/operations/jobSchedule.js b/lib/services/batch/lib/operations/jobSchedule.js index 0bebb73902..83f1306be0 100644 --- a/lib/services/batch/lib/operations/jobSchedule.js +++ b/lib/services/batch/lib/operations/jobSchedule.js @@ -1218,7 +1218,7 @@ function _get(jobScheduleId, options, callback) { * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -2063,7 +2063,7 @@ function _patch(jobScheduleId, jobSchedulePatchParameter, options, callback) { /** * @summary Updates the properties of the specified job schedule. * - * This fully replaces all the updateable properties of the job schedule. For + * This fully replaces all the updatable properties of the job schedule. For * example, if the schedule property is not specified with this request, then * the Batch service will remove the existing schedule. Changes to a job * schedule only impact jobs created by the schedule after the update has taken @@ -2440,7 +2440,7 @@ function _patch(jobScheduleId, jobSchedulePatchParameter, options, callback) { * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -4425,7 +4425,7 @@ function _terminate(jobScheduleId, options, callback) { * [cloudJobSchedule.jobSpecification.jobPreparationTask.userIdentity] The user * identity under which the Job Preparation task runs. If omitted, the task * runs as a non-administrative user unique to the task on Windows nodes, or a - * a non-administrative user unique to the pool on Linux nodes. + * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [cloudJobSchedule.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -6543,7 +6543,7 @@ class JobSchedule { * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -7554,7 +7554,7 @@ class JobSchedule { * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobSchedulePatchParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -8211,7 +8211,7 @@ class JobSchedule { /** * @summary Updates the properties of the specified job schedule. * - * This fully replaces all the updateable properties of the job schedule. For + * This fully replaces all the updatable properties of the job schedule. For * example, if the schedule property is not specified with this request, then * the Batch service will remove the existing schedule. Changes to a job * schedule only impact jobs created by the schedule after the update has taken @@ -8588,7 +8588,7 @@ class JobSchedule { * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -9228,7 +9228,7 @@ class JobSchedule { /** * @summary Updates the properties of the specified job schedule. * - * This fully replaces all the updateable properties of the job schedule. For + * This fully replaces all the updatable properties of the job schedule. For * example, if the schedule property is not specified with this request, then * the Batch service will remove the existing schedule. Changes to a job * schedule only impact jobs created by the schedule after the update has taken @@ -9605,7 +9605,7 @@ class JobSchedule { * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.userIdentity] * The user identity under which the Job Preparation task runs. If omitted, the * task runs as a non-administrative user unique to the task on Windows nodes, - * or a a non-administrative user unique to the pool on Linux nodes. + * or a non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [jobScheduleUpdateParameter.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -11110,7 +11110,7 @@ class JobSchedule { * [cloudJobSchedule.jobSpecification.jobPreparationTask.userIdentity] The user * identity under which the Job Preparation task runs. If omitted, the task * runs as a non-administrative user unique to the task on Windows nodes, or a - * a non-administrative user unique to the pool on Linux nodes. + * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [cloudJobSchedule.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] @@ -12086,7 +12086,7 @@ class JobSchedule { * [cloudJobSchedule.jobSpecification.jobPreparationTask.userIdentity] The user * identity under which the Job Preparation task runs. If omitted, the task * runs as a non-administrative user unique to the task on Windows nodes, or a - * a non-administrative user unique to the pool on Linux nodes. + * non-administrative user unique to the pool on Linux nodes. * * @param {boolean} * [cloudJobSchedule.jobSpecification.jobPreparationTask.rerunOnNodeRebootAfterSuccess] diff --git a/lib/services/batch/lib/operations/pool.js b/lib/services/batch/lib/operations/pool.js index 841e342477..a1dbcac4c8 100644 --- a/lib/services/batch/lib/operations/pool.js +++ b/lib/services/batch/lib/operations/pool.js @@ -3878,7 +3878,7 @@ function _stopResize(poolId, options, callback) { /** * @summary Updates the properties of the specified pool. * - * This fully replaces all the updateable properties of the pool. For example, + * This fully replaces all the updatable properties of the pool. For example, * if the pool has a start task associated with it and if start task is not * specified with this request, then the Batch service will remove the existing * start task. @@ -8026,7 +8026,7 @@ class Pool { /** * @summary Updates the properties of the specified pool. * - * This fully replaces all the updateable properties of the pool. For example, + * This fully replaces all the updatable properties of the pool. For example, * if the pool has a start task associated with it and if start task is not * specified with this request, then the Batch service will remove the existing * start task. @@ -8222,7 +8222,7 @@ class Pool { /** * @summary Updates the properties of the specified pool. * - * This fully replaces all the updateable properties of the pool. For example, + * This fully replaces all the updatable properties of the pool. For example, * if the pool has a start task associated with it and if start task is not * specified with this request, then the Batch service will remove the existing * start task.