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