@azure/arm-batch 4.0.0 → 7.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (251) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/{LICENSE.txt → LICENSE} +2 -2
  3. package/README.md +75 -77
  4. package/dist/index.js +6873 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/index.min.js +1 -0
  7. package/dist/index.min.js.map +1 -0
  8. package/dist-esm/src/batchManagementClient.d.ts +24 -0
  9. package/dist-esm/src/batchManagementClient.d.ts.map +1 -0
  10. package/dist-esm/src/batchManagementClient.js +31 -0
  11. package/dist-esm/src/batchManagementClient.js.map +1 -0
  12. package/dist-esm/src/batchManagementClientContext.d.ts +17 -0
  13. package/dist-esm/src/batchManagementClientContext.d.ts.map +1 -0
  14. package/dist-esm/src/batchManagementClientContext.js +50 -0
  15. package/dist-esm/src/batchManagementClientContext.js.map +1 -0
  16. package/dist-esm/src/index.d.ts +6 -0
  17. package/dist-esm/src/index.d.ts.map +1 -0
  18. package/dist-esm/src/index.js +13 -0
  19. package/dist-esm/src/index.js.map +1 -0
  20. package/dist-esm/src/lroImpl.d.ts +16 -0
  21. package/dist-esm/src/lroImpl.d.ts.map +1 -0
  22. package/dist-esm/src/lroImpl.js +29 -0
  23. package/dist-esm/src/lroImpl.js.map +1 -0
  24. package/dist-esm/src/models/index.d.ts +1780 -0
  25. package/dist-esm/src/models/index.d.ts.map +1 -0
  26. package/dist-esm/src/models/index.js +9 -0
  27. package/dist-esm/src/models/index.js.map +1 -0
  28. package/dist-esm/src/models/mappers.d.ts +112 -0
  29. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  30. package/{esm → dist-esm/src}/models/mappers.js +2357 -1248
  31. package/dist-esm/src/models/mappers.js.map +1 -0
  32. package/dist-esm/src/models/parameters.d.ts +34 -0
  33. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  34. package/dist-esm/src/models/parameters.js +303 -0
  35. package/dist-esm/src/models/parameters.js.map +1 -0
  36. package/dist-esm/src/operations/applicationOperations.d.ts +71 -0
  37. package/dist-esm/src/operations/applicationOperations.d.ts.map +1 -0
  38. package/dist-esm/src/operations/applicationOperations.js +269 -0
  39. package/dist-esm/src/operations/applicationOperations.js.map +1 -0
  40. package/dist-esm/src/operations/applicationPackageOperations.d.ts +83 -0
  41. package/dist-esm/src/operations/applicationPackageOperations.d.ts.map +1 -0
  42. package/dist-esm/src/operations/applicationPackageOperations.js +294 -0
  43. package/dist-esm/src/operations/applicationPackageOperations.js.map +1 -0
  44. package/dist-esm/src/operations/batchAccountOperations.d.ts +171 -0
  45. package/dist-esm/src/operations/batchAccountOperations.d.ts.map +1 -0
  46. package/dist-esm/src/operations/batchAccountOperations.js +681 -0
  47. package/dist-esm/src/operations/batchAccountOperations.js.map +1 -0
  48. package/dist-esm/src/operations/certificateOperations.d.ts +106 -0
  49. package/dist-esm/src/operations/certificateOperations.d.ts.map +1 -0
  50. package/dist-esm/src/operations/certificateOperations.js +388 -0
  51. package/dist-esm/src/operations/certificateOperations.js.map +1 -0
  52. package/{esm → dist-esm/src}/operations/index.d.ts +2 -0
  53. package/dist-esm/src/operations/index.d.ts.map +1 -0
  54. package/dist-esm/src/operations/index.js +17 -0
  55. package/dist-esm/src/operations/index.js.map +1 -0
  56. package/dist-esm/src/operations/location.d.ts +71 -0
  57. package/dist-esm/src/operations/location.d.ts.map +1 -0
  58. package/dist-esm/src/operations/location.js +316 -0
  59. package/dist-esm/src/operations/location.js.map +1 -0
  60. package/dist-esm/src/operations/operations.d.ts +32 -0
  61. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  62. package/dist-esm/src/operations/operations.js +120 -0
  63. package/dist-esm/src/operations/operations.js.map +1 -0
  64. package/dist-esm/src/operations/poolOperations.d.ts +103 -0
  65. package/dist-esm/src/operations/poolOperations.d.ts.map +1 -0
  66. package/dist-esm/src/operations/poolOperations.js +410 -0
  67. package/dist-esm/src/operations/poolOperations.js.map +1 -0
  68. package/dist-esm/src/operations/privateEndpointConnectionOperations.d.ts +70 -0
  69. package/dist-esm/src/operations/privateEndpointConnectionOperations.d.ts.map +1 -0
  70. package/dist-esm/src/operations/privateEndpointConnectionOperations.js +278 -0
  71. package/dist-esm/src/operations/privateEndpointConnectionOperations.js.map +1 -0
  72. package/dist-esm/src/operations/privateLinkResourceOperations.d.ts +47 -0
  73. package/dist-esm/src/operations/privateLinkResourceOperations.d.ts.map +1 -0
  74. package/dist-esm/src/operations/privateLinkResourceOperations.js +170 -0
  75. package/dist-esm/src/operations/privateLinkResourceOperations.js.map +1 -0
  76. package/dist-esm/src/operationsInterfaces/applicationOperations.d.ts +46 -0
  77. package/dist-esm/src/operationsInterfaces/applicationOperations.d.ts.map +1 -0
  78. package/dist-esm/src/operationsInterfaces/applicationOperations.js +9 -0
  79. package/dist-esm/src/operationsInterfaces/applicationOperations.js.map +1 -0
  80. package/dist-esm/src/operationsInterfaces/applicationPackageOperations.d.ts +56 -0
  81. package/dist-esm/src/operationsInterfaces/applicationPackageOperations.d.ts.map +1 -0
  82. package/dist-esm/src/operationsInterfaces/applicationPackageOperations.js +9 -0
  83. package/dist-esm/src/operationsInterfaces/applicationPackageOperations.js.map +1 -0
  84. package/dist-esm/src/operationsInterfaces/batchAccountOperations.d.ts +112 -0
  85. package/dist-esm/src/operationsInterfaces/batchAccountOperations.d.ts.map +1 -0
  86. package/dist-esm/src/operationsInterfaces/batchAccountOperations.js +9 -0
  87. package/dist-esm/src/operationsInterfaces/batchAccountOperations.js.map +1 -0
  88. package/dist-esm/src/operationsInterfaces/certificateOperations.d.ts +81 -0
  89. package/dist-esm/src/operationsInterfaces/certificateOperations.d.ts.map +1 -0
  90. package/dist-esm/src/operationsInterfaces/certificateOperations.js +9 -0
  91. package/dist-esm/src/operationsInterfaces/certificateOperations.js.map +1 -0
  92. package/dist-esm/src/operationsInterfaces/index.d.ts +10 -0
  93. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  94. package/dist-esm/src/operationsInterfaces/index.js +17 -0
  95. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  96. package/dist-esm/src/operationsInterfaces/location.d.ts +31 -0
  97. package/dist-esm/src/operationsInterfaces/location.d.ts.map +1 -0
  98. package/dist-esm/src/operationsInterfaces/location.js +9 -0
  99. package/dist-esm/src/operationsInterfaces/location.js.map +1 -0
  100. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  101. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  102. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  103. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  104. package/dist-esm/src/operationsInterfaces/poolOperations.d.ts +78 -0
  105. package/dist-esm/src/operationsInterfaces/poolOperations.d.ts.map +1 -0
  106. package/dist-esm/src/operationsInterfaces/poolOperations.js +9 -0
  107. package/dist-esm/src/operationsInterfaces/poolOperations.js.map +1 -0
  108. package/dist-esm/src/operationsInterfaces/privateEndpointConnectionOperations.d.ts +45 -0
  109. package/dist-esm/src/operationsInterfaces/privateEndpointConnectionOperations.d.ts.map +1 -0
  110. package/dist-esm/src/operationsInterfaces/privateEndpointConnectionOperations.js +9 -0
  111. package/dist-esm/src/operationsInterfaces/privateEndpointConnectionOperations.js.map +1 -0
  112. package/dist-esm/src/operationsInterfaces/privateLinkResourceOperations.d.ts +22 -0
  113. package/dist-esm/src/operationsInterfaces/privateLinkResourceOperations.d.ts.map +1 -0
  114. package/dist-esm/src/operationsInterfaces/privateLinkResourceOperations.js +9 -0
  115. package/dist-esm/src/operationsInterfaces/privateLinkResourceOperations.js.map +1 -0
  116. package/dist-esm/test/sampleTest.d.ts +4 -0
  117. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  118. package/dist-esm/test/sampleTest.js +479 -0
  119. package/dist-esm/test/sampleTest.js.map +1 -0
  120. package/package.json +71 -34
  121. package/review/arm-batch.api.md +1459 -0
  122. package/rollup.config.js +184 -27
  123. package/src/batchManagementClient.ts +75 -0
  124. package/src/batchManagementClientContext.ts +71 -0
  125. package/src/index.ts +13 -0
  126. package/src/lroImpl.ts +34 -0
  127. package/src/models/index.ts +2045 -0
  128. package/{lib → src}/models/mappers.ts +2413 -1223
  129. package/src/models/parameters.ts +351 -0
  130. package/src/operations/applicationOperations.ts +357 -0
  131. package/src/operations/applicationPackageOperations.ts +410 -0
  132. package/src/operations/batchAccountOperations.ts +901 -0
  133. package/src/operations/certificateOperations.ts +527 -0
  134. package/{lib → src}/operations/index.ts +5 -5
  135. package/src/operations/location.ts +413 -0
  136. package/src/operations/operations.ts +137 -0
  137. package/src/operations/poolOperations.ts +560 -0
  138. package/src/operations/privateEndpointConnectionOperations.ts +388 -0
  139. package/src/operations/privateLinkResourceOperations.ts +235 -0
  140. package/src/operationsInterfaces/applicationOperations.ts +90 -0
  141. package/src/operationsInterfaces/applicationPackageOperations.ts +106 -0
  142. package/src/operationsInterfaces/batchAccountOperations.ts +196 -0
  143. package/src/operationsInterfaces/certificateOperations.ts +139 -0
  144. package/{esm/operations/index.js → src/operationsInterfaces/index.ts} +6 -6
  145. package/src/operationsInterfaces/location.ts +62 -0
  146. package/src/operationsInterfaces/operations.ts +22 -0
  147. package/src/operationsInterfaces/poolOperations.ts +142 -0
  148. package/src/operationsInterfaces/privateEndpointConnectionOperations.ts +87 -0
  149. package/src/operationsInterfaces/privateLinkResourceOperations.ts +45 -0
  150. package/tsconfig.json +4 -4
  151. package/types/arm-batch.d.ts +2528 -0
  152. package/types/tsdoc-metadata.json +11 -0
  153. package/dist/arm-batch.js +0 -4689
  154. package/dist/arm-batch.js.map +0 -1
  155. package/dist/arm-batch.min.js +0 -1
  156. package/dist/arm-batch.min.js.map +0 -1
  157. package/esm/batchManagementClient.d.ts +0 -25
  158. package/esm/batchManagementClient.d.ts.map +0 -1
  159. package/esm/batchManagementClient.js +0 -40
  160. package/esm/batchManagementClient.js.map +0 -1
  161. package/esm/batchManagementClientContext.d.ts +0 -17
  162. package/esm/batchManagementClientContext.d.ts.map +0 -1
  163. package/esm/batchManagementClientContext.js +0 -57
  164. package/esm/batchManagementClientContext.js.map +0 -1
  165. package/esm/models/applicationOperationsMappers.d.ts +0 -2
  166. package/esm/models/applicationOperationsMappers.d.ts.map +0 -1
  167. package/esm/models/applicationOperationsMappers.js +0 -11
  168. package/esm/models/applicationOperationsMappers.js.map +0 -1
  169. package/esm/models/applicationPackageOperationsMappers.d.ts +0 -2
  170. package/esm/models/applicationPackageOperationsMappers.d.ts.map +0 -1
  171. package/esm/models/applicationPackageOperationsMappers.js +0 -11
  172. package/esm/models/applicationPackageOperationsMappers.js.map +0 -1
  173. package/esm/models/batchAccountOperationsMappers.d.ts +0 -2
  174. package/esm/models/batchAccountOperationsMappers.d.ts.map +0 -1
  175. package/esm/models/batchAccountOperationsMappers.js +0 -11
  176. package/esm/models/batchAccountOperationsMappers.js.map +0 -1
  177. package/esm/models/certificateOperationsMappers.d.ts +0 -2
  178. package/esm/models/certificateOperationsMappers.d.ts.map +0 -1
  179. package/esm/models/certificateOperationsMappers.js +0 -11
  180. package/esm/models/certificateOperationsMappers.js.map +0 -1
  181. package/esm/models/index.d.ts +0 -3108
  182. package/esm/models/index.d.ts.map +0 -1
  183. package/esm/models/index.js +0 -10
  184. package/esm/models/index.js.map +0 -1
  185. package/esm/models/locationMappers.d.ts +0 -2
  186. package/esm/models/locationMappers.d.ts.map +0 -1
  187. package/esm/models/locationMappers.js +0 -11
  188. package/esm/models/locationMappers.js.map +0 -1
  189. package/esm/models/mappers.d.ts +0 -76
  190. package/esm/models/mappers.d.ts.map +0 -1
  191. package/esm/models/mappers.js.map +0 -1
  192. package/esm/models/operationsMappers.d.ts +0 -2
  193. package/esm/models/operationsMappers.d.ts.map +0 -1
  194. package/esm/models/operationsMappers.js +0 -11
  195. package/esm/models/operationsMappers.js.map +0 -1
  196. package/esm/models/parameters.d.ts +0 -18
  197. package/esm/models/parameters.d.ts.map +0 -1
  198. package/esm/models/parameters.js +0 -196
  199. package/esm/models/parameters.js.map +0 -1
  200. package/esm/models/poolOperationsMappers.d.ts +0 -2
  201. package/esm/models/poolOperationsMappers.d.ts.map +0 -1
  202. package/esm/models/poolOperationsMappers.js +0 -11
  203. package/esm/models/poolOperationsMappers.js.map +0 -1
  204. package/esm/operations/applicationOperations.d.ts +0 -151
  205. package/esm/operations/applicationOperations.d.ts.map +0 -1
  206. package/esm/operations/applicationOperations.js +0 -226
  207. package/esm/operations/applicationOperations.js.map +0 -1
  208. package/esm/operations/applicationPackageOperations.d.ts +0 -124
  209. package/esm/operations/applicationPackageOperations.d.ts.map +0 -1
  210. package/esm/operations/applicationPackageOperations.js +0 -171
  211. package/esm/operations/applicationPackageOperations.js.map +0 -1
  212. package/esm/operations/batchAccountOperations.d.ts +0 -246
  213. package/esm/operations/batchAccountOperations.d.ts.map +0 -1
  214. package/esm/operations/batchAccountOperations.js +0 -426
  215. package/esm/operations/batchAccountOperations.js.map +0 -1
  216. package/esm/operations/certificateOperations.d.ts +0 -198
  217. package/esm/operations/certificateOperations.d.ts.map +0 -1
  218. package/esm/operations/certificateOperations.js +0 -326
  219. package/esm/operations/certificateOperations.js.map +0 -1
  220. package/esm/operations/index.d.ts.map +0 -1
  221. package/esm/operations/index.js.map +0 -1
  222. package/esm/operations/location.d.ts +0 -52
  223. package/esm/operations/location.d.ts.map +0 -1
  224. package/esm/operations/location.js +0 -93
  225. package/esm/operations/location.js.map +0 -1
  226. package/esm/operations/operations.d.ts +0 -46
  227. package/esm/operations/operations.d.ts.map +0 -1
  228. package/esm/operations/operations.js +0 -77
  229. package/esm/operations/operations.js.map +0 -1
  230. package/esm/operations/poolOperations.d.ts +0 -199
  231. package/esm/operations/poolOperations.d.ts.map +0 -1
  232. package/esm/operations/poolOperations.js +0 -352
  233. package/esm/operations/poolOperations.js.map +0 -1
  234. package/lib/batchManagementClient.ts +0 -55
  235. package/lib/batchManagementClientContext.ts +0 -63
  236. package/lib/models/applicationOperationsMappers.ts +0 -19
  237. package/lib/models/applicationPackageOperationsMappers.ts +0 -16
  238. package/lib/models/batchAccountOperationsMappers.ts +0 -61
  239. package/lib/models/certificateOperationsMappers.ts +0 -60
  240. package/lib/models/index.ts +0 -3252
  241. package/lib/models/locationMappers.ts +0 -17
  242. package/lib/models/operationsMappers.ts +0 -17
  243. package/lib/models/parameters.ts +0 -198
  244. package/lib/models/poolOperationsMappers.ts +0 -61
  245. package/lib/operations/applicationOperations.ts +0 -399
  246. package/lib/operations/applicationPackageOperations.ts +0 -307
  247. package/lib/operations/batchAccountOperations.ts +0 -683
  248. package/lib/operations/certificateOperations.ts +0 -510
  249. package/lib/operations/location.ts +0 -147
  250. package/lib/operations/operations.ts +0 -123
  251. package/lib/operations/poolOperations.ts +0 -550
@@ -1,3108 +0,0 @@
1
- import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
2
- import * as msRest from "@azure/ms-rest-js";
3
- export { BaseResource, CloudError };
4
- /**
5
- * @interface
6
- * An interface representing AutoStorageBaseProperties.
7
- * The properties related to the auto-storage account.
8
- *
9
- */
10
- export interface AutoStorageBaseProperties {
11
- /**
12
- * @member {string} storageAccountId The resource ID of the storage account
13
- * to be used for auto-storage account.
14
- */
15
- storageAccountId: string;
16
- }
17
- /**
18
- * @interface
19
- * An interface representing KeyVaultReference.
20
- * Identifies the Azure key vault associated with a Batch account.
21
- *
22
- */
23
- export interface KeyVaultReference {
24
- /**
25
- * @member {string} id The resource ID of the Azure key vault associated with
26
- * the Batch account.
27
- */
28
- id: string;
29
- /**
30
- * @member {string} url The URL of the Azure key vault associated with the
31
- * Batch account.
32
- */
33
- url: string;
34
- }
35
- /**
36
- * @interface
37
- * An interface representing BatchAccountCreateParameters.
38
- * Parameters supplied to the Create operation.
39
- *
40
- */
41
- export interface BatchAccountCreateParameters {
42
- /**
43
- * @member {string} location The region in which to create the account.
44
- */
45
- location: string;
46
- /**
47
- * @member {{ [propertyName: string]: string }} [tags] The user-specified
48
- * tags associated with the account.
49
- */
50
- tags?: {
51
- [propertyName: string]: string;
52
- };
53
- /**
54
- * @member {AutoStorageBaseProperties} [autoStorage] The properties related
55
- * to the auto-storage account.
56
- */
57
- autoStorage?: AutoStorageBaseProperties;
58
- /**
59
- * @member {PoolAllocationMode} [poolAllocationMode] The allocation mode to
60
- * use for creating pools in the Batch account. The pool allocation mode also
61
- * affects how clients may authenticate to the Batch Service API. If the mode
62
- * is BatchService, clients may authenticate using access keys or Azure
63
- * Active Directory. If the mode is UserSubscription, clients must use Azure
64
- * Active Directory. The default is BatchService. Possible values include:
65
- * 'BatchService', 'UserSubscription'
66
- */
67
- poolAllocationMode?: PoolAllocationMode;
68
- /**
69
- * @member {KeyVaultReference} [keyVaultReference] A reference to the Azure
70
- * key vault associated with the Batch account.
71
- */
72
- keyVaultReference?: KeyVaultReference;
73
- }
74
- /**
75
- * @interface
76
- * An interface representing AutoStorageProperties.
77
- * Contains information about the auto-storage account associated with a Batch
78
- * account.
79
- *
80
- * @extends AutoStorageBaseProperties
81
- */
82
- export interface AutoStorageProperties extends AutoStorageBaseProperties {
83
- /**
84
- * @member {Date} lastKeySync The UTC time at which storage keys were last
85
- * synchronized with the Batch account.
86
- */
87
- lastKeySync: Date;
88
- }
89
- /**
90
- * @interface
91
- * An interface representing Resource.
92
- * A definition of an Azure resource.
93
- *
94
- * @extends BaseResource
95
- */
96
- export interface Resource extends BaseResource {
97
- /**
98
- * @member {string} [id] The ID of the resource.
99
- * **NOTE: This property will not be serialized. It can only be populated by
100
- * the server.**
101
- */
102
- readonly id?: string;
103
- /**
104
- * @member {string} [name] The name of the resource.
105
- * **NOTE: This property will not be serialized. It can only be populated by
106
- * the server.**
107
- */
108
- readonly name?: string;
109
- /**
110
- * @member {string} [type] The type of the resource.
111
- * **NOTE: This property will not be serialized. It can only be populated by
112
- * the server.**
113
- */
114
- readonly type?: string;
115
- /**
116
- * @member {string} [location] The location of the resource.
117
- * **NOTE: This property will not be serialized. It can only be populated by
118
- * the server.**
119
- */
120
- readonly location?: string;
121
- /**
122
- * @member {{ [propertyName: string]: string }} [tags] The tags of the
123
- * resource.
124
- * **NOTE: This property will not be serialized. It can only be populated by
125
- * the server.**
126
- */
127
- readonly tags?: {
128
- [propertyName: string]: string;
129
- };
130
- }
131
- /**
132
- * @interface
133
- * An interface representing BatchAccount.
134
- * Contains information about an Azure Batch account.
135
- *
136
- * @extends Resource
137
- */
138
- export interface BatchAccount extends Resource {
139
- /**
140
- * @member {string} [accountEndpoint] The account endpoint used to interact
141
- * with the Batch service.
142
- * **NOTE: This property will not be serialized. It can only be populated by
143
- * the server.**
144
- */
145
- readonly accountEndpoint?: string;
146
- /**
147
- * @member {ProvisioningState} [provisioningState] The provisioned state of
148
- * the resource. Possible values include: 'Invalid', 'Creating', 'Deleting',
149
- * 'Succeeded', 'Failed', 'Cancelled'
150
- * **NOTE: This property will not be serialized. It can only be populated by
151
- * the server.**
152
- */
153
- readonly provisioningState?: ProvisioningState;
154
- /**
155
- * @member {PoolAllocationMode} [poolAllocationMode] The allocation mode to
156
- * use for creating pools in the Batch account. Possible values include:
157
- * 'BatchService', 'UserSubscription'
158
- * **NOTE: This property will not be serialized. It can only be populated by
159
- * the server.**
160
- */
161
- readonly poolAllocationMode?: PoolAllocationMode;
162
- /**
163
- * @member {KeyVaultReference} [keyVaultReference] A reference to the Azure
164
- * key vault associated with the Batch account. **NOTE: This property will
165
- * not be serialized. It can only be populated by the server.**
166
- */
167
- readonly keyVaultReference?: KeyVaultReference;
168
- /**
169
- * @member {AutoStorageProperties} [autoStorage] The properties and status of
170
- * any auto-storage account associated with the Batch account. **NOTE: This
171
- * property will not be serialized. It can only be populated by the server.**
172
- */
173
- readonly autoStorage?: AutoStorageProperties;
174
- /**
175
- * @member {number} [dedicatedCoreQuota] The dedicated core quota for this
176
- * Batch account. **NOTE: This property will not be serialized. It can only
177
- * be populated by the server.**
178
- */
179
- readonly dedicatedCoreQuota?: number;
180
- /**
181
- * @member {number} [lowPriorityCoreQuota] The low-priority core quota for
182
- * this Batch account. **NOTE: This property will not be serialized. It can
183
- * only be populated by the server.**
184
- */
185
- readonly lowPriorityCoreQuota?: number;
186
- /**
187
- * @member {number} [poolQuota] The pool quota for this Batch account.
188
- * **NOTE: This property will not be serialized. It can only be populated by
189
- * the server.**
190
- */
191
- readonly poolQuota?: number;
192
- /**
193
- * @member {number} [activeJobAndJobScheduleQuota] The active job and job
194
- * schedule quota for this Batch account. **NOTE: This property will not be
195
- * serialized. It can only be populated by the server.**
196
- */
197
- readonly activeJobAndJobScheduleQuota?: number;
198
- }
199
- /**
200
- * @interface
201
- * An interface representing BatchAccountUpdateParameters.
202
- * Parameters for updating an Azure Batch account.
203
- *
204
- */
205
- export interface BatchAccountUpdateParameters {
206
- /**
207
- * @member {{ [propertyName: string]: string }} [tags] The user-specified
208
- * tags associated with the account.
209
- */
210
- tags?: {
211
- [propertyName: string]: string;
212
- };
213
- /**
214
- * @member {AutoStorageBaseProperties} [autoStorage] The properties related
215
- * to the auto-storage account.
216
- */
217
- autoStorage?: AutoStorageBaseProperties;
218
- }
219
- /**
220
- * @interface
221
- * An interface representing BatchAccountRegenerateKeyParameters.
222
- * Parameters supplied to the RegenerateKey operation.
223
- *
224
- */
225
- export interface BatchAccountRegenerateKeyParameters {
226
- /**
227
- * @member {AccountKeyType} keyName The type of account key to regenerate.
228
- * Possible values include: 'Primary', 'Secondary'
229
- */
230
- keyName: AccountKeyType;
231
- }
232
- /**
233
- * @interface
234
- * An interface representing BatchAccountKeys.
235
- * A set of Azure Batch account keys.
236
- *
237
- */
238
- export interface BatchAccountKeys {
239
- /**
240
- * @member {string} [accountName] The Batch account name.
241
- * **NOTE: This property will not be serialized. It can only be populated by
242
- * the server.**
243
- */
244
- readonly accountName?: string;
245
- /**
246
- * @member {string} [primary] The primary key associated with the account.
247
- * **NOTE: This property will not be serialized. It can only be populated by
248
- * the server.**
249
- */
250
- readonly primary?: string;
251
- /**
252
- * @member {string} [secondary] The secondary key associated with the
253
- * account.
254
- * **NOTE: This property will not be serialized. It can only be populated by
255
- * the server.**
256
- */
257
- readonly secondary?: string;
258
- }
259
- /**
260
- * @interface
261
- * An interface representing ActivateApplicationPackageParameters.
262
- * Parameters for an activating an application package.
263
- *
264
- */
265
- export interface ActivateApplicationPackageParameters {
266
- /**
267
- * @member {string} format The format of the application package binary file.
268
- */
269
- format: string;
270
- }
271
- /**
272
- * @interface
273
- * An interface representing ApplicationCreateParameters.
274
- * Parameters for adding an Application.
275
- *
276
- */
277
- export interface ApplicationCreateParameters {
278
- /**
279
- * @member {boolean} [allowUpdates] A value indicating whether packages
280
- * within the application may be overwritten using the same version string.
281
- */
282
- allowUpdates?: boolean;
283
- /**
284
- * @member {string} [displayName] The display name for the application.
285
- */
286
- displayName?: string;
287
- }
288
- /**
289
- * @interface
290
- * An interface representing ApplicationPackage.
291
- * An application package which represents a particular version of an
292
- * application.
293
- *
294
- */
295
- export interface ApplicationPackage {
296
- /**
297
- * @member {string} [id] The ID of the application.
298
- * **NOTE: This property will not be serialized. It can only be populated by
299
- * the server.**
300
- */
301
- readonly id?: string;
302
- /**
303
- * @member {string} [version] The version of the application package.
304
- * **NOTE: This property will not be serialized. It can only be populated by
305
- * the server.**
306
- */
307
- readonly version?: string;
308
- /**
309
- * @member {PackageState} [state] The current state of the application
310
- * package. Possible values include: 'Pending', 'Active', 'Unmapped'
311
- * **NOTE: This property will not be serialized. It can only be populated by
312
- * the server.**
313
- */
314
- readonly state?: PackageState;
315
- /**
316
- * @member {string} [format] The format of the application package, if the
317
- * package is active.
318
- * **NOTE: This property will not be serialized. It can only be populated by
319
- * the server.**
320
- */
321
- readonly format?: string;
322
- /**
323
- * @member {string} [storageUrl] The URL for the application package in Azure
324
- * Storage.
325
- * **NOTE: This property will not be serialized. It can only be populated by
326
- * the server.**
327
- */
328
- readonly storageUrl?: string;
329
- /**
330
- * @member {Date} [storageUrlExpiry] The UTC time at which the Azure Storage
331
- * URL will expire.
332
- * **NOTE: This property will not be serialized. It can only be populated by
333
- * the server.**
334
- */
335
- readonly storageUrlExpiry?: Date;
336
- /**
337
- * @member {Date} [lastActivationTime] The time at which the package was last
338
- * activated, if the package is active.
339
- * **NOTE: This property will not be serialized. It can only be populated by
340
- * the server.**
341
- */
342
- readonly lastActivationTime?: Date;
343
- }
344
- /**
345
- * @interface
346
- * An interface representing Application.
347
- * Contains information about an application in a Batch account.
348
- *
349
- */
350
- export interface Application {
351
- /**
352
- * @member {string} [id] A string that uniquely identifies the application
353
- * within the account.
354
- */
355
- id?: string;
356
- /**
357
- * @member {string} [displayName] The display name for the application.
358
- */
359
- displayName?: string;
360
- /**
361
- * @member {ApplicationPackage[]} [packages] The list of packages under this
362
- * application.
363
- */
364
- packages?: ApplicationPackage[];
365
- /**
366
- * @member {boolean} [allowUpdates] A value indicating whether packages
367
- * within the application may be overwritten using the same version string.
368
- */
369
- allowUpdates?: boolean;
370
- /**
371
- * @member {string} [defaultVersion] The package to use if a client requests
372
- * the application but does not specify a version.
373
- */
374
- defaultVersion?: string;
375
- }
376
- /**
377
- * @interface
378
- * An interface representing ApplicationUpdateParameters.
379
- * Parameters for an update application request.
380
- *
381
- */
382
- export interface ApplicationUpdateParameters {
383
- /**
384
- * @member {boolean} [allowUpdates] A value indicating whether packages
385
- * within the application may be overwritten using the same version string.
386
- */
387
- allowUpdates?: boolean;
388
- /**
389
- * @member {string} [defaultVersion] The package to use if a client requests
390
- * the application but does not specify a version.
391
- */
392
- defaultVersion?: string;
393
- /**
394
- * @member {string} [displayName] The display name for the application.
395
- */
396
- displayName?: string;
397
- }
398
- /**
399
- * @interface
400
- * An interface representing BatchLocationQuota.
401
- * Quotas associated with a Batch region for a particular subscription.
402
- *
403
- */
404
- export interface BatchLocationQuota {
405
- /**
406
- * @member {number} [accountQuota] The number of Batch accounts that may be
407
- * created under the subscription in the specified region.
408
- * **NOTE: This property will not be serialized. It can only be populated by
409
- * the server.**
410
- */
411
- readonly accountQuota?: number;
412
- }
413
- /**
414
- * @interface
415
- * An interface representing ProxyResource.
416
- * A definition of an Azure resource.
417
- *
418
- * @extends BaseResource
419
- */
420
- export interface ProxyResource extends BaseResource {
421
- /**
422
- * @member {string} [id] The ID of the resource.
423
- * **NOTE: This property will not be serialized. It can only be populated by
424
- * the server.**
425
- */
426
- readonly id?: string;
427
- /**
428
- * @member {string} [name] The name of the resource.
429
- * **NOTE: This property will not be serialized. It can only be populated by
430
- * the server.**
431
- */
432
- readonly name?: string;
433
- /**
434
- * @member {string} [type] The type of the resource.
435
- * **NOTE: This property will not be serialized. It can only be populated by
436
- * the server.**
437
- */
438
- readonly type?: string;
439
- /**
440
- * @member {string} [etag] The ETag of the resource, used for concurrency
441
- * statements.
442
- * **NOTE: This property will not be serialized. It can only be populated by
443
- * the server.**
444
- */
445
- readonly etag?: string;
446
- }
447
- /**
448
- * @interface
449
- * An interface representing CertificateBaseProperties.
450
- */
451
- export interface CertificateBaseProperties {
452
- /**
453
- * @member {string} [thumbprintAlgorithm] The algorithm of the certificate
454
- * thumbprint. This must match the first portion of the certificate name.
455
- * Currently required to be 'SHA1'.
456
- */
457
- thumbprintAlgorithm?: string;
458
- /**
459
- * @member {string} [thumbprint] The thumbprint of the certificate. This must
460
- * match the thumbprint from the name.
461
- */
462
- thumbprint?: string;
463
- /**
464
- * @member {CertificateFormat} [format] The format of the certificate -
465
- * either Pfx or Cer. If omitted, the default is Pfx. Possible values
466
- * include: 'Pfx', 'Cer'
467
- */
468
- format?: CertificateFormat;
469
- }
470
- /**
471
- * @interface
472
- * An interface representing DeleteCertificateError.
473
- * An error response from the Batch service.
474
- *
475
- */
476
- export interface DeleteCertificateError {
477
- /**
478
- * @member {string} code An identifier for the error. Codes are invariant and
479
- * are intended to be consumed programmatically.
480
- */
481
- code: string;
482
- /**
483
- * @member {string} message A message describing the error, intended to be
484
- * suitable for display in a user interface.
485
- */
486
- message: string;
487
- /**
488
- * @member {string} [target] The target of the particular error. For example,
489
- * the name of the property in error.
490
- */
491
- target?: string;
492
- /**
493
- * @member {DeleteCertificateError[]} [details] A list of additional details
494
- * about the error.
495
- */
496
- details?: DeleteCertificateError[];
497
- }
498
- /**
499
- * @interface
500
- * An interface representing Certificate.
501
- * Contains information about a certificate.
502
- *
503
- * @extends ProxyResource
504
- */
505
- export interface Certificate extends ProxyResource {
506
- /**
507
- * @member {string} [thumbprintAlgorithm] The algorithm of the certificate
508
- * thumbprint. This must match the first portion of the certificate name.
509
- * Currently required to be 'SHA1'.
510
- */
511
- thumbprintAlgorithm?: string;
512
- /**
513
- * @member {string} [thumbprint] The thumbprint of the certificate. This must
514
- * match the thumbprint from the name.
515
- */
516
- thumbprint?: string;
517
- /**
518
- * @member {CertificateFormat} [format] The format of the certificate -
519
- * either Pfx or Cer. If omitted, the default is Pfx. Possible values
520
- * include: 'Pfx', 'Cer'
521
- */
522
- format?: CertificateFormat;
523
- /**
524
- * @member {CertificateProvisioningState} [provisioningState] The provisioned
525
- * state of the resource. Values are:
526
- *
527
- * Succeeded - The certificate is available for use in pools.
528
- * Deleting - The user has requested that the certificate be deleted, but the
529
- * delete operation has not yet completed. You may not reference the
530
- * certificate when creating or updating pools.
531
- * Failed - The user requested that the certificate be deleted, but there are
532
- * pools that still have references to the certificate, or it is still
533
- * installed on one or more compute nodes. (The latter can occur if the
534
- * certificate has been removed from the pool, but the node has not yet
535
- * restarted. Nodes refresh their certificates only when they restart.) You
536
- * may use the cancel certificate delete operation to cancel the delete, or
537
- * the delete certificate operation to retry the delete. Possible values
538
- * include: 'Succeeded', 'Deleting', 'Failed'
539
- * **NOTE: This property will not be serialized. It can only be populated by
540
- * the server.**
541
- */
542
- readonly provisioningState?: CertificateProvisioningState;
543
- /**
544
- * @member {Date} [provisioningStateTransitionTime] The time at which the
545
- * certificate entered its current state. **NOTE: This property will not be
546
- * serialized. It can only be populated by the server.**
547
- */
548
- readonly provisioningStateTransitionTime?: Date;
549
- /**
550
- * @member {CertificateProvisioningState} [previousProvisioningState] The
551
- * previous provisioned state of the resource. Possible values include:
552
- * 'Succeeded', 'Deleting', 'Failed'
553
- * **NOTE: This property will not be serialized. It can only be populated by
554
- * the server.**
555
- */
556
- readonly previousProvisioningState?: CertificateProvisioningState;
557
- /**
558
- * @member {Date} [previousProvisioningStateTransitionTime] The time at which
559
- * the certificate entered its previous state. **NOTE: This property will not
560
- * be serialized. It can only be populated by the server.**
561
- */
562
- readonly previousProvisioningStateTransitionTime?: Date;
563
- /**
564
- * @member {string} [publicData] The public key of the certificate.
565
- * **NOTE: This property will not be serialized. It can only be populated by
566
- * the server.**
567
- */
568
- readonly publicData?: string;
569
- /**
570
- * @member {DeleteCertificateError} [deleteCertificateError] The error which
571
- * occurred while deleting the certificate. This is only returned when the
572
- * certificate provisioningState is 'Failed'.
573
- * **NOTE: This property will not be serialized. It can only be populated by
574
- * the server.**
575
- */
576
- readonly deleteCertificateError?: DeleteCertificateError;
577
- }
578
- /**
579
- * @interface
580
- * An interface representing CertificateCreateOrUpdateParameters.
581
- * Contains information about a certificate.
582
- *
583
- * @extends ProxyResource
584
- */
585
- export interface CertificateCreateOrUpdateParameters extends ProxyResource {
586
- /**
587
- * @member {string} [thumbprintAlgorithm] The algorithm of the certificate
588
- * thumbprint. This must match the first portion of the certificate name.
589
- * Currently required to be 'SHA1'.
590
- */
591
- thumbprintAlgorithm?: string;
592
- /**
593
- * @member {string} [thumbprint] The thumbprint of the certificate. This must
594
- * match the thumbprint from the name.
595
- */
596
- thumbprint?: string;
597
- /**
598
- * @member {CertificateFormat} [format] The format of the certificate -
599
- * either Pfx or Cer. If omitted, the default is Pfx. Possible values
600
- * include: 'Pfx', 'Cer'
601
- */
602
- format?: CertificateFormat;
603
- /**
604
- * @member {string} data The base64-encoded contents of the certificate. The
605
- * maximum size is 10KB.
606
- */
607
- data: string;
608
- /**
609
- * @member {string} [password] The password to access the certificate's
610
- * private key. This is required if the certificate format is pfx and must be
611
- * omitted if the certificate format is cer.
612
- */
613
- password?: string;
614
- }
615
- /**
616
- * @interface
617
- * An interface representing CloudServiceConfiguration.
618
- * @summary The configuration for nodes in a pool based on the Azure Cloud
619
- * Services platform.
620
- *
621
- */
622
- export interface CloudServiceConfiguration {
623
- /**
624
- * @member {string} osFamily The Azure Guest OS family to be installed on the
625
- * virtual machines in the pool. Possible values are: 2 - OS Family 2,
626
- * equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to
627
- * Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012
628
- * R2. 5 - OS Family 5, equivalent to Windows Server 2016. For more
629
- * information, see Azure Guest OS Releases
630
- * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
631
- */
632
- osFamily: string;
633
- /**
634
- * @member {string} [targetOSVersion] The Azure Guest OS version to be
635
- * installed on the virtual machines in the pool. The default value is *
636
- * which specifies the latest operating system version for the specified OS
637
- * family.
638
- */
639
- targetOSVersion?: string;
640
- /**
641
- * @member {string} [currentOSVersion] The Azure Guest OS Version currently
642
- * installed on the virtual machines in the pool. This may differ from
643
- * targetOSVersion if the pool state is Upgrading. In this case some virtual
644
- * machines may be on the targetOSVersion and some may be on the
645
- * currentOSVersion during the upgrade process. Once all virtual machines
646
- * have upgraded, currentOSVersion is updated to be the same as
647
- * targetOSVersion.
648
- */
649
- currentOSVersion?: string;
650
- }
651
- /**
652
- * @interface
653
- * An interface representing ImageReference.
654
- * @summary A reference to an Azure Virtual Machines Marketplace image or the
655
- * Azure Image resource of a custom Virtual Machine. To get the list of all
656
- * imageReferences verified by Azure Batch, see the 'List supported node agent
657
- * SKUs' operation.
658
- *
659
- */
660
- export interface ImageReference {
661
- /**
662
- * @member {string} [publisher] The publisher of the Azure Virtual Machines
663
- * Marketplace image. For example, Canonical or MicrosoftWindowsServer.
664
- */
665
- publisher?: string;
666
- /**
667
- * @member {string} [offer] The offer type of the Azure Virtual Machines
668
- * Marketplace image. For example, UbuntuServer or WindowsServer.
669
- */
670
- offer?: string;
671
- /**
672
- * @member {string} [sku] The SKU of the Azure Virtual Machines Marketplace
673
- * image. For example, 14.04.0-LTS or 2012-R2-Datacenter.
674
- */
675
- sku?: string;
676
- /**
677
- * @member {string} [version] The version of the Azure Virtual Machines
678
- * Marketplace image. A value of 'latest' can be specified to select the
679
- * latest version of an image. If omitted, the default is 'latest'.
680
- */
681
- version?: string;
682
- /**
683
- * @member {string} [id] The ARM resource identifier of the virtual machine
684
- * image. Computes nodes of the pool will be created using this custom image.
685
- * This is of the form
686
- * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}.
687
- * This property is mutually exclusive with other properties. The virtual
688
- * machine image must be in the same region and subscription as the Azure
689
- * Batch account. For information about the firewall settings for Batch node
690
- * agent to communicate with Batch service see
691
- * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
692
- * .
693
- */
694
- id?: string;
695
- }
696
- /**
697
- * @interface
698
- * An interface representing OSDisk.
699
- * @summary Settings for the operating system disk of the virtual machine.
700
- *
701
- */
702
- export interface OSDisk {
703
- /**
704
- * @member {CachingType} [caching] The type of caching to be enabled for the
705
- * data disks. none - The caching mode for the disk is not enabled. readOnly
706
- * - The caching mode for the disk is read only. readWrite - The caching mode
707
- * for the disk is read and write. Default value is none. Possible values
708
- * include: 'None', 'ReadOnly', 'ReadWrite'
709
- */
710
- caching?: CachingType;
711
- }
712
- /**
713
- * @interface
714
- * An interface representing WindowsConfiguration.
715
- * @summary Windows operating system settings to apply to the virtual machine.
716
- *
717
- */
718
- export interface WindowsConfiguration {
719
- /**
720
- * @member {boolean} [enableAutomaticUpdates] Whether automatic updates are
721
- * enabled on the virtual machine. If omitted, the default value is true.
722
- */
723
- enableAutomaticUpdates?: boolean;
724
- }
725
- /**
726
- * @interface
727
- * An interface representing DataDisk.
728
- * Data Disk settings which will be used by the data disks associated to
729
- * Compute Nodes in the pool.
730
- *
731
- */
732
- export interface DataDisk {
733
- /**
734
- * @member {number} lun The logical unit number. The lun is used to uniquely
735
- * identify each data disk. If attaching multiple disks, each should have a
736
- * distinct lun.
737
- */
738
- lun: number;
739
- /**
740
- * @member {CachingType} [caching] The type of caching to be enabled for the
741
- * data disks. Values are:
742
- *
743
- * none - The caching mode for the disk is not enabled.
744
- * readOnly - The caching mode for the disk is read only.
745
- * readWrite - The caching mode for the disk is read and write.
746
- *
747
- * The default value for caching is none. For information about the caching
748
- * options see:
749
- * https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
750
- * Possible values include: 'None', 'ReadOnly', 'ReadWrite'
751
- */
752
- caching?: CachingType;
753
- /**
754
- * @member {number} diskSizeGB The initial disk size in GB when creating new
755
- * data disk.
756
- */
757
- diskSizeGB: number;
758
- /**
759
- * @member {StorageAccountType} [storageAccountType] The storage account type
760
- * to be used for the data disk. If omitted, the default is "Standard_LRS".
761
- * Values are:
762
- *
763
- * Standard_LRS - The data disk should use standard locally redundant
764
- * storage.
765
- * Premium_LRS - The data disk should use premium locally redundant storage.
766
- * Possible values include: 'Standard_LRS', 'Premium_LRS'
767
- */
768
- storageAccountType?: StorageAccountType;
769
- }
770
- /**
771
- * @interface
772
- * An interface representing VirtualMachineConfiguration.
773
- * @summary The configuration for compute nodes in a pool based on the Azure
774
- * Virtual Machines infrastructure.
775
- *
776
- */
777
- export interface VirtualMachineConfiguration {
778
- /**
779
- * @member {ImageReference} imageReference A reference to the Azure Virtual
780
- * Machines Marketplace Image or the custom Virtual Machine Image to use.
781
- */
782
- imageReference: ImageReference;
783
- /**
784
- * @member {OSDisk} [osDisk] Settings for the operating system disk of the
785
- * Virtual Machine.
786
- */
787
- osDisk?: OSDisk;
788
- /**
789
- * @member {string} nodeAgentSkuId The SKU of the Batch node agent to be
790
- * provisioned on compute nodes in the pool. The Batch node agent is a
791
- * program that runs on each node in the pool, and provides the
792
- * command-and-control interface between the node and the Batch service.
793
- * There are different implementations of the node agent, known as SKUs, for
794
- * different operating systems. You must specify a node agent SKU which
795
- * matches the selected image reference. To get the list of supported node
796
- * agent SKUs along with their list of verified image references, see the
797
- * 'List supported node agent SKUs' operation.
798
- */
799
- nodeAgentSkuId: string;
800
- /**
801
- * @member {WindowsConfiguration} [windowsConfiguration] Windows operating
802
- * system settings on the virtual machine. This property must not be
803
- * specified if the imageReference specifies a Linux OS image.
804
- */
805
- windowsConfiguration?: WindowsConfiguration;
806
- /**
807
- * @member {DataDisk[]} [dataDisks] The configuration for data disks attached
808
- * to the compute nodes in the pool. This property must be specified if the
809
- * compute nodes in the pool need to have empty data disks attached to them.
810
- */
811
- dataDisks?: DataDisk[];
812
- /**
813
- * @member {string} [licenseType] The type of on-premises license to be used
814
- * when deploying the operating system. This only applies to images that
815
- * contain the Windows operating system, and should only be used when you
816
- * hold valid on-premises licenses for the nodes which will be deployed. If
817
- * omitted, no on-premises licensing discount is applied. Values are:
818
- *
819
- * Windows_Server - The on-premises license is for Windows Server.
820
- * Windows_Client - The on-premises license is for Windows Client.
821
- */
822
- licenseType?: string;
823
- }
824
- /**
825
- * @interface
826
- * An interface representing DeploymentConfiguration.
827
- * @summary Deployment configuration properties.
828
- *
829
- */
830
- export interface DeploymentConfiguration {
831
- /**
832
- * @member {CloudServiceConfiguration} [cloudServiceConfiguration] The cloud
833
- * service configuration for the pool. This property and
834
- * virtualMachineConfiguration are mutually exclusive and one of the
835
- * properties must be specified. This property cannot be specified if the
836
- * Batch account was created with its poolAllocationMode property set to
837
- * 'UserSubscription'.
838
- */
839
- cloudServiceConfiguration?: CloudServiceConfiguration;
840
- /**
841
- * @member {VirtualMachineConfiguration} [virtualMachineConfiguration] The
842
- * virtual machine configuration for the pool. This property and
843
- * cloudServiceConfiguration are mutually exclusive and one of the properties
844
- * must be specified.
845
- */
846
- virtualMachineConfiguration?: VirtualMachineConfiguration;
847
- }
848
- /**
849
- * @interface
850
- * An interface representing FixedScaleSettings.
851
- * @summary Fixed scale settings for the pool.
852
- *
853
- */
854
- export interface FixedScaleSettings {
855
- /**
856
- * @member {string} [resizeTimeout] The timeout for allocation of compute
857
- * nodes to the pool. The default value is 15 minutes. Timeout values use ISO
858
- * 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5
859
- * minutes. If you specify a value less than 5 minutes, the Batch service
860
- * rejects the request with an error; if you are calling the REST API
861
- * directly, the HTTP status code is 400 (Bad Request).
862
- */
863
- resizeTimeout?: string;
864
- /**
865
- * @member {number} [targetDedicatedNodes] The desired number of dedicated
866
- * compute nodes in the pool. At least one of targetDedicatedNodes,
867
- * targetLowPriority nodes must be set.
868
- */
869
- targetDedicatedNodes?: number;
870
- /**
871
- * @member {number} [targetLowPriorityNodes] The desired number of
872
- * low-priority compute nodes in the pool. At least one of
873
- * targetDedicatedNodes, targetLowPriority nodes must be set.
874
- */
875
- targetLowPriorityNodes?: number;
876
- /**
877
- * @member {ComputeNodeDeallocationOption} [nodeDeallocationOption]
878
- * Determines what to do with a node and its running task(s) if the pool size
879
- * is decreasing. If omitted, the default value is Requeue. Possible values
880
- * include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'
881
- */
882
- nodeDeallocationOption?: ComputeNodeDeallocationOption;
883
- }
884
- /**
885
- * @interface
886
- * An interface representing AutoScaleSettings.
887
- * @summary AutoScale settings for the pool.
888
- *
889
- */
890
- export interface AutoScaleSettings {
891
- /**
892
- * @member {string} formula A formula for the desired number of compute nodes
893
- * in the pool.
894
- */
895
- formula: string;
896
- /**
897
- * @member {string} [evaluationInterval] The time interval at which to
898
- * automatically adjust the pool size according to the autoscale formula. If
899
- * omitted, the default value is 15 minutes (PT15M).
900
- */
901
- evaluationInterval?: string;
902
- }
903
- /**
904
- * @interface
905
- * An interface representing ScaleSettings.
906
- * @summary Scale settings for the pool
907
- *
908
- * Defines the desired size of the pool. This can either be 'fixedScale' where
909
- * the requested targetDedicatedNodes is specified, or 'autoScale' which
910
- * defines a formula which is periodically reevaluated. If this property is not
911
- * specified, the pool will have a fixed scale with 0 targetDedicatedNodes.
912
- *
913
- */
914
- export interface ScaleSettings {
915
- /**
916
- * @member {FixedScaleSettings} [fixedScale] Fixed scale settings for the
917
- * pool. This property and autoScale are mutually exclusive and one of the
918
- * properties must be specified.
919
- */
920
- fixedScale?: FixedScaleSettings;
921
- /**
922
- * @member {AutoScaleSettings} [autoScale] AutoScale settings for the pool.
923
- * This property and fixedScale are mutually exclusive and one of the
924
- * properties must be specified.
925
- */
926
- autoScale?: AutoScaleSettings;
927
- }
928
- /**
929
- * @interface
930
- * An interface representing AutoScaleRunError.
931
- * @summary An error that occurred when autoscaling a pool.
932
- *
933
- */
934
- export interface AutoScaleRunError {
935
- /**
936
- * @member {string} code An identifier for the error. Codes are invariant and
937
- * are intended to be consumed programmatically.
938
- */
939
- code: string;
940
- /**
941
- * @member {string} message A message describing the error, intended to be
942
- * suitable for display in a user interface.
943
- */
944
- message: string;
945
- /**
946
- * @member {AutoScaleRunError[]} [details] Additional details about the
947
- * error.
948
- */
949
- details?: AutoScaleRunError[];
950
- }
951
- /**
952
- * @interface
953
- * An interface representing AutoScaleRun.
954
- * @summary The results and errors from an execution of a pool autoscale
955
- * formula.
956
- *
957
- */
958
- export interface AutoScaleRun {
959
- /**
960
- * @member {Date} evaluationTime The time at which the autoscale formula was
961
- * last evaluated.
962
- */
963
- evaluationTime: Date;
964
- /**
965
- * @member {string} [results] The final values of all variables used in the
966
- * evaluation of the autoscale formula. Each variable value is returned in
967
- * the form $variable=value, and variables are separated by semicolons.
968
- */
969
- results?: string;
970
- /**
971
- * @member {AutoScaleRunError} [error] Details of the error encountered
972
- * evaluating the autoscale formula on the pool, if the evaluation was
973
- * unsuccessful.
974
- */
975
- error?: AutoScaleRunError;
976
- }
977
- /**
978
- * @interface
979
- * An interface representing NetworkSecurityGroupRule.
980
- * @summary A network security group rule to apply to an inbound endpoint.
981
- *
982
- */
983
- export interface NetworkSecurityGroupRule {
984
- /**
985
- * @member {number} priority The priority for this rule. Priorities within a
986
- * pool must be unique and are evaluated in order of priority. The lower the
987
- * number the higher the priority. For example, rules could be specified with
988
- * order numbers of 150, 250, and 350. The rule with the order number of 150
989
- * takes precedence over the rule that has an order of 250. Allowed
990
- * priorities are 150 to 3500. If any reserved or duplicate values are
991
- * provided the request fails with HTTP status code 400.
992
- */
993
- priority: number;
994
- /**
995
- * @member {NetworkSecurityGroupRuleAccess} access The action that should be
996
- * taken for a specified IP address, subnet range or tag. Possible values
997
- * include: 'Allow', 'Deny'
998
- */
999
- access: NetworkSecurityGroupRuleAccess;
1000
- /**
1001
- * @member {string} sourceAddressPrefix The source address prefix or tag to
1002
- * match for the rule. Valid values are a single IP address (i.e.
1003
- * 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all
1004
- * addresses). If any other values are provided the request fails with HTTP
1005
- * status code 400.
1006
- */
1007
- sourceAddressPrefix: string;
1008
- }
1009
- /**
1010
- * @interface
1011
- * An interface representing InboundNatPool.
1012
- * @summary A inbound NAT pool that can be used to address specific ports on
1013
- * compute nodes in a Batch pool externally.
1014
- *
1015
- */
1016
- export interface InboundNatPool {
1017
- /**
1018
- * @member {string} name The name of the endpoint. The name must be unique
1019
- * within a Batch pool, can contain letters, numbers, underscores, periods,
1020
- * and hyphens. Names must start with a letter or number, must end with a
1021
- * letter, number, or underscore, and cannot exceed 77 characters. If any
1022
- * invalid values are provided the request fails with HTTP status code 400.
1023
- */
1024
- name: string;
1025
- /**
1026
- * @member {InboundEndpointProtocol} protocol The protocol of the endpoint.
1027
- * Possible values include: 'TCP', 'UDP'
1028
- */
1029
- protocol: InboundEndpointProtocol;
1030
- /**
1031
- * @member {number} backendPort The port number on the compute node. This
1032
- * must be unique within a Batch pool. Acceptable values are between 1 and
1033
- * 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any
1034
- * reserved values are provided the request fails with HTTP status code 400.
1035
- */
1036
- backendPort: number;
1037
- /**
1038
- * @member {number} frontendPortRangeStart The first port number in the range
1039
- * of external ports that will be used to provide inbound access to the
1040
- * backendPort on individual compute nodes. Acceptable values range between 1
1041
- * and 65534 except ports from 50000 to 55000 which are reserved. All ranges
1042
- * within a pool must be distinct and cannot overlap. If any reserved or
1043
- * overlapping values are provided the request fails with HTTP status code
1044
- * 400.
1045
- */
1046
- frontendPortRangeStart: number;
1047
- /**
1048
- * @member {number} frontendPortRangeEnd The last port number in the range of
1049
- * external ports that will be used to provide inbound access to the
1050
- * backendPort on individual compute nodes. Acceptable values range between 1
1051
- * and 65534 except ports from 50000 to 55000 which are reserved by the Batch
1052
- * service. All ranges within a pool must be distinct and cannot overlap. If
1053
- * any reserved or overlapping values are provided the request fails with
1054
- * HTTP status code 400.
1055
- */
1056
- frontendPortRangeEnd: number;
1057
- /**
1058
- * @member {NetworkSecurityGroupRule[]} [networkSecurityGroupRules] A list of
1059
- * network security group rules that will be applied to the endpoint. The
1060
- * maximum number of rules that can be specified across all the endpoints on
1061
- * a Batch pool is 25. If no network security group rules are specified, a
1062
- * default rule will be created to allow inbound access to the specified
1063
- * backendPort. If the maximum number of network security group rules is
1064
- * exceeded the request fails with HTTP status code 400.
1065
- */
1066
- networkSecurityGroupRules?: NetworkSecurityGroupRule[];
1067
- }
1068
- /**
1069
- * @interface
1070
- * An interface representing PoolEndpointConfiguration.
1071
- * @summary The endpoint configuration for a pool.
1072
- *
1073
- */
1074
- export interface PoolEndpointConfiguration {
1075
- /**
1076
- * @member {InboundNatPool[]} inboundNatPools A list of inbound NAT pools
1077
- * that can be used to address specific ports on an individual compute node
1078
- * externally. The maximum number of inbound NAT pools per Batch pool is 5.
1079
- * If the maximum number of inbound NAT pools is exceeded the request fails
1080
- * with HTTP status code 400.
1081
- */
1082
- inboundNatPools: InboundNatPool[];
1083
- }
1084
- /**
1085
- * @interface
1086
- * An interface representing NetworkConfiguration.
1087
- * The network configuration for a pool.
1088
- *
1089
- */
1090
- export interface NetworkConfiguration {
1091
- /**
1092
- * @member {string} [subnetId] The ARM resource identifier of the virtual
1093
- * network subnet which the compute nodes of the pool will join. This is of
1094
- * the form
1095
- * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
1096
- * The virtual network must be in the same region and subscription as the
1097
- * Azure Batch account. The specified subnet should have enough free IP
1098
- * addresses to accommodate the number of nodes in the pool. If the subnet
1099
- * doesn't have enough free IP addresses, the pool will partially allocate
1100
- * compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch'
1101
- * service principal must have the 'Classic Virtual Machine Contributor'
1102
- * Role-Based Access Control (RBAC) role for the specified VNet. The
1103
- * specified subnet must allow communication from the Azure Batch service to
1104
- * be able to schedule tasks on the compute nodes. This can be verified by
1105
- * checking if the specified VNet has any associated Network Security Groups
1106
- * (NSG). If communication to the compute nodes in the specified subnet is
1107
- * denied by an NSG, then the Batch service will set the state of the compute
1108
- * nodes to unusable. For pools created via virtualMachineConfiguration the
1109
- * Batch account must have poolAllocationMode userSubscription in order to
1110
- * use a VNet. If the specified VNet has any associated Network Security
1111
- * Groups (NSG), then a few reserved system ports must be enabled for inbound
1112
- * communication. For pools created with a virtual machine configuration,
1113
- * enable ports 29876 and 29877, as well as port 22 for Linux and port 3389
1114
- * for Windows. For pools created with a cloud service configuration, enable
1115
- * ports 10100, 20100, and 30100. Also enable outbound connections to Azure
1116
- * Storage on port 443. For more details see:
1117
- * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
1118
- */
1119
- subnetId?: string;
1120
- /**
1121
- * @member {PoolEndpointConfiguration} [endpointConfiguration] The
1122
- * configuration for endpoints on compute nodes in the Batch pool. Pool
1123
- * endpoint configuration is only supported on pools with the
1124
- * virtualMachineConfiguration property.
1125
- */
1126
- endpointConfiguration?: PoolEndpointConfiguration;
1127
- }
1128
- /**
1129
- * @interface
1130
- * An interface representing TaskSchedulingPolicy.
1131
- * @summary Specifies how tasks should be distributed across compute nodes.
1132
- *
1133
- */
1134
- export interface TaskSchedulingPolicy {
1135
- /**
1136
- * @member {ComputeNodeFillType} nodeFillType How tasks should be distributed
1137
- * across compute nodes. Possible values include: 'Spread', 'Pack'
1138
- */
1139
- nodeFillType: ComputeNodeFillType;
1140
- }
1141
- /**
1142
- * @interface
1143
- * An interface representing LinuxUserConfiguration.
1144
- * @summary Properties used to create a user account on a Linux node.
1145
- *
1146
- */
1147
- export interface LinuxUserConfiguration {
1148
- /**
1149
- * @member {number} [uid] The user ID of the user account. The uid and gid
1150
- * properties must be specified together or not at all. If not specified the
1151
- * underlying operating system picks the uid.
1152
- */
1153
- uid?: number;
1154
- /**
1155
- * @member {number} [gid] The group ID for the user account. The uid and gid
1156
- * properties must be specified together or not at all. If not specified the
1157
- * underlying operating system picks the gid.
1158
- */
1159
- gid?: number;
1160
- /**
1161
- * @member {string} [sshPrivateKey] The SSH private key for the user account.
1162
- * The private key must not be password protected. The private key is used to
1163
- * automatically configure asymmetric-key based authentication for SSH
1164
- * between nodes in a Linux pool when the pool's enableInterNodeCommunication
1165
- * property is true (it is ignored if enableInterNodeCommunication is false).
1166
- * It does this by placing the key pair into the user's .ssh directory. If
1167
- * not specified, password-less SSH is not configured between nodes (no
1168
- * modification of the user's .ssh directory is done).
1169
- */
1170
- sshPrivateKey?: string;
1171
- }
1172
- /**
1173
- * @interface
1174
- * An interface representing UserAccount.
1175
- * @summary Properties used to create a user on an Azure Batch node.
1176
- *
1177
- */
1178
- export interface UserAccount {
1179
- /**
1180
- * @member {string} name The name of the user account.
1181
- */
1182
- name: string;
1183
- /**
1184
- * @member {string} password The password for the user account.
1185
- */
1186
- password: string;
1187
- /**
1188
- * @member {ElevationLevel} [elevationLevel] The elevation level of the user
1189
- * account. nonAdmin - The auto user is a standard user without elevated
1190
- * access. admin - The auto user is a user with elevated access and operates
1191
- * with full Administrator permissions. The default value is nonAdmin.
1192
- * Possible values include: 'NonAdmin', 'Admin'
1193
- */
1194
- elevationLevel?: ElevationLevel;
1195
- /**
1196
- * @member {LinuxUserConfiguration} [linuxUserConfiguration] The
1197
- * Linux-specific user configuration for the user account. This property is
1198
- * ignored if specified on a Windows pool. If not specified, the user is
1199
- * created with the default options.
1200
- */
1201
- linuxUserConfiguration?: LinuxUserConfiguration;
1202
- }
1203
- /**
1204
- * @interface
1205
- * An interface representing MetadataItem.
1206
- * @summary A name-value pair associated with a Batch service resource.
1207
- *
1208
- * The Batch service does not assign any meaning to this metadata; it is solely
1209
- * for the use of user code.
1210
- *
1211
- */
1212
- export interface MetadataItem {
1213
- /**
1214
- * @member {string} name The name of the metadata item.
1215
- */
1216
- name: string;
1217
- /**
1218
- * @member {string} value The value of the metadata item.
1219
- */
1220
- value: string;
1221
- }
1222
- /**
1223
- * @interface
1224
- * An interface representing ResourceFile.
1225
- * @summary A file to be downloaded from Azure blob storage to a compute node.
1226
- *
1227
- */
1228
- export interface ResourceFile {
1229
- /**
1230
- * @member {string} blobSource The URL of the file within Azure Blob Storage.
1231
- * This URL must be readable using anonymous access; that is, the Batch
1232
- * service does not present any credentials when downloading the blob. There
1233
- * are two ways to get such a URL for a blob in Azure storage: include a
1234
- * Shared Access Signature (SAS) granting read permissions on the blob, or
1235
- * set the ACL for the blob or its container to allow public access.
1236
- */
1237
- blobSource: string;
1238
- /**
1239
- * @member {string} filePath The location on the compute node to which to
1240
- * download the file, relative to the task's working directory.
1241
- */
1242
- filePath: string;
1243
- /**
1244
- * @member {string} [fileMode] The file permission mode attribute in octal
1245
- * format. This property applies only to files being downloaded to Linux
1246
- * compute nodes. It will be ignored if it is specified for a resourceFile
1247
- * which will be downloaded to a Windows node. If this property is not
1248
- * specified for a Linux node, then a default value of 0770 is applied to the
1249
- * file.
1250
- */
1251
- fileMode?: string;
1252
- }
1253
- /**
1254
- * @interface
1255
- * An interface representing EnvironmentSetting.
1256
- * @summary An environment variable to be set on a task process.
1257
- *
1258
- */
1259
- export interface EnvironmentSetting {
1260
- /**
1261
- * @member {string} name The name of the environment variable.
1262
- */
1263
- name: string;
1264
- /**
1265
- * @member {string} [value] The value of the environment variable.
1266
- */
1267
- value?: string;
1268
- }
1269
- /**
1270
- * @interface
1271
- * An interface representing AutoUserSpecification.
1272
- * @summary Specifies the parameters for the auto user that runs a task on the
1273
- * Batch service.
1274
- *
1275
- */
1276
- export interface AutoUserSpecification {
1277
- /**
1278
- * @member {AutoUserScope} [scope] The scope for the auto user. pool -
1279
- * specifies that the task runs as the common auto user account which is
1280
- * created on every node in a pool. task - specifies that the service should
1281
- * create a new user for the task. The default value is task. Possible values
1282
- * include: 'Task', 'Pool'
1283
- */
1284
- scope?: AutoUserScope;
1285
- /**
1286
- * @member {ElevationLevel} [elevationLevel] The elevation level of the auto
1287
- * user. nonAdmin - The auto user is a standard user without elevated access.
1288
- * admin - The auto user is a user with elevated access and operates with
1289
- * full Administrator permissions. The default value is nonAdmin. Possible
1290
- * values include: 'NonAdmin', 'Admin'
1291
- */
1292
- elevationLevel?: ElevationLevel;
1293
- }
1294
- /**
1295
- * @interface
1296
- * An interface representing UserIdentity.
1297
- * @summary The definition of the user identity under which the task is run.
1298
- *
1299
- * Specify either the userName or autoUser property, but not both.
1300
- *
1301
- */
1302
- export interface UserIdentity {
1303
- /**
1304
- * @member {string} [userName] The name of the user identity under which the
1305
- * task is run. The userName and autoUser properties are mutually exclusive;
1306
- * you must specify one but not both.
1307
- */
1308
- userName?: string;
1309
- /**
1310
- * @member {AutoUserSpecification} [autoUser] The auto user under which the
1311
- * task is run. The userName and autoUser properties are mutually exclusive;
1312
- * you must specify one but not both.
1313
- */
1314
- autoUser?: AutoUserSpecification;
1315
- }
1316
- /**
1317
- * @interface
1318
- * An interface representing StartTask.
1319
- * @summary A task which is run when a compute node joins a pool in the Azure
1320
- * Batch service, or when the compute node is rebooted or reimaged.
1321
- *
1322
- */
1323
- export interface StartTask {
1324
- /**
1325
- * @member {string} [commandLine] The command line of the start task. The
1326
- * command line does not run under a shell, and therefore cannot take
1327
- * advantage of shell features such as environment variable expansion. If you
1328
- * want to take advantage of such features, you should invoke the shell in
1329
- * the command line, for example using "cmd /c MyCommand" in Windows or
1330
- * "/bin/sh -c MyCommand" in Linux. Required if any other properties of the
1331
- * startTask are specified.
1332
- */
1333
- commandLine?: string;
1334
- /**
1335
- * @member {ResourceFile[]} [resourceFiles] A list of files that the Batch
1336
- * service will download to the compute node before running the command line.
1337
- */
1338
- resourceFiles?: ResourceFile[];
1339
- /**
1340
- * @member {EnvironmentSetting[]} [environmentSettings] A list of environment
1341
- * variable settings for the start task.
1342
- */
1343
- environmentSettings?: EnvironmentSetting[];
1344
- /**
1345
- * @member {UserIdentity} [userIdentity] The user identity under which the
1346
- * start task runs. If omitted, the task runs as a non-administrative user
1347
- * unique to the task.
1348
- */
1349
- userIdentity?: UserIdentity;
1350
- /**
1351
- * @member {number} [maxTaskRetryCount] The maximum number of times the task
1352
- * may be retried. The Batch service retries a task if its exit code is
1353
- * nonzero. Note that this value specifically controls the number of retries.
1354
- * The Batch service will try the task once, and may then retry up to this
1355
- * limit. For example, if the maximum retry count is 3, Batch tries the task
1356
- * up to 4 times (one initial try and 3 retries). If the maximum retry count
1357
- * is 0, the Batch service does not retry the task. If the maximum retry
1358
- * count is -1, the Batch service retries the task without limit.
1359
- */
1360
- maxTaskRetryCount?: number;
1361
- /**
1362
- * @member {boolean} [waitForSuccess] Whether the Batch service should wait
1363
- * for the start task to complete successfully (that is, to exit with exit
1364
- * code 0) before scheduling any tasks on the compute node. If true and the
1365
- * start task fails on a compute node, the Batch service retries the start
1366
- * task up to its maximum retry count (maxTaskRetryCount). If the task has
1367
- * still not completed successfully after all retries, then the Batch service
1368
- * marks the compute node unusable, and will not schedule tasks to it. This
1369
- * condition can be detected via the node state and scheduling error detail.
1370
- * If false, the Batch service will not wait for the start task to complete.
1371
- * In this case, other tasks can start executing on the compute node while
1372
- * the start task is still running; and even if the start task fails, new
1373
- * tasks will continue to be scheduled on the node. The default is false.
1374
- */
1375
- waitForSuccess?: boolean;
1376
- }
1377
- /**
1378
- * @interface
1379
- * An interface representing CertificateReference.
1380
- * @summary A reference to a certificate to be installed on compute nodes in a
1381
- * pool. This must exist inside the same account as the pool.
1382
- *
1383
- */
1384
- export interface CertificateReference {
1385
- /**
1386
- * @member {string} id The fully qualified ID of the certificate to install
1387
- * on the pool. This must be inside the same batch account as the pool.
1388
- */
1389
- id: string;
1390
- /**
1391
- * @member {CertificateStoreLocation} [storeLocation] The location of the
1392
- * certificate store on the compute node into which to install the
1393
- * certificate. The default value is currentUser. This property is applicable
1394
- * only for pools configured with Windows nodes (that is, created with
1395
- * cloudServiceConfiguration, or with virtualMachineConfiguration using a
1396
- * Windows image reference). For Linux compute nodes, the certificates are
1397
- * stored in a directory inside the task working directory and an environment
1398
- * variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for
1399
- * this location. For certificates with visibility of 'remoteUser', a 'certs'
1400
- * directory is created in the user's home directory (e.g.,
1401
- * /home/{user-name}/certs) and certificates are placed in that directory.
1402
- * Possible values include: 'CurrentUser', 'LocalMachine'
1403
- */
1404
- storeLocation?: CertificateStoreLocation;
1405
- /**
1406
- * @member {string} [storeName] The name of the certificate store on the
1407
- * compute node into which to install the certificate. This property is
1408
- * applicable only for pools configured with Windows nodes (that is, created
1409
- * with cloudServiceConfiguration, or with virtualMachineConfiguration using
1410
- * a Windows image reference). Common store names include: My, Root, CA,
1411
- * Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook,
1412
- * but any custom store name can also be used. The default value is My.
1413
- */
1414
- storeName?: string;
1415
- /**
1416
- * @member {CertificateVisibility[]} [visibility] Which user accounts on the
1417
- * compute node should have access to the private data of the certificate.
1418
- * Values are:
1419
- *
1420
- * starttask - The user account under which the start task is run.
1421
- * task - The accounts under which job tasks are run.
1422
- * remoteuser - The accounts under which users remotely access the node.
1423
- *
1424
- * You can specify more than one visibility in this collection. The default
1425
- * is all accounts.
1426
- */
1427
- visibility?: CertificateVisibility[];
1428
- }
1429
- /**
1430
- * @interface
1431
- * An interface representing ApplicationPackageReference.
1432
- * @summary Link to an application package inside the batch account
1433
- *
1434
- */
1435
- export interface ApplicationPackageReference {
1436
- /**
1437
- * @member {string} id The ID of the application package to install. This
1438
- * must be inside the same batch account as the pool. This can either be a
1439
- * reference to a specific version or the default version if one exists.
1440
- */
1441
- id: string;
1442
- /**
1443
- * @member {string} [version] The version of the application to deploy. If
1444
- * omitted, the default version is deployed. If this is omitted, and no
1445
- * default version is specified for this application, the request fails with
1446
- * the error code InvalidApplicationPackageReferences. If you are calling the
1447
- * REST API directly, the HTTP status code is 409.
1448
- */
1449
- version?: string;
1450
- }
1451
- /**
1452
- * @interface
1453
- * An interface representing ResizeError.
1454
- * @summary An error that occurred when resizing a pool.
1455
- *
1456
- */
1457
- export interface ResizeError {
1458
- /**
1459
- * @member {string} code An identifier for the error. Codes are invariant and
1460
- * are intended to be consumed programmatically.
1461
- */
1462
- code: string;
1463
- /**
1464
- * @member {string} message A message describing the error, intended to be
1465
- * suitable for display in a user interface.
1466
- */
1467
- message: string;
1468
- /**
1469
- * @member {ResizeError[]} [details] Additional details about the error.
1470
- */
1471
- details?: ResizeError[];
1472
- }
1473
- /**
1474
- * @interface
1475
- * An interface representing ResizeOperationStatus.
1476
- * @summary Details about the current or last completed resize operation.
1477
- *
1478
- * Describes either the current operation (if the pool AllocationState is
1479
- * Resizing) or the previously completed operation (if the AllocationState is
1480
- * Steady).
1481
- *
1482
- */
1483
- export interface ResizeOperationStatus {
1484
- /**
1485
- * @member {number} [targetDedicatedNodes] The desired number of dedicated
1486
- * compute nodes in the pool.
1487
- */
1488
- targetDedicatedNodes?: number;
1489
- /**
1490
- * @member {number} [targetLowPriorityNodes] The desired number of
1491
- * low-priority compute nodes in the pool.
1492
- */
1493
- targetLowPriorityNodes?: number;
1494
- /**
1495
- * @member {string} [resizeTimeout] The timeout for allocation of compute
1496
- * nodes to the pool or removal of compute nodes from the pool. The default
1497
- * value is 15 minutes. The minimum value is 5 minutes. If you specify a
1498
- * value less than 5 minutes, the Batch service returns an error; if you are
1499
- * calling the REST API directly, the HTTP status code is 400 (Bad Request).
1500
- */
1501
- resizeTimeout?: string;
1502
- /**
1503
- * @member {ComputeNodeDeallocationOption} [nodeDeallocationOption]
1504
- * Determines what to do with a node and its running task(s) if the pool size
1505
- * is decreasing. The default value is requeue. Possible values include:
1506
- * 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'
1507
- */
1508
- nodeDeallocationOption?: ComputeNodeDeallocationOption;
1509
- /**
1510
- * @member {Date} [startTime] The time when this resize operation was
1511
- * started.
1512
- */
1513
- startTime?: Date;
1514
- /**
1515
- * @member {ResizeError[]} [errors] Details of any errors encountered while
1516
- * performing the last resize on the pool. This property is set only if an
1517
- * error occurred during the last pool resize, and only when the pool
1518
- * allocationState is Steady.
1519
- */
1520
- errors?: ResizeError[];
1521
- }
1522
- /**
1523
- * @interface
1524
- * An interface representing Pool.
1525
- * Contains information about a pool.
1526
- *
1527
- * @extends ProxyResource
1528
- */
1529
- export interface Pool extends ProxyResource {
1530
- /**
1531
- * @member {string} [displayName] The display name for the pool. The display
1532
- * name need not be unique and can contain any Unicode characters up to a
1533
- * maximum length of 1024.
1534
- */
1535
- displayName?: string;
1536
- /**
1537
- * @member {Date} [lastModified] The last modified time of the pool. This is
1538
- * the last time at which the pool level data, such as the
1539
- * targetDedicatedNodes or autoScaleSettings, changed. It does not factor in
1540
- * node-level changes such as a compute node changing state.
1541
- * **NOTE: This property will not be serialized. It can only be populated by
1542
- * the server.**
1543
- */
1544
- readonly lastModified?: Date;
1545
- /**
1546
- * @member {Date} [creationTime] The creation time of the pool. **NOTE: This
1547
- * property will not be serialized. It can only be populated by the server.**
1548
- */
1549
- readonly creationTime?: Date;
1550
- /**
1551
- * @member {PoolProvisioningState} [provisioningState] The current state of
1552
- * the pool. Values are:
1553
- *
1554
- * Succeeded - The pool is available to run tasks subject to the availability
1555
- * of compute nodes.
1556
- * Deleting - The user has requested that the pool be deleted, but the delete
1557
- * operation has not yet completed. Possible values include: 'Succeeded',
1558
- * 'Deleting'
1559
- * **NOTE: This property will not be serialized. It can only be populated by
1560
- * the server.**
1561
- */
1562
- readonly provisioningState?: PoolProvisioningState;
1563
- /**
1564
- * @member {Date} [provisioningStateTransitionTime] The time at which the
1565
- * pool entered its current state. **NOTE: This property will not be
1566
- * serialized. It can only be populated by the server.**
1567
- */
1568
- readonly provisioningStateTransitionTime?: Date;
1569
- /**
1570
- * @member {AllocationState} [allocationState] Whether the pool is resizing.
1571
- * Values are:
1572
- *
1573
- * Steady - The pool is not resizing. There are no changes to the number of
1574
- * nodes in the pool in progress. A pool enters this state when it is created
1575
- * and when no operations are being performed on the pool to change the
1576
- * number of dedicated nodes.
1577
- * Resizing - The pool is resizing; that is, compute nodes are being added to
1578
- * or removed from the pool.
1579
- * Stopping - The pool was resizing, but the user has requested that the
1580
- * resize be stopped, but the stop request has not yet been completed.
1581
- * Possible values include: 'Steady', 'Resizing', 'Stopping'
1582
- * **NOTE: This property will not be serialized. It can only be populated by
1583
- * the server.**
1584
- */
1585
- readonly allocationState?: AllocationState;
1586
- /**
1587
- * @member {Date} [allocationStateTransitionTime] The time at which the pool
1588
- * entered its current allocation state. **NOTE: This property will not be
1589
- * serialized. It can only be populated by the server.**
1590
- */
1591
- readonly allocationStateTransitionTime?: Date;
1592
- /**
1593
- * @member {string} [vmSize] The size of virtual machines in the pool. All
1594
- * VMs in a pool are the same size. For information about available sizes of
1595
- * virtual machines for Cloud Services pools (pools created with
1596
- * cloudServiceConfiguration), see Sizes for Cloud Services
1597
- * (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
1598
- * Batch supports all Cloud Services VM sizes except ExtraSmall. For
1599
- * information about available VM sizes for pools using images from the
1600
- * Virtual Machines Marketplace (pools created with
1601
- * virtualMachineConfiguration) see Sizes for Virtual Machines (Linux)
1602
- * (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/)
1603
- * or Sizes for Virtual Machines (Windows)
1604
- * (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/).
1605
- * Batch supports all Azure VM sizes except STANDARD_A0 and those with
1606
- * premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
1607
- */
1608
- vmSize?: string;
1609
- /**
1610
- * @member {DeploymentConfiguration} [deploymentConfiguration] This property
1611
- * describes how the pool nodes will be deployed - using Cloud Services or
1612
- * Virtual Machines. Using CloudServiceConfiguration specifies that the nodes
1613
- * should be creating using Azure Cloud Services (PaaS), while
1614
- * VirtualMachineConfiguration uses Azure Virtual Machines (IaaS).
1615
- */
1616
- deploymentConfiguration?: DeploymentConfiguration;
1617
- /**
1618
- * @member {number} [currentDedicatedNodes] The number of compute nodes
1619
- * currently in the pool. **NOTE: This property will not be serialized. It
1620
- * can only be populated by the server.**
1621
- */
1622
- readonly currentDedicatedNodes?: number;
1623
- /**
1624
- * @member {number} [currentLowPriorityNodes] The number of low priority
1625
- * compute nodes currently in the pool. **NOTE: This property will not be
1626
- * serialized. It can only be populated by the server.**
1627
- */
1628
- readonly currentLowPriorityNodes?: number;
1629
- /**
1630
- * @member {ScaleSettings} [scaleSettings] Settings which configure the
1631
- * number of nodes in the pool.
1632
- */
1633
- scaleSettings?: ScaleSettings;
1634
- /**
1635
- * @member {AutoScaleRun} [autoScaleRun] The results and errors from the last
1636
- * execution of the autoscale formula. This property is set only if the pool
1637
- * automatically scales, i.e. autoScaleSettings are used.
1638
- * **NOTE: This property will not be serialized. It can only be populated by
1639
- * the server.**
1640
- */
1641
- readonly autoScaleRun?: AutoScaleRun;
1642
- /**
1643
- * @member {InterNodeCommunicationState} [interNodeCommunication] Whether the
1644
- * pool permits direct communication between nodes. This imposes restrictions
1645
- * on which nodes can be assigned to the pool. Enabling this value can reduce
1646
- * the chance of the requested number of nodes to be allocated in the pool.
1647
- * If not specified, this value defaults to 'Disabled'. Possible values
1648
- * include: 'Enabled', 'Disabled'
1649
- */
1650
- interNodeCommunication?: InterNodeCommunicationState;
1651
- /**
1652
- * @member {NetworkConfiguration} [networkConfiguration] The network
1653
- * configuration for the pool.
1654
- */
1655
- networkConfiguration?: NetworkConfiguration;
1656
- /**
1657
- * @member {number} [maxTasksPerNode] The maximum number of tasks that can
1658
- * run concurrently on a single compute node in the pool.
1659
- */
1660
- maxTasksPerNode?: number;
1661
- /**
1662
- * @member {TaskSchedulingPolicy} [taskSchedulingPolicy] How tasks are
1663
- * distributed across compute nodes in a pool.
1664
- */
1665
- taskSchedulingPolicy?: TaskSchedulingPolicy;
1666
- /**
1667
- * @member {UserAccount[]} [userAccounts] The list of user accounts to be
1668
- * created on each node in the pool.
1669
- */
1670
- userAccounts?: UserAccount[];
1671
- /**
1672
- * @member {MetadataItem[]} [metadata] A list of name-value pairs associated
1673
- * with the pool as metadata. The Batch service does not assign any meaning
1674
- * to metadata; it is solely for the use of user code.
1675
- */
1676
- metadata?: MetadataItem[];
1677
- /**
1678
- * @member {StartTask} [startTask] A task specified to run on each compute
1679
- * node as it joins the pool. In an PATCH (update) operation, this property
1680
- * can be set to an empty object to remove the start task from the pool.
1681
- */
1682
- startTask?: StartTask;
1683
- /**
1684
- * @member {CertificateReference[]} [certificates] The list of certificates
1685
- * to be installed on each compute node in the pool. For Windows compute
1686
- * nodes, the Batch service installs the certificates to the specified
1687
- * certificate store and location. For Linux compute nodes, the certificates
1688
- * are stored in a directory inside the task working directory and an
1689
- * environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to
1690
- * query for this location. For certificates with visibility of 'remoteUser',
1691
- * a 'certs' directory is created in the user's home directory (e.g.,
1692
- * /home/{user-name}/certs) and certificates are placed in that directory.
1693
- */
1694
- certificates?: CertificateReference[];
1695
- /**
1696
- * @member {ApplicationPackageReference[]} [applicationPackages] The list of
1697
- * application packages to be installed on each compute node in the pool.
1698
- * Changes to application packages affect all new compute nodes joining the
1699
- * pool, but do not affect compute nodes that are already in the pool until
1700
- * they are rebooted or reimaged.
1701
- */
1702
- applicationPackages?: ApplicationPackageReference[];
1703
- /**
1704
- * @member {string[]} [applicationLicenses] The list of application licenses
1705
- * the Batch service will make available on each compute node in the pool.
1706
- * The list of application licenses must be a subset of available Batch
1707
- * service application licenses. If a license is requested which is not
1708
- * supported, pool creation will fail.
1709
- */
1710
- applicationLicenses?: string[];
1711
- /**
1712
- * @member {ResizeOperationStatus} [resizeOperationStatus] Contains details
1713
- * about the current or last completed resize operation. **NOTE: This
1714
- * property will not be serialized. It can only be populated by the server.**
1715
- */
1716
- readonly resizeOperationStatus?: ResizeOperationStatus;
1717
- }
1718
- /**
1719
- * @interface
1720
- * An interface representing OperationDisplay.
1721
- * @summary The object that describes the operation.
1722
- *
1723
- */
1724
- export interface OperationDisplay {
1725
- /**
1726
- * @member {string} [provider] Friendly name of the resource provider.
1727
- */
1728
- provider?: string;
1729
- /**
1730
- * @member {string} [operation] The operation type. For example: read, write,
1731
- * delete, or listKeys/action
1732
- */
1733
- operation?: string;
1734
- /**
1735
- * @member {string} [resource] The resource type on which the operation is
1736
- * performed.
1737
- */
1738
- resource?: string;
1739
- /**
1740
- * @member {string} [description] The friendly name of the operation.
1741
- */
1742
- description?: string;
1743
- }
1744
- /**
1745
- * @interface
1746
- * An interface representing Operation.
1747
- * @summary A REST API operation
1748
- *
1749
- */
1750
- export interface Operation {
1751
- /**
1752
- * @member {string} [name] The operation name. This is of the format
1753
- * {provider}/{resource}/{operation}
1754
- */
1755
- name?: string;
1756
- /**
1757
- * @member {OperationDisplay} [display] The object that describes the
1758
- * operation.
1759
- */
1760
- display?: OperationDisplay;
1761
- /**
1762
- * @member {string} [origin] The intended executor of the operation.
1763
- */
1764
- origin?: string;
1765
- /**
1766
- * @member {any} [properties] Properties of the operation.
1767
- */
1768
- properties?: any;
1769
- }
1770
- /**
1771
- * @interface
1772
- * An interface representing CheckNameAvailabilityParameters.
1773
- * Parameters for a check name availability request.
1774
- *
1775
- */
1776
- export interface CheckNameAvailabilityParameters {
1777
- /**
1778
- * @member {string} name The name to check for availability
1779
- */
1780
- name: string;
1781
- }
1782
- /**
1783
- * @interface
1784
- * An interface representing CheckNameAvailabilityResult.
1785
- * The CheckNameAvailability operation response.
1786
- *
1787
- */
1788
- export interface CheckNameAvailabilityResult {
1789
- /**
1790
- * @member {boolean} [nameAvailable] Gets a boolean value that indicates
1791
- * whether the name is available for you to use. If true, the name is
1792
- * available. If false, the name has already been taken or invalid and cannot
1793
- * be used.
1794
- * **NOTE: This property will not be serialized. It can only be populated by
1795
- * the server.**
1796
- */
1797
- readonly nameAvailable?: boolean;
1798
- /**
1799
- * @member {NameAvailabilityReason} [reason] Gets the reason that a Batch
1800
- * account name could not be used. The Reason element is only returned if
1801
- * NameAvailable is false. Possible values include: 'Invalid',
1802
- * 'AlreadyExists'
1803
- * **NOTE: This property will not be serialized. It can only be populated by
1804
- * the server.**
1805
- */
1806
- readonly reason?: NameAvailabilityReason;
1807
- /**
1808
- * @member {string} [message] Gets an error message explaining the Reason
1809
- * value in more detail.
1810
- * **NOTE: This property will not be serialized. It can only be populated by
1811
- * the server.**
1812
- */
1813
- readonly message?: string;
1814
- }
1815
- /**
1816
- * @interface
1817
- * An interface representing ApplicationCreateOptionalParams.
1818
- * Optional Parameters.
1819
- *
1820
- * @extends RequestOptionsBase
1821
- */
1822
- export interface ApplicationCreateOptionalParams extends msRest.RequestOptionsBase {
1823
- /**
1824
- * @member {ApplicationCreateParameters} [parameters] The parameters for the
1825
- * request.
1826
- */
1827
- parameters?: ApplicationCreateParameters;
1828
- }
1829
- /**
1830
- * @interface
1831
- * An interface representing ApplicationListOptionalParams.
1832
- * Optional Parameters.
1833
- *
1834
- * @extends RequestOptionsBase
1835
- */
1836
- export interface ApplicationListOptionalParams extends msRest.RequestOptionsBase {
1837
- /**
1838
- * @member {number} [maxresults] The maximum number of items to return in the
1839
- * response.
1840
- */
1841
- maxresults?: number;
1842
- }
1843
- /**
1844
- * @interface
1845
- * An interface representing CertificateListByBatchAccountOptionalParams.
1846
- * Optional Parameters.
1847
- *
1848
- * @extends RequestOptionsBase
1849
- */
1850
- export interface CertificateListByBatchAccountOptionalParams extends msRest.RequestOptionsBase {
1851
- /**
1852
- * @member {number} [maxresults] The maximum number of items to return in the
1853
- * response.
1854
- */
1855
- maxresults?: number;
1856
- /**
1857
- * @member {string} [select] Comma separated list of properties that should
1858
- * be returned. e.g. "properties/provisioningState". Only top level
1859
- * properties under properties/ are valid for selection.
1860
- */
1861
- select?: string;
1862
- /**
1863
- * @member {string} [filter] OData filter expression. Valid properties for
1864
- * filtering are "properties/provisioningState",
1865
- * "properties/provisioningStateTransitionTime", "name".
1866
- */
1867
- filter?: string;
1868
- }
1869
- /**
1870
- * @interface
1871
- * An interface representing CertificateCreateOptionalParams.
1872
- * Optional Parameters.
1873
- *
1874
- * @extends RequestOptionsBase
1875
- */
1876
- export interface CertificateCreateOptionalParams extends msRest.RequestOptionsBase {
1877
- /**
1878
- * @member {string} [ifMatch] The entity state (ETag) version of the
1879
- * certificate to update. A value of "*" can be used to apply the operation
1880
- * only if the certificate already exists. If omitted, this operation will
1881
- * always be applied.
1882
- */
1883
- ifMatch?: string;
1884
- /**
1885
- * @member {string} [ifNoneMatch] Set to '*' to allow a new certificate to be
1886
- * created, but to prevent updating an existing certificate. Other values
1887
- * will be ignored.
1888
- */
1889
- ifNoneMatch?: string;
1890
- }
1891
- /**
1892
- * @interface
1893
- * An interface representing CertificateUpdateOptionalParams.
1894
- * Optional Parameters.
1895
- *
1896
- * @extends RequestOptionsBase
1897
- */
1898
- export interface CertificateUpdateOptionalParams extends msRest.RequestOptionsBase {
1899
- /**
1900
- * @member {string} [ifMatch] The entity state (ETag) version of the
1901
- * certificate to update. This value can be omitted or set to "*" to apply
1902
- * the operation unconditionally.
1903
- */
1904
- ifMatch?: string;
1905
- }
1906
- /**
1907
- * @interface
1908
- * An interface representing CertificateBeginCreateOptionalParams.
1909
- * Optional Parameters.
1910
- *
1911
- * @extends RequestOptionsBase
1912
- */
1913
- export interface CertificateBeginCreateOptionalParams extends msRest.RequestOptionsBase {
1914
- /**
1915
- * @member {string} [ifMatch] The entity state (ETag) version of the
1916
- * certificate to update. A value of "*" can be used to apply the operation
1917
- * only if the certificate already exists. If omitted, this operation will
1918
- * always be applied.
1919
- */
1920
- ifMatch?: string;
1921
- /**
1922
- * @member {string} [ifNoneMatch] Set to '*' to allow a new certificate to be
1923
- * created, but to prevent updating an existing certificate. Other values
1924
- * will be ignored.
1925
- */
1926
- ifNoneMatch?: string;
1927
- }
1928
- /**
1929
- * @interface
1930
- * An interface representing PoolListByBatchAccountOptionalParams.
1931
- * Optional Parameters.
1932
- *
1933
- * @extends RequestOptionsBase
1934
- */
1935
- export interface PoolListByBatchAccountOptionalParams extends msRest.RequestOptionsBase {
1936
- /**
1937
- * @member {number} [maxresults] The maximum number of items to return in the
1938
- * response.
1939
- */
1940
- maxresults?: number;
1941
- /**
1942
- * @member {string} [select] Comma separated list of properties that should
1943
- * be returned. e.g. "properties/provisioningState". Only top level
1944
- * properties under properties/ are valid for selection.
1945
- */
1946
- select?: string;
1947
- /**
1948
- * @member {string} [filter] OData filter expression. Valid properties for
1949
- * filtering are:
1950
- *
1951
- * name
1952
- * properties/allocationState
1953
- * properties/allocationStateTransitionTime
1954
- * properties/creationTime
1955
- * properties/provisioningState
1956
- * properties/provisioningStateTransitionTime
1957
- * properties/lastModified
1958
- * properties/vmSize
1959
- * properties/interNodeCommunication
1960
- * properties/scaleSettings/autoScale
1961
- * properties/scaleSettings/fixedScale
1962
- */
1963
- filter?: string;
1964
- }
1965
- /**
1966
- * @interface
1967
- * An interface representing PoolCreateOptionalParams.
1968
- * Optional Parameters.
1969
- *
1970
- * @extends RequestOptionsBase
1971
- */
1972
- export interface PoolCreateOptionalParams extends msRest.RequestOptionsBase {
1973
- /**
1974
- * @member {string} [ifMatch] The entity state (ETag) version of the pool to
1975
- * update. A value of "*" can be used to apply the operation only if the pool
1976
- * already exists. If omitted, this operation will always be applied.
1977
- */
1978
- ifMatch?: string;
1979
- /**
1980
- * @member {string} [ifNoneMatch] Set to '*' to allow a new pool to be
1981
- * created, but to prevent updating an existing pool. Other values will be
1982
- * ignored.
1983
- */
1984
- ifNoneMatch?: string;
1985
- }
1986
- /**
1987
- * @interface
1988
- * An interface representing PoolUpdateOptionalParams.
1989
- * Optional Parameters.
1990
- *
1991
- * @extends RequestOptionsBase
1992
- */
1993
- export interface PoolUpdateOptionalParams extends msRest.RequestOptionsBase {
1994
- /**
1995
- * @member {string} [ifMatch] The entity state (ETag) version of the pool to
1996
- * update. This value can be omitted or set to "*" to apply the operation
1997
- * unconditionally.
1998
- */
1999
- ifMatch?: string;
2000
- }
2001
- /**
2002
- * @interface
2003
- * An interface representing PoolBeginCreateOptionalParams.
2004
- * Optional Parameters.
2005
- *
2006
- * @extends RequestOptionsBase
2007
- */
2008
- export interface PoolBeginCreateOptionalParams extends msRest.RequestOptionsBase {
2009
- /**
2010
- * @member {string} [ifMatch] The entity state (ETag) version of the pool to
2011
- * update. A value of "*" can be used to apply the operation only if the pool
2012
- * already exists. If omitted, this operation will always be applied.
2013
- */
2014
- ifMatch?: string;
2015
- /**
2016
- * @member {string} [ifNoneMatch] Set to '*' to allow a new pool to be
2017
- * created, but to prevent updating an existing pool. Other values will be
2018
- * ignored.
2019
- */
2020
- ifNoneMatch?: string;
2021
- }
2022
- /**
2023
- * @interface
2024
- * An interface representing BatchManagementClientOptions.
2025
- * @extends AzureServiceClientOptions
2026
- */
2027
- export interface BatchManagementClientOptions extends AzureServiceClientOptions {
2028
- /**
2029
- * @member {string} [baseUri]
2030
- */
2031
- baseUri?: string;
2032
- }
2033
- /**
2034
- * @interface
2035
- * An interface representing BatchAccountCreateHeaders.
2036
- * Defines headers for Create operation.
2037
- *
2038
- */
2039
- export interface BatchAccountCreateHeaders {
2040
- /**
2041
- * @member {string} [locationHeader] The URL of the resource used to check
2042
- * the status of the asynchronous operation.
2043
- */
2044
- locationHeader: string;
2045
- /**
2046
- * @member {number} [retryAfter] Suggested delay to check the status of the
2047
- * asynchronous operation. The value is an integer that specifies the delay
2048
- * in seconds.
2049
- */
2050
- retryAfter: number;
2051
- }
2052
- /**
2053
- * @interface
2054
- * An interface representing BatchAccountDeleteHeaders.
2055
- * Defines headers for Delete operation.
2056
- *
2057
- */
2058
- export interface BatchAccountDeleteHeaders {
2059
- /**
2060
- * @member {string} [location] The URL of the resource used to check the
2061
- * status of the asynchronous operation.
2062
- */
2063
- location: string;
2064
- /**
2065
- * @member {number} [retryAfter] Suggested delay to check the status of the
2066
- * asynchronous operation. The value is an integer that specifies the delay
2067
- * in seconds.
2068
- */
2069
- retryAfter: number;
2070
- }
2071
- /**
2072
- * @interface
2073
- * An interface representing CertificateCreateHeaders.
2074
- * Defines headers for Create operation.
2075
- *
2076
- */
2077
- export interface CertificateCreateHeaders {
2078
- /**
2079
- * @member {string} [eTag] The ETag HTTP response header. This is an opaque
2080
- * string. You can use it to detect whether the resource has changed between
2081
- * requests. In particular, you can pass the ETag to one of the If-Match or
2082
- * If-None-Match headers.
2083
- */
2084
- eTag: string;
2085
- }
2086
- /**
2087
- * @interface
2088
- * An interface representing CertificateUpdateHeaders.
2089
- * Defines headers for Update operation.
2090
- *
2091
- */
2092
- export interface CertificateUpdateHeaders {
2093
- /**
2094
- * @member {string} [eTag] The ETag HTTP response header. This is an opaque
2095
- * string. You can use it to detect whether the resource has changed between
2096
- * requests. In particular, you can pass the ETag to one of the If-Match or
2097
- * If-None-Match headers.
2098
- */
2099
- eTag: string;
2100
- }
2101
- /**
2102
- * @interface
2103
- * An interface representing CertificateDeleteHeaders.
2104
- * Defines headers for Delete operation.
2105
- *
2106
- */
2107
- export interface CertificateDeleteHeaders {
2108
- /**
2109
- * @member {string} [location] The URL of the resource used to check the
2110
- * status of the asynchronous operation.
2111
- */
2112
- location: string;
2113
- /**
2114
- * @member {number} [retryAfter] Suggested delay to check the status of the
2115
- * asynchronous operation. The value is an integer that represents the
2116
- * seconds.
2117
- */
2118
- retryAfter: number;
2119
- }
2120
- /**
2121
- * @interface
2122
- * An interface representing CertificateGetHeaders.
2123
- * Defines headers for Get operation.
2124
- *
2125
- */
2126
- export interface CertificateGetHeaders {
2127
- /**
2128
- * @member {string} [eTag] The ETag HTTP response header. This is an opaque
2129
- * string. You can use it to detect whether the resource has changed between
2130
- * requests. In particular, you can pass the ETag to one of the If-Match or
2131
- * If-None-Match headers.
2132
- */
2133
- eTag: string;
2134
- }
2135
- /**
2136
- * @interface
2137
- * An interface representing CertificateCancelDeletionHeaders.
2138
- * Defines headers for CancelDeletion operation.
2139
- *
2140
- */
2141
- export interface CertificateCancelDeletionHeaders {
2142
- /**
2143
- * @member {string} [eTag] The ETag HTTP response header. This is an opaque
2144
- * string. You can use it to detect whether the resource has changed between
2145
- * requests. In particular, you can pass the ETag to one of the If-Match or
2146
- * If-None-Match headers.
2147
- */
2148
- eTag: string;
2149
- }
2150
- /**
2151
- * @interface
2152
- * An interface representing PoolCreateHeaders.
2153
- * Defines headers for Create operation.
2154
- *
2155
- */
2156
- export interface PoolCreateHeaders {
2157
- /**
2158
- * @member {string} [eTag] The ETag HTTP response header. This is an opaque
2159
- * string. You can use it to detect whether the resource has changed between
2160
- * requests. In particular, you can pass the ETag to one of the If-Match or
2161
- * If-None-Match headers.
2162
- */
2163
- eTag: string;
2164
- }
2165
- /**
2166
- * @interface
2167
- * An interface representing PoolUpdateHeaders.
2168
- * Defines headers for Update operation.
2169
- *
2170
- */
2171
- export interface PoolUpdateHeaders {
2172
- /**
2173
- * @member {string} [eTag] The ETag HTTP response header. This is an opaque
2174
- * string. You can use it to detect whether the resource has changed between
2175
- * requests. In particular, you can pass the ETag to one of the If-Match or
2176
- * If-None-Match headers.
2177
- */
2178
- eTag: string;
2179
- }
2180
- /**
2181
- * @interface
2182
- * An interface representing PoolDeleteHeaders.
2183
- * Defines headers for Delete operation.
2184
- *
2185
- */
2186
- export interface PoolDeleteHeaders {
2187
- /**
2188
- * @member {string} [location] The URL of the resource used to check the
2189
- * status of the asynchronous operation.
2190
- */
2191
- location: string;
2192
- /**
2193
- * @member {number} [retryAfter] Suggested delay to check the status of the
2194
- * asynchronous operation. The value is an integer that represents the
2195
- * seconds.
2196
- */
2197
- retryAfter: number;
2198
- }
2199
- /**
2200
- * @interface
2201
- * An interface representing PoolGetHeaders.
2202
- * Defines headers for Get operation.
2203
- *
2204
- */
2205
- export interface PoolGetHeaders {
2206
- /**
2207
- * @member {string} [eTag] The ETag HTTP response header. This is an opaque
2208
- * string. You can use it to detect whether the resource has changed between
2209
- * requests. In particular, you can pass the ETag to one of the If-Match or
2210
- * If-None-Match headers.
2211
- */
2212
- eTag: string;
2213
- }
2214
- /**
2215
- * @interface
2216
- * An interface representing PoolDisableAutoScaleHeaders.
2217
- * Defines headers for DisableAutoScale operation.
2218
- *
2219
- */
2220
- export interface PoolDisableAutoScaleHeaders {
2221
- /**
2222
- * @member {string} [eTag] The ETag HTTP response header. This is an opaque
2223
- * string. You can use it to detect whether the resource has changed between
2224
- * requests. In particular, you can pass the ETag to one of the If-Match or
2225
- * If-None-Match headers.
2226
- */
2227
- eTag: string;
2228
- }
2229
- /**
2230
- * @interface
2231
- * An interface representing PoolStopResizeHeaders.
2232
- * Defines headers for StopResize operation.
2233
- *
2234
- */
2235
- export interface PoolStopResizeHeaders {
2236
- /**
2237
- * @member {string} [eTag] The ETag HTTP response header. This is an opaque
2238
- * string. You can use it to detect whether the resource has changed between
2239
- * requests. In particular, you can pass the ETag to one of the If-Match or
2240
- * If-None-Match headers.
2241
- */
2242
- eTag: string;
2243
- }
2244
- /**
2245
- * @interface
2246
- * An interface representing the BatchAccountListResult.
2247
- * Values returned by the List operation.
2248
- *
2249
- * @extends Array<BatchAccount>
2250
- */
2251
- export interface BatchAccountListResult extends Array<BatchAccount> {
2252
- /**
2253
- * @member {string} [nextLink] The continuation token.
2254
- */
2255
- nextLink?: string;
2256
- }
2257
- /**
2258
- * @interface
2259
- * An interface representing the ListApplicationsResult.
2260
- * The result of performing list applications.
2261
- *
2262
- * @extends Array<Application>
2263
- */
2264
- export interface ListApplicationsResult extends Array<Application> {
2265
- /**
2266
- * @member {string} [nextLink] The URL to get the next set of results.
2267
- */
2268
- nextLink?: string;
2269
- }
2270
- /**
2271
- * @interface
2272
- * An interface representing the OperationListResult.
2273
- * @summary Result of the request to list REST API operations. It contains a
2274
- * list of operations and a URL nextLink to get the next set of results.
2275
- *
2276
- * @extends Array<Operation>
2277
- */
2278
- export interface OperationListResult extends Array<Operation> {
2279
- /**
2280
- * @member {string} [nextLink]
2281
- */
2282
- nextLink?: string;
2283
- }
2284
- /**
2285
- * @interface
2286
- * An interface representing the ListCertificatesResult.
2287
- * Values returned by the List operation.
2288
- *
2289
- * @extends Array<Certificate>
2290
- */
2291
- export interface ListCertificatesResult extends Array<Certificate> {
2292
- /**
2293
- * @member {string} [nextLink] The continuation token.
2294
- */
2295
- nextLink?: string;
2296
- }
2297
- /**
2298
- * @interface
2299
- * An interface representing the ListPoolsResult.
2300
- * Values returned by the List operation.
2301
- *
2302
- * @extends Array<Pool>
2303
- */
2304
- export interface ListPoolsResult extends Array<Pool> {
2305
- /**
2306
- * @member {string} [nextLink] The continuation token.
2307
- */
2308
- nextLink?: string;
2309
- }
2310
- /**
2311
- * Defines values for PoolAllocationMode.
2312
- * Possible values include: 'BatchService', 'UserSubscription'
2313
- * @readonly
2314
- * @enum {string}
2315
- */
2316
- export declare type PoolAllocationMode = 'BatchService' | 'UserSubscription';
2317
- /**
2318
- * Defines values for ProvisioningState.
2319
- * Possible values include: 'Invalid', 'Creating', 'Deleting', 'Succeeded', 'Failed', 'Cancelled'
2320
- * @readonly
2321
- * @enum {string}
2322
- */
2323
- export declare type ProvisioningState = 'Invalid' | 'Creating' | 'Deleting' | 'Succeeded' | 'Failed' | 'Cancelled';
2324
- /**
2325
- * Defines values for AccountKeyType.
2326
- * Possible values include: 'Primary', 'Secondary'
2327
- * @readonly
2328
- * @enum {string}
2329
- */
2330
- export declare type AccountKeyType = 'Primary' | 'Secondary';
2331
- /**
2332
- * Defines values for PackageState.
2333
- * Possible values include: 'Pending', 'Active', 'Unmapped'
2334
- * @readonly
2335
- * @enum {string}
2336
- */
2337
- export declare type PackageState = 'Pending' | 'Active' | 'Unmapped';
2338
- /**
2339
- * Defines values for CertificateFormat.
2340
- * Possible values include: 'Pfx', 'Cer'
2341
- * @readonly
2342
- * @enum {string}
2343
- */
2344
- export declare type CertificateFormat = 'Pfx' | 'Cer';
2345
- /**
2346
- * Defines values for CertificateProvisioningState.
2347
- * Possible values include: 'Succeeded', 'Deleting', 'Failed'
2348
- * @readonly
2349
- * @enum {string}
2350
- */
2351
- export declare type CertificateProvisioningState = 'Succeeded' | 'Deleting' | 'Failed';
2352
- /**
2353
- * Defines values for PoolProvisioningState.
2354
- * Possible values include: 'Succeeded', 'Deleting'
2355
- * @readonly
2356
- * @enum {string}
2357
- */
2358
- export declare type PoolProvisioningState = 'Succeeded' | 'Deleting';
2359
- /**
2360
- * Defines values for AllocationState.
2361
- * Possible values include: 'Steady', 'Resizing', 'Stopping'
2362
- * @readonly
2363
- * @enum {string}
2364
- */
2365
- export declare type AllocationState = 'Steady' | 'Resizing' | 'Stopping';
2366
- /**
2367
- * Defines values for CachingType.
2368
- * Possible values include: 'None', 'ReadOnly', 'ReadWrite'
2369
- * @readonly
2370
- * @enum {string}
2371
- */
2372
- export declare type CachingType = 'None' | 'ReadOnly' | 'ReadWrite';
2373
- /**
2374
- * Defines values for StorageAccountType.
2375
- * Possible values include: 'Standard_LRS', 'Premium_LRS'
2376
- * @readonly
2377
- * @enum {string}
2378
- */
2379
- export declare type StorageAccountType = 'Standard_LRS' | 'Premium_LRS';
2380
- /**
2381
- * Defines values for ComputeNodeDeallocationOption.
2382
- * Possible values include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'
2383
- * @readonly
2384
- * @enum {string}
2385
- */
2386
- export declare type ComputeNodeDeallocationOption = 'Requeue' | 'Terminate' | 'TaskCompletion' | 'RetainedData';
2387
- /**
2388
- * Defines values for InterNodeCommunicationState.
2389
- * Possible values include: 'Enabled', 'Disabled'
2390
- * @readonly
2391
- * @enum {string}
2392
- */
2393
- export declare type InterNodeCommunicationState = 'Enabled' | 'Disabled';
2394
- /**
2395
- * Defines values for InboundEndpointProtocol.
2396
- * Possible values include: 'TCP', 'UDP'
2397
- * @readonly
2398
- * @enum {string}
2399
- */
2400
- export declare type InboundEndpointProtocol = 'TCP' | 'UDP';
2401
- /**
2402
- * Defines values for NetworkSecurityGroupRuleAccess.
2403
- * Possible values include: 'Allow', 'Deny'
2404
- * @readonly
2405
- * @enum {string}
2406
- */
2407
- export declare type NetworkSecurityGroupRuleAccess = 'Allow' | 'Deny';
2408
- /**
2409
- * Defines values for ComputeNodeFillType.
2410
- * Possible values include: 'Spread', 'Pack'
2411
- * @readonly
2412
- * @enum {string}
2413
- */
2414
- export declare type ComputeNodeFillType = 'Spread' | 'Pack';
2415
- /**
2416
- * Defines values for ElevationLevel.
2417
- * Possible values include: 'NonAdmin', 'Admin'
2418
- * @readonly
2419
- * @enum {string}
2420
- */
2421
- export declare type ElevationLevel = 'NonAdmin' | 'Admin';
2422
- /**
2423
- * Defines values for AutoUserScope.
2424
- * Possible values include: 'Task', 'Pool'
2425
- * @readonly
2426
- * @enum {string}
2427
- */
2428
- export declare type AutoUserScope = 'Task' | 'Pool';
2429
- /**
2430
- * Defines values for CertificateStoreLocation.
2431
- * Possible values include: 'CurrentUser', 'LocalMachine'
2432
- * @readonly
2433
- * @enum {string}
2434
- */
2435
- export declare type CertificateStoreLocation = 'CurrentUser' | 'LocalMachine';
2436
- /**
2437
- * Defines values for CertificateVisibility.
2438
- * Possible values include: 'StartTask', 'Task', 'RemoteUser'
2439
- * @readonly
2440
- * @enum {string}
2441
- */
2442
- export declare type CertificateVisibility = 'StartTask' | 'Task' | 'RemoteUser';
2443
- /**
2444
- * Defines values for NameAvailabilityReason.
2445
- * Possible values include: 'Invalid', 'AlreadyExists'
2446
- * @readonly
2447
- * @enum {string}
2448
- */
2449
- export declare type NameAvailabilityReason = 'Invalid' | 'AlreadyExists';
2450
- /**
2451
- * Contains response data for the create operation.
2452
- */
2453
- export declare type BatchAccountCreateResponse = BatchAccount & BatchAccountCreateHeaders & {
2454
- /**
2455
- * The underlying HTTP response.
2456
- */
2457
- _response: msRest.HttpResponse & {
2458
- /**
2459
- * The parsed HTTP response headers.
2460
- */
2461
- parsedHeaders: BatchAccountCreateHeaders;
2462
- /**
2463
- * The response body as text (string format)
2464
- */
2465
- bodyAsText: string;
2466
- /**
2467
- * The response body as parsed JSON or XML
2468
- */
2469
- parsedBody: BatchAccount;
2470
- };
2471
- };
2472
- /**
2473
- * Contains response data for the update operation.
2474
- */
2475
- export declare type BatchAccountUpdateResponse = BatchAccount & {
2476
- /**
2477
- * The underlying HTTP response.
2478
- */
2479
- _response: msRest.HttpResponse & {
2480
- /**
2481
- * The response body as text (string format)
2482
- */
2483
- bodyAsText: string;
2484
- /**
2485
- * The response body as parsed JSON or XML
2486
- */
2487
- parsedBody: BatchAccount;
2488
- };
2489
- };
2490
- /**
2491
- * Contains response data for the deleteMethod operation.
2492
- */
2493
- export declare type BatchAccountDeleteResponse = BatchAccountDeleteHeaders & {
2494
- /**
2495
- * The underlying HTTP response.
2496
- */
2497
- _response: msRest.HttpResponse & {
2498
- /**
2499
- * The parsed HTTP response headers.
2500
- */
2501
- parsedHeaders: BatchAccountDeleteHeaders;
2502
- };
2503
- };
2504
- /**
2505
- * Contains response data for the get operation.
2506
- */
2507
- export declare type BatchAccountGetResponse = BatchAccount & {
2508
- /**
2509
- * The underlying HTTP response.
2510
- */
2511
- _response: msRest.HttpResponse & {
2512
- /**
2513
- * The response body as text (string format)
2514
- */
2515
- bodyAsText: string;
2516
- /**
2517
- * The response body as parsed JSON or XML
2518
- */
2519
- parsedBody: BatchAccount;
2520
- };
2521
- };
2522
- /**
2523
- * Contains response data for the list operation.
2524
- */
2525
- export declare type BatchAccountListResponse = BatchAccountListResult & {
2526
- /**
2527
- * The underlying HTTP response.
2528
- */
2529
- _response: msRest.HttpResponse & {
2530
- /**
2531
- * The response body as text (string format)
2532
- */
2533
- bodyAsText: string;
2534
- /**
2535
- * The response body as parsed JSON or XML
2536
- */
2537
- parsedBody: BatchAccountListResult;
2538
- };
2539
- };
2540
- /**
2541
- * Contains response data for the listByResourceGroup operation.
2542
- */
2543
- export declare type BatchAccountListByResourceGroupResponse = BatchAccountListResult & {
2544
- /**
2545
- * The underlying HTTP response.
2546
- */
2547
- _response: msRest.HttpResponse & {
2548
- /**
2549
- * The response body as text (string format)
2550
- */
2551
- bodyAsText: string;
2552
- /**
2553
- * The response body as parsed JSON or XML
2554
- */
2555
- parsedBody: BatchAccountListResult;
2556
- };
2557
- };
2558
- /**
2559
- * Contains response data for the regenerateKey operation.
2560
- */
2561
- export declare type BatchAccountRegenerateKeyResponse = BatchAccountKeys & {
2562
- /**
2563
- * The underlying HTTP response.
2564
- */
2565
- _response: msRest.HttpResponse & {
2566
- /**
2567
- * The response body as text (string format)
2568
- */
2569
- bodyAsText: string;
2570
- /**
2571
- * The response body as parsed JSON or XML
2572
- */
2573
- parsedBody: BatchAccountKeys;
2574
- };
2575
- };
2576
- /**
2577
- * Contains response data for the getKeys operation.
2578
- */
2579
- export declare type BatchAccountGetKeysResponse = BatchAccountKeys & {
2580
- /**
2581
- * The underlying HTTP response.
2582
- */
2583
- _response: msRest.HttpResponse & {
2584
- /**
2585
- * The response body as text (string format)
2586
- */
2587
- bodyAsText: string;
2588
- /**
2589
- * The response body as parsed JSON or XML
2590
- */
2591
- parsedBody: BatchAccountKeys;
2592
- };
2593
- };
2594
- /**
2595
- * Contains response data for the listNext operation.
2596
- */
2597
- export declare type BatchAccountListNextResponse = BatchAccountListResult & {
2598
- /**
2599
- * The underlying HTTP response.
2600
- */
2601
- _response: msRest.HttpResponse & {
2602
- /**
2603
- * The response body as text (string format)
2604
- */
2605
- bodyAsText: string;
2606
- /**
2607
- * The response body as parsed JSON or XML
2608
- */
2609
- parsedBody: BatchAccountListResult;
2610
- };
2611
- };
2612
- /**
2613
- * Contains response data for the listByResourceGroupNext operation.
2614
- */
2615
- export declare type BatchAccountListByResourceGroupNextResponse = BatchAccountListResult & {
2616
- /**
2617
- * The underlying HTTP response.
2618
- */
2619
- _response: msRest.HttpResponse & {
2620
- /**
2621
- * The response body as text (string format)
2622
- */
2623
- bodyAsText: string;
2624
- /**
2625
- * The response body as parsed JSON or XML
2626
- */
2627
- parsedBody: BatchAccountListResult;
2628
- };
2629
- };
2630
- /**
2631
- * Contains response data for the create operation.
2632
- */
2633
- export declare type ApplicationPackageCreateResponse = ApplicationPackage & {
2634
- /**
2635
- * The underlying HTTP response.
2636
- */
2637
- _response: msRest.HttpResponse & {
2638
- /**
2639
- * The response body as text (string format)
2640
- */
2641
- bodyAsText: string;
2642
- /**
2643
- * The response body as parsed JSON or XML
2644
- */
2645
- parsedBody: ApplicationPackage;
2646
- };
2647
- };
2648
- /**
2649
- * Contains response data for the get operation.
2650
- */
2651
- export declare type ApplicationPackageGetResponse = ApplicationPackage & {
2652
- /**
2653
- * The underlying HTTP response.
2654
- */
2655
- _response: msRest.HttpResponse & {
2656
- /**
2657
- * The response body as text (string format)
2658
- */
2659
- bodyAsText: string;
2660
- /**
2661
- * The response body as parsed JSON or XML
2662
- */
2663
- parsedBody: ApplicationPackage;
2664
- };
2665
- };
2666
- /**
2667
- * Contains response data for the create operation.
2668
- */
2669
- export declare type ApplicationCreateResponse = Application & {
2670
- /**
2671
- * The underlying HTTP response.
2672
- */
2673
- _response: msRest.HttpResponse & {
2674
- /**
2675
- * The response body as text (string format)
2676
- */
2677
- bodyAsText: string;
2678
- /**
2679
- * The response body as parsed JSON or XML
2680
- */
2681
- parsedBody: Application;
2682
- };
2683
- };
2684
- /**
2685
- * Contains response data for the get operation.
2686
- */
2687
- export declare type ApplicationGetResponse = Application & {
2688
- /**
2689
- * The underlying HTTP response.
2690
- */
2691
- _response: msRest.HttpResponse & {
2692
- /**
2693
- * The response body as text (string format)
2694
- */
2695
- bodyAsText: string;
2696
- /**
2697
- * The response body as parsed JSON or XML
2698
- */
2699
- parsedBody: Application;
2700
- };
2701
- };
2702
- /**
2703
- * Contains response data for the list operation.
2704
- */
2705
- export declare type ApplicationListResponse = ListApplicationsResult & {
2706
- /**
2707
- * The underlying HTTP response.
2708
- */
2709
- _response: msRest.HttpResponse & {
2710
- /**
2711
- * The response body as text (string format)
2712
- */
2713
- bodyAsText: string;
2714
- /**
2715
- * The response body as parsed JSON or XML
2716
- */
2717
- parsedBody: ListApplicationsResult;
2718
- };
2719
- };
2720
- /**
2721
- * Contains response data for the listNext operation.
2722
- */
2723
- export declare type ApplicationListNextResponse = ListApplicationsResult & {
2724
- /**
2725
- * The underlying HTTP response.
2726
- */
2727
- _response: msRest.HttpResponse & {
2728
- /**
2729
- * The response body as text (string format)
2730
- */
2731
- bodyAsText: string;
2732
- /**
2733
- * The response body as parsed JSON or XML
2734
- */
2735
- parsedBody: ListApplicationsResult;
2736
- };
2737
- };
2738
- /**
2739
- * Contains response data for the getQuotas operation.
2740
- */
2741
- export declare type LocationGetQuotasResponse = BatchLocationQuota & {
2742
- /**
2743
- * The underlying HTTP response.
2744
- */
2745
- _response: msRest.HttpResponse & {
2746
- /**
2747
- * The response body as text (string format)
2748
- */
2749
- bodyAsText: string;
2750
- /**
2751
- * The response body as parsed JSON or XML
2752
- */
2753
- parsedBody: BatchLocationQuota;
2754
- };
2755
- };
2756
- /**
2757
- * Contains response data for the checkNameAvailability operation.
2758
- */
2759
- export declare type LocationCheckNameAvailabilityResponse = CheckNameAvailabilityResult & {
2760
- /**
2761
- * The underlying HTTP response.
2762
- */
2763
- _response: msRest.HttpResponse & {
2764
- /**
2765
- * The response body as text (string format)
2766
- */
2767
- bodyAsText: string;
2768
- /**
2769
- * The response body as parsed JSON or XML
2770
- */
2771
- parsedBody: CheckNameAvailabilityResult;
2772
- };
2773
- };
2774
- /**
2775
- * Contains response data for the list operation.
2776
- */
2777
- export declare type OperationsListResponse = OperationListResult & {
2778
- /**
2779
- * The underlying HTTP response.
2780
- */
2781
- _response: msRest.HttpResponse & {
2782
- /**
2783
- * The response body as text (string format)
2784
- */
2785
- bodyAsText: string;
2786
- /**
2787
- * The response body as parsed JSON or XML
2788
- */
2789
- parsedBody: OperationListResult;
2790
- };
2791
- };
2792
- /**
2793
- * Contains response data for the listNext operation.
2794
- */
2795
- export declare type OperationsListNextResponse = OperationListResult & {
2796
- /**
2797
- * The underlying HTTP response.
2798
- */
2799
- _response: msRest.HttpResponse & {
2800
- /**
2801
- * The response body as text (string format)
2802
- */
2803
- bodyAsText: string;
2804
- /**
2805
- * The response body as parsed JSON or XML
2806
- */
2807
- parsedBody: OperationListResult;
2808
- };
2809
- };
2810
- /**
2811
- * Contains response data for the listByBatchAccount operation.
2812
- */
2813
- export declare type CertificateListByBatchAccountResponse = ListCertificatesResult & {
2814
- /**
2815
- * The underlying HTTP response.
2816
- */
2817
- _response: msRest.HttpResponse & {
2818
- /**
2819
- * The response body as text (string format)
2820
- */
2821
- bodyAsText: string;
2822
- /**
2823
- * The response body as parsed JSON or XML
2824
- */
2825
- parsedBody: ListCertificatesResult;
2826
- };
2827
- };
2828
- /**
2829
- * Contains response data for the create operation.
2830
- */
2831
- export declare type CertificateCreateResponse = Certificate & CertificateCreateHeaders & {
2832
- /**
2833
- * The underlying HTTP response.
2834
- */
2835
- _response: msRest.HttpResponse & {
2836
- /**
2837
- * The parsed HTTP response headers.
2838
- */
2839
- parsedHeaders: CertificateCreateHeaders;
2840
- /**
2841
- * The response body as text (string format)
2842
- */
2843
- bodyAsText: string;
2844
- /**
2845
- * The response body as parsed JSON or XML
2846
- */
2847
- parsedBody: Certificate;
2848
- };
2849
- };
2850
- /**
2851
- * Contains response data for the update operation.
2852
- */
2853
- export declare type CertificateUpdateResponse = Certificate & CertificateUpdateHeaders & {
2854
- /**
2855
- * The underlying HTTP response.
2856
- */
2857
- _response: msRest.HttpResponse & {
2858
- /**
2859
- * The parsed HTTP response headers.
2860
- */
2861
- parsedHeaders: CertificateUpdateHeaders;
2862
- /**
2863
- * The response body as text (string format)
2864
- */
2865
- bodyAsText: string;
2866
- /**
2867
- * The response body as parsed JSON or XML
2868
- */
2869
- parsedBody: Certificate;
2870
- };
2871
- };
2872
- /**
2873
- * Contains response data for the deleteMethod operation.
2874
- */
2875
- export declare type CertificateDeleteResponse = CertificateDeleteHeaders & {
2876
- /**
2877
- * The underlying HTTP response.
2878
- */
2879
- _response: msRest.HttpResponse & {
2880
- /**
2881
- * The parsed HTTP response headers.
2882
- */
2883
- parsedHeaders: CertificateDeleteHeaders;
2884
- };
2885
- };
2886
- /**
2887
- * Contains response data for the get operation.
2888
- */
2889
- export declare type CertificateGetResponse = Certificate & CertificateGetHeaders & {
2890
- /**
2891
- * The underlying HTTP response.
2892
- */
2893
- _response: msRest.HttpResponse & {
2894
- /**
2895
- * The parsed HTTP response headers.
2896
- */
2897
- parsedHeaders: CertificateGetHeaders;
2898
- /**
2899
- * The response body as text (string format)
2900
- */
2901
- bodyAsText: string;
2902
- /**
2903
- * The response body as parsed JSON or XML
2904
- */
2905
- parsedBody: Certificate;
2906
- };
2907
- };
2908
- /**
2909
- * Contains response data for the cancelDeletion operation.
2910
- */
2911
- export declare type CertificateCancelDeletionResponse = Certificate & CertificateCancelDeletionHeaders & {
2912
- /**
2913
- * The underlying HTTP response.
2914
- */
2915
- _response: msRest.HttpResponse & {
2916
- /**
2917
- * The parsed HTTP response headers.
2918
- */
2919
- parsedHeaders: CertificateCancelDeletionHeaders;
2920
- /**
2921
- * The response body as text (string format)
2922
- */
2923
- bodyAsText: string;
2924
- /**
2925
- * The response body as parsed JSON or XML
2926
- */
2927
- parsedBody: Certificate;
2928
- };
2929
- };
2930
- /**
2931
- * Contains response data for the listByBatchAccountNext operation.
2932
- */
2933
- export declare type CertificateListByBatchAccountNextResponse = ListCertificatesResult & {
2934
- /**
2935
- * The underlying HTTP response.
2936
- */
2937
- _response: msRest.HttpResponse & {
2938
- /**
2939
- * The response body as text (string format)
2940
- */
2941
- bodyAsText: string;
2942
- /**
2943
- * The response body as parsed JSON or XML
2944
- */
2945
- parsedBody: ListCertificatesResult;
2946
- };
2947
- };
2948
- /**
2949
- * Contains response data for the listByBatchAccount operation.
2950
- */
2951
- export declare type PoolListByBatchAccountResponse = ListPoolsResult & {
2952
- /**
2953
- * The underlying HTTP response.
2954
- */
2955
- _response: msRest.HttpResponse & {
2956
- /**
2957
- * The response body as text (string format)
2958
- */
2959
- bodyAsText: string;
2960
- /**
2961
- * The response body as parsed JSON or XML
2962
- */
2963
- parsedBody: ListPoolsResult;
2964
- };
2965
- };
2966
- /**
2967
- * Contains response data for the create operation.
2968
- */
2969
- export declare type PoolCreateResponse = Pool & PoolCreateHeaders & {
2970
- /**
2971
- * The underlying HTTP response.
2972
- */
2973
- _response: msRest.HttpResponse & {
2974
- /**
2975
- * The parsed HTTP response headers.
2976
- */
2977
- parsedHeaders: PoolCreateHeaders;
2978
- /**
2979
- * The response body as text (string format)
2980
- */
2981
- bodyAsText: string;
2982
- /**
2983
- * The response body as parsed JSON or XML
2984
- */
2985
- parsedBody: Pool;
2986
- };
2987
- };
2988
- /**
2989
- * Contains response data for the update operation.
2990
- */
2991
- export declare type PoolUpdateResponse = Pool & PoolUpdateHeaders & {
2992
- /**
2993
- * The underlying HTTP response.
2994
- */
2995
- _response: msRest.HttpResponse & {
2996
- /**
2997
- * The parsed HTTP response headers.
2998
- */
2999
- parsedHeaders: PoolUpdateHeaders;
3000
- /**
3001
- * The response body as text (string format)
3002
- */
3003
- bodyAsText: string;
3004
- /**
3005
- * The response body as parsed JSON or XML
3006
- */
3007
- parsedBody: Pool;
3008
- };
3009
- };
3010
- /**
3011
- * Contains response data for the deleteMethod operation.
3012
- */
3013
- export declare type PoolDeleteResponse = PoolDeleteHeaders & {
3014
- /**
3015
- * The underlying HTTP response.
3016
- */
3017
- _response: msRest.HttpResponse & {
3018
- /**
3019
- * The parsed HTTP response headers.
3020
- */
3021
- parsedHeaders: PoolDeleteHeaders;
3022
- };
3023
- };
3024
- /**
3025
- * Contains response data for the get operation.
3026
- */
3027
- export declare type PoolGetResponse = Pool & PoolGetHeaders & {
3028
- /**
3029
- * The underlying HTTP response.
3030
- */
3031
- _response: msRest.HttpResponse & {
3032
- /**
3033
- * The parsed HTTP response headers.
3034
- */
3035
- parsedHeaders: PoolGetHeaders;
3036
- /**
3037
- * The response body as text (string format)
3038
- */
3039
- bodyAsText: string;
3040
- /**
3041
- * The response body as parsed JSON or XML
3042
- */
3043
- parsedBody: Pool;
3044
- };
3045
- };
3046
- /**
3047
- * Contains response data for the disableAutoScale operation.
3048
- */
3049
- export declare type PoolDisableAutoScaleResponse = Pool & PoolDisableAutoScaleHeaders & {
3050
- /**
3051
- * The underlying HTTP response.
3052
- */
3053
- _response: msRest.HttpResponse & {
3054
- /**
3055
- * The parsed HTTP response headers.
3056
- */
3057
- parsedHeaders: PoolDisableAutoScaleHeaders;
3058
- /**
3059
- * The response body as text (string format)
3060
- */
3061
- bodyAsText: string;
3062
- /**
3063
- * The response body as parsed JSON or XML
3064
- */
3065
- parsedBody: Pool;
3066
- };
3067
- };
3068
- /**
3069
- * Contains response data for the stopResize operation.
3070
- */
3071
- export declare type PoolStopResizeResponse = Pool & PoolStopResizeHeaders & {
3072
- /**
3073
- * The underlying HTTP response.
3074
- */
3075
- _response: msRest.HttpResponse & {
3076
- /**
3077
- * The parsed HTTP response headers.
3078
- */
3079
- parsedHeaders: PoolStopResizeHeaders;
3080
- /**
3081
- * The response body as text (string format)
3082
- */
3083
- bodyAsText: string;
3084
- /**
3085
- * The response body as parsed JSON or XML
3086
- */
3087
- parsedBody: Pool;
3088
- };
3089
- };
3090
- /**
3091
- * Contains response data for the listByBatchAccountNext operation.
3092
- */
3093
- export declare type PoolListByBatchAccountNextResponse = ListPoolsResult & {
3094
- /**
3095
- * The underlying HTTP response.
3096
- */
3097
- _response: msRest.HttpResponse & {
3098
- /**
3099
- * The response body as text (string format)
3100
- */
3101
- bodyAsText: string;
3102
- /**
3103
- * The response body as parsed JSON or XML
3104
- */
3105
- parsedBody: ListPoolsResult;
3106
- };
3107
- };
3108
- //# sourceMappingURL=index.d.ts.map