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