|
2 | 2 | "swagger": "2.0", |
3 | 3 | "info": { |
4 | 4 | "title": "BatchService", |
5 | | - "version": "2018-03-01.6.1", |
| 5 | + "version": "2018-08-01.7.0", |
6 | 6 | "description": "A client for issuing REST requests to the Azure Batch service.", |
7 | 7 | "x-ms-code-generation-settings": { |
8 | 8 | "name": "BatchServiceClient" |
|
542 | 542 | "in": "query", |
543 | 543 | "required": false, |
544 | 544 | "type": "string", |
545 | | - "description": "An OData $filter clause.", |
| 545 | + "description": "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.", |
546 | 546 | "x-ms-parameter-grouping": { |
547 | 547 | "postfix": "Options" |
548 | 548 | } |
|
1712 | 1712 | }, |
1713 | 1713 | "description": "A response containing the file content.", |
1714 | 1714 | "schema": { |
1715 | | - "type": "file" |
| 1715 | + "type": "object", |
| 1716 | + "format": "file" |
1716 | 1717 | } |
1717 | 1718 | }, |
1718 | 1719 | "default": { |
|
2168 | 2169 | }, |
2169 | 2170 | "description": "The file content.", |
2170 | 2171 | "schema": { |
2171 | | - "type": "file" |
| 2172 | + "type": "object", |
| 2173 | + "format": "file" |
2172 | 2174 | } |
2173 | 2175 | }, |
2174 | 2176 | "default": { |
|
5751 | 5753 | "Job get task counts": { "$ref": "./examples/JobGetTaskCounts.json" } |
5752 | 5754 | }, |
5753 | 5755 | "summary": "Gets the task counts for the specified job.", |
5754 | | - "description": "Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running. If the validationStatus is unvalidated, then the Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks.", |
| 5756 | + "description": "Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.", |
5755 | 5757 | "x-ms-request-id": "request-id", |
5756 | 5758 | "parameters": [ |
5757 | 5759 | { |
|
10319 | 10321 | }, |
10320 | 10322 | "description": "A response containing the RDP information.", |
10321 | 10323 | "schema": { |
10322 | | - "type": "file" |
| 10324 | + "type": "object", |
| 10325 | + "format": "file" |
10323 | 10326 | } |
10324 | 10327 | }, |
10325 | 10328 | "default": { |
|
10610 | 10613 | "vmSize": { |
10611 | 10614 | "type": "string", |
10612 | 10615 | "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", |
10613 | | - "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). Batch supports all Cloud Services VM sizes except ExtraSmall, STANDARD_A1_V2 and STANDARD_A2_V2. 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)." |
| 10616 | + "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)." |
10614 | 10617 | }, |
10615 | 10618 | "totalCoreHours": { |
10616 | 10619 | "type": "number", |
|
11893 | 11896 | "vmSize": { |
11894 | 11897 | "type": "string", |
11895 | 11898 | "title": "The size of the virtual machines in the pool. All virtual machines in a pool are the same size.", |
11896 | | - "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)." |
| 11899 | + "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)." |
11897 | 11900 | }, |
11898 | 11901 | "cloudServiceConfiguration": { |
11899 | 11902 | "$ref": "#/definitions/CloudServiceConfiguration", |
|
11983 | 11986 | "type": "string" |
11984 | 11987 | }, |
11985 | 11988 | "title": "The list of application licenses the Batch service will make available on each compute node in the pool.", |
11986 | | - "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." |
| 11989 | + "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." |
11987 | 11990 | }, |
11988 | 11991 | "userAccounts": { |
11989 | 11992 | "type": "array", |
|
12900 | 12903 | "type": "integer", |
12901 | 12904 | "format": "int32", |
12902 | 12905 | "title": "The number of tasks which failed. A task fails if its result (found in the executionInfo property) is 'failure'." |
12903 | | - }, |
12904 | | - "validationStatus": { |
12905 | | - "type": "string", |
12906 | | - "title": "Whether the task counts have been validated.", |
12907 | | - "enum": [ |
12908 | | - "validated", |
12909 | | - "unvalidated" |
12910 | | - ], |
12911 | | - "x-ms-enum": { |
12912 | | - "name": "TaskCountValidationStatus", |
12913 | | - "modelAsString": false, |
12914 | | - "values": [ |
12915 | | - { |
12916 | | - "value": "validated", |
12917 | | - "description": "The Batch service has validated the state counts against the task states as reported in the List Tasks API." |
12918 | | - }, |
12919 | | - { |
12920 | | - "value": "unvalidated", |
12921 | | - "description": "The Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains more than 200,000 tasks." |
12922 | | - } |
12923 | | - ] |
12924 | | - } |
12925 | 12906 | } |
12926 | 12907 | }, |
12927 | | - "required": ["active", "running", "completed", "succeeded", "failed", "validationStatus"], |
| 12908 | + "required": [ "active", "running", "completed", "succeeded", "failed" ], |
12928 | 12909 | "title": "The task counts for a job." |
12929 | 12910 | }, |
12930 | 12911 | "AutoScaleRunError": { |
|
13043 | 13024 | "properties": { |
13044 | 13025 | "caching": { |
13045 | 13026 | "title": "The type of caching to enable for the OS disk.", |
13046 | | - "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", |
| 13027 | + "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/.", |
13047 | 13028 | "$ref": "#/definitions/CachingType" |
13048 | 13029 | } |
13049 | 13030 | }, |
|
13070 | 13051 | "caching": { |
13071 | 13052 | "$ref": "#/definitions/CachingType", |
13072 | 13053 | "title": "The type of caching to be enabled for the data disks.", |
13073 | | - "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." |
| 13054 | + "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/." |
13074 | 13055 | }, |
13075 | 13056 | "diskSizeGB": { |
13076 | 13057 | "type": "integer", |
@@ -13211,15 +13192,15 @@ |
13211 | 13192 | "type": "string", |
13212 | 13193 | "title": "The container technology to be used.", |
13213 | 13194 | "enum": [ |
13214 | | - "docker" |
| 13195 | + "dockerCompatible" |
13215 | 13196 | ], |
13216 | 13197 | "x-ms-enum": { |
13217 | 13198 | "name": "ContainerType", |
13218 | 13199 | "modelAsString": false, |
13219 | 13200 | "values": [ |
13220 | 13201 | { |
13221 | | - "value": "docker", |
13222 | | - "description": "Docker will be used to launch the containers." |
| 13202 | + "value": "dockerCompatible", |
| 13203 | + "description": "A Docker compatible container technology will be used to launch the containers." |
13223 | 13204 | } |
13224 | 13205 | ] |
13225 | 13206 | } |
|
13362 | 13343 | "vmSize": { |
13363 | 13344 | "type": "string", |
13364 | 13345 | "title": "The size of virtual machines in the pool. All virtual machines in a pool are the same size.", |
13365 | | - "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)." |
| 13346 | + "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)." |
13366 | 13347 | }, |
13367 | 13348 | "cloudServiceConfiguration": { |
13368 | 13349 | "$ref": "#/definitions/CloudServiceConfiguration", |
|
13758 | 13739 | }, |
13759 | 13740 | "title": "Information about the compute node on which a task ran." |
13760 | 13741 | }, |
| 13742 | + "NodeAgentInformation": { |
| 13743 | + "properties": { |
| 13744 | + "version": { |
| 13745 | + "type": "string", |
| 13746 | + "title":"The version of the Batch node agent running on the compute node.", |
| 13747 | + "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." |
| 13748 | + }, |
| 13749 | + "lastUpdateTime": { |
| 13750 | + "type": "string", |
| 13751 | + "format": "date-time", |
| 13752 | + "title": "The time when the node agent was updated on the compute node.", |
| 13753 | + "description": "This is the most recent time that the node agent was updated to a new version." |
| 13754 | + } |
| 13755 | + }, |
| 13756 | + "required": [ "version", "lastUpdateTime" ], |
| 13757 | + "title": "Information about the node agent.", |
| 13758 | + "description": "The Batch node agent is a program that runs on each node in the pool and provides Batch capability on the compute node." |
| 13759 | + }, |
13761 | 13760 | "MultiInstanceSettings": { |
13762 | 13761 | "properties": { |
13763 | 13762 | "numberOfInstances": { |
|
14119 | 14118 | "$ref": "#/definitions/TaskAddParameter" |
14120 | 14119 | }, |
14121 | 14120 | "maxItems": 100, |
14122 | | - "title": "The collection of tasks to add.", |
| 14121 | + "title": "The collection of tasks to add. The maximum count of tasks is 100.", |
14123 | 14122 | "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." |
14124 | 14123 | } |
14125 | 14124 | }, |
|
14556 | 14555 | "vmSize": { |
14557 | 14556 | "type": "string", |
14558 | 14557 | "title": "The size of the virtual machine hosting the compute node.", |
14559 | | - "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)." |
| 14558 | + "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)." |
14560 | 14559 | }, |
14561 | 14560 | "totalTasksRun": { |
14562 | 14561 | "type": "integer", |
|
14611 | 14610 | "endpointConfiguration": { |
14612 | 14611 | "$ref": "#/definitions/ComputeNodeEndpointConfiguration", |
14613 | 14612 | "title": "The endpoint configuration for the compute node." |
| 14613 | + }, |
| 14614 | + "nodeAgentInfo": { |
| 14615 | + "$ref":"#/definitions/NodeAgentInformation", |
| 14616 | + "title": "Information about the node agent version and the time the node upgraded to a new version." |
14614 | 14617 | } |
14615 | 14618 | }, |
14616 | 14619 | "title": "A compute node in the Batch service." |
|
0 commit comments