@azure-rest/batch 1.0.0-beta.1 → 1.0.0-beta.3

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 (190) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +5 -4
  3. package/dist/browser/batchClient.d.ts +3 -3
  4. package/dist/browser/batchClient.js +20 -24
  5. package/dist/browser/batchClient.js.map +1 -1
  6. package/dist/browser/clientDefinitions.d.ts +68 -7
  7. package/dist/browser/clientDefinitions.js +1 -1
  8. package/dist/browser/clientDefinitions.js.map +1 -1
  9. package/dist/browser/credentials/batchSharedKeyCredentials-browser.mjs.map +1 -1
  10. package/dist/browser/credentials/batchSharedKeyCredentials.js +1 -1
  11. package/dist/browser/index.d.ts +0 -1
  12. package/dist/browser/index.js +1 -2
  13. package/dist/browser/index.js.map +1 -1
  14. package/dist/browser/isUnexpected.d.ts +9 -1
  15. package/dist/browser/isUnexpected.js +15 -6
  16. package/dist/browser/isUnexpected.js.map +1 -1
  17. package/dist/browser/logger.js +1 -1
  18. package/dist/browser/logger.js.map +1 -1
  19. package/dist/browser/models.d.ts +485 -156
  20. package/dist/browser/models.js +1 -1
  21. package/dist/browser/models.js.map +1 -1
  22. package/dist/browser/outputModels.d.ts +532 -155
  23. package/dist/browser/outputModels.js +1 -1
  24. package/dist/browser/outputModels.js.map +1 -1
  25. package/dist/browser/paginateHelper.d.ts +28 -3
  26. package/dist/browser/paginateHelper.js +70 -3
  27. package/dist/browser/paginateHelper.js.map +1 -1
  28. package/dist/browser/parameters.d.ts +546 -58
  29. package/dist/browser/parameters.js +1 -1
  30. package/dist/browser/parameters.js.map +1 -1
  31. package/dist/browser/responses.d.ts +178 -4
  32. package/dist/browser/responses.js +1 -1
  33. package/dist/browser/responses.js.map +1 -1
  34. package/dist/commonjs/batchClient.d.ts +3 -3
  35. package/dist/commonjs/batchClient.js +20 -24
  36. package/dist/commonjs/batchClient.js.map +1 -1
  37. package/dist/commonjs/clientDefinitions.d.ts +68 -7
  38. package/dist/commonjs/clientDefinitions.js +1 -1
  39. package/dist/commonjs/clientDefinitions.js.map +1 -1
  40. package/dist/commonjs/credentials/batchSharedKeyCredentials.d.ts +1 -1
  41. package/dist/commonjs/credentials/batchSharedKeyCredentials.js +2 -3
  42. package/dist/commonjs/credentials/batchSharedKeyCredentials.js.map +1 -1
  43. package/dist/commonjs/index.d.ts +0 -1
  44. package/dist/commonjs/index.js +1 -2
  45. package/dist/commonjs/index.js.map +1 -1
  46. package/dist/commonjs/isUnexpected.d.ts +9 -1
  47. package/dist/commonjs/isUnexpected.js +15 -6
  48. package/dist/commonjs/isUnexpected.js.map +1 -1
  49. package/dist/commonjs/logger.js +1 -1
  50. package/dist/commonjs/logger.js.map +1 -1
  51. package/dist/commonjs/models.d.ts +485 -156
  52. package/dist/commonjs/models.js +1 -1
  53. package/dist/commonjs/models.js.map +1 -1
  54. package/dist/commonjs/outputModels.d.ts +532 -155
  55. package/dist/commonjs/outputModels.js +1 -1
  56. package/dist/commonjs/outputModels.js.map +1 -1
  57. package/dist/commonjs/paginateHelper.d.ts +28 -3
  58. package/dist/commonjs/paginateHelper.js +71 -4
  59. package/dist/commonjs/paginateHelper.js.map +1 -1
  60. package/dist/commonjs/parameters.d.ts +546 -58
  61. package/dist/commonjs/parameters.js +1 -1
  62. package/dist/commonjs/parameters.js.map +1 -1
  63. package/dist/commonjs/responses.d.ts +178 -4
  64. package/dist/commonjs/responses.js +1 -1
  65. package/dist/commonjs/responses.js.map +1 -1
  66. package/dist/commonjs/tsdoc-metadata.json +11 -11
  67. package/dist/esm/batchClient.d.ts +3 -3
  68. package/dist/esm/batchClient.js +20 -24
  69. package/dist/esm/batchClient.js.map +1 -1
  70. package/dist/esm/clientDefinitions.d.ts +68 -7
  71. package/dist/esm/clientDefinitions.js +1 -1
  72. package/dist/esm/clientDefinitions.js.map +1 -1
  73. package/dist/esm/credentials/batchSharedKeyCredentials.d.ts +1 -1
  74. package/dist/esm/credentials/batchSharedKeyCredentials.js +2 -3
  75. package/dist/esm/credentials/batchSharedKeyCredentials.js.map +1 -1
  76. package/dist/esm/index.d.ts +0 -1
  77. package/dist/esm/index.js +1 -2
  78. package/dist/esm/index.js.map +1 -1
  79. package/dist/esm/isUnexpected.d.ts +9 -1
  80. package/dist/esm/isUnexpected.js +15 -6
  81. package/dist/esm/isUnexpected.js.map +1 -1
  82. package/dist/esm/logger.js +1 -1
  83. package/dist/esm/logger.js.map +1 -1
  84. package/dist/esm/models.d.ts +485 -156
  85. package/dist/esm/models.js +1 -1
  86. package/dist/esm/models.js.map +1 -1
  87. package/dist/esm/outputModels.d.ts +532 -155
  88. package/dist/esm/outputModels.js +1 -1
  89. package/dist/esm/outputModels.js.map +1 -1
  90. package/dist/esm/paginateHelper.d.ts +28 -3
  91. package/dist/esm/paginateHelper.js +70 -3
  92. package/dist/esm/paginateHelper.js.map +1 -1
  93. package/dist/esm/parameters.d.ts +546 -58
  94. package/dist/esm/parameters.js +1 -1
  95. package/dist/esm/parameters.js.map +1 -1
  96. package/dist/esm/responses.d.ts +178 -4
  97. package/dist/esm/responses.js +1 -1
  98. package/dist/esm/responses.js.map +1 -1
  99. package/dist/react-native/batchClient.d.ts +3 -3
  100. package/dist/react-native/batchClient.js +20 -24
  101. package/dist/react-native/batchClient.js.map +1 -1
  102. package/dist/react-native/clientDefinitions.d.ts +68 -7
  103. package/dist/react-native/clientDefinitions.js +1 -1
  104. package/dist/react-native/clientDefinitions.js.map +1 -1
  105. package/dist/react-native/credentials/batchSharedKeyCredentials-react-native.mjs.map +1 -1
  106. package/dist/react-native/credentials/batchSharedKeyCredentials.js +1 -1
  107. package/dist/react-native/index.d.ts +0 -1
  108. package/dist/react-native/index.js +1 -2
  109. package/dist/react-native/index.js.map +1 -1
  110. package/dist/react-native/isUnexpected.d.ts +9 -1
  111. package/dist/react-native/isUnexpected.js +15 -6
  112. package/dist/react-native/isUnexpected.js.map +1 -1
  113. package/dist/react-native/logger.js +1 -1
  114. package/dist/react-native/logger.js.map +1 -1
  115. package/dist/react-native/models.d.ts +485 -156
  116. package/dist/react-native/models.js +1 -1
  117. package/dist/react-native/models.js.map +1 -1
  118. package/dist/react-native/outputModels.d.ts +532 -155
  119. package/dist/react-native/outputModels.js +1 -1
  120. package/dist/react-native/outputModels.js.map +1 -1
  121. package/dist/react-native/paginateHelper.d.ts +28 -3
  122. package/dist/react-native/paginateHelper.js +70 -3
  123. package/dist/react-native/paginateHelper.js.map +1 -1
  124. package/dist/react-native/parameters.d.ts +546 -58
  125. package/dist/react-native/parameters.js +1 -1
  126. package/dist/react-native/parameters.js.map +1 -1
  127. package/dist/react-native/responses.d.ts +178 -4
  128. package/dist/react-native/responses.js +1 -1
  129. package/dist/react-native/responses.js.map +1 -1
  130. package/package.json +33 -51
  131. package/dist/browser/batchClient.d.ts.map +0 -1
  132. package/dist/browser/clientDefinitions.d.ts.map +0 -1
  133. package/dist/browser/credentials/batchSharedKeyCredentials-browser.d.mts.map +0 -1
  134. package/dist/browser/index.d.ts.map +0 -1
  135. package/dist/browser/isUnexpected.d.ts.map +0 -1
  136. package/dist/browser/logger.d.ts.map +0 -1
  137. package/dist/browser/models.d.ts.map +0 -1
  138. package/dist/browser/outputModels.d.ts.map +0 -1
  139. package/dist/browser/paginateHelper.d.ts.map +0 -1
  140. package/dist/browser/parameters.d.ts.map +0 -1
  141. package/dist/browser/replacePoolPropertiesPolicy.d.ts +0 -11
  142. package/dist/browser/replacePoolPropertiesPolicy.d.ts.map +0 -1
  143. package/dist/browser/replacePoolPropertiesPolicy.js +0 -33
  144. package/dist/browser/replacePoolPropertiesPolicy.js.map +0 -1
  145. package/dist/browser/responses.d.ts.map +0 -1
  146. package/dist/commonjs/batchClient.d.ts.map +0 -1
  147. package/dist/commonjs/clientDefinitions.d.ts.map +0 -1
  148. package/dist/commonjs/credentials/batchSharedKeyCredentials.d.ts.map +0 -1
  149. package/dist/commonjs/index.d.ts.map +0 -1
  150. package/dist/commonjs/isUnexpected.d.ts.map +0 -1
  151. package/dist/commonjs/logger.d.ts.map +0 -1
  152. package/dist/commonjs/models.d.ts.map +0 -1
  153. package/dist/commonjs/outputModels.d.ts.map +0 -1
  154. package/dist/commonjs/paginateHelper.d.ts.map +0 -1
  155. package/dist/commonjs/parameters.d.ts.map +0 -1
  156. package/dist/commonjs/replacePoolPropertiesPolicy.d.ts +0 -11
  157. package/dist/commonjs/replacePoolPropertiesPolicy.d.ts.map +0 -1
  158. package/dist/commonjs/replacePoolPropertiesPolicy.js +0 -36
  159. package/dist/commonjs/replacePoolPropertiesPolicy.js.map +0 -1
  160. package/dist/commonjs/responses.d.ts.map +0 -1
  161. package/dist/esm/batchClient.d.ts.map +0 -1
  162. package/dist/esm/clientDefinitions.d.ts.map +0 -1
  163. package/dist/esm/credentials/batchSharedKeyCredentials.d.ts.map +0 -1
  164. package/dist/esm/index.d.ts.map +0 -1
  165. package/dist/esm/isUnexpected.d.ts.map +0 -1
  166. package/dist/esm/logger.d.ts.map +0 -1
  167. package/dist/esm/models.d.ts.map +0 -1
  168. package/dist/esm/outputModels.d.ts.map +0 -1
  169. package/dist/esm/paginateHelper.d.ts.map +0 -1
  170. package/dist/esm/parameters.d.ts.map +0 -1
  171. package/dist/esm/replacePoolPropertiesPolicy.d.ts +0 -11
  172. package/dist/esm/replacePoolPropertiesPolicy.d.ts.map +0 -1
  173. package/dist/esm/replacePoolPropertiesPolicy.js +0 -33
  174. package/dist/esm/replacePoolPropertiesPolicy.js.map +0 -1
  175. package/dist/esm/responses.d.ts.map +0 -1
  176. package/dist/react-native/batchClient.d.ts.map +0 -1
  177. package/dist/react-native/clientDefinitions.d.ts.map +0 -1
  178. package/dist/react-native/credentials/batchSharedKeyCredentials-react-native.d.mts.map +0 -1
  179. package/dist/react-native/index.d.ts.map +0 -1
  180. package/dist/react-native/isUnexpected.d.ts.map +0 -1
  181. package/dist/react-native/logger.d.ts.map +0 -1
  182. package/dist/react-native/models.d.ts.map +0 -1
  183. package/dist/react-native/outputModels.d.ts.map +0 -1
  184. package/dist/react-native/paginateHelper.d.ts.map +0 -1
  185. package/dist/react-native/parameters.d.ts.map +0 -1
  186. package/dist/react-native/replacePoolPropertiesPolicy.d.ts +0 -11
  187. package/dist/react-native/replacePoolPropertiesPolicy.d.ts.map +0 -1
  188. package/dist/react-native/replacePoolPropertiesPolicy.js +0 -33
  189. package/dist/react-native/replacePoolPropertiesPolicy.js.map +0 -1
  190. package/dist/react-native/responses.d.ts.map +0 -1
@@ -17,7 +17,7 @@ export interface BatchApplicationOutput {
17
17
  /** An error response received from the Azure Batch service. */
18
18
  export interface BatchErrorOutput {
19
19
  /** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
20
- code: string;
20
+ code?: string;
21
21
  /** A message describing the error, intended to be suitable for display in a user interface. */
22
22
  message?: BatchErrorMessageOutput;
23
23
  /** A collection of key-value pairs containing additional details about the error. */
@@ -52,7 +52,7 @@ export interface BatchPoolUsageMetricsOutput {
52
52
  startTime: string;
53
53
  /** The end time of the aggregation interval covered by this entry. */
54
54
  endTime: string;
55
- /** The size of virtual machines in the Pool. All VMs in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). */
55
+ /** The size of virtual machines in the Pool. All VMs in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). */
56
56
  vmSize: string;
57
57
  /** The total core hours used in the Pool during this aggregation interval. */
58
58
  totalCoreHours: number;
@@ -63,12 +63,12 @@ export interface BatchPoolUsageMetricsOutput {
63
63
  */
64
64
  export interface VirtualMachineConfigurationOutput {
65
65
  /** A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. */
66
- imageReference: ImageReferenceOutput;
66
+ imageReference: BatchVmImageReferenceOutput;
67
67
  /** The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation. */
68
68
  nodeAgentSKUId: string;
69
69
  /** Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. */
70
70
  windowsConfiguration?: WindowsConfigurationOutput;
71
- /** The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. */
71
+ /** The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. */
72
72
  dataDisks?: Array<DataDiskOutput>;
73
73
  /**
74
74
  * This only applies to Images that contain the Windows operating system, and
@@ -83,7 +83,7 @@ export interface VirtualMachineConfigurationOutput {
83
83
  */
84
84
  licenseType?: string;
85
85
  /** The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it. */
86
- containerConfiguration?: ContainerConfigurationOutput;
86
+ containerConfiguration?: BatchContainerConfigurationOutput;
87
87
  /** The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. */
88
88
  diskEncryptionConfiguration?: DiskEncryptionConfigurationOutput;
89
89
  /** The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. */
@@ -91,7 +91,7 @@ export interface VirtualMachineConfigurationOutput {
91
91
  /** The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. */
92
92
  extensions?: Array<VMExtensionOutput>;
93
93
  /** Settings for the operating system disk of the Virtual Machine. */
94
- osDisk?: OSDiskOutput;
94
+ osDisk?: BatchOsDiskOutput;
95
95
  /** Specifies the security profile settings for the virtual machine or virtual machine scale set. */
96
96
  securityProfile?: SecurityProfileOutput;
97
97
  /** Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} */
@@ -102,7 +102,7 @@ export interface VirtualMachineConfigurationOutput {
102
102
  * To get the list of all Azure Marketplace Image references verified by Azure Batch, see the
103
103
  * ' List Supported Images ' operation.
104
104
  */
105
- export interface ImageReferenceOutput {
105
+ export interface BatchVmImageReferenceOutput {
106
106
  /** The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. */
107
107
  publisher?: string;
108
108
  /** The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. */
@@ -111,10 +111,14 @@ export interface ImageReferenceOutput {
111
111
  sku?: string;
112
112
  /** The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'. */
113
113
  version?: string;
114
- /** The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. */
114
+ /** The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. */
115
115
  virtualMachineImageId?: string;
116
116
  /** The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. */
117
117
  readonly exactVersion?: string;
118
+ /** The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. */
119
+ sharedGalleryImageId?: string;
120
+ /** The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. */
121
+ communityGalleryImageId?: string;
118
122
  }
119
123
  /** Windows operating system settings to apply to the virtual machine. */
120
124
  export interface WindowsConfigurationOutput {
@@ -129,16 +133,28 @@ export interface WindowsConfigurationOutput {
129
133
  export interface DataDiskOutput {
130
134
  /** The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. */
131
135
  lun: number;
132
- /** The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. */
136
+ /**
137
+ * The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
138
+ *
139
+ * Possible values: "none", "readonly", "readwrite"
140
+ */
133
141
  caching?: CachingTypeOutput;
134
142
  /** The initial disk size in gigabytes. */
135
143
  diskSizeGB: number;
136
- /** The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". */
144
+ /**
145
+ * The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs".
146
+ *
147
+ * Possible values: "standard_lrs", "premium_lrs", "standardssd_lrs"
148
+ */
137
149
  storageAccountType?: StorageAccountTypeOutput;
138
150
  }
139
151
  /** The configuration for container-enabled Pools. */
140
- export interface ContainerConfigurationOutput {
141
- /** The container technology to be used. */
152
+ export interface BatchContainerConfigurationOutput {
153
+ /**
154
+ * The container technology to be used.
155
+ *
156
+ * Possible values: "dockerCompatible", "criCompatible"
157
+ */
142
158
  type: ContainerTypeOutput;
143
159
  /** The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. */
144
160
  containerImageNames?: string[];
@@ -170,7 +186,7 @@ export interface BatchNodeIdentityReferenceOutput {
170
186
  * Azure Compute Gallery Image.
171
187
  */
172
188
  export interface DiskEncryptionConfigurationOutput {
173
- /** The list of disk targets Batch Service will encrypt on the compute node. If omitted, no disks on the compute nodes in the pool will be encrypted. On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. */
189
+ /** The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node. */
174
190
  targets?: DiskEncryptionTargetOutput[];
175
191
  }
176
192
  /**
@@ -179,7 +195,11 @@ export interface DiskEncryptionConfigurationOutput {
179
195
  * with best effort balancing.
180
196
  */
181
197
  export interface BatchNodePlacementConfigurationOutput {
182
- /** Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. */
198
+ /**
199
+ * Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.
200
+ *
201
+ * Possible values: "regional", "zonal"
202
+ */
183
203
  policy?: BatchNodePlacementPolicyTypeOutput;
184
204
  }
185
205
  /** The configuration for virtual machine extensions. */
@@ -204,10 +224,14 @@ export interface VMExtensionOutput {
204
224
  provisionAfterExtensions?: string[];
205
225
  }
206
226
  /** Settings for the operating system disk of the compute node (VM). */
207
- export interface OSDiskOutput {
227
+ export interface BatchOsDiskOutput {
208
228
  /** Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). */
209
- ephemeralOSDiskSettings?: DiffDiskSettingsOutput;
210
- /** Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage. */
229
+ ephemeralOSDiskSettings?: BatchDiffDiskSettingsOutput;
230
+ /**
231
+ * Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
232
+ *
233
+ * Possible values: "none", "readonly", "readwrite"
234
+ */
211
235
  caching?: CachingTypeOutput;
212
236
  /** The initial disk size in GB when creating new OS disk. */
213
237
  diskSizeGB?: number;
@@ -220,26 +244,49 @@ export interface OSDiskOutput {
220
244
  * Specifies the ephemeral Disk Settings for the operating system disk used by the
221
245
  * compute node (VM).
222
246
  */
223
- export interface DiffDiskSettingsOutput {
224
- /** Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. */
247
+ export interface BatchDiffDiskSettingsOutput {
248
+ /**
249
+ * Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.
250
+ *
251
+ * Possible values: "cachedisk"
252
+ */
225
253
  placement?: DiffDiskPlacementOutput;
226
254
  }
227
255
  /** The managed disk parameters. */
228
256
  export interface ManagedDiskOutput {
229
- /** The storage account type for managed disk. */
230
- storageAccountType: StorageAccountTypeOutput;
257
+ /**
258
+ * The storage account type for managed disk.
259
+ *
260
+ * Possible values: "standard_lrs", "premium_lrs", "standardssd_lrs"
261
+ */
262
+ storageAccountType?: StorageAccountTypeOutput;
263
+ /** Specifies the security profile settings for the managed disk. */
264
+ securityProfile?: BatchVmDiskSecurityProfileOutput;
265
+ }
266
+ /** Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and required when using Confidential VMs. */
267
+ export interface BatchVmDiskSecurityProfileOutput {
268
+ /**
269
+ * Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs.
270
+ *
271
+ * Possible values: "NonPersistedTPM", "VMGuestStateOnly"
272
+ */
273
+ securityEncryptionType?: SecurityEncryptionTypesOutput;
231
274
  }
232
275
  /** Specifies the security profile settings for the virtual machine or virtual machine scale set. */
233
276
  export interface SecurityProfileOutput {
234
- /** This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. */
235
- encryptionAtHost: boolean;
236
- /** Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. */
237
- securityType: SecurityTypesOutput;
277
+ /** This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. */
278
+ encryptionAtHost?: boolean;
279
+ /**
280
+ * Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
281
+ *
282
+ * Possible values: "trustedLaunch", "confidentialVM"
283
+ */
284
+ securityType?: SecurityTypesOutput;
238
285
  /** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine. */
239
- uefiSettings: UefiSettingsOutput;
286
+ uefiSettings?: BatchUefiSettingsOutput;
240
287
  }
241
288
  /** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. */
242
- export interface UefiSettingsOutput {
289
+ export interface BatchUefiSettingsOutput {
243
290
  /** Specifies whether secure boot should be enabled on the virtual machine. */
244
291
  secureBootEnabled?: boolean;
245
292
  /** Specifies whether vTPM should be enabled on the virtual machine. */
@@ -255,32 +302,40 @@ export interface ServiceArtifactReferenceOutput {
255
302
  }
256
303
  /** The network configuration for a Pool. */
257
304
  export interface NetworkConfigurationOutput {
258
- /** The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. For Pools created with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For Pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. */
305
+ /** The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration */
259
306
  subnetId?: string;
260
- /** The scope of dynamic vnet assignment. */
307
+ /**
308
+ * The scope of dynamic vnet assignment.
309
+ *
310
+ * Possible values: "none", "job"
311
+ */
261
312
  dynamicVNetAssignmentScope?: DynamicVNetAssignmentScopeOutput;
262
- /** The configuration for endpoints on Compute Nodes in the Batch Pool. Pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property. */
313
+ /** The configuration for endpoints on Compute Nodes in the Batch Pool. */
263
314
  endpointConfiguration?: BatchPoolEndpointConfigurationOutput;
264
- /** The Public IPAddress configuration for Compute Nodes in the Batch Pool. Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property. */
265
- publicIPAddressConfiguration?: PublicIpAddressConfigurationOutput;
315
+ /** The Public IPAddress configuration for Compute Nodes in the Batch Pool. */
316
+ publicIPAddressConfiguration?: BatchPublicIpAddressConfigurationOutput;
266
317
  /** Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. */
267
318
  enableAcceleratedNetworking?: boolean;
268
319
  }
269
320
  /** The endpoint configuration for a Pool. */
270
321
  export interface BatchPoolEndpointConfigurationOutput {
271
322
  /** A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. */
272
- inboundNATPools: Array<InboundNatPoolOutput>;
323
+ inboundNATPools: Array<BatchInboundNatPoolOutput>;
273
324
  }
274
325
  /**
275
326
  * A inbound NAT Pool that can be used to address specific ports on Compute Nodes
276
327
  * in a Batch Pool externally.
277
328
  */
278
- export interface InboundNatPoolOutput {
329
+ export interface BatchInboundNatPoolOutput {
279
330
  /** The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. */
280
331
  name: string;
281
- /** The protocol of the endpoint. */
332
+ /**
333
+ * The protocol of the endpoint.
334
+ *
335
+ * Possible values: "tcp", "udp"
336
+ */
282
337
  protocol: InboundEndpointProtocolOutput;
283
- /** The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. */
338
+ /** The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. */
284
339
  backendPort: number;
285
340
  /** The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. */
286
341
  frontendPortRangeStart: number;
@@ -293,7 +348,11 @@ export interface InboundNatPoolOutput {
293
348
  export interface NetworkSecurityGroupRuleOutput {
294
349
  /** The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. */
295
350
  priority: number;
296
- /** The action that should be taken for a specified IP address, subnet range or tag. */
351
+ /**
352
+ * The action that should be taken for a specified IP address, subnet range or tag.
353
+ *
354
+ * Possible values: "allow", "deny"
355
+ */
297
356
  access: NetworkSecurityGroupRuleAccessOutput;
298
357
  /** The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. */
299
358
  sourceAddressPrefix: string;
@@ -301,8 +360,12 @@ export interface NetworkSecurityGroupRuleOutput {
301
360
  sourcePortRanges?: string[];
302
361
  }
303
362
  /** The public IP Address configuration of the networking configuration of a Pool. */
304
- export interface PublicIpAddressConfigurationOutput {
305
- /** The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. */
363
+ export interface BatchPublicIpAddressConfigurationOutput {
364
+ /**
365
+ * The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged.
366
+ *
367
+ * Possible values: "batchmanaged", "usermanaged", "nopublicipaddresses"
368
+ */
306
369
  provision?: IpAddressProvisioningTypeOutput;
307
370
  /** The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. */
308
371
  ipAddressIds?: string[];
@@ -323,7 +386,7 @@ export interface PublicIpAddressConfigurationOutput {
323
386
  * block Batch from being able to re-run the StartTask.
324
387
  */
325
388
  export interface BatchStartTaskOutput {
326
- /** The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */
389
+ /** The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). */
327
390
  commandLine: string;
328
391
  /** The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. */
329
392
  containerSettings?: BatchTaskContainerSettingsOutput;
@@ -346,8 +409,25 @@ export interface BatchTaskContainerSettingsOutput {
346
409
  imageName: string;
347
410
  /** The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. */
348
411
  registry?: ContainerRegistryReferenceOutput;
349
- /** The location of the container Task working directory. The default is 'taskWorkingDirectory'. */
412
+ /**
413
+ * The location of the container Task working directory. The default is 'taskWorkingDirectory'.
414
+ *
415
+ * Possible values: "taskWorkingDirectory", "containerImageDefault"
416
+ */
350
417
  workingDirectory?: ContainerWorkingDirectoryOutput;
418
+ /** The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. */
419
+ containerHostBatchBindMounts?: Array<ContainerHostBatchBindMountEntryOutput>;
420
+ }
421
+ /** The entry of path and mount mode you want to mount into task container. */
422
+ export interface ContainerHostBatchBindMountEntryOutput {
423
+ /**
424
+ * The path which be mounted to container customer can select.
425
+ *
426
+ * Possible values: "Shared", "Startup", "VfsMounts", "Task", "JobPrep", "Applications"
427
+ */
428
+ source?: ContainerHostDataPathOutput;
429
+ /** Mount this source path as read-only mode or not. Default value is false (read/write mode). For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. */
430
+ isReadOnly?: boolean;
351
431
  }
352
432
  /** A single file or multiple files to be downloaded to a Compute Node. */
353
433
  export interface ResourceFileOutput {
@@ -382,11 +462,36 @@ export interface UserIdentityOutput {
382
462
  }
383
463
  /** Specifies the options for the auto user that runs an Azure Batch Task. */
384
464
  export interface AutoUserSpecificationOutput {
385
- /** The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks. */
465
+ /**
466
+ * The scope for the auto user. The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks.
467
+ *
468
+ * Possible values: "task", "pool"
469
+ */
386
470
  scope?: AutoUserScopeOutput;
387
- /** The elevation level of the auto user. The default value is nonAdmin. */
471
+ /**
472
+ * The elevation level of the auto user. The default value is nonAdmin.
473
+ *
474
+ * Possible values: "nonadmin", "admin"
475
+ */
388
476
  elevationLevel?: ElevationLevelOutput;
389
477
  }
478
+ /** A reference to a Certificate to be installed on Compute Nodes in a Pool. Warning: This object is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead. */
479
+ export interface BatchCertificateReferenceOutput {
480
+ /** The thumbprint of the Certificate. */
481
+ thumbprint: string;
482
+ /** The algorithm with which the thumbprint is associated. This must be sha1. */
483
+ thumbprintAlgorithm: string;
484
+ /**
485
+ * The location of the Certificate store on the Compute Node into which to install the Certificate. The default value is currentuser. This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.
486
+ *
487
+ * Possible values: "currentuser", "localmachine"
488
+ */
489
+ storeLocation?: BatchCertificateStoreLocationOutput;
490
+ /** The name of the Certificate store on the Compute Node into which to install the Certificate. This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My. */
491
+ storeName?: string;
492
+ /** Which user Accounts on the Compute Node should have access to the private data of the Certificate. You can specify more than one visibility in this collection. The default is all Accounts. */
493
+ visibility?: BatchCertificateVisibilityOutput[];
494
+ }
390
495
  /** A reference to an Package to be deployed to Compute Nodes. */
391
496
  export interface BatchApplicationPackageReferenceOutput {
392
497
  /** The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). */
@@ -396,7 +501,11 @@ export interface BatchApplicationPackageReferenceOutput {
396
501
  }
397
502
  /** Specifies how Tasks should be distributed across Compute Nodes. */
398
503
  export interface BatchTaskSchedulingPolicyOutput {
399
- /** How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. */
504
+ /**
505
+ * How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.
506
+ *
507
+ * Possible values: "spread", "pack"
508
+ */
400
509
  nodeFillType: BatchNodeFillTypeOutput;
401
510
  }
402
511
  /**
@@ -408,7 +517,11 @@ export interface UserAccountOutput {
408
517
  name: string;
409
518
  /** The password for the user Account. */
410
519
  password: string;
411
- /** The elevation level of the user Account. The default value is nonAdmin. */
520
+ /**
521
+ * The elevation level of the user Account. The default value is nonAdmin.
522
+ *
523
+ * Possible values: "nonadmin", "admin"
524
+ */
412
525
  elevationLevel?: ElevationLevelOutput;
413
526
  /** The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options. */
414
527
  linuxUserConfiguration?: LinuxUserConfigurationOutput;
@@ -426,14 +539,18 @@ export interface LinuxUserConfigurationOutput {
426
539
  }
427
540
  /** Properties used to create a user Account on a Windows Compute Node. */
428
541
  export interface WindowsUserConfigurationOutput {
429
- /** The login mode for the user. The default value for VirtualMachineConfiguration Pools is 'batch'. */
542
+ /**
543
+ * The login mode for the user. The default is 'batch'.
544
+ *
545
+ * Possible values: "batch", "interactive"
546
+ */
430
547
  loginMode?: LoginModeOutput;
431
548
  }
432
549
  /**
433
550
  * The Batch service does not assign any meaning to this metadata; it is solely
434
551
  * for the use of user code.
435
552
  */
436
- export interface MetadataItemOutput {
553
+ export interface BatchMetadataItemOutput {
437
554
  /** The name of the metadata item. */
438
555
  name: string;
439
556
  /** The value of the metadata item. */
@@ -493,10 +610,10 @@ export interface CifsMountConfigurationOutput {
493
610
  export interface AzureFileShareConfigurationOutput {
494
611
  /** The Azure Storage account name. */
495
612
  accountName: string;
496
- /** The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. */
497
- azureFileUrl: string;
498
613
  /** The Azure Storage account key. */
499
614
  accountKey: string;
615
+ /** The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. */
616
+ azureFileUrl: string;
500
617
  /** The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */
501
618
  relativeMountPath: string;
502
619
  /** Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. */
@@ -504,18 +621,22 @@ export interface AzureFileShareConfigurationOutput {
504
621
  }
505
622
  /** Describes an upgrade policy - automatic, manual, or rolling. */
506
623
  export interface UpgradePolicyOutput {
507
- /** Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time.<br /><br /> **Rolling** - Scale set performs updates in batches with an optional pause time in between. */
624
+ /**
625
+ * Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time.<br /><br /> **Rolling** - Scale set performs updates in batches with an optional pause time in between.
626
+ *
627
+ * Possible values: "automatic", "manual", "rolling"
628
+ */
508
629
  mode: UpgradeModeOutput;
509
630
  /** Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade. */
510
631
  automaticOSUpgradePolicy?: AutomaticOsUpgradePolicyOutput;
511
- /** The configuration parameters used while performing a rolling upgrade. This property is only supported on Pools with the virtualMachineConfiguration property. */
632
+ /** The configuration parameters used while performing a rolling upgrade. */
512
633
  rollingUpgradePolicy?: RollingUpgradePolicyOutput;
513
634
  }
514
635
  /** The configuration parameters used for performing automatic OS upgrade. */
515
636
  export interface AutomaticOsUpgradePolicyOutput {
516
637
  /** Whether OS image rollback feature should be disabled. */
517
638
  disableAutomaticRollback?: boolean;
518
- /** Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br /><br /> If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. */
639
+ /** Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br /><br /> If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true. */
519
640
  enableAutomaticOSUpgrade?: boolean;
520
641
  /** Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. */
521
642
  useRollingUpgradePolicy?: boolean;
@@ -560,15 +681,23 @@ export interface BatchPoolOutput {
560
681
  readonly lastModified?: string;
561
682
  /** The creation time of the Pool. */
562
683
  readonly creationTime?: string;
563
- /** The current state of the Pool. */
684
+ /**
685
+ * The current state of the Pool.
686
+ *
687
+ * Possible values: "active", "deleting"
688
+ */
564
689
  readonly state?: BatchPoolStateOutput;
565
690
  /** The time at which the Pool entered its current state. */
566
691
  readonly stateTransitionTime?: string;
567
- /** Whether the Pool is resizing. */
692
+ /**
693
+ * Whether the Pool is resizing.
694
+ *
695
+ * Possible values: "steady", "resizing", "stopping"
696
+ */
568
697
  readonly allocationState?: AllocationStateOutput;
569
698
  /** The time at which the Pool entered its current allocation state. */
570
699
  readonly allocationStateTransitionTime?: string;
571
- /** The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). */
700
+ /** The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). */
572
701
  readonly vmSize?: string;
573
702
  /** The virtual machine configuration for the Pool. This property must be specified. */
574
703
  readonly virtualMachineConfiguration?: VirtualMachineConfigurationOutput;
@@ -600,6 +729,13 @@ export interface BatchPoolOutput {
600
729
  readonly networkConfiguration?: NetworkConfigurationOutput;
601
730
  /** A Task specified to run on each Compute Node as it joins the Pool. */
602
731
  startTask?: BatchStartTaskOutput;
732
+ /**
733
+ * For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location.
734
+ * For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location.
735
+ * For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.
736
+ * Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.
737
+ */
738
+ readonly certificateReferences?: Array<BatchCertificateReferenceOutput>;
603
739
  /** The list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. */
604
740
  readonly applicationPackageReferences?: Array<BatchApplicationPackageReferenceOutput>;
605
741
  /** The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. */
@@ -609,16 +745,24 @@ export interface BatchPoolOutput {
609
745
  /** The list of user Accounts to be created on each Compute Node in the Pool. */
610
746
  readonly userAccounts?: Array<UserAccountOutput>;
611
747
  /** A list of name-value pairs associated with the Pool as metadata. */
612
- readonly metadata?: Array<MetadataItemOutput>;
613
- /** Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. */
748
+ readonly metadata?: Array<BatchMetadataItemOutput>;
749
+ /** Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the BatchPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. */
614
750
  readonly stats?: BatchPoolStatisticsOutput;
615
751
  /** A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. */
616
752
  readonly mountConfiguration?: Array<MountConfigurationOutput>;
617
753
  /** The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
618
754
  readonly identity?: BatchPoolIdentityOutput;
619
- /** The desired node communication mode for the pool. If omitted, the default value is Default. */
755
+ /**
756
+ * The desired node communication mode for the pool. If omitted, the default value is Default.
757
+ *
758
+ * Possible values: "default", "classic", "simplified"
759
+ */
620
760
  targetNodeCommunicationMode?: BatchNodeCommunicationModeOutput;
621
- /** The current state of the pool communication mode. */
761
+ /**
762
+ * The current state of the pool communication mode.
763
+ *
764
+ * Possible values: "default", "classic", "simplified"
765
+ */
622
766
  readonly currentNodeCommunicationMode?: BatchNodeCommunicationModeOutput;
623
767
  /** The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. */
624
768
  upgradePolicy?: UpgradePolicyOutput;
@@ -696,9 +840,9 @@ export interface BatchPoolResourceStatisticsOutput {
696
840
  /** The peak used disk space in GiB across all Compute Nodes in the Pool. */
697
841
  peakDiskGiB: number;
698
842
  /** The total number of disk read operations across all Compute Nodes in the Pool. */
699
- diskReadIOps: number;
843
+ diskReadIOps: string;
700
844
  /** The total number of disk write operations across all Compute Nodes in the Pool. */
701
- diskWriteIOps: number;
845
+ diskWriteIOps: string;
702
846
  /** The total amount of data in GiB of disk reads across all Compute Nodes in the Pool. */
703
847
  diskReadGiB: number;
704
848
  /** The total amount of data in GiB of disk writes across all Compute Nodes in the Pool. */
@@ -710,13 +854,17 @@ export interface BatchPoolResourceStatisticsOutput {
710
854
  }
711
855
  /** The identity of the Batch pool, if configured. */
712
856
  export interface BatchPoolIdentityOutput {
713
- /** The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
857
+ /**
858
+ * The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
859
+ *
860
+ * Possible values: "UserAssigned", "None"
861
+ */
714
862
  type: BatchPoolIdentityTypeOutput;
715
863
  /** The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
716
- userAssignedIdentities?: Array<UserAssignedIdentityOutput>;
864
+ userAssignedIdentities?: Array<BatchUserAssignedIdentityOutput>;
717
865
  }
718
866
  /** The user assigned Identity */
719
- export interface UserAssignedIdentityOutput {
867
+ export interface BatchUserAssignedIdentityOutput {
720
868
  /** The ARM resource id of the user assigned identity. */
721
869
  resourceId: string;
722
870
  /** The client id of the user assigned identity. */
@@ -739,14 +887,22 @@ export interface BatchSupportedImageOutput {
739
887
  /** The ID of the Compute Node agent SKU which the Image supports. */
740
888
  nodeAgentSKUId: string;
741
889
  /** The reference to the Azure Virtual Machine's Marketplace Image. */
742
- imageReference: ImageReferenceOutput;
743
- /** The type of operating system (e.g. Windows or Linux) of the Image. */
890
+ imageReference: BatchVmImageReferenceOutput;
891
+ /**
892
+ * The type of operating system (e.g. Windows or Linux) of the Image.
893
+ *
894
+ * Possible values: "linux", "windows"
895
+ */
744
896
  osType: OSTypeOutput;
745
897
  /** The capabilities or features which the Image supports. Not every capability of the Image is listed. Capabilities in this list are considered of special interest and are generally related to integration with other features in the Azure Batch service. */
746
898
  capabilities?: string[];
747
899
  /** The time when the Azure Batch service will stop accepting create Pool requests for the Image. */
748
900
  batchSupportEndOfLife?: string;
749
- /** Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU. */
901
+ /**
902
+ * Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU.
903
+ *
904
+ * Possible values: "verified", "unverified"
905
+ */
750
906
  verificationType: ImageVerificationTypeOutput;
751
907
  }
752
908
  /** The result of listing the Compute Node counts in the Account. */
@@ -793,6 +949,10 @@ export interface BatchNodeCountsOutput {
793
949
  unusable: number;
794
950
  /** The number of Compute Nodes in the waitingForStartTask state. */
795
951
  waitingForStartTask: number;
952
+ /** The number of Compute Nodes in the deallocated state. */
953
+ deallocated: number;
954
+ /** The number of Compute Nodes in the deallocating state. */
955
+ deallocating: number;
796
956
  /** The total number of Compute Nodes. */
797
957
  total: number;
798
958
  /** The number of Compute Nodes in the upgradingOS state. */
@@ -814,11 +974,19 @@ export interface BatchJobOutput {
814
974
  readonly lastModified?: string;
815
975
  /** The creation time of the Job. */
816
976
  readonly creationTime?: string;
817
- /** The current state of the Job. */
977
+ /**
978
+ * The current state of the Job.
979
+ *
980
+ * Possible values: "active", "disabling", "disabled", "enabling", "terminating", "completed", "deleting"
981
+ */
818
982
  readonly state?: BatchJobStateOutput;
819
983
  /** The time at which the Job entered its current state. */
820
984
  readonly stateTransitionTime?: string;
821
- /** The previous state of the Job. This property is not set if the Job is in its initial Active state. */
985
+ /**
986
+ * The previous state of the Job. This property is not set if the Job is in its initial Active state.
987
+ *
988
+ * Possible values: "active", "disabling", "disabled", "enabling", "terminating", "completed", "deleting"
989
+ */
822
990
  readonly previousState?: BatchJobStateOutput;
823
991
  /** The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state. */
824
992
  readonly previousStateTransitionTime?: string;
@@ -840,17 +1008,25 @@ export interface BatchJobOutput {
840
1008
  readonly commonEnvironmentSettings?: Array<EnvironmentSettingOutput>;
841
1009
  /** The Pool settings associated with the Job. */
842
1010
  poolInfo: BatchPoolInfoOutput;
843
- /** The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction. */
844
- onAllTasksComplete?: OnAllBatchTasksCompleteOutput;
845
- /** The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. */
846
- readonly onTaskFailure?: OnBatchTaskFailureOutput;
1011
+ /**
1012
+ * The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction.
1013
+ *
1014
+ * Possible values: "noaction", "terminatejob"
1015
+ */
1016
+ onAllTasksComplete?: BatchAllTasksCompleteModeOutput;
1017
+ /**
1018
+ * The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.
1019
+ *
1020
+ * Possible values: "noaction", "performexitoptionsjobaction"
1021
+ */
1022
+ readonly onTaskFailure?: BatchTaskFailureModeOutput;
847
1023
  /** The network configuration for the Job. */
848
1024
  readonly networkConfiguration?: BatchJobNetworkConfigurationOutput;
849
1025
  /** A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. */
850
- metadata?: Array<MetadataItemOutput>;
1026
+ metadata?: Array<BatchMetadataItemOutput>;
851
1027
  /** The execution information for the Job. */
852
1028
  readonly executionInfo?: BatchJobExecutionInfoOutput;
853
- /** Resource usage statistics for the entire lifetime of the Job. This property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. */
1029
+ /** Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. */
854
1030
  readonly stats?: BatchJobStatisticsOutput;
855
1031
  }
856
1032
  /** The execution constraints for a Job. */
@@ -890,7 +1066,7 @@ export interface BatchJobManagerTaskOutput {
890
1066
  id: string;
891
1067
  /** The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024. */
892
1068
  displayName?: string;
893
- /** The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */
1069
+ /** The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). */
894
1070
  commandLine: string;
895
1071
  /** The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. */
896
1072
  containerSettings?: BatchTaskContainerSettingsOutput;
@@ -948,11 +1124,11 @@ export interface OutputFileBlobContainerDestinationOutput {
948
1124
  containerUrl: string;
949
1125
  /** The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container. */
950
1126
  identityReference?: BatchNodeIdentityReferenceOutput;
951
- /** A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types. */
952
- uploadHeaders?: Array<HttpHeaderOutput>;
1127
+ /** A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types. */
1128
+ uploadHeaders?: Array<OutputFileUploadHeaderOutput>;
953
1129
  }
954
1130
  /** An HTTP header name-value pair */
955
- export interface HttpHeaderOutput {
1131
+ export interface OutputFileUploadHeaderOutput {
956
1132
  /** The case-insensitive name of the header to be used while uploading output files. */
957
1133
  name: string;
958
1134
  /** The value of the header to be used while uploading output files. */
@@ -963,7 +1139,11 @@ export interface HttpHeaderOutput {
963
1139
  * to perform the upload.
964
1140
  */
965
1141
  export interface OutputFileUploadConfigOutput {
966
- /** The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. */
1142
+ /**
1143
+ * The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion.
1144
+ *
1145
+ * Possible values: "tasksuccess", "taskfailure", "taskcompletion"
1146
+ */
967
1147
  uploadCondition: OutputFileUploadConditionOutput;
968
1148
  }
969
1149
  /** Execution constraints to apply to a Task. */
@@ -981,7 +1161,7 @@ export interface BatchTaskConstraintsOutput {
981
1161
  */
982
1162
  export interface AuthenticationTokenSettingsOutput {
983
1163
  /** The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task. */
984
- access?: AccessScopeOutput[];
1164
+ access?: BatchAccessScopeOutput[];
985
1165
  }
986
1166
  /**
987
1167
  * A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.
@@ -1014,7 +1194,7 @@ export interface AuthenticationTokenSettingsOutput {
1014
1194
  export interface BatchJobPreparationTaskOutput {
1015
1195
  /** A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). */
1016
1196
  id?: string;
1017
- /** The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */
1197
+ /** The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). */
1018
1198
  commandLine: string;
1019
1199
  /** The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. */
1020
1200
  containerSettings?: BatchTaskContainerSettingsOutput;
@@ -1052,7 +1232,7 @@ export interface BatchJobPreparationTaskOutput {
1052
1232
  export interface BatchJobReleaseTaskOutput {
1053
1233
  /** A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). */
1054
1234
  id?: string;
1055
- /** The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */
1235
+ /** The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). */
1056
1236
  commandLine: string;
1057
1237
  /** The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. */
1058
1238
  containerSettings?: BatchTaskContainerSettingsOutput;
@@ -1081,7 +1261,11 @@ export interface BatchPoolInfoOutput {
1081
1261
  export interface BatchAutoPoolSpecificationOutput {
1082
1262
  /** A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. */
1083
1263
  autoPoolIdPrefix?: string;
1084
- /** The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. */
1264
+ /**
1265
+ * The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools.
1266
+ *
1267
+ * Possible values: "jobschedule", "job"
1268
+ */
1085
1269
  poolLifetimeOption: BatchPoolLifetimeOptionOutput;
1086
1270
  /** Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. */
1087
1271
  keepAlive?: boolean;
@@ -1092,9 +1276,9 @@ export interface BatchAutoPoolSpecificationOutput {
1092
1276
  export interface BatchPoolSpecificationOutput {
1093
1277
  /** The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. */
1094
1278
  displayName?: string;
1095
- /** The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). */
1279
+ /** The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). */
1096
1280
  vmSize: string;
1097
- /** The virtual machine configuration for the Pool. This property must be specified if the Pool needs to be created with Azure IaaS VMs. If it is not specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */
1281
+ /** The virtual machine configuration for the Pool. This property must be specified. */
1098
1282
  virtualMachineConfiguration?: VirtualMachineConfigurationOutput;
1099
1283
  /** The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. */
1100
1284
  taskSlotsPerNode?: number;
@@ -1120,23 +1304,35 @@ export interface BatchPoolSpecificationOutput {
1120
1304
  networkConfiguration?: NetworkConfigurationOutput;
1121
1305
  /** A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. */
1122
1306
  startTask?: BatchStartTaskOutput;
1307
+ /**
1308
+ * For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.
1309
+ * Warning: This property is deprecated and will be removed after February, 2024.
1310
+ * Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.
1311
+ */
1312
+ certificateReferences?: Array<BatchCertificateReferenceOutput>;
1123
1313
  /** The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. */
1124
1314
  applicationPackageReferences?: Array<BatchApplicationPackageReferenceOutput>;
1125
1315
  /** The list of user Accounts to be created on each Compute Node in the Pool. */
1126
1316
  userAccounts?: Array<UserAccountOutput>;
1127
1317
  /** A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. */
1128
- metadata?: Array<MetadataItemOutput>;
1318
+ metadata?: Array<BatchMetadataItemOutput>;
1129
1319
  /** A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. */
1130
1320
  mountConfiguration?: Array<MountConfigurationOutput>;
1131
- /** The desired node communication mode for the pool. If omitted, the default value is Default. */
1321
+ /**
1322
+ * The desired node communication mode for the pool. If omitted, the default value is Default.
1323
+ *
1324
+ * Possible values: "default", "classic", "simplified"
1325
+ */
1132
1326
  targetNodeCommunicationMode?: BatchNodeCommunicationModeOutput;
1133
1327
  /** The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. */
1134
1328
  upgradePolicy?: UpgradePolicyOutput;
1135
1329
  }
1136
1330
  /** The network configuration for the Job. */
1137
1331
  export interface BatchJobNetworkConfigurationOutput {
1138
- /** The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. This will only work with a VirtualMachineConfiguration Pool. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. */
1332
+ /** The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. */
1139
1333
  subnetId: string;
1334
+ /** Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false. */
1335
+ skipWithdrawFromVNet?: boolean;
1140
1336
  }
1141
1337
  /** Contains information about the execution of a Job in the Azure Batch service. */
1142
1338
  export interface BatchJobExecutionInfoOutput {
@@ -1153,8 +1349,12 @@ export interface BatchJobExecutionInfoOutput {
1153
1349
  }
1154
1350
  /** An error encountered by the Batch service when scheduling a Job. */
1155
1351
  export interface BatchJobSchedulingErrorOutput {
1156
- /** The category of the Job scheduling error. */
1157
- category: ErrorCategoryOutput;
1352
+ /**
1353
+ * The category of the Job scheduling error.
1354
+ *
1355
+ * Possible values: "usererror", "servererror"
1356
+ */
1357
+ category: BatchErrorSourceCategoryOutput;
1158
1358
  /** An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. */
1159
1359
  code?: string;
1160
1360
  /** A message describing the Job scheduling error, intended to be suitable for display in a user interface. */
@@ -1177,19 +1377,19 @@ export interface BatchJobStatisticsOutput {
1177
1377
  /** The total wall clock time of all Tasks in the Job. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries. */
1178
1378
  wallClockTime: string;
1179
1379
  /** The total number of disk read operations made by all Tasks in the Job. */
1180
- readIOps: number;
1380
+ readIOps: string;
1181
1381
  /** The total number of disk write operations made by all Tasks in the Job. */
1182
- writeIOps: number;
1382
+ writeIOps: string;
1183
1383
  /** The total amount of data in GiB read from disk by all Tasks in the Job. */
1184
1384
  readIOGiB: number;
1185
1385
  /** The total amount of data in GiB written to disk by all Tasks in the Job. */
1186
1386
  writeIOGiB: number;
1187
1387
  /** The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0. */
1188
- numSucceededTasks: number;
1388
+ numSucceededTasks: string;
1189
1389
  /** The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0. */
1190
- numFailedTasks: number;
1390
+ numFailedTasks: string;
1191
1391
  /** The total number of retries on all the Tasks in the Job during the given time range. */
1192
- numTaskRetries: number;
1392
+ numTaskRetries: string;
1193
1393
  /** The total wait time of all Tasks in the Job. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. */
1194
1394
  waitTime: string;
1195
1395
  }
@@ -1232,7 +1432,11 @@ export interface BatchJobPreparationTaskExecutionInfoOutput {
1232
1432
  startTime: string;
1233
1433
  /** The time at which the Job Preparation Task completed. This property is set only if the Task is in the Completed state. */
1234
1434
  endTime?: string;
1235
- /** The current state of the Job Preparation Task on the Compute Node. */
1435
+ /**
1436
+ * The current state of the Job Preparation Task on the Compute Node.
1437
+ *
1438
+ * Possible values: "running", "completed"
1439
+ */
1236
1440
  state: BatchJobPreparationTaskStateOutput;
1237
1441
  /** The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files. */
1238
1442
  taskRootDirectory?: string;
@@ -1248,7 +1452,11 @@ export interface BatchJobPreparationTaskExecutionInfoOutput {
1248
1452
  retryCount: number;
1249
1453
  /** The most recent time at which a retry of the Job Preparation Task started running. This property is set only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. */
1250
1454
  lastRetryTime?: string;
1251
- /** The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. */
1455
+ /**
1456
+ * The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property.
1457
+ *
1458
+ * Possible values: "success", "failure"
1459
+ */
1252
1460
  result?: BatchTaskExecutionResultOutput;
1253
1461
  }
1254
1462
  /** Contains information about the container which a Task is executing. */
@@ -1262,8 +1470,12 @@ export interface BatchTaskContainerExecutionInfoOutput {
1262
1470
  }
1263
1471
  /** Information about a Task failure. */
1264
1472
  export interface BatchTaskFailureInfoOutput {
1265
- /** The category of the Task error. */
1266
- category: ErrorCategoryOutput;
1473
+ /**
1474
+ * The category of the Task error.
1475
+ *
1476
+ * Possible values: "usererror", "servererror"
1477
+ */
1478
+ category: BatchErrorSourceCategoryOutput;
1267
1479
  /** An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. */
1268
1480
  code?: string;
1269
1481
  /** A message describing the Task error, intended to be suitable for display in a user interface. */
@@ -1280,7 +1492,11 @@ export interface BatchJobReleaseTaskExecutionInfoOutput {
1280
1492
  startTime: string;
1281
1493
  /** The time at which the Job Release Task completed. This property is set only if the Task is in the Completed state. */
1282
1494
  endTime?: string;
1283
- /** The current state of the Job Release Task on the Compute Node. */
1495
+ /**
1496
+ * The current state of the Job Release Task on the Compute Node.
1497
+ *
1498
+ * Possible values: "running", "completed"
1499
+ */
1284
1500
  state: BatchJobReleaseTaskStateOutput;
1285
1501
  /** The root directory of the Job Release Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files. */
1286
1502
  taskRootDirectory?: string;
@@ -1292,7 +1508,11 @@ export interface BatchJobReleaseTaskExecutionInfoOutput {
1292
1508
  containerInfo?: BatchTaskContainerExecutionInfoOutput;
1293
1509
  /** Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. */
1294
1510
  failureInfo?: BatchTaskFailureInfoOutput;
1295
- /** The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. */
1511
+ /**
1512
+ * The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property.
1513
+ *
1514
+ * Possible values: "success", "failure"
1515
+ */
1296
1516
  result?: BatchTaskExecutionResultOutput;
1297
1517
  }
1298
1518
  /** The Task and TaskSlot counts for a Job. */
@@ -1328,6 +1548,64 @@ export interface BatchTaskSlotCountsOutput {
1328
1548
  /** The number of TaskSlots for failed Tasks. */
1329
1549
  failed: number;
1330
1550
  }
1551
+ /**
1552
+ * A Certificate that can be installed on Compute Nodes and can be used to
1553
+ * authenticate operations on the machine.
1554
+ */
1555
+ export interface BatchCertificateOutput {
1556
+ /** The X.509 thumbprint of the Certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed). */
1557
+ thumbprint: string;
1558
+ /** The algorithm used to derive the thumbprint. This must be sha1. */
1559
+ thumbprintAlgorithm: string;
1560
+ /** The URL of the Certificate. */
1561
+ readonly url?: string;
1562
+ /**
1563
+ * The state of the Certificate.
1564
+ *
1565
+ * Possible values: "active", "deleting", "deletefailed"
1566
+ */
1567
+ readonly state?: BatchCertificateStateOutput;
1568
+ /** The time at which the Certificate entered its current state. */
1569
+ readonly stateTransitionTime?: string;
1570
+ /**
1571
+ * The previous state of the Certificate. This property is not set if the Certificate is in its initial active state.
1572
+ *
1573
+ * Possible values: "active", "deleting", "deletefailed"
1574
+ */
1575
+ readonly previousState?: BatchCertificateStateOutput;
1576
+ /** The time at which the Certificate entered its previous state. This property is not set if the Certificate is in its initial Active state. */
1577
+ readonly previousStateTransitionTime?: string;
1578
+ /** The public part of the Certificate as a base-64 encoded .cer file. */
1579
+ readonly publicData?: string;
1580
+ /** The error that occurred on the last attempt to delete this Certificate. This property is set only if the Certificate is in the DeleteFailed state. */
1581
+ readonly deleteCertificateError?: BatchCertificateDeleteErrorOutput;
1582
+ /** The base64-encoded contents of the Certificate. The maximum size is 10KB. */
1583
+ data: string;
1584
+ /**
1585
+ * The format of the Certificate data.
1586
+ *
1587
+ * Possible values: "pfx", "cer"
1588
+ */
1589
+ certificateFormat?: BatchCertificateFormatOutput;
1590
+ /** The password to access the Certificate's private key. This must be omitted if the Certificate format is cer. */
1591
+ password?: string;
1592
+ }
1593
+ /** An error encountered by the Batch service when deleting a Certificate. */
1594
+ export interface BatchCertificateDeleteErrorOutput {
1595
+ /** An identifier for the Certificate deletion error. Codes are invariant and are intended to be consumed programmatically. */
1596
+ code?: string;
1597
+ /** A message describing the Certificate deletion error, intended to be suitable for display in a user interface. */
1598
+ message?: string;
1599
+ /** A list of additional error details related to the Certificate deletion error. This list includes details such as the active Pools and Compute Nodes referencing this Certificate. However, if a large number of resources reference the Certificate, the list contains only about the first hundred. */
1600
+ values?: Array<NameValuePairOutput>;
1601
+ }
1602
+ /** The result of listing the Certificates in the Account. */
1603
+ export interface BatchCertificateListResultOutput {
1604
+ /** The list of Certificates. */
1605
+ value?: Array<BatchCertificateOutput>;
1606
+ /** The URL to get the next set of results. */
1607
+ "odata.nextLink"?: string;
1608
+ }
1331
1609
  /**
1332
1610
  * A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a
1333
1611
  * specification used to create each Job.
@@ -1345,11 +1623,19 @@ export interface BatchJobScheduleOutput {
1345
1623
  readonly lastModified?: string;
1346
1624
  /** The creation time of the Job Schedule. */
1347
1625
  readonly creationTime?: string;
1348
- /** The current state of the Job Schedule. */
1626
+ /**
1627
+ * The current state of the Job Schedule.
1628
+ *
1629
+ * Possible values: "active", "completed", "disabled", "terminating", "deleting"
1630
+ */
1349
1631
  readonly state?: BatchJobScheduleStateOutput;
1350
1632
  /** The time at which the Job Schedule entered the current state. */
1351
1633
  readonly stateTransitionTime?: string;
1352
- /** The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state. */
1634
+ /**
1635
+ * The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state.
1636
+ *
1637
+ * Possible values: "active", "completed", "disabled", "terminating", "deleting"
1638
+ */
1353
1639
  readonly previousState?: BatchJobScheduleStateOutput;
1354
1640
  /** The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state. */
1355
1641
  readonly previousStateTransitionTime?: string;
@@ -1360,7 +1646,7 @@ export interface BatchJobScheduleOutput {
1360
1646
  /** Information about Jobs that have been and will be run under this schedule. */
1361
1647
  readonly executionInfo?: BatchJobScheduleExecutionInfoOutput;
1362
1648
  /** A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. */
1363
- metadata?: Array<MetadataItemOutput>;
1649
+ metadata?: Array<BatchMetadataItemOutput>;
1364
1650
  /** The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. */
1365
1651
  readonly stats?: BatchJobScheduleStatisticsOutput;
1366
1652
  }
@@ -1390,10 +1676,18 @@ export interface BatchJobSpecificationOutput {
1390
1676
  displayName?: string;
1391
1677
  /** Whether Tasks in the Job can define dependencies on each other. The default is false. */
1392
1678
  usesTaskDependencies?: boolean;
1393
- /** The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction. */
1394
- onAllTasksComplete?: OnAllBatchTasksCompleteOutput;
1395
- /** The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. */
1396
- onTaskFailure?: OnBatchTaskFailureOutput;
1679
+ /**
1680
+ * The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction.
1681
+ *
1682
+ * Possible values: "noaction", "terminatejob"
1683
+ */
1684
+ onAllTasksComplete?: BatchAllTasksCompleteModeOutput;
1685
+ /**
1686
+ * The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.
1687
+ *
1688
+ * Possible values: "noaction", "performexitoptionsjobaction"
1689
+ */
1690
+ onTaskFailure?: BatchTaskFailureModeOutput;
1397
1691
  /** The network configuration for the Job. */
1398
1692
  networkConfiguration?: BatchJobNetworkConfigurationOutput;
1399
1693
  /** The execution constraints for Jobs created under this schedule. */
@@ -1409,7 +1703,7 @@ export interface BatchJobSpecificationOutput {
1409
1703
  /** The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. */
1410
1704
  poolInfo: BatchPoolInfoOutput;
1411
1705
  /** A list of name-value pairs associated with each Job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code. */
1412
- metadata?: Array<MetadataItemOutput>;
1706
+ metadata?: Array<BatchMetadataItemOutput>;
1413
1707
  }
1414
1708
  /**
1415
1709
  * Contains information about Jobs that have been and will be run under a Job
@@ -1445,19 +1739,19 @@ export interface BatchJobScheduleStatisticsOutput {
1445
1739
  /** The total wall clock time of all the Tasks in all the Jobs created under the schedule. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries. */
1446
1740
  wallClockTime: string;
1447
1741
  /** The total number of disk read operations made by all Tasks in all Jobs created under the schedule. */
1448
- readIOps: number;
1742
+ readIOps: string;
1449
1743
  /** The total number of disk write operations made by all Tasks in all Jobs created under the schedule. */
1450
- writeIOps: number;
1744
+ writeIOps: string;
1451
1745
  /** The total gibibytes read from disk by all Tasks in all Jobs created under the schedule. */
1452
1746
  readIOGiB: number;
1453
1747
  /** The total gibibytes written to disk by all Tasks in all Jobs created under the schedule. */
1454
1748
  writeIOGiB: number;
1455
1749
  /** The total number of Tasks successfully completed during the given time range in Jobs created under the schedule. A Task completes successfully if it returns exit code 0. */
1456
- numSucceededTasks: number;
1750
+ numSucceededTasks: string;
1457
1751
  /** The total number of Tasks that failed during the given time range in Jobs created under the schedule. A Task fails if it exhausts its maximum retry count without returning exit code 0. */
1458
- numFailedTasks: number;
1752
+ numFailedTasks: string;
1459
1753
  /** The total number of retries during the given time range on all Tasks in all Jobs created under the schedule. */
1460
- numTaskRetries: number;
1754
+ numTaskRetries: string;
1461
1755
  /** The total wait time of all Tasks in all Jobs created under the schedule. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.). This value is only reported in the Account lifetime statistics; it is not included in the Job statistics. */
1462
1756
  waitTime: string;
1463
1757
  }
@@ -1493,9 +1787,17 @@ export interface ExitCodeMappingOutput {
1493
1787
  }
1494
1788
  /** Specifies how the Batch service responds to a particular exit condition. */
1495
1789
  export interface ExitOptionsOutput {
1496
- /** An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'. The default is none for exit code 0 and terminate for all other exit conditions. If the Job's onTaskFailed property is noaction, then specifying this property returns an error and the add Task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */
1497
- jobAction?: BatchJobActionOutput;
1498
- /** An action that the Batch service performs on Tasks that depend on this Task. Possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks. */
1790
+ /**
1791
+ * An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'. The default is none for exit code 0 and terminate for all other exit conditions. If the Job's onTaskFailed property is noaction, then specifying this property returns an error and the add Task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
1792
+ *
1793
+ * Possible values: "none", "disable", "terminate"
1794
+ */
1795
+ jobAction?: BatchJobActionKindOutput;
1796
+ /**
1797
+ * An action that the Batch service performs on Tasks that depend on this Task. Possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks.
1798
+ *
1799
+ * Possible values: "satisfy", "block"
1800
+ */
1499
1801
  dependencyAction?: DependencyActionOutput;
1500
1802
  }
1501
1803
  /**
@@ -1514,7 +1816,7 @@ export interface ExitCodeRangeMappingOutput {
1514
1816
  * A locality hint that can be used by the Batch service to select a Compute Node
1515
1817
  * on which to start a Task.
1516
1818
  */
1517
- export interface AffinityInfoOutput {
1819
+ export interface BatchAffinityInfoOutput {
1518
1820
  /** An opaque string representing the location of a Compute Node or a Task that has run previously. You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere. */
1519
1821
  affinityId: string;
1520
1822
  }
@@ -1586,15 +1888,23 @@ export interface BatchTaskOutput {
1586
1888
  readonly creationTime?: string;
1587
1889
  /** How the Batch service should respond when the Task completes. */
1588
1890
  readonly exitConditions?: ExitConditionsOutput;
1589
- /** The current state of the Task. */
1891
+ /**
1892
+ * The current state of the Task.
1893
+ *
1894
+ * Possible values: "active", "preparing", "running", "completed"
1895
+ */
1590
1896
  readonly state?: BatchTaskStateOutput;
1591
1897
  /** The time at which the Task entered its current state. */
1592
1898
  readonly stateTransitionTime?: string;
1593
- /** The previous state of the Task. This property is not set if the Task is in its initial Active state. */
1899
+ /**
1900
+ * The previous state of the Task. This property is not set if the Task is in its initial Active state.
1901
+ *
1902
+ * Possible values: "active", "preparing", "running", "completed"
1903
+ */
1594
1904
  readonly previousState?: BatchTaskStateOutput;
1595
1905
  /** The time at which the Task entered its previous state. This property is not set if the Task is in its initial Active state. */
1596
1906
  readonly previousStateTransitionTime?: string;
1597
- /** The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables). */
1907
+ /** The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). */
1598
1908
  readonly commandLine?: string;
1599
1909
  /** The settings for the container under which the Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. */
1600
1910
  readonly containerSettings?: BatchTaskContainerSettingsOutput;
@@ -1605,7 +1915,7 @@ export interface BatchTaskOutput {
1605
1915
  /** A list of environment variable settings for the Task. */
1606
1916
  readonly environmentSettings?: Array<EnvironmentSettingOutput>;
1607
1917
  /** A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. */
1608
- readonly affinityInfo?: AffinityInfoOutput;
1918
+ readonly affinityInfo?: BatchAffinityInfoOutput;
1609
1919
  /** The execution constraints that apply to this Task. */
1610
1920
  constraints?: BatchTaskConstraintsOutput;
1611
1921
  /** The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1. */
@@ -1647,7 +1957,11 @@ export interface BatchTaskExecutionInfoOutput {
1647
1957
  requeueCount: number;
1648
1958
  /** The most recent time at which the Task has been requeued by the Batch service as the result of a user request. This property is set only if the requeueCount is nonzero. */
1649
1959
  lastRequeueTime?: string;
1650
- /** The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. */
1960
+ /**
1961
+ * The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property.
1962
+ *
1963
+ * Possible values: "success", "failure"
1964
+ */
1651
1965
  result?: BatchTaskExecutionResultOutput;
1652
1966
  }
1653
1967
  /** Information about the Compute Node on which a Task ran. */
@@ -1680,9 +1994,9 @@ export interface BatchTaskStatisticsOutput {
1680
1994
  /** The total wall clock time of the Task. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If the Task was retried, this includes the wall clock time of all the Task retries. */
1681
1995
  wallClockTime: string;
1682
1996
  /** The total number of disk read operations made by the Task. */
1683
- readIOps: number;
1997
+ readIOps: string;
1684
1998
  /** The total number of disk write operations made by the Task. */
1685
- writeIOps: number;
1999
+ writeIOps: string;
1686
2000
  /** The total gibibytes read from disk by the Task. */
1687
2001
  readIOGiB: number;
1688
2002
  /** The total gibibytes written to disk by the Task. */
@@ -1690,14 +2004,18 @@ export interface BatchTaskStatisticsOutput {
1690
2004
  /** The total wait time of the Task. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.). */
1691
2005
  waitTime: string;
1692
2006
  }
1693
- /** The result of adding a collection of Tasks to a Job. */
1694
- export interface BatchTaskAddCollectionResultOutput {
1695
- /** The results of the add Task collection operation. */
1696
- value?: Array<BatchTaskAddResultOutput>;
2007
+ /** The result of creating a collection of Tasks to a Job. */
2008
+ export interface BatchCreateTaskCollectionResultOutput {
2009
+ /** The results of the create Task collection operation. */
2010
+ value?: Array<BatchTaskCreateResultOutput>;
1697
2011
  }
1698
- /** Result for a single Task added as part of an add Task collection operation. */
1699
- export interface BatchTaskAddResultOutput {
1700
- /** The status of the add Task request. */
2012
+ /** Result for a single Task created as part of an add Task collection operation. */
2013
+ export interface BatchTaskCreateResultOutput {
2014
+ /**
2015
+ * The status of the add Task request.
2016
+ *
2017
+ * Possible values: "success", "clienterror", "servererror"
2018
+ */
1701
2019
  status: BatchTaskAddStatusOutput;
1702
2020
  /** The ID of the Task for which this is the result. */
1703
2021
  taskId: string;
@@ -1733,15 +2051,27 @@ export interface BatchSubtaskOutput {
1733
2051
  containerInfo?: BatchTaskContainerExecutionInfoOutput;
1734
2052
  /** Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure. */
1735
2053
  failureInfo?: BatchTaskFailureInfoOutput;
1736
- /** The current state of the subtask. */
2054
+ /**
2055
+ * The current state of the subtask.
2056
+ *
2057
+ * Possible values: "preparing", "running", "completed"
2058
+ */
1737
2059
  state?: BatchSubtaskStateOutput;
1738
2060
  /** The time at which the subtask entered its current state. */
1739
2061
  stateTransitionTime?: string;
1740
- /** The previous state of the subtask. This property is not set if the subtask is in its initial running state. */
2062
+ /**
2063
+ * The previous state of the subtask. This property is not set if the subtask is in its initial running state.
2064
+ *
2065
+ * Possible values: "preparing", "running", "completed"
2066
+ */
1741
2067
  previousState?: BatchSubtaskStateOutput;
1742
2068
  /** The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state. */
1743
2069
  previousStateTransitionTime?: string;
1744
- /** The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. */
2070
+ /**
2071
+ * The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property.
2072
+ *
2073
+ * Possible values: "success", "failure"
2074
+ */
1745
2075
  result?: BatchTaskExecutionResultOutput;
1746
2076
  }
1747
2077
  /**
@@ -1784,9 +2114,17 @@ export interface BatchNodeOutput {
1784
2114
  id?: string;
1785
2115
  /** The URL of the Compute Node. */
1786
2116
  url?: string;
1787
- /** The current state of the Compute Node. The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available. */
2117
+ /**
2118
+ * The current state of the Compute Node. The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available.
2119
+ *
2120
+ * Possible values: "idle", "rebooting", "reimaging", "running", "unusable", "creating", "starting", "waitingforstarttask", "starttaskfailed", "unknown", "leavingpool", "offline", "preempted", "upgradingos", "deallocated", "deallocating"
2121
+ */
1788
2122
  state?: BatchNodeStateOutput;
1789
- /** Whether the Compute Node is available for Task scheduling. */
2123
+ /**
2124
+ * Whether the Compute Node is available for Task scheduling.
2125
+ *
2126
+ * Possible values: "enabled", "disabled"
2127
+ */
1790
2128
  schedulingState?: SchedulingStateOutput;
1791
2129
  /** The time at which the Compute Node entered its current state. */
1792
2130
  stateTransitionTime?: string;
@@ -1798,7 +2136,7 @@ export interface BatchNodeOutput {
1798
2136
  ipAddress?: string;
1799
2137
  /** An identifier which can be passed when adding a Task to request that the Task be scheduled on this Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere. */
1800
2138
  affinityId?: string;
1801
- /** The size of the virtual machine hosting the Compute Node. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes). */
2139
+ /** The size of the virtual machine hosting the Compute Node. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). */
1802
2140
  vmSize?: string;
1803
2141
  /** The total number of Job Tasks completed on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. */
1804
2142
  totalTasksRun?: number;
@@ -1814,6 +2152,13 @@ export interface BatchNodeOutput {
1814
2152
  startTask?: BatchStartTaskOutput;
1815
2153
  /** Runtime information about the execution of the StartTask on the Compute Node. */
1816
2154
  startTaskInfo?: BatchStartTaskInfoOutput;
2155
+ /**
2156
+ * For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location.
2157
+ * For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location.
2158
+ * For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.
2159
+ * Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.
2160
+ */
2161
+ certificateReferences?: Array<BatchCertificateReferenceOutput>;
1817
2162
  /** The list of errors that are currently being encountered by the Compute Node. */
1818
2163
  errors?: Array<BatchNodeErrorOutput>;
1819
2164
  /** Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a Spot/Low-priority Compute Node. */
@@ -1835,14 +2180,22 @@ export interface BatchTaskInfoOutput {
1835
2180
  taskId?: string;
1836
2181
  /** The ID of the subtask if the Task is a multi-instance Task. */
1837
2182
  subtaskId?: number;
1838
- /** The current state of the Task. */
2183
+ /**
2184
+ * The current state of the Task.
2185
+ *
2186
+ * Possible values: "active", "preparing", "running", "completed"
2187
+ */
1839
2188
  taskState: BatchTaskStateOutput;
1840
2189
  /** Information about the execution of the Task. */
1841
2190
  executionInfo?: BatchTaskExecutionInfoOutput;
1842
2191
  }
1843
2192
  /** Information about a StartTask running on a Compute Node. */
1844
2193
  export interface BatchStartTaskInfoOutput {
1845
- /** The state of the StartTask on the Compute Node. */
2194
+ /**
2195
+ * The state of the StartTask on the Compute Node.
2196
+ *
2197
+ * Possible values: "running", "completed"
2198
+ */
1846
2199
  state: BatchStartTaskStateOutput;
1847
2200
  /** The time at which the StartTask started running. This value is reset every time the Task is restarted or retried (that is, this is the most recent time at which the StartTask started running). */
1848
2201
  startTime: string;
@@ -1858,7 +2211,11 @@ export interface BatchStartTaskInfoOutput {
1858
2211
  retryCount: number;
1859
2212
  /** The most recent time at which a retry of the Task started running. This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not. */
1860
2213
  lastRetryTime?: string;
1861
- /** The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. */
2214
+ /**
2215
+ * The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property.
2216
+ *
2217
+ * Possible values: "success", "failure"
2218
+ */
1862
2219
  result?: BatchTaskExecutionResultOutput;
1863
2220
  }
1864
2221
  /** An error encountered by a Compute Node. */
@@ -1879,7 +2236,11 @@ export interface BatchNodeEndpointConfigurationOutput {
1879
2236
  export interface InboundEndpointOutput {
1880
2237
  /** The name of the endpoint. */
1881
2238
  name: string;
1882
- /** The protocol of the endpoint. */
2239
+ /**
2240
+ * The protocol of the endpoint.
2241
+ *
2242
+ * Possible values: "tcp", "udp"
2243
+ */
1883
2244
  protocol: InboundEndpointProtocolOutput;
1884
2245
  /** The public IP address of the Compute Node. */
1885
2246
  publicIPAddress: string;
@@ -1903,7 +2264,7 @@ export interface BatchNodeAgentInfoOutput {
1903
2264
  /** Info about the current state of the virtual machine. */
1904
2265
  export interface VirtualMachineInfoOutput {
1905
2266
  /** The reference to the Azure Virtual Machine's Marketplace Image. */
1906
- imageReference?: ImageReferenceOutput;
2267
+ imageReference?: BatchVmImageReferenceOutput;
1907
2268
  /** The resource ID of the Compute Node's current Virtual Machine Scale Set VM. Only defined if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'. */
1908
2269
  scaleSetVmResourceId?: string;
1909
2270
  }
@@ -1952,7 +2313,11 @@ export interface InstanceViewStatusOutput {
1952
2313
  code?: string;
1953
2314
  /** The localized label for the status. */
1954
2315
  displayStatus?: string;
1955
- /** Level code. */
2316
+ /**
2317
+ * Level code.
2318
+ *
2319
+ * Possible values: "Error", "Info", "Warning"
2320
+ */
1956
2321
  level?: StatusLevelTypesOutput;
1957
2322
  /** The detailed status message. */
1958
2323
  message?: string;
@@ -1978,6 +2343,8 @@ export type DiskEncryptionTargetOutput = string;
1978
2343
  export type BatchNodePlacementPolicyTypeOutput = string;
1979
2344
  /** Alias for DiffDiskPlacementOutput */
1980
2345
  export type DiffDiskPlacementOutput = string;
2346
+ /** Alias for SecurityEncryptionTypesOutput */
2347
+ export type SecurityEncryptionTypesOutput = string;
1981
2348
  /** Alias for SecurityTypesOutput */
1982
2349
  export type SecurityTypesOutput = string;
1983
2350
  /** Alias for DynamicVNetAssignmentScopeOutput */
@@ -1990,10 +2357,16 @@ export type NetworkSecurityGroupRuleAccessOutput = string;
1990
2357
  export type IpAddressProvisioningTypeOutput = string;
1991
2358
  /** Alias for ContainerWorkingDirectoryOutput */
1992
2359
  export type ContainerWorkingDirectoryOutput = string;
2360
+ /** Alias for ContainerHostDataPathOutput */
2361
+ export type ContainerHostDataPathOutput = string;
1993
2362
  /** Alias for AutoUserScopeOutput */
1994
2363
  export type AutoUserScopeOutput = string;
1995
2364
  /** Alias for ElevationLevelOutput */
1996
2365
  export type ElevationLevelOutput = string;
2366
+ /** Alias for BatchCertificateStoreLocationOutput */
2367
+ export type BatchCertificateStoreLocationOutput = string;
2368
+ /** Alias for BatchCertificateVisibilityOutput */
2369
+ export type BatchCertificateVisibilityOutput = string;
1997
2370
  /** Alias for BatchNodeFillTypeOutput */
1998
2371
  export type BatchNodeFillTypeOutput = string;
1999
2372
  /** Alias for LoginModeOutput */
@@ -2016,26 +2389,30 @@ export type ImageVerificationTypeOutput = string;
2016
2389
  export type BatchJobStateOutput = string;
2017
2390
  /** Alias for OutputFileUploadConditionOutput */
2018
2391
  export type OutputFileUploadConditionOutput = string;
2019
- /** Alias for AccessScopeOutput */
2020
- export type AccessScopeOutput = string;
2392
+ /** Alias for BatchAccessScopeOutput */
2393
+ export type BatchAccessScopeOutput = string;
2021
2394
  /** Alias for BatchPoolLifetimeOptionOutput */
2022
2395
  export type BatchPoolLifetimeOptionOutput = string;
2023
- /** Alias for OnAllBatchTasksCompleteOutput */
2024
- export type OnAllBatchTasksCompleteOutput = string;
2025
- /** Alias for OnBatchTaskFailureOutput */
2026
- export type OnBatchTaskFailureOutput = string;
2027
- /** Alias for ErrorCategoryOutput */
2028
- export type ErrorCategoryOutput = string;
2396
+ /** Alias for BatchAllTasksCompleteModeOutput */
2397
+ export type BatchAllTasksCompleteModeOutput = string;
2398
+ /** Alias for BatchTaskFailureModeOutput */
2399
+ export type BatchTaskFailureModeOutput = string;
2400
+ /** Alias for BatchErrorSourceCategoryOutput */
2401
+ export type BatchErrorSourceCategoryOutput = string;
2029
2402
  /** Alias for BatchJobPreparationTaskStateOutput */
2030
2403
  export type BatchJobPreparationTaskStateOutput = string;
2031
2404
  /** Alias for BatchTaskExecutionResultOutput */
2032
2405
  export type BatchTaskExecutionResultOutput = string;
2033
2406
  /** Alias for BatchJobReleaseTaskStateOutput */
2034
2407
  export type BatchJobReleaseTaskStateOutput = string;
2408
+ /** Alias for BatchCertificateStateOutput */
2409
+ export type BatchCertificateStateOutput = string;
2410
+ /** Alias for BatchCertificateFormatOutput */
2411
+ export type BatchCertificateFormatOutput = string;
2035
2412
  /** Alias for BatchJobScheduleStateOutput */
2036
2413
  export type BatchJobScheduleStateOutput = string;
2037
- /** Alias for BatchJobActionOutput */
2038
- export type BatchJobActionOutput = string;
2414
+ /** Alias for BatchJobActionKindOutput */
2415
+ export type BatchJobActionKindOutput = string;
2039
2416
  /** Alias for DependencyActionOutput */
2040
2417
  export type DependencyActionOutput = string;
2041
2418
  /** Alias for BatchTaskStateOutput */