@azure/arm-batch 6.0.0 → 7.0.0-alpha.20211122.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 (254) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/{LICENSE.txt → LICENSE} +1 -1
  3. package/README.md +70 -82
  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/{esm → dist-esm/src}/models/index.js +1 -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 +1723 -1885
  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 +0 -0
  53. package/dist-esm/src/operations/index.d.ts.map +1 -0
  54. package/{esm → dist-esm/src}/operations/index.js +1 -2
  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/{src/models/operationsMappers.ts → dist-esm/src/operationsInterfaces/applicationOperations.js} +2 -7
  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/{esm/models/operationsMappers.js → dist-esm/src/operationsInterfaces/applicationPackageOperations.js} +2 -2
  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/{src/models/locationMappers.ts → dist-esm/src/operationsInterfaces/batchAccountOperations.js} +2 -10
  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 +66 -22
  121. package/review/arm-batch.api.md +1459 -0
  122. package/rollup.config.js +181 -30
  123. package/src/batchManagementClient.ts +59 -48
  124. package/src/batchManagementClientContext.ts +46 -43
  125. package/src/index.ts +13 -0
  126. package/src/lroImpl.ts +34 -0
  127. package/src/models/index.ts +1460 -3635
  128. package/src/models/mappers.ts +1705 -1851
  129. package/src/models/parameters.ts +216 -117
  130. package/src/operations/applicationOperations.ts +215 -263
  131. package/src/operations/applicationPackageOperations.ts +252 -279
  132. package/src/operations/batchAccountOperations.ts +660 -572
  133. package/src/operations/certificateOperations.ts +360 -359
  134. package/src/operations/index.ts +1 -2
  135. package/src/operations/location.ts +285 -234
  136. package/src/operations/operations.ts +82 -70
  137. package/src/operations/poolOperations.ts +373 -378
  138. package/src/operations/privateEndpointConnectionOperations.ts +269 -169
  139. package/src/operations/privateLinkResourceOperations.ts +156 -126
  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/src/operationsInterfaces/index.ts +17 -0
  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 +3 -3
  151. package/types/arm-batch.d.ts +2528 -0
  152. package/types/tsdoc-metadata.json +11 -0
  153. package/dist/arm-batch.js +0 -6972
  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 -33
  158. package/esm/batchManagementClient.d.ts.map +0 -1
  159. package/esm/batchManagementClient.js +0 -46
  160. package/esm/batchManagementClient.js.map +0 -1
  161. package/esm/batchManagementClientContext.d.ts +0 -23
  162. package/esm/batchManagementClientContext.d.ts.map +0 -1
  163. package/esm/batchManagementClientContext.js +0 -61
  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 -9
  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 -9
  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 -9
  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 -9
  180. package/esm/models/certificateOperationsMappers.js.map +0 -1
  181. package/esm/models/index.d.ts +0 -3946
  182. package/esm/models/index.d.ts.map +0 -1
  183. package/esm/models/index.js.map +0 -1
  184. package/esm/models/locationMappers.d.ts +0 -2
  185. package/esm/models/locationMappers.d.ts.map +0 -1
  186. package/esm/models/locationMappers.js +0 -9
  187. package/esm/models/locationMappers.js.map +0 -1
  188. package/esm/models/mappers.d.ts +0 -110
  189. package/esm/models/mappers.d.ts.map +0 -1
  190. package/esm/models/mappers.js.map +0 -1
  191. package/esm/models/operationsMappers.d.ts +0 -2
  192. package/esm/models/operationsMappers.d.ts.map +0 -1
  193. package/esm/models/operationsMappers.js.map +0 -1
  194. package/esm/models/parameters.d.ts +0 -21
  195. package/esm/models/parameters.d.ts.map +0 -1
  196. package/esm/models/parameters.js +0 -250
  197. package/esm/models/parameters.js.map +0 -1
  198. package/esm/models/poolOperationsMappers.d.ts +0 -2
  199. package/esm/models/poolOperationsMappers.d.ts.map +0 -1
  200. package/esm/models/poolOperationsMappers.js +0 -9
  201. package/esm/models/poolOperationsMappers.js.map +0 -1
  202. package/esm/models/privateEndpointConnectionOperationsMappers.d.ts +0 -2
  203. package/esm/models/privateEndpointConnectionOperationsMappers.d.ts.map +0 -1
  204. package/esm/models/privateEndpointConnectionOperationsMappers.js +0 -9
  205. package/esm/models/privateEndpointConnectionOperationsMappers.js.map +0 -1
  206. package/esm/models/privateLinkResourceOperationsMappers.d.ts +0 -2
  207. package/esm/models/privateLinkResourceOperationsMappers.d.ts.map +0 -1
  208. package/esm/models/privateLinkResourceOperationsMappers.js +0 -9
  209. package/esm/models/privateLinkResourceOperationsMappers.js.map +0 -1
  210. package/esm/operations/applicationOperations.d.ts +0 -151
  211. package/esm/operations/applicationOperations.d.ts.map +0 -1
  212. package/esm/operations/applicationOperations.js +0 -232
  213. package/esm/operations/applicationOperations.js.map +0 -1
  214. package/esm/operations/applicationPackageOperations.d.ts +0 -171
  215. package/esm/operations/applicationPackageOperations.d.ts.map +0 -1
  216. package/esm/operations/applicationPackageOperations.js +0 -244
  217. package/esm/operations/applicationPackageOperations.js.map +0 -1
  218. package/esm/operations/batchAccountOperations.d.ts +0 -299
  219. package/esm/operations/batchAccountOperations.d.ts.map +0 -1
  220. package/esm/operations/batchAccountOperations.js +0 -493
  221. package/esm/operations/batchAccountOperations.js.map +0 -1
  222. package/esm/operations/certificateOperations.d.ts +0 -207
  223. package/esm/operations/certificateOperations.d.ts.map +0 -1
  224. package/esm/operations/certificateOperations.js +0 -310
  225. package/esm/operations/certificateOperations.js.map +0 -1
  226. package/esm/operations/index.d.ts.map +0 -1
  227. package/esm/operations/index.js.map +0 -1
  228. package/esm/operations/location.d.ts +0 -124
  229. package/esm/operations/location.d.ts.map +0 -1
  230. package/esm/operations/location.js +0 -216
  231. package/esm/operations/location.js.map +0 -1
  232. package/esm/operations/operations.d.ts +0 -46
  233. package/esm/operations/operations.d.ts.map +0 -1
  234. package/esm/operations/operations.js +0 -79
  235. package/esm/operations/operations.js.map +0 -1
  236. package/esm/operations/poolOperations.d.ts +0 -206
  237. package/esm/operations/poolOperations.d.ts.map +0 -1
  238. package/esm/operations/poolOperations.js +0 -341
  239. package/esm/operations/poolOperations.js.map +0 -1
  240. package/esm/operations/privateEndpointConnectionOperations.d.ts +0 -104
  241. package/esm/operations/privateEndpointConnectionOperations.d.ts.map +0 -1
  242. package/esm/operations/privateEndpointConnectionOperations.js +0 -195
  243. package/esm/operations/privateEndpointConnectionOperations.js.map +0 -1
  244. package/esm/operations/privateLinkResourceOperations.d.ts +0 -79
  245. package/esm/operations/privateLinkResourceOperations.d.ts.map +0 -1
  246. package/esm/operations/privateLinkResourceOperations.js +0 -121
  247. package/esm/operations/privateLinkResourceOperations.js.map +0 -1
  248. package/src/models/applicationOperationsMappers.ts +0 -79
  249. package/src/models/applicationPackageOperationsMappers.ts +0 -80
  250. package/src/models/batchAccountOperationsMappers.ts +0 -89
  251. package/src/models/certificateOperationsMappers.ts +0 -84
  252. package/src/models/poolOperationsMappers.ts +0 -85
  253. package/src/models/privateEndpointConnectionOperationsMappers.ts +0 -80
  254. package/src/models/privateLinkResourceOperationsMappers.ts +0 -79
@@ -1,3946 +0,0 @@
1
- import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
2
- import * as msRest from "@azure/ms-rest-js";
3
- export { BaseResource, CloudError };
4
- /**
5
- * The reference to a user assigned identity associated with the Batch pool which a compute node
6
- * will use.
7
- */
8
- export interface ComputeNodeIdentityReference {
9
- /**
10
- * The ARM resource id of the user assigned identity.
11
- */
12
- resourceId?: string;
13
- }
14
- /**
15
- * The properties related to the auto-storage account.
16
- */
17
- export interface AutoStorageBaseProperties {
18
- /**
19
- * The resource ID of the storage account to be used for auto-storage account.
20
- */
21
- storageAccountId: string;
22
- /**
23
- * The authentication mode which the Batch service will use to manage the auto-storage account.
24
- * Possible values include: 'StorageKeys', 'BatchAccountManagedIdentity'. Default value:
25
- * 'StorageKeys'.
26
- */
27
- authenticationMode?: AutoStorageAuthenticationMode;
28
- /**
29
- * The reference to the user assigned identity which compute nodes will use to access
30
- * auto-storage. The identity referenced here must be assigned to pools which have compute nodes
31
- * that need access to auto-storage.
32
- */
33
- nodeIdentityReference?: ComputeNodeIdentityReference;
34
- }
35
- /**
36
- * KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
37
- */
38
- export interface KeyVaultProperties {
39
- /**
40
- * Full path to the versioned secret. Example
41
- * https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable
42
- * the following prerequisites must be met:
43
- *
44
- * The Batch Account has a System Assigned identity
45
- * The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions
46
- * The KeyVault has soft-delete and purge protection enabled
47
- */
48
- keyIdentifier?: string;
49
- }
50
- /**
51
- * Configures how customer data is encrypted inside the Batch account. By default, accounts are
52
- * encrypted using a Microsoft managed key. For additional control, a customer-managed key can be
53
- * used instead.
54
- */
55
- export interface EncryptionProperties {
56
- /**
57
- * Type of the key source. Possible values include: 'Microsoft.Batch', 'Microsoft.KeyVault'
58
- */
59
- keySource?: KeySource;
60
- /**
61
- * Additional details when using Microsoft.KeyVault
62
- */
63
- keyVaultProperties?: KeyVaultProperties;
64
- }
65
- /**
66
- * Identifies the Azure key vault associated with a Batch account.
67
- */
68
- export interface KeyVaultReference {
69
- /**
70
- * The resource ID of the Azure key vault associated with the Batch account.
71
- */
72
- id: string;
73
- /**
74
- * The URL of the Azure key vault associated with the Batch account.
75
- */
76
- url: string;
77
- }
78
- /**
79
- * The list of associated user identities.
80
- */
81
- export interface UserAssignedIdentities {
82
- /**
83
- * The principal id of user assigned identity.
84
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
85
- */
86
- readonly principalId?: string;
87
- /**
88
- * The client id of user assigned identity.
89
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
90
- */
91
- readonly clientId?: string;
92
- }
93
- /**
94
- * The identity of the Batch account, if configured. This is used when the user specifies
95
- * 'Microsoft.KeyVault' as their Batch account encryption configuration or when `ManagedIdentity`
96
- * is selected as the auto-storage authentication mode.
97
- */
98
- export interface BatchAccountIdentity {
99
- /**
100
- * The principal id of the Batch account. This property will only be provided for a system
101
- * assigned identity.
102
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
103
- */
104
- readonly principalId?: string;
105
- /**
106
- * The tenant id associated with the Batch account. This property will only be provided for a
107
- * system assigned identity.
108
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
109
- */
110
- readonly tenantId?: string;
111
- /**
112
- * The type of identity used for the Batch account. Possible values include: 'SystemAssigned',
113
- * 'UserAssigned', 'None'
114
- */
115
- type: ResourceIdentityType;
116
- /**
117
- * The list of user identities associated with the Batch account.
118
- */
119
- userAssignedIdentities?: {
120
- [propertyName: string]: UserAssignedIdentities;
121
- };
122
- }
123
- /**
124
- * Parameters supplied to the Create operation.
125
- */
126
- export interface BatchAccountCreateParameters {
127
- /**
128
- * The region in which to create the account.
129
- */
130
- location: string;
131
- /**
132
- * The user-specified tags associated with the account.
133
- */
134
- tags?: {
135
- [propertyName: string]: string;
136
- };
137
- /**
138
- * The properties related to the auto-storage account.
139
- */
140
- autoStorage?: AutoStorageBaseProperties;
141
- /**
142
- * The allocation mode to use for creating pools in the Batch account. The pool allocation mode
143
- * also affects how clients may authenticate to the Batch Service API. If the mode is
144
- * BatchService, clients may authenticate using access keys or Azure Active Directory. If the
145
- * mode is UserSubscription, clients must use Azure Active Directory. The default is
146
- * BatchService. Possible values include: 'BatchService', 'UserSubscription'
147
- */
148
- poolAllocationMode?: PoolAllocationMode;
149
- /**
150
- * A reference to the Azure key vault associated with the Batch account.
151
- */
152
- keyVaultReference?: KeyVaultReference;
153
- /**
154
- * The network access type for accessing Azure Batch account. If not specified, the default value
155
- * is 'enabled'. Possible values include: 'Enabled', 'Disabled'. Default value: 'Enabled'.
156
- */
157
- publicNetworkAccess?: PublicNetworkAccessType;
158
- /**
159
- * The encryption configuration for the Batch account. Configures how customer data is encrypted
160
- * inside the Batch account. By default, accounts are encrypted using a Microsoft managed key.
161
- * For additional control, a customer-managed key can be used instead.
162
- */
163
- encryption?: EncryptionProperties;
164
- /**
165
- * List of allowed authentication modes for the Batch account that can be used to authenticate
166
- * with the data plane. This does not affect authentication with the control plane.
167
- */
168
- allowedAuthenticationModes?: AuthenticationMode[];
169
- /**
170
- * The identity of the Batch account.
171
- */
172
- identity?: BatchAccountIdentity;
173
- }
174
- /**
175
- * Contains information about the auto-storage account associated with a Batch account.
176
- */
177
- export interface AutoStorageProperties extends AutoStorageBaseProperties {
178
- /**
179
- * The UTC time at which storage keys were last synchronized with the Batch account.
180
- */
181
- lastKeySync: Date;
182
- }
183
- /**
184
- * A VM Family and its associated core quota for the Batch account.
185
- */
186
- export interface VirtualMachineFamilyCoreQuota {
187
- /**
188
- * The Virtual Machine family name.
189
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
190
- */
191
- readonly name?: string;
192
- /**
193
- * The core quota for the VM family for the Batch account.
194
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
195
- */
196
- readonly coreQuota?: number;
197
- }
198
- /**
199
- * The private endpoint of the private endpoint connection.
200
- */
201
- export interface PrivateEndpoint {
202
- /**
203
- * The ARM resource identifier of the private endpoint. This is of the form
204
- * /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.
205
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
206
- */
207
- readonly id?: string;
208
- }
209
- /**
210
- * The private link service connection state of the private endpoint connection
211
- */
212
- export interface PrivateLinkServiceConnectionState {
213
- /**
214
- * The status for the private endpoint connection of Batch account. Possible values include:
215
- * 'Approved', 'Pending', 'Rejected', 'Disconnected'
216
- */
217
- status: PrivateLinkServiceConnectionStatus;
218
- /**
219
- * Description of the private Connection state.
220
- */
221
- description?: string;
222
- /**
223
- * Action required on the private connection state. **NOTE: This property will not be serialized.
224
- * It can only be populated by the server.**
225
- */
226
- readonly actionRequired?: string;
227
- }
228
- /**
229
- * A definition of an Azure resource.
230
- */
231
- export interface ProxyResource extends BaseResource {
232
- /**
233
- * The ID of the resource.
234
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
235
- */
236
- readonly id?: string;
237
- /**
238
- * The name of the resource.
239
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
240
- */
241
- readonly name?: string;
242
- /**
243
- * The type of the resource.
244
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
245
- */
246
- readonly type?: string;
247
- /**
248
- * The ETag of the resource, used for concurrency statements.
249
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
250
- */
251
- readonly etag?: string;
252
- }
253
- /**
254
- * Contains information about a private link resource.
255
- */
256
- export interface PrivateEndpointConnection extends ProxyResource {
257
- /**
258
- * The provisioning state of the private endpoint connection. Possible values include:
259
- * 'Succeeded', 'Updating', 'Failed'
260
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
261
- */
262
- readonly provisioningState?: PrivateEndpointConnectionProvisioningState;
263
- /**
264
- * The ARM resource identifier of the private endpoint.
265
- */
266
- privateEndpoint?: PrivateEndpoint;
267
- /**
268
- * The private link service connection state of the private endpoint connection.
269
- */
270
- privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
271
- }
272
- /**
273
- * A definition of an Azure resource.
274
- */
275
- export interface Resource extends BaseResource {
276
- /**
277
- * The ID of the resource.
278
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
279
- */
280
- readonly id?: string;
281
- /**
282
- * The name of the resource.
283
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
284
- */
285
- readonly name?: string;
286
- /**
287
- * The type of the resource.
288
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
289
- */
290
- readonly type?: string;
291
- /**
292
- * The location of the resource.
293
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
294
- */
295
- readonly location?: string;
296
- /**
297
- * The tags of the resource.
298
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
299
- */
300
- readonly tags?: {
301
- [propertyName: string]: string;
302
- };
303
- }
304
- /**
305
- * Contains information about an Azure Batch account.
306
- */
307
- export interface BatchAccount extends Resource {
308
- /**
309
- * The account endpoint used to interact with the Batch service.
310
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
311
- */
312
- readonly accountEndpoint?: string;
313
- /**
314
- * The provisioned state of the resource. Possible values include: 'Invalid', 'Creating',
315
- * 'Deleting', 'Succeeded', 'Failed', 'Cancelled'
316
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
317
- */
318
- readonly provisioningState?: ProvisioningState;
319
- /**
320
- * The allocation mode to use for creating pools in the Batch account. Possible values include:
321
- * 'BatchService', 'UserSubscription'
322
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
323
- */
324
- readonly poolAllocationMode?: PoolAllocationMode;
325
- /**
326
- * A reference to the Azure key vault associated with the Batch account. **NOTE: This property
327
- * will not be serialized. It can only be populated by the server.**
328
- */
329
- readonly keyVaultReference?: KeyVaultReference;
330
- /**
331
- * The network interface type for accessing Azure Batch service and Batch account operations. If
332
- * not specified, the default value is 'enabled'. Possible values include: 'Enabled', 'Disabled'
333
- * **NOTE: This property will not be serialized. It can only be populated by the server.**.
334
- * Default value: 'Enabled'.
335
- */
336
- readonly publicNetworkAccess?: PublicNetworkAccessType;
337
- /**
338
- * List of private endpoint connections associated with the Batch account
339
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
340
- */
341
- readonly privateEndpointConnections?: PrivateEndpointConnection[];
342
- /**
343
- * The properties and status of any auto-storage account associated with the Batch account.
344
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
345
- */
346
- readonly autoStorage?: AutoStorageProperties;
347
- /**
348
- * The encryption configuration for the Batch account. Configures how customer data is encrypted
349
- * inside the Batch account. By default, accounts are encrypted using a Microsoft managed key.
350
- * For additional control, a customer-managed key can be used instead.
351
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
352
- */
353
- readonly encryption?: EncryptionProperties;
354
- /**
355
- * The dedicated core quota for the Batch account. For accounts with PoolAllocationMode set to
356
- * UserSubscription, quota is managed on the subscription so this value is not returned.
357
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
358
- */
359
- readonly dedicatedCoreQuota?: number;
360
- /**
361
- * The low-priority core quota for the Batch account. For accounts with PoolAllocationMode set to
362
- * UserSubscription, quota is managed on the subscription so this value is not returned.
363
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
364
- */
365
- readonly lowPriorityCoreQuota?: number;
366
- /**
367
- * A list of the dedicated core quota per Virtual Machine family for the Batch account. For
368
- * accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription
369
- * so this value is not returned.
370
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
371
- */
372
- readonly dedicatedCoreQuotaPerVMFamily?: VirtualMachineFamilyCoreQuota[];
373
- /**
374
- * A value indicating whether core quotas per Virtual Machine family are enforced for this
375
- * account. Batch is transitioning its core quota system for dedicated cores to be enforced per
376
- * Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual
377
- * Machine family may not yet be enforced. If this flag is false, dedicated core quota is
378
- * enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual
379
- * Machine family. If this flag is true, dedicated core quota is enforced via the
380
- * dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not
381
- * apply.
382
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
383
- */
384
- readonly dedicatedCoreQuotaPerVMFamilyEnforced?: boolean;
385
- /**
386
- * The pool quota for the Batch account. **NOTE: This property will not be serialized. It can
387
- * only be populated by the server.**
388
- */
389
- readonly poolQuota?: number;
390
- /**
391
- * The active job and job schedule quota for the Batch account. **NOTE: This property will not be
392
- * serialized. It can only be populated by the server.**
393
- */
394
- readonly activeJobAndJobScheduleQuota?: number;
395
- /**
396
- * List of allowed authentication modes for the Batch account that can be used to authenticate
397
- * with the data plane. This does not affect authentication with the control plane.
398
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
399
- */
400
- readonly allowedAuthenticationModes?: AuthenticationMode[];
401
- /**
402
- * The identity of the Batch account.
403
- */
404
- identity?: BatchAccountIdentity;
405
- }
406
- /**
407
- * Parameters for updating an Azure Batch account.
408
- */
409
- export interface BatchAccountUpdateParameters {
410
- /**
411
- * The user-specified tags associated with the account.
412
- */
413
- tags?: {
414
- [propertyName: string]: string;
415
- };
416
- /**
417
- * The properties related to the auto-storage account.
418
- */
419
- autoStorage?: AutoStorageBaseProperties;
420
- /**
421
- * The encryption configuration for the Batch account. Configures how customer data is encrypted
422
- * inside the Batch account. By default, accounts are encrypted using a Microsoft managed key.
423
- * For additional control, a customer-managed key can be used instead.
424
- */
425
- encryption?: EncryptionProperties;
426
- /**
427
- * List of allowed authentication modes for the Batch account that can be used to authenticate
428
- * with the data plane. This does not affect authentication with the control plane.
429
- */
430
- allowedAuthenticationModes?: AuthenticationMode[];
431
- /**
432
- * The identity of the Batch account.
433
- */
434
- identity?: BatchAccountIdentity;
435
- }
436
- /**
437
- * Parameters supplied to the RegenerateKey operation.
438
- */
439
- export interface BatchAccountRegenerateKeyParameters {
440
- /**
441
- * The type of account key to regenerate. Possible values include: 'Primary', 'Secondary'
442
- */
443
- keyName: AccountKeyType;
444
- }
445
- /**
446
- * A set of Azure Batch account keys.
447
- */
448
- export interface BatchAccountKeys {
449
- /**
450
- * The Batch account name.
451
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
452
- */
453
- readonly accountName?: string;
454
- /**
455
- * The primary key associated with the account.
456
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
457
- */
458
- readonly primary?: string;
459
- /**
460
- * The secondary key associated with the account.
461
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
462
- */
463
- readonly secondary?: string;
464
- }
465
- /**
466
- * Parameters for an activating an application package.
467
- */
468
- export interface ActivateApplicationPackageParameters {
469
- /**
470
- * The format of the application package binary file.
471
- */
472
- format: string;
473
- }
474
- /**
475
- * Contains information about an application in a Batch account.
476
- */
477
- export interface Application extends ProxyResource {
478
- /**
479
- * The display name for the application.
480
- */
481
- displayName?: string;
482
- /**
483
- * A value indicating whether packages within the application may be overwritten using the same
484
- * version string.
485
- */
486
- allowUpdates?: boolean;
487
- /**
488
- * The package to use if a client requests the application but does not specify a version. This
489
- * property can only be set to the name of an existing package.
490
- */
491
- defaultVersion?: string;
492
- }
493
- /**
494
- * An application package which represents a particular version of an application.
495
- */
496
- export interface ApplicationPackage extends ProxyResource {
497
- /**
498
- * The current state of the application package. Possible values include: 'Pending', 'Active'
499
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
500
- */
501
- readonly state?: PackageState;
502
- /**
503
- * The format of the application package, if the package is active.
504
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
505
- */
506
- readonly format?: string;
507
- /**
508
- * The URL for the application package in Azure Storage.
509
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
510
- */
511
- readonly storageUrl?: string;
512
- /**
513
- * The UTC time at which the Azure Storage URL will expire.
514
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
515
- */
516
- readonly storageUrlExpiry?: Date;
517
- /**
518
- * The time at which the package was last activated, if the package is active.
519
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
520
- */
521
- readonly lastActivationTime?: Date;
522
- }
523
- /**
524
- * Quotas associated with a Batch region for a particular subscription.
525
- */
526
- export interface BatchLocationQuota {
527
- /**
528
- * The number of Batch accounts that may be created under the subscription in the specified
529
- * region.
530
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
531
- */
532
- readonly accountQuota?: number;
533
- }
534
- /**
535
- * Base certificate properties.
536
- */
537
- export interface CertificateBaseProperties {
538
- /**
539
- * The algorithm of the certificate thumbprint. This must match the first portion of the
540
- * certificate name. Currently required to be 'SHA1'.
541
- */
542
- thumbprintAlgorithm?: string;
543
- /**
544
- * The thumbprint of the certificate. This must match the thumbprint from the name.
545
- */
546
- thumbprint?: string;
547
- /**
548
- * The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. Possible
549
- * values include: 'Pfx', 'Cer'
550
- */
551
- format?: CertificateFormat;
552
- }
553
- /**
554
- * An error response from the Batch service.
555
- */
556
- export interface DeleteCertificateError {
557
- /**
558
- * An identifier for the error. Codes are invariant and are intended to be consumed
559
- * programmatically.
560
- */
561
- code: string;
562
- /**
563
- * A message describing the error, intended to be suitable for display in a user interface.
564
- */
565
- message: string;
566
- /**
567
- * The target of the particular error. For example, the name of the property in error.
568
- */
569
- target?: string;
570
- /**
571
- * A list of additional details about the error.
572
- */
573
- details?: DeleteCertificateError[];
574
- }
575
- /**
576
- * Contains information about a certificate.
577
- */
578
- export interface Certificate extends ProxyResource {
579
- /**
580
- * The algorithm of the certificate thumbprint. This must match the first portion of the
581
- * certificate name. Currently required to be 'SHA1'.
582
- */
583
- thumbprintAlgorithm?: string;
584
- /**
585
- * The thumbprint of the certificate. This must match the thumbprint from the name.
586
- */
587
- thumbprint?: string;
588
- /**
589
- * The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. Possible
590
- * values include: 'Pfx', 'Cer'
591
- */
592
- format?: CertificateFormat;
593
- /**
594
- * The provisioned state of the resource. Possible values include: 'Succeeded', 'Deleting',
595
- * 'Failed'
596
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
597
- */
598
- readonly provisioningState?: CertificateProvisioningState;
599
- /**
600
- * The time at which the certificate entered its current state. **NOTE: This property will not be
601
- * serialized. It can only be populated by the server.**
602
- */
603
- readonly provisioningStateTransitionTime?: Date;
604
- /**
605
- * The previous provisioned state of the resource. Possible values include: 'Succeeded',
606
- * 'Deleting', 'Failed'
607
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
608
- */
609
- readonly previousProvisioningState?: CertificateProvisioningState;
610
- /**
611
- * The time at which the certificate entered its previous state. **NOTE: This property will not
612
- * be serialized. It can only be populated by the server.**
613
- */
614
- readonly previousProvisioningStateTransitionTime?: Date;
615
- /**
616
- * The public key of the certificate.
617
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
618
- */
619
- readonly publicData?: string;
620
- /**
621
- * The error which occurred while deleting the certificate. This is only returned when the
622
- * certificate provisioningState is 'Failed'.
623
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
624
- */
625
- readonly deleteCertificateError?: DeleteCertificateError;
626
- }
627
- /**
628
- * Contains information about a certificate.
629
- */
630
- export interface CertificateCreateOrUpdateParameters extends ProxyResource {
631
- /**
632
- * The algorithm of the certificate thumbprint. This must match the first portion of the
633
- * certificate name. Currently required to be 'SHA1'.
634
- */
635
- thumbprintAlgorithm?: string;
636
- /**
637
- * The thumbprint of the certificate. This must match the thumbprint from the name.
638
- */
639
- thumbprint?: string;
640
- /**
641
- * The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. Possible
642
- * values include: 'Pfx', 'Cer'
643
- */
644
- format?: CertificateFormat;
645
- /**
646
- * The base64-encoded contents of the certificate. The maximum size is 10KB.
647
- */
648
- data: string;
649
- /**
650
- * The password to access the certificate's private key. This must not be specified if the
651
- * certificate format is Cer.
652
- */
653
- password?: string;
654
- }
655
- /**
656
- * Contains information about a private link resource.
657
- */
658
- export interface PrivateLinkResource extends ProxyResource {
659
- /**
660
- * The group id of the private link resource. The group id is used to establish the private link
661
- * connection.
662
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
663
- */
664
- readonly groupId?: string;
665
- /**
666
- * The list of required members that are used to establish the private link connection. **NOTE:
667
- * This property will not be serialized. It can only be populated by the server.**
668
- */
669
- readonly requiredMembers?: string[];
670
- /**
671
- * The list of required zone names for the private DNS resource name. **NOTE: This property will
672
- * not be serialized. It can only be populated by the server.**
673
- */
674
- readonly requiredZoneNames?: string[];
675
- }
676
- /**
677
- * An interface representing CloudServiceConfiguration.
678
- * @summary The configuration for nodes in a pool based on the Azure Cloud Services platform.
679
- */
680
- export interface CloudServiceConfiguration {
681
- /**
682
- * The Azure Guest OS family to be installed on the virtual machines in the pool. Possible values
683
- * are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to
684
- * Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5,
685
- * equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For
686
- * more information, see Azure Guest OS Releases
687
- * (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
688
- */
689
- osFamily: string;
690
- /**
691
- * The Azure Guest OS version to be installed on the virtual machines in the pool. The default
692
- * value is * which specifies the latest operating system version for the specified OS family.
693
- */
694
- osVersion?: string;
695
- }
696
- /**
697
- * An interface representing ImageReference.
698
- * @summary A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource
699
- * of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see
700
- * the 'List supported node agent SKUs' operation.
701
- */
702
- export interface ImageReference {
703
- /**
704
- * The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or
705
- * MicrosoftWindowsServer.
706
- */
707
- publisher?: string;
708
- /**
709
- * The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or
710
- * WindowsServer.
711
- */
712
- offer?: string;
713
- /**
714
- * The SKU of the Azure Virtual Machines Marketplace image. For example, 18.04-LTS or
715
- * 2019-Datacenter.
716
- */
717
- sku?: string;
718
- /**
719
- * The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be
720
- * specified to select the latest version of an image. If omitted, the default is 'latest'.
721
- */
722
- version?: string;
723
- /**
724
- * The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will
725
- * be created using this Image Id. This is of the form
726
- * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.
727
- * This property is mutually exclusive with other properties. The Shared Image Gallery image must
728
- * have replicas in the same region as the Azure Batch account. For information about the
729
- * firewall settings for the Batch node agent to communicate with the Batch service see
730
- * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
731
- */
732
- id?: string;
733
- }
734
- /**
735
- * An interface representing WindowsConfiguration.
736
- * @summary Windows operating system settings to apply to the virtual machine.
737
- */
738
- export interface WindowsConfiguration {
739
- /**
740
- * Whether automatic updates are enabled on the virtual machine. If omitted, the default value is
741
- * true.
742
- */
743
- enableAutomaticUpdates?: boolean;
744
- }
745
- /**
746
- * Settings which will be used by the data disks associated to Compute Nodes in the Pool. When
747
- * using attached data disks, you need to mount and format the disks from within a VM to use them.
748
- */
749
- export interface DataDisk {
750
- /**
751
- * The logical unit number. The lun is used to uniquely identify each data disk. If attaching
752
- * multiple disks, each should have a distinct lun. The value must be between 0 and 63,
753
- * inclusive.
754
- */
755
- lun: number;
756
- /**
757
- * The type of caching to be enabled for the data disks. Values are:
758
- *
759
- * none - The caching mode for the disk is not enabled.
760
- * readOnly - The caching mode for the disk is read only.
761
- * readWrite - The caching mode for the disk is read and write.
762
- *
763
- * The default value for caching is none. For information about the caching options see:
764
- * https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
765
- * Possible values include: 'None', 'ReadOnly', 'ReadWrite'
766
- */
767
- caching?: CachingType;
768
- /**
769
- * The initial disk size in GB when creating new data disk.
770
- */
771
- diskSizeGB: number;
772
- /**
773
- * The storage account type to be used for the data disk. If omitted, the default is
774
- * "Standard_LRS". Values are:
775
- *
776
- * Standard_LRS - The data disk should use standard locally redundant storage.
777
- * Premium_LRS - The data disk should use premium locally redundant storage. Possible values
778
- * include: 'Standard_LRS', 'Premium_LRS'
779
- */
780
- storageAccountType?: StorageAccountType;
781
- }
782
- /**
783
- * An interface representing ContainerRegistry.
784
- * @summary A private container registry.
785
- */
786
- export interface ContainerRegistry {
787
- /**
788
- * The user name to log into the registry server.
789
- */
790
- userName?: string;
791
- /**
792
- * The password to log into the registry server.
793
- */
794
- password?: string;
795
- /**
796
- * The registry URL. If omitted, the default is "docker.io".
797
- */
798
- registryServer?: string;
799
- /**
800
- * The reference to the user assigned identity to use to access an Azure Container Registry
801
- * instead of username and password.
802
- */
803
- identityReference?: ComputeNodeIdentityReference;
804
- }
805
- /**
806
- * An interface representing ContainerConfiguration.
807
- * @summary The configuration for container-enabled pools.
808
- */
809
- export interface ContainerConfiguration {
810
- /**
811
- * The collection of container image names. This is the full image reference, as would be
812
- * specified to "docker pull". An image will be sourced from the default Docker registry unless
813
- * the image is fully qualified with an alternative registry.
814
- */
815
- containerImageNames?: string[];
816
- /**
817
- * Additional private registries from which containers can be pulled. If any images must be
818
- * downloaded from a private registry which requires credentials, then those credentials must be
819
- * provided here.
820
- */
821
- containerRegistries?: ContainerRegistry[];
822
- }
823
- /**
824
- * The disk encryption configuration applied on compute nodes in the pool. Disk encryption
825
- * configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image
826
- * Gallery Image.
827
- */
828
- export interface DiskEncryptionConfiguration {
829
- /**
830
- * The list of disk targets Batch Service will encrypt on the compute node. On Linux pool, only
831
- * "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.
832
- */
833
- targets?: DiskEncryptionTarget[];
834
- }
835
- /**
836
- * Allocation configuration used by Batch Service to provision the nodes.
837
- * @summary Node placement configuration for batch pools.
838
- */
839
- export interface NodePlacementConfiguration {
840
- /**
841
- * Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to
842
- * provision the nodes. If not specified, Batch will use the regional policy. Possible values
843
- * include: 'Regional', 'Zonal'
844
- */
845
- policy?: NodePlacementPolicyType;
846
- }
847
- /**
848
- * An interface representing VMExtension.
849
- * @summary The configuration for virtual machine extensions.
850
- */
851
- export interface VMExtension {
852
- /**
853
- * The name of the virtual machine extension.
854
- */
855
- name: string;
856
- /**
857
- * The name of the extension handler publisher.
858
- */
859
- publisher: string;
860
- /**
861
- * The type of the extensions.
862
- */
863
- type: string;
864
- /**
865
- * The version of script handler.
866
- */
867
- typeHandlerVersion?: string;
868
- /**
869
- * Indicates whether the extension should use a newer minor version if one is available at
870
- * deployment time. Once deployed, however, the extension will not upgrade minor versions unless
871
- * redeployed, even with this property set to true.
872
- */
873
- autoUpgradeMinorVersion?: boolean;
874
- /**
875
- * JSON formatted public settings for the extension.
876
- */
877
- settings?: any;
878
- /**
879
- * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no
880
- * protected settings at all.
881
- */
882
- protectedSettings?: any;
883
- /**
884
- * The collection of extension names. Collection of extension names after which this extension
885
- * needs to be provisioned.
886
- */
887
- provisionAfterExtensions?: string[];
888
- }
889
- /**
890
- * An interface representing DiffDiskSettings.
891
- * @summary Specifies the ephemeral Disk Settings for the operating system disk used by the virtual
892
- * machine.
893
- */
894
- export interface DiffDiskSettings {
895
- /**
896
- * Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This
897
- * property can be used by user in the request to choose which location the operating system
898
- * should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information
899
- * on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements
900
- * for Windows VMs at
901
- * https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements
902
- * and Linux VMs at
903
- * https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.
904
- * Possible values include: 'CacheDisk'
905
- */
906
- placement?: DiffDiskPlacement;
907
- }
908
- /**
909
- * An interface representing OSDisk.
910
- * @summary Settings for the operating system disk of the virtual machine.
911
- */
912
- export interface OSDisk {
913
- /**
914
- * Specifies the ephemeral Disk Settings for the operating system disk used by the virtual
915
- * machine.
916
- */
917
- ephemeralOSDiskSettings?: DiffDiskSettings;
918
- }
919
- /**
920
- * An interface representing VirtualMachineConfiguration.
921
- * @summary The configuration for compute nodes in a pool based on the Azure Virtual Machines
922
- * infrastructure.
923
- */
924
- export interface VirtualMachineConfiguration {
925
- /**
926
- * A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine
927
- * Image to use.
928
- */
929
- imageReference: ImageReference;
930
- /**
931
- * The SKU of the Batch node agent to be provisioned on compute nodes in the pool. The Batch node
932
- * agent is a program that runs on each node in the pool, and provides the command-and-control
933
- * interface between the node and the Batch service. There are different implementations of the
934
- * node agent, known as SKUs, for different operating systems. You must specify a node agent SKU
935
- * which matches the selected image reference. To get the list of supported node agent SKUs along
936
- * with their list of verified image references, see the 'List supported node agent SKUs'
937
- * operation.
938
- */
939
- nodeAgentSkuId: string;
940
- /**
941
- * Windows operating system settings on the virtual machine. This property must not be specified
942
- * if the imageReference specifies a Linux OS image.
943
- */
944
- windowsConfiguration?: WindowsConfiguration;
945
- /**
946
- * The configuration for data disks attached to the compute nodes in the pool. This property must
947
- * be specified if the compute nodes in the pool need to have empty data disks attached to them.
948
- */
949
- dataDisks?: DataDisk[];
950
- /**
951
- * The type of on-premises license to be used when deploying the operating system. This only
952
- * applies to images that contain the Windows operating system, and should only be used when you
953
- * hold valid on-premises licenses for the nodes which will be deployed. If omitted, no
954
- * on-premises licensing discount is applied. Values are:
955
- *
956
- * Windows_Server - The on-premises license is for Windows Server.
957
- * Windows_Client - The on-premises license is for Windows Client.
958
- */
959
- licenseType?: string;
960
- /**
961
- * The container configuration for the pool. If specified, setup is performed on each node in the
962
- * pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this
963
- * pool must specify the containerSettings property, and all other tasks may specify it.
964
- */
965
- containerConfiguration?: ContainerConfiguration;
966
- /**
967
- * The disk encryption configuration for the pool. If specified, encryption is performed on each
968
- * node in the pool during node provisioning.
969
- */
970
- diskEncryptionConfiguration?: DiskEncryptionConfiguration;
971
- /**
972
- * The node placement configuration for the pool. This configuration will specify rules on how
973
- * nodes in the pool will be physically allocated.
974
- */
975
- nodePlacementConfiguration?: NodePlacementConfiguration;
976
- /**
977
- * The virtual machine extension for the pool. If specified, the extensions mentioned in this
978
- * configuration will be installed on each node.
979
- */
980
- extensions?: VMExtension[];
981
- /**
982
- * Settings for the operating system disk of the Virtual Machine. Contains configuration for
983
- * ephemeral OSDisk settings.
984
- */
985
- osDisk?: OSDisk;
986
- }
987
- /**
988
- * An interface representing DeploymentConfiguration.
989
- * @summary Deployment configuration properties.
990
- */
991
- export interface DeploymentConfiguration {
992
- /**
993
- * The cloud service configuration for the pool. This property and virtualMachineConfiguration
994
- * are mutually exclusive and one of the properties must be specified. This property cannot be
995
- * specified if the Batch account was created with its poolAllocationMode property set to
996
- * 'UserSubscription'.
997
- */
998
- cloudServiceConfiguration?: CloudServiceConfiguration;
999
- /**
1000
- * The virtual machine configuration for the pool. This property and cloudServiceConfiguration
1001
- * are mutually exclusive and one of the properties must be specified.
1002
- */
1003
- virtualMachineConfiguration?: VirtualMachineConfiguration;
1004
- }
1005
- /**
1006
- * An interface representing FixedScaleSettings.
1007
- * @summary Fixed scale settings for the pool.
1008
- */
1009
- export interface FixedScaleSettings {
1010
- /**
1011
- * The timeout for allocation of compute nodes to the pool. The default value is 15 minutes.
1012
- * Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value
1013
- * is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the
1014
- * request with an error; if you are calling the REST API directly, the HTTP status code is 400
1015
- * (Bad Request).
1016
- */
1017
- resizeTimeout?: string;
1018
- /**
1019
- * The desired number of dedicated compute nodes in the pool. At least one of
1020
- * targetDedicatedNodes, targetLowPriorityNodes must be set.
1021
- */
1022
- targetDedicatedNodes?: number;
1023
- /**
1024
- * The desired number of low-priority compute nodes in the pool. At least one of
1025
- * targetDedicatedNodes, targetLowPriorityNodes must be set.
1026
- */
1027
- targetLowPriorityNodes?: number;
1028
- /**
1029
- * Determines what to do with a node and its running task(s) if the pool size is decreasing. If
1030
- * omitted, the default value is Requeue. Possible values include: 'Requeue', 'Terminate',
1031
- * 'TaskCompletion', 'RetainedData'
1032
- */
1033
- nodeDeallocationOption?: ComputeNodeDeallocationOption;
1034
- }
1035
- /**
1036
- * An interface representing AutoScaleSettings.
1037
- * @summary AutoScale settings for the pool.
1038
- */
1039
- export interface AutoScaleSettings {
1040
- /**
1041
- * A formula for the desired number of compute nodes in the pool.
1042
- */
1043
- formula: string;
1044
- /**
1045
- * The time interval at which to automatically adjust the pool size according to the autoscale
1046
- * formula. If omitted, the default value is 15 minutes (PT15M).
1047
- */
1048
- evaluationInterval?: string;
1049
- }
1050
- /**
1051
- * Defines the desired size of the pool. This can either be 'fixedScale' where the requested
1052
- * targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically
1053
- * reevaluated. If this property is not specified, the pool will have a fixed scale with 0
1054
- * targetDedicatedNodes.
1055
- * @summary Scale settings for the pool
1056
- */
1057
- export interface ScaleSettings {
1058
- /**
1059
- * Fixed scale settings for the pool. This property and autoScale are mutually exclusive and one
1060
- * of the properties must be specified.
1061
- */
1062
- fixedScale?: FixedScaleSettings;
1063
- /**
1064
- * AutoScale settings for the pool. This property and fixedScale are mutually exclusive and one
1065
- * of the properties must be specified.
1066
- */
1067
- autoScale?: AutoScaleSettings;
1068
- }
1069
- /**
1070
- * An interface representing AutoScaleRunError.
1071
- * @summary An error that occurred when autoscaling a pool.
1072
- */
1073
- export interface AutoScaleRunError {
1074
- /**
1075
- * An identifier for the error. Codes are invariant and are intended to be consumed
1076
- * programmatically.
1077
- */
1078
- code: string;
1079
- /**
1080
- * A message describing the error, intended to be suitable for display in a user interface.
1081
- */
1082
- message: string;
1083
- /**
1084
- * Additional details about the error.
1085
- */
1086
- details?: AutoScaleRunError[];
1087
- }
1088
- /**
1089
- * An interface representing AutoScaleRun.
1090
- * @summary The results and errors from an execution of a pool autoscale formula.
1091
- */
1092
- export interface AutoScaleRun {
1093
- /**
1094
- * The time at which the autoscale formula was last evaluated.
1095
- */
1096
- evaluationTime: Date;
1097
- /**
1098
- * The final values of all variables used in the evaluation of the autoscale formula. Each
1099
- * variable value is returned in the form $variable=value, and variables are separated by
1100
- * semicolons.
1101
- */
1102
- results?: string;
1103
- /**
1104
- * Details of the error encountered evaluating the autoscale formula on the pool, if the
1105
- * evaluation was unsuccessful.
1106
- */
1107
- error?: AutoScaleRunError;
1108
- }
1109
- /**
1110
- * An interface representing NetworkSecurityGroupRule.
1111
- * @summary A network security group rule to apply to an inbound endpoint.
1112
- */
1113
- export interface NetworkSecurityGroupRule {
1114
- /**
1115
- * The priority for this rule. Priorities within a pool must be unique and are evaluated in order
1116
- * of priority. The lower the number the higher the priority. For example, rules could be
1117
- * specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes
1118
- * precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any
1119
- * reserved or duplicate values are provided the request fails with HTTP status code 400.
1120
- */
1121
- priority: number;
1122
- /**
1123
- * The action that should be taken for a specified IP address, subnet range or tag. Possible
1124
- * values include: 'Allow', 'Deny'
1125
- */
1126
- access: NetworkSecurityGroupRuleAccess;
1127
- /**
1128
- * The source address prefix or tag to match for the rule. Valid values are a single IP address
1129
- * (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses).
1130
- * If any other values are provided the request fails with HTTP status code 400.
1131
- */
1132
- sourceAddressPrefix: string;
1133
- /**
1134
- * The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535)
1135
- * or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535
1136
- * and the port ranges or ports can't overlap. If any other values are provided the request fails
1137
- * with HTTP status code 400. Default value will be *.
1138
- */
1139
- sourcePortRanges?: string[];
1140
- }
1141
- /**
1142
- * An interface representing InboundNatPool.
1143
- * @summary A inbound NAT pool that can be used to address specific ports on compute nodes in a
1144
- * Batch pool externally.
1145
- */
1146
- export interface InboundNatPool {
1147
- /**
1148
- * The name of the endpoint. The name must be unique within a Batch pool, can contain letters,
1149
- * numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end
1150
- * with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values
1151
- * are provided the request fails with HTTP status code 400.
1152
- */
1153
- name: string;
1154
- /**
1155
- * The protocol of the endpoint. Possible values include: 'TCP', 'UDP'
1156
- */
1157
- protocol: InboundEndpointProtocol;
1158
- /**
1159
- * The port number on the compute node. This must be unique within a Batch pool. Acceptable
1160
- * values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If
1161
- * any reserved values are provided the request fails with HTTP status code 400.
1162
- */
1163
- backendPort: number;
1164
- /**
1165
- * The first port number in the range of external ports that will be used to provide inbound
1166
- * access to the backendPort on individual compute nodes. Acceptable values range between 1 and
1167
- * 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be
1168
- * distinct and cannot overlap. If any reserved or overlapping values are provided the request
1169
- * fails with HTTP status code 400.
1170
- */
1171
- frontendPortRangeStart: number;
1172
- /**
1173
- * The last port number in the range of external ports that will be used to provide inbound
1174
- * access to the backendPort on individual compute nodes. Acceptable values range between 1 and
1175
- * 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges
1176
- * within a pool must be distinct and cannot overlap. If any reserved or overlapping values are
1177
- * provided the request fails with HTTP status code 400.
1178
- */
1179
- frontendPortRangeEnd: number;
1180
- /**
1181
- * A list of network security group rules that will be applied to the endpoint. The maximum
1182
- * number of rules that can be specified across all the endpoints on a Batch pool is 25. If no
1183
- * network security group rules are specified, a default rule will be created to allow inbound
1184
- * access to the specified backendPort. If the maximum number of network security group rules is
1185
- * exceeded the request fails with HTTP status code 400.
1186
- */
1187
- networkSecurityGroupRules?: NetworkSecurityGroupRule[];
1188
- }
1189
- /**
1190
- * An interface representing PoolEndpointConfiguration.
1191
- * @summary The endpoint configuration for a pool.
1192
- */
1193
- export interface PoolEndpointConfiguration {
1194
- /**
1195
- * A list of inbound NAT pools that can be used to address specific ports on an individual
1196
- * compute node externally. The maximum number of inbound NAT pools per Batch pool is 5. If the
1197
- * maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400.
1198
- * This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.
1199
- */
1200
- inboundNatPools: InboundNatPool[];
1201
- }
1202
- /**
1203
- * The public IP Address configuration of the networking configuration of a Pool.
1204
- */
1205
- export interface PublicIPAddressConfiguration {
1206
- /**
1207
- * The provisioning type for Public IP Addresses for the pool. The default value is BatchManaged.
1208
- * Possible values include: 'BatchManaged', 'UserManaged', 'NoPublicIPAddresses'
1209
- */
1210
- provision?: IPAddressProvisioningType;
1211
- /**
1212
- * The list of public IPs which the Batch service will use when provisioning Compute Nodes. The
1213
- * number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100
1214
- * low-priority nodes can be allocated for each public IP. For example, a pool needing 250
1215
- * dedicated VMs would need at least 3 public IPs specified. Each element of this collection is
1216
- * of the form:
1217
- * /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
1218
- */
1219
- ipAddressIds?: string[];
1220
- }
1221
- /**
1222
- * The network configuration for a pool.
1223
- */
1224
- export interface NetworkConfiguration {
1225
- /**
1226
- * The ARM resource identifier of the virtual network subnet which the compute nodes of the pool
1227
- * will join. This is of the form
1228
- * /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
1229
- * The virtual network must be in the same region and subscription as the Azure Batch account.
1230
- * The specified subnet should have enough free IP addresses to accommodate the number of nodes
1231
- * in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially
1232
- * allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service
1233
- * principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC)
1234
- * role for the specified VNet. The specified subnet must allow communication from the Azure
1235
- * Batch service to be able to schedule tasks on the compute nodes. This can be verified by
1236
- * checking if the specified VNet has any associated Network Security Groups (NSG). If
1237
- * communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch
1238
- * service will set the state of the compute nodes to unusable. If the specified VNet has any
1239
- * associated Network Security Groups (NSG), then a few reserved system ports must be enabled for
1240
- * inbound communication. For pools created with a virtual machine configuration, enable ports
1241
- * 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created
1242
- * with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound
1243
- * connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic'
1244
- * VNETs are supported. For more details see:
1245
- * https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration
1246
- */
1247
- subnetId?: string;
1248
- /**
1249
- * The configuration for endpoints on compute nodes in the Batch pool. Pool endpoint
1250
- * configuration is only supported on pools with the virtualMachineConfiguration property.
1251
- */
1252
- endpointConfiguration?: PoolEndpointConfiguration;
1253
- /**
1254
- * The Public IPAddress configuration for Compute Nodes in the Batch Pool. This property is only
1255
- * supported on Pools with the virtualMachineConfiguration property.
1256
- */
1257
- publicIPAddressConfiguration?: PublicIPAddressConfiguration;
1258
- }
1259
- /**
1260
- * An interface representing TaskSchedulingPolicy.
1261
- * @summary Specifies how tasks should be distributed across compute nodes.
1262
- */
1263
- export interface TaskSchedulingPolicy {
1264
- /**
1265
- * How tasks should be distributed across compute nodes. Possible values include: 'Spread',
1266
- * 'Pack'
1267
- */
1268
- nodeFillType: ComputeNodeFillType;
1269
- }
1270
- /**
1271
- * An interface representing LinuxUserConfiguration.
1272
- * @summary Properties used to create a user account on a Linux node.
1273
- */
1274
- export interface LinuxUserConfiguration {
1275
- /**
1276
- * The user ID of the user account. The uid and gid properties must be specified together or not
1277
- * at all. If not specified the underlying operating system picks the uid.
1278
- */
1279
- uid?: number;
1280
- /**
1281
- * The group ID for the user account. The uid and gid properties must be specified together or
1282
- * not at all. If not specified the underlying operating system picks the gid.
1283
- */
1284
- gid?: number;
1285
- /**
1286
- * The SSH private key for the user account. The private key must not be password protected. The
1287
- * private key is used to automatically configure asymmetric-key based authentication for SSH
1288
- * between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true
1289
- * (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair
1290
- * into the user's .ssh directory. If not specified, password-less SSH is not configured between
1291
- * nodes (no modification of the user's .ssh directory is done).
1292
- */
1293
- sshPrivateKey?: string;
1294
- }
1295
- /**
1296
- * An interface representing WindowsUserConfiguration.
1297
- * @summary Properties used to create a user account on a Windows node.
1298
- */
1299
- export interface WindowsUserConfiguration {
1300
- /**
1301
- * Login mode for user. Specifies login mode for the user. The default value for
1302
- * VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools
1303
- * is batch mode. Possible values include: 'Batch', 'Interactive'
1304
- */
1305
- loginMode?: LoginMode;
1306
- }
1307
- /**
1308
- * An interface representing UserAccount.
1309
- * @summary Properties used to create a user on an Azure Batch node.
1310
- */
1311
- export interface UserAccount {
1312
- /**
1313
- * The name of the user account.
1314
- */
1315
- name: string;
1316
- /**
1317
- * The password for the user account.
1318
- */
1319
- password: string;
1320
- /**
1321
- * The elevation level of the user account. nonAdmin - The auto user is a standard user without
1322
- * elevated access. admin - The auto user is a user with elevated access and operates with full
1323
- * Administrator permissions. The default value is nonAdmin. Possible values include: 'NonAdmin',
1324
- * 'Admin'
1325
- */
1326
- elevationLevel?: ElevationLevel;
1327
- /**
1328
- * The Linux-specific user configuration for the user account. This property is ignored if
1329
- * specified on a Windows pool. If not specified, the user is created with the default options.
1330
- */
1331
- linuxUserConfiguration?: LinuxUserConfiguration;
1332
- /**
1333
- * The Windows-specific user configuration for the user account. This property can only be
1334
- * specified if the user is on a Windows pool. If not specified and on a Windows pool, the user
1335
- * is created with the default options.
1336
- */
1337
- windowsUserConfiguration?: WindowsUserConfiguration;
1338
- }
1339
- /**
1340
- * The Batch service does not assign any meaning to this metadata; it is solely for the use of user
1341
- * code.
1342
- * @summary A name-value pair associated with a Batch service resource.
1343
- */
1344
- export interface MetadataItem {
1345
- /**
1346
- * The name of the metadata item.
1347
- */
1348
- name: string;
1349
- /**
1350
- * The value of the metadata item.
1351
- */
1352
- value: string;
1353
- }
1354
- /**
1355
- * An interface representing ResourceFile.
1356
- * @summary A single file or multiple files to be downloaded to a compute node.
1357
- */
1358
- export interface ResourceFile {
1359
- /**
1360
- * The storage container name in the auto storage account. The autoStorageContainerName,
1361
- * storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be
1362
- * specified.
1363
- */
1364
- autoStorageContainerName?: string;
1365
- /**
1366
- * The URL of the blob container within Azure Blob Storage. The autoStorageContainerName,
1367
- * storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be
1368
- * specified. This URL must be readable and listable from compute nodes. There are three ways to
1369
- * get such a URL for a container in Azure storage: include a Shared Access Signature (SAS)
1370
- * granting read and list permissions on the container, use a managed identity with read and list
1371
- * permissions, or set the ACL for the container to allow public access.
1372
- */
1373
- storageContainerUrl?: string;
1374
- /**
1375
- * The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl
1376
- * properties are mutually exclusive and one of them must be specified. If the URL points to
1377
- * Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a
1378
- * URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read
1379
- * permissions on the blob, use a managed identity with read permission, or set the ACL for the
1380
- * blob or its container to allow public access.
1381
- */
1382
- httpUrl?: string;
1383
- /**
1384
- * The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs
1385
- * whose names begin with the specified prefix will be downloaded. The property is valid only
1386
- * when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial
1387
- * filename or a subdirectory. If a prefix is not specified, all the files in the container will
1388
- * be downloaded.
1389
- */
1390
- blobPrefix?: string;
1391
- /**
1392
- * The location on the compute node to which to download the file, relative to the task's working
1393
- * directory. If the httpUrl property is specified, the filePath is required and describes the
1394
- * path which the file will be downloaded to, including the filename. Otherwise, if the
1395
- * autoStorageContainerName or storageContainerUrl property is specified, filePath is optional
1396
- * and is the directory to download the files to. In the case where filePath is used as a
1397
- * directory, any directory structure already associated with the input data will be retained in
1398
- * full and appended to the specified filePath directory. The specified relative path cannot
1399
- * break out of the task's working directory (for example by using '..').
1400
- */
1401
- filePath?: string;
1402
- /**
1403
- * The file permission mode attribute in octal format. This property applies only to files being
1404
- * downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile
1405
- * which will be downloaded to a Windows node. If this property is not specified for a Linux
1406
- * node, then a default value of 0770 is applied to the file.
1407
- */
1408
- fileMode?: string;
1409
- /**
1410
- * The reference to the user assigned identity to use to access Azure Blob Storage specified by
1411
- * storageContainerUrl or httpUrl.
1412
- */
1413
- identityReference?: ComputeNodeIdentityReference;
1414
- }
1415
- /**
1416
- * An interface representing EnvironmentSetting.
1417
- * @summary An environment variable to be set on a task process.
1418
- */
1419
- export interface EnvironmentSetting {
1420
- /**
1421
- * The name of the environment variable.
1422
- */
1423
- name: string;
1424
- /**
1425
- * The value of the environment variable.
1426
- */
1427
- value?: string;
1428
- }
1429
- /**
1430
- * An interface representing AutoUserSpecification.
1431
- * @summary Specifies the parameters for the auto user that runs a task on the Batch service.
1432
- */
1433
- export interface AutoUserSpecification {
1434
- /**
1435
- * The scope for the auto user. The default value is Pool. If the pool is running Windows a value
1436
- * of Task should be specified if stricter isolation between tasks is required. For example, if
1437
- * the task mutates the registry in a way which could impact other tasks, or if certificates have
1438
- * been specified on the pool which should not be accessible by normal tasks but should be
1439
- * accessible by start tasks. Possible values include: 'Task', 'Pool'
1440
- */
1441
- scope?: AutoUserScope;
1442
- /**
1443
- * The elevation level of the auto user. The default value is nonAdmin. Possible values include:
1444
- * 'NonAdmin', 'Admin'
1445
- */
1446
- elevationLevel?: ElevationLevel;
1447
- }
1448
- /**
1449
- * Specify either the userName or autoUser property, but not both.
1450
- * @summary The definition of the user identity under which the task is run.
1451
- */
1452
- export interface UserIdentity {
1453
- /**
1454
- * The name of the user identity under which the task is run. The userName and autoUser
1455
- * properties are mutually exclusive; you must specify one but not both.
1456
- */
1457
- userName?: string;
1458
- /**
1459
- * The auto user under which the task is run. The userName and autoUser properties are mutually
1460
- * exclusive; you must specify one but not both.
1461
- */
1462
- autoUser?: AutoUserSpecification;
1463
- }
1464
- /**
1465
- * An interface representing TaskContainerSettings.
1466
- * @summary The container settings for a task.
1467
- */
1468
- export interface TaskContainerSettings {
1469
- /**
1470
- * Additional options to the container create command. These additional options are supplied as
1471
- * arguments to the "docker create" command, in addition to those controlled by the Batch
1472
- * Service.
1473
- */
1474
- containerRunOptions?: string;
1475
- /**
1476
- * The image to use to create the container in which the task will run. This is the full image
1477
- * reference, as would be specified to "docker pull". If no tag is provided as part of the image
1478
- * name, the tag ":latest" is used as a default.
1479
- */
1480
- imageName: string;
1481
- /**
1482
- * The private registry which contains the container image. This setting can be omitted if was
1483
- * already provided at pool creation.
1484
- */
1485
- registry?: ContainerRegistry;
1486
- /**
1487
- * A flag to indicate where the container task working directory is. The default is
1488
- * 'taskWorkingDirectory'. Possible values include: 'TaskWorkingDirectory',
1489
- * 'ContainerImageDefault'
1490
- */
1491
- workingDirectory?: ContainerWorkingDirectory;
1492
- }
1493
- /**
1494
- * In some cases the start task may be re-run even though the node was not rebooted. Due to this,
1495
- * start tasks should be idempotent and exit gracefully if the setup they're performing has already
1496
- * been done. Special care should be taken to avoid start tasks which create breakaway process or
1497
- * install/launch services from the start task working directory, as this will block Batch from
1498
- * being able to re-run the start task.
1499
- * @summary A task which is run when a compute node joins a pool in the Azure Batch service, or
1500
- * when the compute node is rebooted or reimaged.
1501
- */
1502
- export interface StartTask {
1503
- /**
1504
- * The command line of the start task. The command line does not run under a shell, and therefore
1505
- * cannot take advantage of shell features such as environment variable expansion. If you want to
1506
- * take advantage of such features, you should invoke the shell in the command line, for example
1507
- * using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other
1508
- * properties of the startTask are specified.
1509
- */
1510
- commandLine?: string;
1511
- /**
1512
- * A list of files that the Batch service will download to the compute node before running the
1513
- * command line.
1514
- */
1515
- resourceFiles?: ResourceFile[];
1516
- /**
1517
- * A list of environment variable settings for the start task.
1518
- */
1519
- environmentSettings?: EnvironmentSetting[];
1520
- /**
1521
- * The user identity under which the start task runs. If omitted, the task runs as a
1522
- * non-administrative user unique to the task.
1523
- */
1524
- userIdentity?: UserIdentity;
1525
- /**
1526
- * The maximum number of times the task may be retried. The Batch service retries a task if its
1527
- * exit code is nonzero. Note that this value specifically controls the number of retries. The
1528
- * Batch service will try the task once, and may then retry up to this limit. For example, if the
1529
- * maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries).
1530
- * If the maximum retry count is 0, the Batch service does not retry the task. If the maximum
1531
- * retry count is -1, the Batch service retries the task without limit.
1532
- */
1533
- maxTaskRetryCount?: number;
1534
- /**
1535
- * Whether the Batch service should wait for the start task to complete successfully (that is, to
1536
- * exit with exit code 0) before scheduling any tasks on the compute node. If true and the start
1537
- * task fails on a compute node, the Batch service retries the start task up to its maximum retry
1538
- * count (maxTaskRetryCount). If the task has still not completed successfully after all retries,
1539
- * then the Batch service marks the compute node unusable, and will not schedule tasks to it.
1540
- * This condition can be detected via the node state and scheduling error detail. If false, the
1541
- * Batch service will not wait for the start task to complete. In this case, other tasks can
1542
- * start executing on the compute node while the start task is still running; and even if the
1543
- * start task fails, new tasks will continue to be scheduled on the node. The default is true.
1544
- */
1545
- waitForSuccess?: boolean;
1546
- /**
1547
- * The settings for the container under which the start task runs. When this is specified, all
1548
- * directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories
1549
- * on the node) are mapped into the container, all task environment variables are mapped into the
1550
- * container, and the task command line is executed in the container.
1551
- */
1552
- containerSettings?: TaskContainerSettings;
1553
- }
1554
- /**
1555
- * An interface representing CertificateReference.
1556
- * @summary A reference to a certificate to be installed on compute nodes in a pool. This must
1557
- * exist inside the same account as the pool.
1558
- */
1559
- export interface CertificateReference {
1560
- /**
1561
- * The fully qualified ID of the certificate to install on the pool. This must be inside the same
1562
- * batch account as the pool.
1563
- */
1564
- id: string;
1565
- /**
1566
- * The location of the certificate store on the compute node into which to install the
1567
- * certificate. The default value is currentUser. This property is applicable only for pools
1568
- * configured with Windows nodes (that is, created with cloudServiceConfiguration, or with
1569
- * virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the
1570
- * certificates are stored in a directory inside the task working directory and an environment
1571
- * variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For
1572
- * certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's
1573
- * home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
1574
- * Possible values include: 'CurrentUser', 'LocalMachine'
1575
- */
1576
- storeLocation?: CertificateStoreLocation;
1577
- /**
1578
- * The name of the certificate store on the compute node into which to install the certificate.
1579
- * This property is applicable only for pools configured with Windows nodes (that is, created
1580
- * with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image
1581
- * reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople,
1582
- * TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The
1583
- * default value is My.
1584
- */
1585
- storeName?: string;
1586
- /**
1587
- * Which user accounts on the compute node should have access to the private data of the
1588
- * certificate.
1589
- */
1590
- visibility?: CertificateVisibility[];
1591
- }
1592
- /**
1593
- * An interface representing ApplicationPackageReference.
1594
- * @summary Link to an application package inside the batch account
1595
- */
1596
- export interface ApplicationPackageReference {
1597
- /**
1598
- * The ID of the application package to install. This must be inside the same batch account as
1599
- * the pool. This can either be a reference to a specific version or the default version if one
1600
- * exists.
1601
- */
1602
- id: string;
1603
- /**
1604
- * The version of the application to deploy. If omitted, the default version is deployed. If this
1605
- * is omitted, and no default version is specified for this application, the request fails with
1606
- * the error code InvalidApplicationPackageReferences. If you are calling the REST API directly,
1607
- * the HTTP status code is 409.
1608
- */
1609
- version?: string;
1610
- }
1611
- /**
1612
- * An interface representing ResizeError.
1613
- * @summary An error that occurred when resizing a pool.
1614
- */
1615
- export interface ResizeError {
1616
- /**
1617
- * An identifier for the error. Codes are invariant and are intended to be consumed
1618
- * programmatically.
1619
- */
1620
- code: string;
1621
- /**
1622
- * A message describing the error, intended to be suitable for display in a user interface.
1623
- */
1624
- message: string;
1625
- /**
1626
- * Additional details about the error.
1627
- */
1628
- details?: ResizeError[];
1629
- }
1630
- /**
1631
- * Describes either the current operation (if the pool AllocationState is Resizing) or the
1632
- * previously completed operation (if the AllocationState is Steady).
1633
- * @summary Details about the current or last completed resize operation.
1634
- */
1635
- export interface ResizeOperationStatus {
1636
- /**
1637
- * The desired number of dedicated compute nodes in the pool.
1638
- */
1639
- targetDedicatedNodes?: number;
1640
- /**
1641
- * The desired number of low-priority compute nodes in the pool.
1642
- */
1643
- targetLowPriorityNodes?: number;
1644
- /**
1645
- * The timeout for allocation of compute nodes to the pool or removal of compute nodes from the
1646
- * pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value
1647
- * less than 5 minutes, the Batch service returns an error; if you are calling the REST API
1648
- * directly, the HTTP status code is 400 (Bad Request).
1649
- */
1650
- resizeTimeout?: string;
1651
- /**
1652
- * Determines what to do with a node and its running task(s) if the pool size is decreasing. The
1653
- * default value is requeue. Possible values include: 'Requeue', 'Terminate', 'TaskCompletion',
1654
- * 'RetainedData'
1655
- */
1656
- nodeDeallocationOption?: ComputeNodeDeallocationOption;
1657
- /**
1658
- * The time when this resize operation was started.
1659
- */
1660
- startTime?: Date;
1661
- /**
1662
- * Details of any errors encountered while performing the last resize on the pool. This property
1663
- * is set only if an error occurred during the last pool resize, and only when the pool
1664
- * allocationState is Steady.
1665
- */
1666
- errors?: ResizeError[];
1667
- }
1668
- /**
1669
- * An interface representing AzureBlobFileSystemConfiguration.
1670
- * @summary Information used to connect to an Azure Storage Container using Blobfuse.
1671
- */
1672
- export interface AzureBlobFileSystemConfiguration {
1673
- /**
1674
- * The Azure Storage Account name.
1675
- */
1676
- accountName: string;
1677
- /**
1678
- * The Azure Blob Storage Container name.
1679
- */
1680
- containerName: string;
1681
- /**
1682
- * The Azure Storage Account key. This property is mutually exclusive with both sasKey and
1683
- * identity; exactly one must be specified.
1684
- */
1685
- accountKey?: string;
1686
- /**
1687
- * The Azure Storage SAS token. This property is mutually exclusive with both accountKey and
1688
- * identity; exactly one must be specified.
1689
- */
1690
- sasKey?: string;
1691
- /**
1692
- * Additional command line options to pass to the mount command. These are 'net use' options in
1693
- * Windows and 'mount' options in Linux.
1694
- */
1695
- blobfuseOptions?: string;
1696
- /**
1697
- * The relative path on the compute node where the file system will be mounted. All file systems
1698
- * are mounted relative to the Batch mounts directory, accessible via the
1699
- * AZ_BATCH_NODE_MOUNTS_DIR environment variable.
1700
- */
1701
- relativeMountPath: string;
1702
- /**
1703
- * The reference to the user assigned identity to use to access containerName. This property is
1704
- * mutually exclusive with both accountKey and sasKey; exactly one must be specified.
1705
- */
1706
- identityReference?: ComputeNodeIdentityReference;
1707
- }
1708
- /**
1709
- * An interface representing NFSMountConfiguration.
1710
- * @summary Information used to connect to an NFS file system.
1711
- */
1712
- export interface NFSMountConfiguration {
1713
- /**
1714
- * The URI of the file system to mount.
1715
- */
1716
- source: string;
1717
- /**
1718
- * The relative path on the compute node where the file system will be mounted. All file systems
1719
- * are mounted relative to the Batch mounts directory, accessible via the
1720
- * AZ_BATCH_NODE_MOUNTS_DIR environment variable.
1721
- */
1722
- relativeMountPath: string;
1723
- /**
1724
- * Additional command line options to pass to the mount command. These are 'net use' options in
1725
- * Windows and 'mount' options in Linux.
1726
- */
1727
- mountOptions?: string;
1728
- }
1729
- /**
1730
- * An interface representing CIFSMountConfiguration.
1731
- * @summary Information used to connect to a CIFS file system.
1732
- */
1733
- export interface CIFSMountConfiguration {
1734
- /**
1735
- * The user to use for authentication against the CIFS file system.
1736
- */
1737
- username: string;
1738
- /**
1739
- * The URI of the file system to mount.
1740
- */
1741
- source: string;
1742
- /**
1743
- * The relative path on the compute node where the file system will be mounted. All file systems
1744
- * are mounted relative to the Batch mounts directory, accessible via the
1745
- * AZ_BATCH_NODE_MOUNTS_DIR environment variable.
1746
- */
1747
- relativeMountPath: string;
1748
- /**
1749
- * Additional command line options to pass to the mount command. These are 'net use' options in
1750
- * Windows and 'mount' options in Linux.
1751
- */
1752
- mountOptions?: string;
1753
- /**
1754
- * The password to use for authentication against the CIFS file system.
1755
- */
1756
- password: string;
1757
- }
1758
- /**
1759
- * An interface representing AzureFileShareConfiguration.
1760
- * @summary Information used to connect to an Azure Fileshare.
1761
- */
1762
- export interface AzureFileShareConfiguration {
1763
- /**
1764
- * The Azure Storage account name.
1765
- */
1766
- accountName: string;
1767
- /**
1768
- * The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.
1769
- */
1770
- azureFileUrl: string;
1771
- /**
1772
- * The Azure Storage account key.
1773
- */
1774
- accountKey: string;
1775
- /**
1776
- * The relative path on the compute node where the file system will be mounted. All file systems
1777
- * are mounted relative to the Batch mounts directory, accessible via the
1778
- * AZ_BATCH_NODE_MOUNTS_DIR environment variable.
1779
- */
1780
- relativeMountPath: string;
1781
- /**
1782
- * Additional command line options to pass to the mount command. These are 'net use' options in
1783
- * Windows and 'mount' options in Linux.
1784
- */
1785
- mountOptions?: string;
1786
- }
1787
- /**
1788
- * An interface representing MountConfiguration.
1789
- * @summary The file system to mount on each node.
1790
- */
1791
- export interface MountConfiguration {
1792
- /**
1793
- * The Azure Storage Container to mount using blob FUSE on each node. This property is mutually
1794
- * exclusive with all other properties.
1795
- */
1796
- azureBlobFileSystemConfiguration?: AzureBlobFileSystemConfiguration;
1797
- /**
1798
- * The NFS file system to mount on each node. This property is mutually exclusive with all other
1799
- * properties.
1800
- */
1801
- nfsMountConfiguration?: NFSMountConfiguration;
1802
- /**
1803
- * The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all
1804
- * other properties.
1805
- */
1806
- cifsMountConfiguration?: CIFSMountConfiguration;
1807
- /**
1808
- * The Azure File Share to mount on each node. This property is mutually exclusive with all other
1809
- * properties.
1810
- */
1811
- azureFileShareConfiguration?: AzureFileShareConfiguration;
1812
- }
1813
- /**
1814
- * The identity of the Batch pool, if configured. If the pool identity is updated during update an
1815
- * existing pool, only the new vms which are created after the pool shrinks to 0 will have the
1816
- * updated identities
1817
- */
1818
- export interface BatchPoolIdentity {
1819
- /**
1820
- * The type of identity used for the Batch Pool. Possible values include: 'UserAssigned', 'None'
1821
- */
1822
- type: PoolIdentityType;
1823
- /**
1824
- * The list of user identities associated with the Batch pool.
1825
- */
1826
- userAssignedIdentities?: {
1827
- [propertyName: string]: UserAssignedIdentities;
1828
- };
1829
- }
1830
- /**
1831
- * Contains information about a pool.
1832
- */
1833
- export interface Pool extends ProxyResource {
1834
- /**
1835
- * The display name for the pool. The display name need not be unique and can contain any Unicode
1836
- * characters up to a maximum length of 1024.
1837
- */
1838
- displayName?: string;
1839
- /**
1840
- * The last modified time of the pool. This is the last time at which the pool level data, such
1841
- * as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level
1842
- * changes such as a compute node changing state.
1843
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1844
- */
1845
- readonly lastModified?: Date;
1846
- /**
1847
- * The creation time of the pool. **NOTE: This property will not be serialized. It can only be
1848
- * populated by the server.**
1849
- */
1850
- readonly creationTime?: Date;
1851
- /**
1852
- * The current state of the pool. Possible values include: 'Succeeded', 'Deleting'
1853
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1854
- */
1855
- readonly provisioningState?: PoolProvisioningState;
1856
- /**
1857
- * The time at which the pool entered its current state. **NOTE: This property will not be
1858
- * serialized. It can only be populated by the server.**
1859
- */
1860
- readonly provisioningStateTransitionTime?: Date;
1861
- /**
1862
- * Whether the pool is resizing. Possible values include: 'Steady', 'Resizing', 'Stopping'
1863
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1864
- */
1865
- readonly allocationState?: AllocationState;
1866
- /**
1867
- * The time at which the pool entered its current allocation state. **NOTE: This property will
1868
- * not be serialized. It can only be populated by the server.**
1869
- */
1870
- readonly allocationStateTransitionTime?: Date;
1871
- /**
1872
- * The size of virtual machines in the pool. All VMs in a pool are the same size. For information
1873
- * about available sizes of virtual machines for Cloud Services pools (pools created with
1874
- * cloudServiceConfiguration), see Sizes for Cloud Services
1875
- * (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch
1876
- * supports all Cloud Services VM sizes except ExtraSmall. For information about available VM
1877
- * sizes for pools using images from the Virtual Machines Marketplace (pools created with
1878
- * virtualMachineConfiguration) see Sizes for Virtual Machines (Linux)
1879
- * (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes
1880
- * for Virtual Machines (Windows)
1881
- * (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch
1882
- * supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS,
1883
- * STANDARD_DS, and STANDARD_DSV2 series).
1884
- */
1885
- vmSize?: string;
1886
- /**
1887
- * This property describes how the pool nodes will be deployed - using Cloud Services or Virtual
1888
- * Machines. Using CloudServiceConfiguration specifies that the nodes should be creating using
1889
- * Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines
1890
- * (IaaS).
1891
- */
1892
- deploymentConfiguration?: DeploymentConfiguration;
1893
- /**
1894
- * The number of compute nodes currently in the pool. **NOTE: This property will not be
1895
- * serialized. It can only be populated by the server.**
1896
- */
1897
- readonly currentDedicatedNodes?: number;
1898
- /**
1899
- * The number of low-priority compute nodes currently in the pool. **NOTE: This property will not
1900
- * be serialized. It can only be populated by the server.**
1901
- */
1902
- readonly currentLowPriorityNodes?: number;
1903
- /**
1904
- * Settings which configure the number of nodes in the pool.
1905
- */
1906
- scaleSettings?: ScaleSettings;
1907
- /**
1908
- * The results and errors from the last execution of the autoscale formula. This property is set
1909
- * only if the pool automatically scales, i.e. autoScaleSettings are used.
1910
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1911
- */
1912
- readonly autoScaleRun?: AutoScaleRun;
1913
- /**
1914
- * Whether the pool permits direct communication between nodes. This imposes restrictions on
1915
- * which nodes can be assigned to the pool. Enabling this value can reduce the chance of the
1916
- * requested number of nodes to be allocated in the pool. If not specified, this value defaults
1917
- * to 'Disabled'. Possible values include: 'Enabled', 'Disabled'
1918
- */
1919
- interNodeCommunication?: InterNodeCommunicationState;
1920
- /**
1921
- * The network configuration for the pool.
1922
- */
1923
- networkConfiguration?: NetworkConfiguration;
1924
- /**
1925
- * The number of task slots that can be used to run concurrent tasks on a single compute node in
1926
- * the pool. The default value is 1. The maximum value is the smaller of 4 times the number of
1927
- * cores of the vmSize of the pool or 256.
1928
- */
1929
- taskSlotsPerNode?: number;
1930
- /**
1931
- * How tasks are distributed across compute nodes in a pool. If not specified, the default is
1932
- * spread.
1933
- */
1934
- taskSchedulingPolicy?: TaskSchedulingPolicy;
1935
- /**
1936
- * The list of user accounts to be created on each node in the pool.
1937
- */
1938
- userAccounts?: UserAccount[];
1939
- /**
1940
- * A list of name-value pairs associated with the pool as metadata. The Batch service does not
1941
- * assign any meaning to metadata; it is solely for the use of user code.
1942
- */
1943
- metadata?: MetadataItem[];
1944
- /**
1945
- * A task specified to run on each compute node as it joins the pool. In an PATCH (update)
1946
- * operation, this property can be set to an empty object to remove the start task from the pool.
1947
- */
1948
- startTask?: StartTask;
1949
- /**
1950
- * The list of certificates to be installed on each compute node in the pool. For Windows compute
1951
- * nodes, the Batch service installs the certificates to the specified certificate store and
1952
- * location. For Linux compute nodes, the certificates are stored in a directory inside the task
1953
- * working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the
1954
- * task to query for this location. For certificates with visibility of 'remoteUser', a 'certs'
1955
- * directory is created in the user's home directory (e.g., /home/{user-name}/certs) and
1956
- * certificates are placed in that directory.
1957
- */
1958
- certificates?: CertificateReference[];
1959
- /**
1960
- * The list of application packages to be installed on each compute node in the pool. Changes to
1961
- * application package references affect all new compute nodes joining the pool, but do not
1962
- * affect compute nodes that are already in the pool until they are rebooted or reimaged. There
1963
- * is a maximum of 10 application package references on any given pool.
1964
- */
1965
- applicationPackages?: ApplicationPackageReference[];
1966
- /**
1967
- * The list of application licenses the Batch service will make available on each compute node in
1968
- * the pool. The list of application licenses must be a subset of available Batch service
1969
- * application licenses. If a license is requested which is not supported, pool creation will
1970
- * fail.
1971
- */
1972
- applicationLicenses?: string[];
1973
- /**
1974
- * Contains details about the current or last completed resize operation. **NOTE: This property
1975
- * will not be serialized. It can only be populated by the server.**
1976
- */
1977
- readonly resizeOperationStatus?: ResizeOperationStatus;
1978
- /**
1979
- * A list of file systems to mount on each node in the pool. This supports Azure Files, NFS,
1980
- * CIFS/SMB, and Blobfuse.
1981
- */
1982
- mountConfiguration?: MountConfiguration[];
1983
- /**
1984
- * The type of identity used for the Batch Pool. The type of identity used for the Batch Pool.
1985
- */
1986
- identity?: BatchPoolIdentity;
1987
- }
1988
- /**
1989
- * A SKU capability, such as the number of cores.
1990
- */
1991
- export interface SkuCapability {
1992
- /**
1993
- * The name of the feature.
1994
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
1995
- */
1996
- readonly name?: string;
1997
- /**
1998
- * The value of the feature.
1999
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2000
- */
2001
- readonly value?: string;
2002
- }
2003
- /**
2004
- * Describes a Batch supported SKU.
2005
- */
2006
- export interface SupportedSku {
2007
- /**
2008
- * The name of the SKU.
2009
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2010
- */
2011
- readonly name?: string;
2012
- /**
2013
- * The family name of the SKU.
2014
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2015
- */
2016
- readonly familyName?: string;
2017
- /**
2018
- * A collection of capabilities which this SKU supports.
2019
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2020
- */
2021
- readonly capabilities?: SkuCapability[];
2022
- }
2023
- /**
2024
- * An interface representing OperationDisplay.
2025
- * @summary The object that describes the operation.
2026
- */
2027
- export interface OperationDisplay {
2028
- /**
2029
- * Friendly name of the resource provider.
2030
- */
2031
- provider?: string;
2032
- /**
2033
- * The operation type. For example: read, write, delete, or listKeys/action
2034
- */
2035
- operation?: string;
2036
- /**
2037
- * The resource type on which the operation is performed.
2038
- */
2039
- resource?: string;
2040
- /**
2041
- * The friendly name of the operation.
2042
- */
2043
- description?: string;
2044
- }
2045
- /**
2046
- * An interface representing Operation.
2047
- * @summary A REST API operation
2048
- */
2049
- export interface Operation {
2050
- /**
2051
- * The operation name. This is of the format {provider}/{resource}/{operation}
2052
- */
2053
- name?: string;
2054
- /**
2055
- * Indicates whether the operation is a data action
2056
- */
2057
- isDataAction?: boolean;
2058
- /**
2059
- * The object that describes the operation.
2060
- */
2061
- display?: OperationDisplay;
2062
- /**
2063
- * The intended executor of the operation.
2064
- */
2065
- origin?: string;
2066
- /**
2067
- * Properties of the operation.
2068
- */
2069
- properties?: any;
2070
- }
2071
- /**
2072
- * Parameters for a check name availability request.
2073
- */
2074
- export interface CheckNameAvailabilityParameters {
2075
- /**
2076
- * The name to check for availability
2077
- */
2078
- name: string;
2079
- }
2080
- /**
2081
- * The CheckNameAvailability operation response.
2082
- */
2083
- export interface CheckNameAvailabilityResult {
2084
- /**
2085
- * Gets a boolean value that indicates whether the name is available for you to use. If true, the
2086
- * name is available. If false, the name has already been taken or invalid and cannot be used.
2087
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2088
- */
2089
- readonly nameAvailable?: boolean;
2090
- /**
2091
- * Gets the reason that a Batch account name could not be used. The Reason element is only
2092
- * returned if NameAvailable is false. Possible values include: 'Invalid', 'AlreadyExists'
2093
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2094
- */
2095
- readonly reason?: NameAvailabilityReason;
2096
- /**
2097
- * Gets an error message explaining the Reason value in more detail.
2098
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2099
- */
2100
- readonly message?: string;
2101
- }
2102
- /**
2103
- * Details about the connection between the Batch service and the endpoint.
2104
- */
2105
- export interface EndpointDetail {
2106
- /**
2107
- * The port an endpoint is connected to.
2108
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2109
- */
2110
- readonly port?: number;
2111
- }
2112
- /**
2113
- * A domain name and connection details used to access a dependency.
2114
- */
2115
- export interface EndpointDependency {
2116
- /**
2117
- * The domain name of the dependency. Domain names may be fully qualified or may contain a *
2118
- * wildcard.
2119
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2120
- */
2121
- readonly domainName?: string;
2122
- /**
2123
- * Human-readable supplemental information about the dependency and when it is applicable.
2124
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2125
- */
2126
- readonly description?: string;
2127
- /**
2128
- * The list of connection details for this endpoint.
2129
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2130
- */
2131
- readonly endpointDetails?: EndpointDetail[];
2132
- }
2133
- /**
2134
- * A collection of related endpoints from the same service for which the Batch service requires
2135
- * outbound access.
2136
- */
2137
- export interface OutboundEnvironmentEndpoint {
2138
- /**
2139
- * The type of service that the Batch service connects to.
2140
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2141
- */
2142
- readonly category?: string;
2143
- /**
2144
- * The endpoints for this service to which the Batch service makes outbound calls.
2145
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2146
- */
2147
- readonly endpoints?: EndpointDependency[];
2148
- }
2149
- /**
2150
- * Optional Parameters.
2151
- */
2152
- export interface ApplicationPackageListOptionalParams extends msRest.RequestOptionsBase {
2153
- /**
2154
- * The maximum number of items to return in the response.
2155
- */
2156
- maxresults?: number;
2157
- }
2158
- /**
2159
- * Optional Parameters.
2160
- */
2161
- export interface ApplicationPackageListNextOptionalParams extends msRest.RequestOptionsBase {
2162
- /**
2163
- * The maximum number of items to return in the response.
2164
- */
2165
- maxresults?: number;
2166
- }
2167
- /**
2168
- * Optional Parameters.
2169
- */
2170
- export interface ApplicationCreateOptionalParams extends msRest.RequestOptionsBase {
2171
- /**
2172
- * The parameters for the request.
2173
- */
2174
- parameters?: Application;
2175
- }
2176
- /**
2177
- * Optional Parameters.
2178
- */
2179
- export interface ApplicationListOptionalParams extends msRest.RequestOptionsBase {
2180
- /**
2181
- * The maximum number of items to return in the response.
2182
- */
2183
- maxresults?: number;
2184
- }
2185
- /**
2186
- * Optional Parameters.
2187
- */
2188
- export interface ApplicationListNextOptionalParams extends msRest.RequestOptionsBase {
2189
- /**
2190
- * The maximum number of items to return in the response.
2191
- */
2192
- maxresults?: number;
2193
- }
2194
- /**
2195
- * Optional Parameters.
2196
- */
2197
- export interface LocationListSupportedVirtualMachineSkusOptionalParams extends msRest.RequestOptionsBase {
2198
- /**
2199
- * The maximum number of items to return in the response.
2200
- */
2201
- maxresults?: number;
2202
- /**
2203
- * OData filter expression. Valid properties for filtering are "familyName".
2204
- */
2205
- filter?: string;
2206
- }
2207
- /**
2208
- * Optional Parameters.
2209
- */
2210
- export interface LocationListSupportedCloudServiceSkusOptionalParams extends msRest.RequestOptionsBase {
2211
- /**
2212
- * The maximum number of items to return in the response.
2213
- */
2214
- maxresults?: number;
2215
- /**
2216
- * OData filter expression. Valid properties for filtering are "familyName".
2217
- */
2218
- filter?: string;
2219
- }
2220
- /**
2221
- * Optional Parameters.
2222
- */
2223
- export interface LocationListSupportedVirtualMachineSkusNextOptionalParams extends msRest.RequestOptionsBase {
2224
- /**
2225
- * The maximum number of items to return in the response.
2226
- */
2227
- maxresults?: number;
2228
- /**
2229
- * OData filter expression. Valid properties for filtering are "familyName".
2230
- */
2231
- filter?: string;
2232
- }
2233
- /**
2234
- * Optional Parameters.
2235
- */
2236
- export interface LocationListSupportedCloudServiceSkusNextOptionalParams extends msRest.RequestOptionsBase {
2237
- /**
2238
- * The maximum number of items to return in the response.
2239
- */
2240
- maxresults?: number;
2241
- /**
2242
- * OData filter expression. Valid properties for filtering are "familyName".
2243
- */
2244
- filter?: string;
2245
- }
2246
- /**
2247
- * Optional Parameters.
2248
- */
2249
- export interface CertificateListByBatchAccountOptionalParams extends msRest.RequestOptionsBase {
2250
- /**
2251
- * The maximum number of items to return in the response.
2252
- */
2253
- maxresults?: number;
2254
- /**
2255
- * Comma separated list of properties that should be returned. e.g.
2256
- * "properties/provisioningState". Only top level properties under properties/ are valid for
2257
- * selection.
2258
- */
2259
- select?: string;
2260
- /**
2261
- * OData filter expression. Valid properties for filtering are "properties/provisioningState",
2262
- * "properties/provisioningStateTransitionTime", "name".
2263
- */
2264
- filter?: string;
2265
- }
2266
- /**
2267
- * Optional Parameters.
2268
- */
2269
- export interface CertificateCreateOptionalParams extends msRest.RequestOptionsBase {
2270
- /**
2271
- * The entity state (ETag) version of the certificate to update. A value of "*" can be used to
2272
- * apply the operation only if the certificate already exists. If omitted, this operation will
2273
- * always be applied.
2274
- */
2275
- ifMatch?: string;
2276
- /**
2277
- * Set to '*' to allow a new certificate to be created, but to prevent updating an existing
2278
- * certificate. Other values will be ignored.
2279
- */
2280
- ifNoneMatch?: string;
2281
- }
2282
- /**
2283
- * Optional Parameters.
2284
- */
2285
- export interface CertificateUpdateOptionalParams extends msRest.RequestOptionsBase {
2286
- /**
2287
- * The entity state (ETag) version of the certificate to update. This value can be omitted or set
2288
- * to "*" to apply the operation unconditionally.
2289
- */
2290
- ifMatch?: string;
2291
- }
2292
- /**
2293
- * Optional Parameters.
2294
- */
2295
- export interface CertificateListByBatchAccountNextOptionalParams extends msRest.RequestOptionsBase {
2296
- /**
2297
- * The maximum number of items to return in the response.
2298
- */
2299
- maxresults?: number;
2300
- /**
2301
- * Comma separated list of properties that should be returned. e.g.
2302
- * "properties/provisioningState". Only top level properties under properties/ are valid for
2303
- * selection.
2304
- */
2305
- select?: string;
2306
- /**
2307
- * OData filter expression. Valid properties for filtering are "properties/provisioningState",
2308
- * "properties/provisioningStateTransitionTime", "name".
2309
- */
2310
- filter?: string;
2311
- }
2312
- /**
2313
- * Optional Parameters.
2314
- */
2315
- export interface PrivateLinkResourceListByBatchAccountOptionalParams extends msRest.RequestOptionsBase {
2316
- /**
2317
- * The maximum number of items to return in the response.
2318
- */
2319
- maxresults?: number;
2320
- }
2321
- /**
2322
- * Optional Parameters.
2323
- */
2324
- export interface PrivateLinkResourceListByBatchAccountNextOptionalParams extends msRest.RequestOptionsBase {
2325
- /**
2326
- * The maximum number of items to return in the response.
2327
- */
2328
- maxresults?: number;
2329
- }
2330
- /**
2331
- * Optional Parameters.
2332
- */
2333
- export interface PrivateEndpointConnectionListByBatchAccountOptionalParams extends msRest.RequestOptionsBase {
2334
- /**
2335
- * The maximum number of items to return in the response.
2336
- */
2337
- maxresults?: number;
2338
- }
2339
- /**
2340
- * Optional Parameters.
2341
- */
2342
- export interface PrivateEndpointConnectionUpdateOptionalParams extends msRest.RequestOptionsBase {
2343
- /**
2344
- * The state (ETag) version of the private endpoint connection to update. This value can be
2345
- * omitted or set to "*" to apply the operation unconditionally.
2346
- */
2347
- ifMatch?: string;
2348
- }
2349
- /**
2350
- * Optional Parameters.
2351
- */
2352
- export interface PrivateEndpointConnectionBeginUpdateOptionalParams extends msRest.RequestOptionsBase {
2353
- /**
2354
- * The state (ETag) version of the private endpoint connection to update. This value can be
2355
- * omitted or set to "*" to apply the operation unconditionally.
2356
- */
2357
- ifMatch?: string;
2358
- }
2359
- /**
2360
- * Optional Parameters.
2361
- */
2362
- export interface PrivateEndpointConnectionListByBatchAccountNextOptionalParams extends msRest.RequestOptionsBase {
2363
- /**
2364
- * The maximum number of items to return in the response.
2365
- */
2366
- maxresults?: number;
2367
- }
2368
- /**
2369
- * Optional Parameters.
2370
- */
2371
- export interface PoolListByBatchAccountOptionalParams extends msRest.RequestOptionsBase {
2372
- /**
2373
- * The maximum number of items to return in the response.
2374
- */
2375
- maxresults?: number;
2376
- /**
2377
- * Comma separated list of properties that should be returned. e.g.
2378
- * "properties/provisioningState". Only top level properties under properties/ are valid for
2379
- * selection.
2380
- */
2381
- select?: string;
2382
- /**
2383
- * OData filter expression. Valid properties for filtering are:
2384
- *
2385
- * name
2386
- * properties/allocationState
2387
- * properties/allocationStateTransitionTime
2388
- * properties/creationTime
2389
- * properties/provisioningState
2390
- * properties/provisioningStateTransitionTime
2391
- * properties/lastModified
2392
- * properties/vmSize
2393
- * properties/interNodeCommunication
2394
- * properties/scaleSettings/autoScale
2395
- * properties/scaleSettings/fixedScale
2396
- */
2397
- filter?: string;
2398
- }
2399
- /**
2400
- * Optional Parameters.
2401
- */
2402
- export interface PoolCreateOptionalParams extends msRest.RequestOptionsBase {
2403
- /**
2404
- * The entity state (ETag) version of the pool to update. A value of "*" can be used to apply the
2405
- * operation only if the pool already exists. If omitted, this operation will always be applied.
2406
- */
2407
- ifMatch?: string;
2408
- /**
2409
- * Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other
2410
- * values will be ignored.
2411
- */
2412
- ifNoneMatch?: string;
2413
- }
2414
- /**
2415
- * Optional Parameters.
2416
- */
2417
- export interface PoolUpdateOptionalParams extends msRest.RequestOptionsBase {
2418
- /**
2419
- * The entity state (ETag) version of the pool to update. This value can be omitted or set to "*"
2420
- * to apply the operation unconditionally.
2421
- */
2422
- ifMatch?: string;
2423
- }
2424
- /**
2425
- * Optional Parameters.
2426
- */
2427
- export interface PoolListByBatchAccountNextOptionalParams extends msRest.RequestOptionsBase {
2428
- /**
2429
- * The maximum number of items to return in the response.
2430
- */
2431
- maxresults?: number;
2432
- /**
2433
- * Comma separated list of properties that should be returned. e.g.
2434
- * "properties/provisioningState". Only top level properties under properties/ are valid for
2435
- * selection.
2436
- */
2437
- select?: string;
2438
- /**
2439
- * OData filter expression. Valid properties for filtering are:
2440
- *
2441
- * name
2442
- * properties/allocationState
2443
- * properties/allocationStateTransitionTime
2444
- * properties/creationTime
2445
- * properties/provisioningState
2446
- * properties/provisioningStateTransitionTime
2447
- * properties/lastModified
2448
- * properties/vmSize
2449
- * properties/interNodeCommunication
2450
- * properties/scaleSettings/autoScale
2451
- * properties/scaleSettings/fixedScale
2452
- */
2453
- filter?: string;
2454
- }
2455
- /**
2456
- * An interface representing BatchManagementClientOptions.
2457
- */
2458
- export interface BatchManagementClientOptions extends AzureServiceClientOptions {
2459
- baseUri?: string;
2460
- }
2461
- /**
2462
- * Defines headers for Create operation.
2463
- */
2464
- export interface BatchAccountCreateHeaders {
2465
- /**
2466
- * The URL of the resource used to check the status of the asynchronous operation.
2467
- */
2468
- locationHeader: string;
2469
- /**
2470
- * Suggested delay to check the status of the asynchronous operation. The value is an integer
2471
- * that specifies the delay in seconds.
2472
- */
2473
- retryAfter: number;
2474
- }
2475
- /**
2476
- * Defines headers for Delete operation.
2477
- */
2478
- export interface BatchAccountDeleteHeaders {
2479
- /**
2480
- * The URL of the resource used to check the status of the asynchronous operation.
2481
- */
2482
- location: string;
2483
- /**
2484
- * Suggested delay to check the status of the asynchronous operation. The value is an integer
2485
- * that specifies the delay in seconds.
2486
- */
2487
- retryAfter: number;
2488
- }
2489
- /**
2490
- * Defines headers for Create operation.
2491
- */
2492
- export interface CertificateCreateHeaders {
2493
- /**
2494
- * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the
2495
- * resource has changed between requests. In particular, you can pass the ETag to one of the
2496
- * If-Match or If-None-Match headers.
2497
- */
2498
- eTag: string;
2499
- }
2500
- /**
2501
- * Defines headers for Update operation.
2502
- */
2503
- export interface CertificateUpdateHeaders {
2504
- /**
2505
- * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the
2506
- * resource has changed between requests. In particular, you can pass the ETag to one of the
2507
- * If-Match or If-None-Match headers.
2508
- */
2509
- eTag: string;
2510
- }
2511
- /**
2512
- * Defines headers for Delete operation.
2513
- */
2514
- export interface CertificateDeleteHeaders {
2515
- /**
2516
- * The URL of the resource used to check the status of the asynchronous operation.
2517
- */
2518
- location: string;
2519
- /**
2520
- * Suggested delay to check the status of the asynchronous operation. The value is an integer
2521
- * that represents the seconds.
2522
- */
2523
- retryAfter: number;
2524
- }
2525
- /**
2526
- * Defines headers for Get operation.
2527
- */
2528
- export interface CertificateGetHeaders {
2529
- /**
2530
- * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the
2531
- * resource has changed between requests. In particular, you can pass the ETag to one of the
2532
- * If-Match or If-None-Match headers.
2533
- */
2534
- eTag: string;
2535
- }
2536
- /**
2537
- * Defines headers for CancelDeletion operation.
2538
- */
2539
- export interface CertificateCancelDeletionHeaders {
2540
- /**
2541
- * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the
2542
- * resource has changed between requests. In particular, you can pass the ETag to one of the
2543
- * If-Match or If-None-Match headers.
2544
- */
2545
- eTag: string;
2546
- }
2547
- /**
2548
- * Defines headers for Update operation.
2549
- */
2550
- export interface PrivateEndpointConnectionUpdateHeaders {
2551
- /**
2552
- * The URL of the resource used to check the status of the asynchronous operation.
2553
- */
2554
- location: string;
2555
- /**
2556
- * Suggested delay to check the status of the asynchronous operation. The value is an integer
2557
- * that represents the seconds.
2558
- */
2559
- retryAfter: number;
2560
- }
2561
- /**
2562
- * Defines headers for Create operation.
2563
- */
2564
- export interface PoolCreateHeaders {
2565
- /**
2566
- * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the
2567
- * resource has changed between requests. In particular, you can pass the ETag to one of the
2568
- * If-Match or If-None-Match headers.
2569
- */
2570
- eTag: string;
2571
- }
2572
- /**
2573
- * Defines headers for Update operation.
2574
- */
2575
- export interface PoolUpdateHeaders {
2576
- /**
2577
- * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the
2578
- * resource has changed between requests. In particular, you can pass the ETag to one of the
2579
- * If-Match or If-None-Match headers.
2580
- */
2581
- eTag: string;
2582
- }
2583
- /**
2584
- * Defines headers for Delete operation.
2585
- */
2586
- export interface PoolDeleteHeaders {
2587
- /**
2588
- * The URL of the resource used to check the status of the asynchronous operation.
2589
- */
2590
- location: string;
2591
- /**
2592
- * Suggested delay to check the status of the asynchronous operation. The value is an integer
2593
- * that represents the seconds.
2594
- */
2595
- retryAfter: number;
2596
- }
2597
- /**
2598
- * Defines headers for Get operation.
2599
- */
2600
- export interface PoolGetHeaders {
2601
- /**
2602
- * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the
2603
- * resource has changed between requests. In particular, you can pass the ETag to one of the
2604
- * If-Match or If-None-Match headers.
2605
- */
2606
- eTag: string;
2607
- }
2608
- /**
2609
- * Defines headers for DisableAutoScale operation.
2610
- */
2611
- export interface PoolDisableAutoScaleHeaders {
2612
- /**
2613
- * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the
2614
- * resource has changed between requests. In particular, you can pass the ETag to one of the
2615
- * If-Match or If-None-Match headers.
2616
- */
2617
- eTag: string;
2618
- }
2619
- /**
2620
- * Defines headers for StopResize operation.
2621
- */
2622
- export interface PoolStopResizeHeaders {
2623
- /**
2624
- * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the
2625
- * resource has changed between requests. In particular, you can pass the ETag to one of the
2626
- * If-Match or If-None-Match headers.
2627
- */
2628
- eTag: string;
2629
- }
2630
- /**
2631
- * @interface
2632
- * Values returned by the List operation.
2633
- * @extends Array<BatchAccount>
2634
- */
2635
- export interface BatchAccountListResult extends Array<BatchAccount> {
2636
- /**
2637
- * The continuation token.
2638
- */
2639
- nextLink?: string;
2640
- }
2641
- /**
2642
- * @interface
2643
- * Values returned by the List operation.
2644
- * @extends Array<OutboundEnvironmentEndpoint>
2645
- */
2646
- export interface OutboundEnvironmentEndpointCollection extends Array<OutboundEnvironmentEndpoint> {
2647
- /**
2648
- * The continuation token.
2649
- */
2650
- nextLink?: string;
2651
- }
2652
- /**
2653
- * @interface
2654
- * The result of performing list application packages.
2655
- * @extends Array<ApplicationPackage>
2656
- */
2657
- export interface ListApplicationPackagesResult extends Array<ApplicationPackage> {
2658
- /**
2659
- * The URL to get the next set of results.
2660
- */
2661
- nextLink?: string;
2662
- }
2663
- /**
2664
- * @interface
2665
- * The result of performing list applications.
2666
- * @extends Array<Application>
2667
- */
2668
- export interface ListApplicationsResult extends Array<Application> {
2669
- /**
2670
- * The URL to get the next set of results.
2671
- */
2672
- nextLink?: string;
2673
- }
2674
- /**
2675
- * @interface
2676
- * The Batch List supported SKUs operation response.
2677
- * @extends Array<SupportedSku>
2678
- */
2679
- export interface SupportedSkusResult extends Array<SupportedSku> {
2680
- /**
2681
- * The URL to use for getting the next set of results.
2682
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
2683
- */
2684
- readonly nextLink?: string;
2685
- }
2686
- /**
2687
- * @interface
2688
- * An interface representing the OperationListResult.
2689
- * @summary Result of the request to list REST API operations. It contains a list of operations and
2690
- * a URL nextLink to get the next set of results.
2691
- * @extends Array<Operation>
2692
- */
2693
- export interface OperationListResult extends Array<Operation> {
2694
- nextLink?: string;
2695
- }
2696
- /**
2697
- * @interface
2698
- * Values returned by the List operation.
2699
- * @extends Array<Certificate>
2700
- */
2701
- export interface ListCertificatesResult extends Array<Certificate> {
2702
- /**
2703
- * The continuation token.
2704
- */
2705
- nextLink?: string;
2706
- }
2707
- /**
2708
- * @interface
2709
- * Values returned by the List operation.
2710
- * @extends Array<PrivateLinkResource>
2711
- */
2712
- export interface ListPrivateLinkResourcesResult extends Array<PrivateLinkResource> {
2713
- /**
2714
- * The continuation token.
2715
- */
2716
- nextLink?: string;
2717
- }
2718
- /**
2719
- * @interface
2720
- * Values returned by the List operation.
2721
- * @extends Array<PrivateEndpointConnection>
2722
- */
2723
- export interface ListPrivateEndpointConnectionsResult extends Array<PrivateEndpointConnection> {
2724
- /**
2725
- * The continuation token.
2726
- */
2727
- nextLink?: string;
2728
- }
2729
- /**
2730
- * @interface
2731
- * Values returned by the List operation.
2732
- * @extends Array<Pool>
2733
- */
2734
- export interface ListPoolsResult extends Array<Pool> {
2735
- /**
2736
- * The continuation token.
2737
- */
2738
- nextLink?: string;
2739
- }
2740
- /**
2741
- * Defines values for AutoStorageAuthenticationMode.
2742
- * Possible values include: 'StorageKeys', 'BatchAccountManagedIdentity'
2743
- * @readonly
2744
- * @enum {string}
2745
- */
2746
- export declare type AutoStorageAuthenticationMode = 'StorageKeys' | 'BatchAccountManagedIdentity';
2747
- /**
2748
- * Defines values for KeySource.
2749
- * Possible values include: 'Microsoft.Batch', 'Microsoft.KeyVault'
2750
- * @readonly
2751
- * @enum {string}
2752
- */
2753
- export declare type KeySource = 'Microsoft.Batch' | 'Microsoft.KeyVault';
2754
- /**
2755
- * Defines values for AuthenticationMode.
2756
- * Possible values include: 'SharedKey', 'AAD', 'TaskAuthenticationToken'
2757
- * @readonly
2758
- * @enum {string}
2759
- */
2760
- export declare type AuthenticationMode = 'SharedKey' | 'AAD' | 'TaskAuthenticationToken';
2761
- /**
2762
- * Defines values for PoolAllocationMode.
2763
- * Possible values include: 'BatchService', 'UserSubscription'
2764
- * @readonly
2765
- * @enum {string}
2766
- */
2767
- export declare type PoolAllocationMode = 'BatchService' | 'UserSubscription';
2768
- /**
2769
- * Defines values for PublicNetworkAccessType.
2770
- * Possible values include: 'Enabled', 'Disabled'
2771
- * @readonly
2772
- * @enum {string}
2773
- */
2774
- export declare type PublicNetworkAccessType = 'Enabled' | 'Disabled';
2775
- /**
2776
- * Defines values for ResourceIdentityType.
2777
- * Possible values include: 'SystemAssigned', 'UserAssigned', 'None'
2778
- * @readonly
2779
- * @enum {string}
2780
- */
2781
- export declare type ResourceIdentityType = 'SystemAssigned' | 'UserAssigned' | 'None';
2782
- /**
2783
- * Defines values for ProvisioningState.
2784
- * Possible values include: 'Invalid', 'Creating', 'Deleting', 'Succeeded', 'Failed', 'Cancelled'
2785
- * @readonly
2786
- * @enum {string}
2787
- */
2788
- export declare type ProvisioningState = 'Invalid' | 'Creating' | 'Deleting' | 'Succeeded' | 'Failed' | 'Cancelled';
2789
- /**
2790
- * Defines values for PrivateEndpointConnectionProvisioningState.
2791
- * Possible values include: 'Succeeded', 'Updating', 'Failed'
2792
- * @readonly
2793
- * @enum {string}
2794
- */
2795
- export declare type PrivateEndpointConnectionProvisioningState = 'Succeeded' | 'Updating' | 'Failed';
2796
- /**
2797
- * Defines values for PrivateLinkServiceConnectionStatus.
2798
- * Possible values include: 'Approved', 'Pending', 'Rejected', 'Disconnected'
2799
- * @readonly
2800
- * @enum {string}
2801
- */
2802
- export declare type PrivateLinkServiceConnectionStatus = 'Approved' | 'Pending' | 'Rejected' | 'Disconnected';
2803
- /**
2804
- * Defines values for AccountKeyType.
2805
- * Possible values include: 'Primary', 'Secondary'
2806
- * @readonly
2807
- * @enum {string}
2808
- */
2809
- export declare type AccountKeyType = 'Primary' | 'Secondary';
2810
- /**
2811
- * Defines values for PackageState.
2812
- * Possible values include: 'Pending', 'Active'
2813
- * @readonly
2814
- * @enum {string}
2815
- */
2816
- export declare type PackageState = 'Pending' | 'Active';
2817
- /**
2818
- * Defines values for CertificateFormat.
2819
- * Possible values include: 'Pfx', 'Cer'
2820
- * @readonly
2821
- * @enum {string}
2822
- */
2823
- export declare type CertificateFormat = 'Pfx' | 'Cer';
2824
- /**
2825
- * Defines values for CertificateProvisioningState.
2826
- * Possible values include: 'Succeeded', 'Deleting', 'Failed'
2827
- * @readonly
2828
- * @enum {string}
2829
- */
2830
- export declare type CertificateProvisioningState = 'Succeeded' | 'Deleting' | 'Failed';
2831
- /**
2832
- * Defines values for PoolProvisioningState.
2833
- * Possible values include: 'Succeeded', 'Deleting'
2834
- * @readonly
2835
- * @enum {string}
2836
- */
2837
- export declare type PoolProvisioningState = 'Succeeded' | 'Deleting';
2838
- /**
2839
- * Defines values for AllocationState.
2840
- * Possible values include: 'Steady', 'Resizing', 'Stopping'
2841
- * @readonly
2842
- * @enum {string}
2843
- */
2844
- export declare type AllocationState = 'Steady' | 'Resizing' | 'Stopping';
2845
- /**
2846
- * Defines values for CachingType.
2847
- * Possible values include: 'None', 'ReadOnly', 'ReadWrite'
2848
- * @readonly
2849
- * @enum {string}
2850
- */
2851
- export declare type CachingType = 'None' | 'ReadOnly' | 'ReadWrite';
2852
- /**
2853
- * Defines values for StorageAccountType.
2854
- * Possible values include: 'Standard_LRS', 'Premium_LRS'
2855
- * @readonly
2856
- * @enum {string}
2857
- */
2858
- export declare type StorageAccountType = 'Standard_LRS' | 'Premium_LRS';
2859
- /**
2860
- * Defines values for DiskEncryptionTarget.
2861
- * Possible values include: 'OsDisk', 'TemporaryDisk'
2862
- * @readonly
2863
- * @enum {string}
2864
- */
2865
- export declare type DiskEncryptionTarget = 'OsDisk' | 'TemporaryDisk';
2866
- /**
2867
- * Defines values for NodePlacementPolicyType.
2868
- * Possible values include: 'Regional', 'Zonal'
2869
- * @readonly
2870
- * @enum {string}
2871
- */
2872
- export declare type NodePlacementPolicyType = 'Regional' | 'Zonal';
2873
- /**
2874
- * Defines values for DiffDiskPlacement.
2875
- * Possible values include: 'CacheDisk'
2876
- * @readonly
2877
- * @enum {string}
2878
- */
2879
- export declare type DiffDiskPlacement = 'CacheDisk';
2880
- /**
2881
- * Defines values for ComputeNodeDeallocationOption.
2882
- * Possible values include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'
2883
- * @readonly
2884
- * @enum {string}
2885
- */
2886
- export declare type ComputeNodeDeallocationOption = 'Requeue' | 'Terminate' | 'TaskCompletion' | 'RetainedData';
2887
- /**
2888
- * Defines values for InterNodeCommunicationState.
2889
- * Possible values include: 'Enabled', 'Disabled'
2890
- * @readonly
2891
- * @enum {string}
2892
- */
2893
- export declare type InterNodeCommunicationState = 'Enabled' | 'Disabled';
2894
- /**
2895
- * Defines values for InboundEndpointProtocol.
2896
- * Possible values include: 'TCP', 'UDP'
2897
- * @readonly
2898
- * @enum {string}
2899
- */
2900
- export declare type InboundEndpointProtocol = 'TCP' | 'UDP';
2901
- /**
2902
- * Defines values for NetworkSecurityGroupRuleAccess.
2903
- * Possible values include: 'Allow', 'Deny'
2904
- * @readonly
2905
- * @enum {string}
2906
- */
2907
- export declare type NetworkSecurityGroupRuleAccess = 'Allow' | 'Deny';
2908
- /**
2909
- * Defines values for IPAddressProvisioningType.
2910
- * Possible values include: 'BatchManaged', 'UserManaged', 'NoPublicIPAddresses'
2911
- * @readonly
2912
- * @enum {string}
2913
- */
2914
- export declare type IPAddressProvisioningType = 'BatchManaged' | 'UserManaged' | 'NoPublicIPAddresses';
2915
- /**
2916
- * Defines values for ComputeNodeFillType.
2917
- * Possible values include: 'Spread', 'Pack'
2918
- * @readonly
2919
- * @enum {string}
2920
- */
2921
- export declare type ComputeNodeFillType = 'Spread' | 'Pack';
2922
- /**
2923
- * Defines values for ElevationLevel.
2924
- * Possible values include: 'NonAdmin', 'Admin'
2925
- * @readonly
2926
- * @enum {string}
2927
- */
2928
- export declare type ElevationLevel = 'NonAdmin' | 'Admin';
2929
- /**
2930
- * Defines values for LoginMode.
2931
- * Possible values include: 'Batch', 'Interactive'
2932
- * @readonly
2933
- * @enum {string}
2934
- */
2935
- export declare type LoginMode = 'Batch' | 'Interactive';
2936
- /**
2937
- * Defines values for AutoUserScope.
2938
- * Possible values include: 'Task', 'Pool'
2939
- * @readonly
2940
- * @enum {string}
2941
- */
2942
- export declare type AutoUserScope = 'Task' | 'Pool';
2943
- /**
2944
- * Defines values for ContainerWorkingDirectory.
2945
- * Possible values include: 'TaskWorkingDirectory', 'ContainerImageDefault'
2946
- * @readonly
2947
- * @enum {string}
2948
- */
2949
- export declare type ContainerWorkingDirectory = 'TaskWorkingDirectory' | 'ContainerImageDefault';
2950
- /**
2951
- * Defines values for CertificateStoreLocation.
2952
- * Possible values include: 'CurrentUser', 'LocalMachine'
2953
- * @readonly
2954
- * @enum {string}
2955
- */
2956
- export declare type CertificateStoreLocation = 'CurrentUser' | 'LocalMachine';
2957
- /**
2958
- * Defines values for CertificateVisibility.
2959
- * Possible values include: 'StartTask', 'Task', 'RemoteUser'
2960
- * @readonly
2961
- * @enum {string}
2962
- */
2963
- export declare type CertificateVisibility = 'StartTask' | 'Task' | 'RemoteUser';
2964
- /**
2965
- * Defines values for PoolIdentityType.
2966
- * Possible values include: 'UserAssigned', 'None'
2967
- * @readonly
2968
- * @enum {string}
2969
- */
2970
- export declare type PoolIdentityType = 'UserAssigned' | 'None';
2971
- /**
2972
- * Defines values for NameAvailabilityReason.
2973
- * Possible values include: 'Invalid', 'AlreadyExists'
2974
- * @readonly
2975
- * @enum {string}
2976
- */
2977
- export declare type NameAvailabilityReason = 'Invalid' | 'AlreadyExists';
2978
- /**
2979
- * Contains response data for the create operation.
2980
- */
2981
- export declare type BatchAccountCreateResponse = BatchAccount & BatchAccountCreateHeaders & {
2982
- /**
2983
- * The underlying HTTP response.
2984
- */
2985
- _response: msRest.HttpResponse & {
2986
- /**
2987
- * The parsed HTTP response headers.
2988
- */
2989
- parsedHeaders: BatchAccountCreateHeaders;
2990
- /**
2991
- * The response body as text (string format)
2992
- */
2993
- bodyAsText: string;
2994
- /**
2995
- * The response body as parsed JSON or XML
2996
- */
2997
- parsedBody: BatchAccount;
2998
- };
2999
- };
3000
- /**
3001
- * Contains response data for the update operation.
3002
- */
3003
- export declare type BatchAccountUpdateResponse = BatchAccount & {
3004
- /**
3005
- * The underlying HTTP response.
3006
- */
3007
- _response: msRest.HttpResponse & {
3008
- /**
3009
- * The response body as text (string format)
3010
- */
3011
- bodyAsText: string;
3012
- /**
3013
- * The response body as parsed JSON or XML
3014
- */
3015
- parsedBody: BatchAccount;
3016
- };
3017
- };
3018
- /**
3019
- * Contains response data for the deleteMethod operation.
3020
- */
3021
- export declare type BatchAccountDeleteResponse = BatchAccountDeleteHeaders & {
3022
- /**
3023
- * The underlying HTTP response.
3024
- */
3025
- _response: msRest.HttpResponse & {
3026
- /**
3027
- * The parsed HTTP response headers.
3028
- */
3029
- parsedHeaders: BatchAccountDeleteHeaders;
3030
- };
3031
- };
3032
- /**
3033
- * Contains response data for the get operation.
3034
- */
3035
- export declare type BatchAccountGetResponse = BatchAccount & {
3036
- /**
3037
- * The underlying HTTP response.
3038
- */
3039
- _response: msRest.HttpResponse & {
3040
- /**
3041
- * The response body as text (string format)
3042
- */
3043
- bodyAsText: string;
3044
- /**
3045
- * The response body as parsed JSON or XML
3046
- */
3047
- parsedBody: BatchAccount;
3048
- };
3049
- };
3050
- /**
3051
- * Contains response data for the list operation.
3052
- */
3053
- export declare type BatchAccountListResponse = BatchAccountListResult & {
3054
- /**
3055
- * The underlying HTTP response.
3056
- */
3057
- _response: msRest.HttpResponse & {
3058
- /**
3059
- * The response body as text (string format)
3060
- */
3061
- bodyAsText: string;
3062
- /**
3063
- * The response body as parsed JSON or XML
3064
- */
3065
- parsedBody: BatchAccountListResult;
3066
- };
3067
- };
3068
- /**
3069
- * Contains response data for the listByResourceGroup operation.
3070
- */
3071
- export declare type BatchAccountListByResourceGroupResponse = BatchAccountListResult & {
3072
- /**
3073
- * The underlying HTTP response.
3074
- */
3075
- _response: msRest.HttpResponse & {
3076
- /**
3077
- * The response body as text (string format)
3078
- */
3079
- bodyAsText: string;
3080
- /**
3081
- * The response body as parsed JSON or XML
3082
- */
3083
- parsedBody: BatchAccountListResult;
3084
- };
3085
- };
3086
- /**
3087
- * Contains response data for the regenerateKey operation.
3088
- */
3089
- export declare type BatchAccountRegenerateKeyResponse = BatchAccountKeys & {
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: BatchAccountKeys;
3102
- };
3103
- };
3104
- /**
3105
- * Contains response data for the getKeys operation.
3106
- */
3107
- export declare type BatchAccountGetKeysResponse = BatchAccountKeys & {
3108
- /**
3109
- * The underlying HTTP response.
3110
- */
3111
- _response: msRest.HttpResponse & {
3112
- /**
3113
- * The response body as text (string format)
3114
- */
3115
- bodyAsText: string;
3116
- /**
3117
- * The response body as parsed JSON or XML
3118
- */
3119
- parsedBody: BatchAccountKeys;
3120
- };
3121
- };
3122
- /**
3123
- * Contains response data for the listOutboundNetworkDependenciesEndpoints operation.
3124
- */
3125
- export declare type BatchAccountListOutboundNetworkDependenciesEndpointsResponse = OutboundEnvironmentEndpointCollection & {
3126
- /**
3127
- * The underlying HTTP response.
3128
- */
3129
- _response: msRest.HttpResponse & {
3130
- /**
3131
- * The response body as text (string format)
3132
- */
3133
- bodyAsText: string;
3134
- /**
3135
- * The response body as parsed JSON or XML
3136
- */
3137
- parsedBody: OutboundEnvironmentEndpointCollection;
3138
- };
3139
- };
3140
- /**
3141
- * Contains response data for the listNext operation.
3142
- */
3143
- export declare type BatchAccountListNextResponse = BatchAccountListResult & {
3144
- /**
3145
- * The underlying HTTP response.
3146
- */
3147
- _response: msRest.HttpResponse & {
3148
- /**
3149
- * The response body as text (string format)
3150
- */
3151
- bodyAsText: string;
3152
- /**
3153
- * The response body as parsed JSON or XML
3154
- */
3155
- parsedBody: BatchAccountListResult;
3156
- };
3157
- };
3158
- /**
3159
- * Contains response data for the listByResourceGroupNext operation.
3160
- */
3161
- export declare type BatchAccountListByResourceGroupNextResponse = BatchAccountListResult & {
3162
- /**
3163
- * The underlying HTTP response.
3164
- */
3165
- _response: msRest.HttpResponse & {
3166
- /**
3167
- * The response body as text (string format)
3168
- */
3169
- bodyAsText: string;
3170
- /**
3171
- * The response body as parsed JSON or XML
3172
- */
3173
- parsedBody: BatchAccountListResult;
3174
- };
3175
- };
3176
- /**
3177
- * Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation.
3178
- */
3179
- export declare type BatchAccountListOutboundNetworkDependenciesEndpointsNextResponse = OutboundEnvironmentEndpointCollection & {
3180
- /**
3181
- * The underlying HTTP response.
3182
- */
3183
- _response: msRest.HttpResponse & {
3184
- /**
3185
- * The response body as text (string format)
3186
- */
3187
- bodyAsText: string;
3188
- /**
3189
- * The response body as parsed JSON or XML
3190
- */
3191
- parsedBody: OutboundEnvironmentEndpointCollection;
3192
- };
3193
- };
3194
- /**
3195
- * Contains response data for the activate operation.
3196
- */
3197
- export declare type ApplicationPackageActivateResponse = ApplicationPackage & {
3198
- /**
3199
- * The underlying HTTP response.
3200
- */
3201
- _response: msRest.HttpResponse & {
3202
- /**
3203
- * The response body as text (string format)
3204
- */
3205
- bodyAsText: string;
3206
- /**
3207
- * The response body as parsed JSON or XML
3208
- */
3209
- parsedBody: ApplicationPackage;
3210
- };
3211
- };
3212
- /**
3213
- * Contains response data for the create operation.
3214
- */
3215
- export declare type ApplicationPackageCreateResponse = ApplicationPackage & {
3216
- /**
3217
- * The underlying HTTP response.
3218
- */
3219
- _response: msRest.HttpResponse & {
3220
- /**
3221
- * The response body as text (string format)
3222
- */
3223
- bodyAsText: string;
3224
- /**
3225
- * The response body as parsed JSON or XML
3226
- */
3227
- parsedBody: ApplicationPackage;
3228
- };
3229
- };
3230
- /**
3231
- * Contains response data for the get operation.
3232
- */
3233
- export declare type ApplicationPackageGetResponse = ApplicationPackage & {
3234
- /**
3235
- * The underlying HTTP response.
3236
- */
3237
- _response: msRest.HttpResponse & {
3238
- /**
3239
- * The response body as text (string format)
3240
- */
3241
- bodyAsText: string;
3242
- /**
3243
- * The response body as parsed JSON or XML
3244
- */
3245
- parsedBody: ApplicationPackage;
3246
- };
3247
- };
3248
- /**
3249
- * Contains response data for the list operation.
3250
- */
3251
- export declare type ApplicationPackageListResponse = ListApplicationPackagesResult & {
3252
- /**
3253
- * The underlying HTTP response.
3254
- */
3255
- _response: msRest.HttpResponse & {
3256
- /**
3257
- * The response body as text (string format)
3258
- */
3259
- bodyAsText: string;
3260
- /**
3261
- * The response body as parsed JSON or XML
3262
- */
3263
- parsedBody: ListApplicationPackagesResult;
3264
- };
3265
- };
3266
- /**
3267
- * Contains response data for the listNext operation.
3268
- */
3269
- export declare type ApplicationPackageListNextResponse = ListApplicationPackagesResult & {
3270
- /**
3271
- * The underlying HTTP response.
3272
- */
3273
- _response: msRest.HttpResponse & {
3274
- /**
3275
- * The response body as text (string format)
3276
- */
3277
- bodyAsText: string;
3278
- /**
3279
- * The response body as parsed JSON or XML
3280
- */
3281
- parsedBody: ListApplicationPackagesResult;
3282
- };
3283
- };
3284
- /**
3285
- * Contains response data for the create operation.
3286
- */
3287
- export declare type ApplicationCreateResponse = Application & {
3288
- /**
3289
- * The underlying HTTP response.
3290
- */
3291
- _response: msRest.HttpResponse & {
3292
- /**
3293
- * The response body as text (string format)
3294
- */
3295
- bodyAsText: string;
3296
- /**
3297
- * The response body as parsed JSON or XML
3298
- */
3299
- parsedBody: Application;
3300
- };
3301
- };
3302
- /**
3303
- * Contains response data for the get operation.
3304
- */
3305
- export declare type ApplicationGetResponse = Application & {
3306
- /**
3307
- * The underlying HTTP response.
3308
- */
3309
- _response: msRest.HttpResponse & {
3310
- /**
3311
- * The response body as text (string format)
3312
- */
3313
- bodyAsText: string;
3314
- /**
3315
- * The response body as parsed JSON or XML
3316
- */
3317
- parsedBody: Application;
3318
- };
3319
- };
3320
- /**
3321
- * Contains response data for the update operation.
3322
- */
3323
- export declare type ApplicationUpdateResponse = Application & {
3324
- /**
3325
- * The underlying HTTP response.
3326
- */
3327
- _response: msRest.HttpResponse & {
3328
- /**
3329
- * The response body as text (string format)
3330
- */
3331
- bodyAsText: string;
3332
- /**
3333
- * The response body as parsed JSON or XML
3334
- */
3335
- parsedBody: Application;
3336
- };
3337
- };
3338
- /**
3339
- * Contains response data for the list operation.
3340
- */
3341
- export declare type ApplicationListResponse = ListApplicationsResult & {
3342
- /**
3343
- * The underlying HTTP response.
3344
- */
3345
- _response: msRest.HttpResponse & {
3346
- /**
3347
- * The response body as text (string format)
3348
- */
3349
- bodyAsText: string;
3350
- /**
3351
- * The response body as parsed JSON or XML
3352
- */
3353
- parsedBody: ListApplicationsResult;
3354
- };
3355
- };
3356
- /**
3357
- * Contains response data for the listNext operation.
3358
- */
3359
- export declare type ApplicationListNextResponse = ListApplicationsResult & {
3360
- /**
3361
- * The underlying HTTP response.
3362
- */
3363
- _response: msRest.HttpResponse & {
3364
- /**
3365
- * The response body as text (string format)
3366
- */
3367
- bodyAsText: string;
3368
- /**
3369
- * The response body as parsed JSON or XML
3370
- */
3371
- parsedBody: ListApplicationsResult;
3372
- };
3373
- };
3374
- /**
3375
- * Contains response data for the getQuotas operation.
3376
- */
3377
- export declare type LocationGetQuotasResponse = BatchLocationQuota & {
3378
- /**
3379
- * The underlying HTTP response.
3380
- */
3381
- _response: msRest.HttpResponse & {
3382
- /**
3383
- * The response body as text (string format)
3384
- */
3385
- bodyAsText: string;
3386
- /**
3387
- * The response body as parsed JSON or XML
3388
- */
3389
- parsedBody: BatchLocationQuota;
3390
- };
3391
- };
3392
- /**
3393
- * Contains response data for the listSupportedVirtualMachineSkus operation.
3394
- */
3395
- export declare type LocationListSupportedVirtualMachineSkusResponse = SupportedSkusResult & {
3396
- /**
3397
- * The underlying HTTP response.
3398
- */
3399
- _response: msRest.HttpResponse & {
3400
- /**
3401
- * The response body as text (string format)
3402
- */
3403
- bodyAsText: string;
3404
- /**
3405
- * The response body as parsed JSON or XML
3406
- */
3407
- parsedBody: SupportedSkusResult;
3408
- };
3409
- };
3410
- /**
3411
- * Contains response data for the listSupportedCloudServiceSkus operation.
3412
- */
3413
- export declare type LocationListSupportedCloudServiceSkusResponse = SupportedSkusResult & {
3414
- /**
3415
- * The underlying HTTP response.
3416
- */
3417
- _response: msRest.HttpResponse & {
3418
- /**
3419
- * The response body as text (string format)
3420
- */
3421
- bodyAsText: string;
3422
- /**
3423
- * The response body as parsed JSON or XML
3424
- */
3425
- parsedBody: SupportedSkusResult;
3426
- };
3427
- };
3428
- /**
3429
- * Contains response data for the checkNameAvailability operation.
3430
- */
3431
- export declare type LocationCheckNameAvailabilityResponse = CheckNameAvailabilityResult & {
3432
- /**
3433
- * The underlying HTTP response.
3434
- */
3435
- _response: msRest.HttpResponse & {
3436
- /**
3437
- * The response body as text (string format)
3438
- */
3439
- bodyAsText: string;
3440
- /**
3441
- * The response body as parsed JSON or XML
3442
- */
3443
- parsedBody: CheckNameAvailabilityResult;
3444
- };
3445
- };
3446
- /**
3447
- * Contains response data for the listSupportedVirtualMachineSkusNext operation.
3448
- */
3449
- export declare type LocationListSupportedVirtualMachineSkusNextResponse = SupportedSkusResult & {
3450
- /**
3451
- * The underlying HTTP response.
3452
- */
3453
- _response: msRest.HttpResponse & {
3454
- /**
3455
- * The response body as text (string format)
3456
- */
3457
- bodyAsText: string;
3458
- /**
3459
- * The response body as parsed JSON or XML
3460
- */
3461
- parsedBody: SupportedSkusResult;
3462
- };
3463
- };
3464
- /**
3465
- * Contains response data for the listSupportedCloudServiceSkusNext operation.
3466
- */
3467
- export declare type LocationListSupportedCloudServiceSkusNextResponse = SupportedSkusResult & {
3468
- /**
3469
- * The underlying HTTP response.
3470
- */
3471
- _response: msRest.HttpResponse & {
3472
- /**
3473
- * The response body as text (string format)
3474
- */
3475
- bodyAsText: string;
3476
- /**
3477
- * The response body as parsed JSON or XML
3478
- */
3479
- parsedBody: SupportedSkusResult;
3480
- };
3481
- };
3482
- /**
3483
- * Contains response data for the list operation.
3484
- */
3485
- export declare type OperationsListResponse = OperationListResult & {
3486
- /**
3487
- * The underlying HTTP response.
3488
- */
3489
- _response: msRest.HttpResponse & {
3490
- /**
3491
- * The response body as text (string format)
3492
- */
3493
- bodyAsText: string;
3494
- /**
3495
- * The response body as parsed JSON or XML
3496
- */
3497
- parsedBody: OperationListResult;
3498
- };
3499
- };
3500
- /**
3501
- * Contains response data for the listNext operation.
3502
- */
3503
- export declare type OperationsListNextResponse = OperationListResult & {
3504
- /**
3505
- * The underlying HTTP response.
3506
- */
3507
- _response: msRest.HttpResponse & {
3508
- /**
3509
- * The response body as text (string format)
3510
- */
3511
- bodyAsText: string;
3512
- /**
3513
- * The response body as parsed JSON or XML
3514
- */
3515
- parsedBody: OperationListResult;
3516
- };
3517
- };
3518
- /**
3519
- * Contains response data for the listByBatchAccount operation.
3520
- */
3521
- export declare type CertificateListByBatchAccountResponse = ListCertificatesResult & {
3522
- /**
3523
- * The underlying HTTP response.
3524
- */
3525
- _response: msRest.HttpResponse & {
3526
- /**
3527
- * The response body as text (string format)
3528
- */
3529
- bodyAsText: string;
3530
- /**
3531
- * The response body as parsed JSON or XML
3532
- */
3533
- parsedBody: ListCertificatesResult;
3534
- };
3535
- };
3536
- /**
3537
- * Contains response data for the create operation.
3538
- */
3539
- export declare type CertificateCreateResponse = Certificate & CertificateCreateHeaders & {
3540
- /**
3541
- * The underlying HTTP response.
3542
- */
3543
- _response: msRest.HttpResponse & {
3544
- /**
3545
- * The parsed HTTP response headers.
3546
- */
3547
- parsedHeaders: CertificateCreateHeaders;
3548
- /**
3549
- * The response body as text (string format)
3550
- */
3551
- bodyAsText: string;
3552
- /**
3553
- * The response body as parsed JSON or XML
3554
- */
3555
- parsedBody: Certificate;
3556
- };
3557
- };
3558
- /**
3559
- * Contains response data for the update operation.
3560
- */
3561
- export declare type CertificateUpdateResponse = Certificate & CertificateUpdateHeaders & {
3562
- /**
3563
- * The underlying HTTP response.
3564
- */
3565
- _response: msRest.HttpResponse & {
3566
- /**
3567
- * The parsed HTTP response headers.
3568
- */
3569
- parsedHeaders: CertificateUpdateHeaders;
3570
- /**
3571
- * The response body as text (string format)
3572
- */
3573
- bodyAsText: string;
3574
- /**
3575
- * The response body as parsed JSON or XML
3576
- */
3577
- parsedBody: Certificate;
3578
- };
3579
- };
3580
- /**
3581
- * Contains response data for the deleteMethod operation.
3582
- */
3583
- export declare type CertificateDeleteResponse = CertificateDeleteHeaders & {
3584
- /**
3585
- * The underlying HTTP response.
3586
- */
3587
- _response: msRest.HttpResponse & {
3588
- /**
3589
- * The parsed HTTP response headers.
3590
- */
3591
- parsedHeaders: CertificateDeleteHeaders;
3592
- };
3593
- };
3594
- /**
3595
- * Contains response data for the get operation.
3596
- */
3597
- export declare type CertificateGetResponse = Certificate & CertificateGetHeaders & {
3598
- /**
3599
- * The underlying HTTP response.
3600
- */
3601
- _response: msRest.HttpResponse & {
3602
- /**
3603
- * The parsed HTTP response headers.
3604
- */
3605
- parsedHeaders: CertificateGetHeaders;
3606
- /**
3607
- * The response body as text (string format)
3608
- */
3609
- bodyAsText: string;
3610
- /**
3611
- * The response body as parsed JSON or XML
3612
- */
3613
- parsedBody: Certificate;
3614
- };
3615
- };
3616
- /**
3617
- * Contains response data for the cancelDeletion operation.
3618
- */
3619
- export declare type CertificateCancelDeletionResponse = Certificate & CertificateCancelDeletionHeaders & {
3620
- /**
3621
- * The underlying HTTP response.
3622
- */
3623
- _response: msRest.HttpResponse & {
3624
- /**
3625
- * The parsed HTTP response headers.
3626
- */
3627
- parsedHeaders: CertificateCancelDeletionHeaders;
3628
- /**
3629
- * The response body as text (string format)
3630
- */
3631
- bodyAsText: string;
3632
- /**
3633
- * The response body as parsed JSON or XML
3634
- */
3635
- parsedBody: Certificate;
3636
- };
3637
- };
3638
- /**
3639
- * Contains response data for the listByBatchAccountNext operation.
3640
- */
3641
- export declare type CertificateListByBatchAccountNextResponse = ListCertificatesResult & {
3642
- /**
3643
- * The underlying HTTP response.
3644
- */
3645
- _response: msRest.HttpResponse & {
3646
- /**
3647
- * The response body as text (string format)
3648
- */
3649
- bodyAsText: string;
3650
- /**
3651
- * The response body as parsed JSON or XML
3652
- */
3653
- parsedBody: ListCertificatesResult;
3654
- };
3655
- };
3656
- /**
3657
- * Contains response data for the listByBatchAccount operation.
3658
- */
3659
- export declare type PrivateLinkResourceListByBatchAccountResponse = ListPrivateLinkResourcesResult & {
3660
- /**
3661
- * The underlying HTTP response.
3662
- */
3663
- _response: msRest.HttpResponse & {
3664
- /**
3665
- * The response body as text (string format)
3666
- */
3667
- bodyAsText: string;
3668
- /**
3669
- * The response body as parsed JSON or XML
3670
- */
3671
- parsedBody: ListPrivateLinkResourcesResult;
3672
- };
3673
- };
3674
- /**
3675
- * Contains response data for the get operation.
3676
- */
3677
- export declare type PrivateLinkResourceGetResponse = PrivateLinkResource & {
3678
- /**
3679
- * The underlying HTTP response.
3680
- */
3681
- _response: msRest.HttpResponse & {
3682
- /**
3683
- * The response body as text (string format)
3684
- */
3685
- bodyAsText: string;
3686
- /**
3687
- * The response body as parsed JSON or XML
3688
- */
3689
- parsedBody: PrivateLinkResource;
3690
- };
3691
- };
3692
- /**
3693
- * Contains response data for the listByBatchAccountNext operation.
3694
- */
3695
- export declare type PrivateLinkResourceListByBatchAccountNextResponse = ListPrivateLinkResourcesResult & {
3696
- /**
3697
- * The underlying HTTP response.
3698
- */
3699
- _response: msRest.HttpResponse & {
3700
- /**
3701
- * The response body as text (string format)
3702
- */
3703
- bodyAsText: string;
3704
- /**
3705
- * The response body as parsed JSON or XML
3706
- */
3707
- parsedBody: ListPrivateLinkResourcesResult;
3708
- };
3709
- };
3710
- /**
3711
- * Contains response data for the listByBatchAccount operation.
3712
- */
3713
- export declare type PrivateEndpointConnectionListByBatchAccountResponse = ListPrivateEndpointConnectionsResult & {
3714
- /**
3715
- * The underlying HTTP response.
3716
- */
3717
- _response: msRest.HttpResponse & {
3718
- /**
3719
- * The response body as text (string format)
3720
- */
3721
- bodyAsText: string;
3722
- /**
3723
- * The response body as parsed JSON or XML
3724
- */
3725
- parsedBody: ListPrivateEndpointConnectionsResult;
3726
- };
3727
- };
3728
- /**
3729
- * Contains response data for the get operation.
3730
- */
3731
- export declare type PrivateEndpointConnectionGetResponse = PrivateEndpointConnection & {
3732
- /**
3733
- * The underlying HTTP response.
3734
- */
3735
- _response: msRest.HttpResponse & {
3736
- /**
3737
- * The response body as text (string format)
3738
- */
3739
- bodyAsText: string;
3740
- /**
3741
- * The response body as parsed JSON or XML
3742
- */
3743
- parsedBody: PrivateEndpointConnection;
3744
- };
3745
- };
3746
- /**
3747
- * Contains response data for the update operation.
3748
- */
3749
- export declare type PrivateEndpointConnectionUpdateResponse = PrivateEndpointConnection & PrivateEndpointConnectionUpdateHeaders & {
3750
- /**
3751
- * The underlying HTTP response.
3752
- */
3753
- _response: msRest.HttpResponse & {
3754
- /**
3755
- * The parsed HTTP response headers.
3756
- */
3757
- parsedHeaders: PrivateEndpointConnectionUpdateHeaders;
3758
- /**
3759
- * The response body as text (string format)
3760
- */
3761
- bodyAsText: string;
3762
- /**
3763
- * The response body as parsed JSON or XML
3764
- */
3765
- parsedBody: PrivateEndpointConnection;
3766
- };
3767
- };
3768
- /**
3769
- * Contains response data for the listByBatchAccountNext operation.
3770
- */
3771
- export declare type PrivateEndpointConnectionListByBatchAccountNextResponse = ListPrivateEndpointConnectionsResult & {
3772
- /**
3773
- * The underlying HTTP response.
3774
- */
3775
- _response: msRest.HttpResponse & {
3776
- /**
3777
- * The response body as text (string format)
3778
- */
3779
- bodyAsText: string;
3780
- /**
3781
- * The response body as parsed JSON or XML
3782
- */
3783
- parsedBody: ListPrivateEndpointConnectionsResult;
3784
- };
3785
- };
3786
- /**
3787
- * Contains response data for the listByBatchAccount operation.
3788
- */
3789
- export declare type PoolListByBatchAccountResponse = ListPoolsResult & {
3790
- /**
3791
- * The underlying HTTP response.
3792
- */
3793
- _response: msRest.HttpResponse & {
3794
- /**
3795
- * The response body as text (string format)
3796
- */
3797
- bodyAsText: string;
3798
- /**
3799
- * The response body as parsed JSON or XML
3800
- */
3801
- parsedBody: ListPoolsResult;
3802
- };
3803
- };
3804
- /**
3805
- * Contains response data for the create operation.
3806
- */
3807
- export declare type PoolCreateResponse = Pool & PoolCreateHeaders & {
3808
- /**
3809
- * The underlying HTTP response.
3810
- */
3811
- _response: msRest.HttpResponse & {
3812
- /**
3813
- * The parsed HTTP response headers.
3814
- */
3815
- parsedHeaders: PoolCreateHeaders;
3816
- /**
3817
- * The response body as text (string format)
3818
- */
3819
- bodyAsText: string;
3820
- /**
3821
- * The response body as parsed JSON or XML
3822
- */
3823
- parsedBody: Pool;
3824
- };
3825
- };
3826
- /**
3827
- * Contains response data for the update operation.
3828
- */
3829
- export declare type PoolUpdateResponse = Pool & PoolUpdateHeaders & {
3830
- /**
3831
- * The underlying HTTP response.
3832
- */
3833
- _response: msRest.HttpResponse & {
3834
- /**
3835
- * The parsed HTTP response headers.
3836
- */
3837
- parsedHeaders: PoolUpdateHeaders;
3838
- /**
3839
- * The response body as text (string format)
3840
- */
3841
- bodyAsText: string;
3842
- /**
3843
- * The response body as parsed JSON or XML
3844
- */
3845
- parsedBody: Pool;
3846
- };
3847
- };
3848
- /**
3849
- * Contains response data for the deleteMethod operation.
3850
- */
3851
- export declare type PoolDeleteResponse = PoolDeleteHeaders & {
3852
- /**
3853
- * The underlying HTTP response.
3854
- */
3855
- _response: msRest.HttpResponse & {
3856
- /**
3857
- * The parsed HTTP response headers.
3858
- */
3859
- parsedHeaders: PoolDeleteHeaders;
3860
- };
3861
- };
3862
- /**
3863
- * Contains response data for the get operation.
3864
- */
3865
- export declare type PoolGetResponse = Pool & PoolGetHeaders & {
3866
- /**
3867
- * The underlying HTTP response.
3868
- */
3869
- _response: msRest.HttpResponse & {
3870
- /**
3871
- * The parsed HTTP response headers.
3872
- */
3873
- parsedHeaders: PoolGetHeaders;
3874
- /**
3875
- * The response body as text (string format)
3876
- */
3877
- bodyAsText: string;
3878
- /**
3879
- * The response body as parsed JSON or XML
3880
- */
3881
- parsedBody: Pool;
3882
- };
3883
- };
3884
- /**
3885
- * Contains response data for the disableAutoScale operation.
3886
- */
3887
- export declare type PoolDisableAutoScaleResponse = Pool & PoolDisableAutoScaleHeaders & {
3888
- /**
3889
- * The underlying HTTP response.
3890
- */
3891
- _response: msRest.HttpResponse & {
3892
- /**
3893
- * The parsed HTTP response headers.
3894
- */
3895
- parsedHeaders: PoolDisableAutoScaleHeaders;
3896
- /**
3897
- * The response body as text (string format)
3898
- */
3899
- bodyAsText: string;
3900
- /**
3901
- * The response body as parsed JSON or XML
3902
- */
3903
- parsedBody: Pool;
3904
- };
3905
- };
3906
- /**
3907
- * Contains response data for the stopResize operation.
3908
- */
3909
- export declare type PoolStopResizeResponse = Pool & PoolStopResizeHeaders & {
3910
- /**
3911
- * The underlying HTTP response.
3912
- */
3913
- _response: msRest.HttpResponse & {
3914
- /**
3915
- * The parsed HTTP response headers.
3916
- */
3917
- parsedHeaders: PoolStopResizeHeaders;
3918
- /**
3919
- * The response body as text (string format)
3920
- */
3921
- bodyAsText: string;
3922
- /**
3923
- * The response body as parsed JSON or XML
3924
- */
3925
- parsedBody: Pool;
3926
- };
3927
- };
3928
- /**
3929
- * Contains response data for the listByBatchAccountNext operation.
3930
- */
3931
- export declare type PoolListByBatchAccountNextResponse = ListPoolsResult & {
3932
- /**
3933
- * The underlying HTTP response.
3934
- */
3935
- _response: msRest.HttpResponse & {
3936
- /**
3937
- * The response body as text (string format)
3938
- */
3939
- bodyAsText: string;
3940
- /**
3941
- * The response body as parsed JSON or XML
3942
- */
3943
- parsedBody: ListPoolsResult;
3944
- };
3945
- };
3946
- //# sourceMappingURL=index.d.ts.map