@azure-rest/batch 1.0.0-beta.2 → 1.0.0-beta.4
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.
- package/LICENSE +4 -4
- package/README.md +4 -4
- package/dist/browser/batchClient.js +17 -22
- package/dist/browser/batchClient.js.map +1 -1
- package/dist/browser/clientDefinitions.d.ts +1 -1
- package/dist/browser/clientDefinitions.js.map +1 -1
- package/dist/browser/index.d.ts +0 -1
- package/dist/browser/index.js +0 -1
- package/dist/browser/index.js.map +1 -1
- package/dist/browser/isUnexpected.js +4 -5
- package/dist/browser/isUnexpected.js.map +1 -1
- package/dist/browser/models.d.ts +216 -178
- package/dist/browser/models.js.map +1 -1
- package/dist/browser/outputModels.d.ts +254 -202
- package/dist/browser/outputModels.js.map +1 -1
- package/dist/browser/paginateHelper.d.ts +27 -2
- package/dist/browser/paginateHelper.js +69 -2
- package/dist/browser/paginateHelper.js.map +1 -1
- package/dist/browser/parameters.d.ts +274 -58
- package/dist/browser/parameters.js.map +1 -1
- package/dist/browser/responses.d.ts +2 -2
- package/dist/browser/responses.js.map +1 -1
- package/dist/commonjs/batchClient.js +17 -22
- package/dist/commonjs/batchClient.js.map +1 -1
- package/dist/commonjs/clientDefinitions.d.ts +1 -1
- package/dist/commonjs/clientDefinitions.js.map +1 -1
- package/dist/commonjs/credentials/batchSharedKeyCredentials.js +1 -2
- package/dist/commonjs/credentials/batchSharedKeyCredentials.js.map +1 -1
- package/dist/commonjs/index.d.ts +0 -1
- package/dist/commonjs/index.js +0 -1
- package/dist/commonjs/index.js.map +1 -1
- package/dist/commonjs/isUnexpected.js +4 -5
- package/dist/commonjs/isUnexpected.js.map +1 -1
- package/dist/commonjs/models.d.ts +216 -178
- package/dist/commonjs/models.js.map +1 -1
- package/dist/commonjs/outputModels.d.ts +254 -202
- package/dist/commonjs/outputModels.js.map +1 -1
- package/dist/commonjs/paginateHelper.d.ts +27 -2
- package/dist/commonjs/paginateHelper.js +70 -3
- package/dist/commonjs/paginateHelper.js.map +1 -1
- package/dist/commonjs/parameters.d.ts +274 -58
- package/dist/commonjs/parameters.js.map +1 -1
- package/dist/commonjs/responses.d.ts +2 -2
- package/dist/commonjs/responses.js.map +1 -1
- package/dist/commonjs/tsdoc-metadata.json +11 -11
- package/dist/esm/batchClient.js +17 -22
- package/dist/esm/batchClient.js.map +1 -1
- package/dist/esm/clientDefinitions.d.ts +1 -1
- package/dist/esm/clientDefinitions.js.map +1 -1
- package/dist/esm/credentials/batchSharedKeyCredentials.js +1 -2
- package/dist/esm/credentials/batchSharedKeyCredentials.js.map +1 -1
- package/dist/esm/index.d.ts +0 -1
- package/dist/esm/index.js +0 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/isUnexpected.js +4 -5
- package/dist/esm/isUnexpected.js.map +1 -1
- package/dist/esm/models.d.ts +216 -178
- package/dist/esm/models.js.map +1 -1
- package/dist/esm/outputModels.d.ts +254 -202
- package/dist/esm/outputModels.js.map +1 -1
- package/dist/esm/paginateHelper.d.ts +27 -2
- package/dist/esm/paginateHelper.js +69 -2
- package/dist/esm/paginateHelper.js.map +1 -1
- package/dist/esm/parameters.d.ts +274 -58
- package/dist/esm/parameters.js.map +1 -1
- package/dist/esm/responses.d.ts +2 -2
- package/dist/esm/responses.js.map +1 -1
- package/dist/react-native/batchClient.js +17 -22
- package/dist/react-native/batchClient.js.map +1 -1
- package/dist/react-native/clientDefinitions.d.ts +1 -1
- package/dist/react-native/clientDefinitions.js.map +1 -1
- package/dist/react-native/index.d.ts +0 -1
- package/dist/react-native/index.js +0 -1
- package/dist/react-native/index.js.map +1 -1
- package/dist/react-native/isUnexpected.js +4 -5
- package/dist/react-native/isUnexpected.js.map +1 -1
- package/dist/react-native/models.d.ts +216 -178
- package/dist/react-native/models.js.map +1 -1
- package/dist/react-native/outputModels.d.ts +254 -202
- package/dist/react-native/outputModels.js.map +1 -1
- package/dist/react-native/paginateHelper.d.ts +27 -2
- package/dist/react-native/paginateHelper.js +69 -2
- package/dist/react-native/paginateHelper.js.map +1 -1
- package/dist/react-native/parameters.d.ts +274 -58
- package/dist/react-native/parameters.js.map +1 -1
- package/dist/react-native/responses.d.ts +2 -2
- package/dist/react-native/responses.js.map +1 -1
- package/package.json +52 -53
- package/dist/browser/batchClient.d.ts.map +0 -1
- package/dist/browser/clientDefinitions.d.ts.map +0 -1
- package/dist/browser/credentials/batchSharedKeyCredentials-browser.d.mts.map +0 -1
- package/dist/browser/index.d.ts.map +0 -1
- package/dist/browser/isUnexpected.d.ts.map +0 -1
- package/dist/browser/logger.d.ts.map +0 -1
- package/dist/browser/models.d.ts.map +0 -1
- package/dist/browser/outputModels.d.ts.map +0 -1
- package/dist/browser/paginateHelper.d.ts.map +0 -1
- package/dist/browser/parameters.d.ts.map +0 -1
- package/dist/browser/replacePoolPropertiesPolicy.d.ts +0 -11
- package/dist/browser/replacePoolPropertiesPolicy.d.ts.map +0 -1
- package/dist/browser/replacePoolPropertiesPolicy.js +0 -33
- package/dist/browser/replacePoolPropertiesPolicy.js.map +0 -1
- package/dist/browser/responses.d.ts.map +0 -1
- package/dist/commonjs/batchClient.d.ts.map +0 -1
- package/dist/commonjs/clientDefinitions.d.ts.map +0 -1
- package/dist/commonjs/credentials/batchSharedKeyCredentials.d.ts.map +0 -1
- package/dist/commonjs/index.d.ts.map +0 -1
- package/dist/commonjs/isUnexpected.d.ts.map +0 -1
- package/dist/commonjs/logger.d.ts.map +0 -1
- package/dist/commonjs/models.d.ts.map +0 -1
- package/dist/commonjs/outputModels.d.ts.map +0 -1
- package/dist/commonjs/paginateHelper.d.ts.map +0 -1
- package/dist/commonjs/parameters.d.ts.map +0 -1
- package/dist/commonjs/replacePoolPropertiesPolicy.d.ts +0 -11
- package/dist/commonjs/replacePoolPropertiesPolicy.d.ts.map +0 -1
- package/dist/commonjs/replacePoolPropertiesPolicy.js +0 -36
- package/dist/commonjs/replacePoolPropertiesPolicy.js.map +0 -1
- package/dist/commonjs/responses.d.ts.map +0 -1
- package/dist/esm/batchClient.d.ts.map +0 -1
- package/dist/esm/clientDefinitions.d.ts.map +0 -1
- package/dist/esm/credentials/batchSharedKeyCredentials.d.ts.map +0 -1
- package/dist/esm/index.d.ts.map +0 -1
- package/dist/esm/isUnexpected.d.ts.map +0 -1
- package/dist/esm/logger.d.ts.map +0 -1
- package/dist/esm/models.d.ts.map +0 -1
- package/dist/esm/outputModels.d.ts.map +0 -1
- package/dist/esm/paginateHelper.d.ts.map +0 -1
- package/dist/esm/parameters.d.ts.map +0 -1
- package/dist/esm/replacePoolPropertiesPolicy.d.ts +0 -11
- package/dist/esm/replacePoolPropertiesPolicy.d.ts.map +0 -1
- package/dist/esm/replacePoolPropertiesPolicy.js +0 -33
- package/dist/esm/replacePoolPropertiesPolicy.js.map +0 -1
- package/dist/esm/responses.d.ts.map +0 -1
- package/dist/react-native/batchClient.d.ts.map +0 -1
- package/dist/react-native/clientDefinitions.d.ts.map +0 -1
- package/dist/react-native/credentials/batchSharedKeyCredentials-react-native.d.mts.map +0 -1
- package/dist/react-native/index.d.ts.map +0 -1
- package/dist/react-native/isUnexpected.d.ts.map +0 -1
- package/dist/react-native/logger.d.ts.map +0 -1
- package/dist/react-native/models.d.ts.map +0 -1
- package/dist/react-native/outputModels.d.ts.map +0 -1
- package/dist/react-native/paginateHelper.d.ts.map +0 -1
- package/dist/react-native/parameters.d.ts.map +0 -1
- package/dist/react-native/replacePoolPropertiesPolicy.d.ts +0 -11
- package/dist/react-native/replacePoolPropertiesPolicy.d.ts.map +0 -1
- package/dist/react-native/replacePoolPropertiesPolicy.js +0 -33
- package/dist/react-native/replacePoolPropertiesPolicy.js.map +0 -1
- 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
|
|
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://
|
|
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:
|
|
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://
|
|
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?:
|
|
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?:
|
|
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
|
|
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,7 +111,7 @@ 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://
|
|
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;
|
|
@@ -141,6 +141,8 @@ export interface DataDiskOutput {
|
|
|
141
141
|
caching?: CachingTypeOutput;
|
|
142
142
|
/** The initial disk size in gigabytes. */
|
|
143
143
|
diskSizeGB: number;
|
|
144
|
+
/** The managed disk parameters. */
|
|
145
|
+
managedDisk?: ManagedDiskOutput;
|
|
144
146
|
/**
|
|
145
147
|
* The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs".
|
|
146
148
|
*
|
|
@@ -148,8 +150,35 @@ export interface DataDiskOutput {
|
|
|
148
150
|
*/
|
|
149
151
|
storageAccountType?: StorageAccountTypeOutput;
|
|
150
152
|
}
|
|
153
|
+
/** The managed disk parameters. */
|
|
154
|
+
export interface ManagedDiskOutput {
|
|
155
|
+
/** Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. */
|
|
156
|
+
diskEncryptionSet?: DiskEncryptionSetParametersOutput;
|
|
157
|
+
/**
|
|
158
|
+
* The storage account type for managed disk.
|
|
159
|
+
*
|
|
160
|
+
* Possible values: "standard_lrs", "premium_lrs", "standardssd_lrs"
|
|
161
|
+
*/
|
|
162
|
+
storageAccountType?: StorageAccountTypeOutput;
|
|
163
|
+
/** Specifies the security profile settings for the managed disk. */
|
|
164
|
+
securityProfile?: BatchVmDiskSecurityProfileOutput;
|
|
165
|
+
}
|
|
166
|
+
/** The ARM resource id of the disk encryption set. */
|
|
167
|
+
export interface DiskEncryptionSetParametersOutput {
|
|
168
|
+
/** The ARM resource id of the disk encryption set. The resource must be in the same subscription as the Batch account. */
|
|
169
|
+
id?: string;
|
|
170
|
+
}
|
|
171
|
+
/** Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and required when using Confidential VMs. */
|
|
172
|
+
export interface BatchVmDiskSecurityProfileOutput {
|
|
173
|
+
/**
|
|
174
|
+
* 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.
|
|
175
|
+
*
|
|
176
|
+
* Possible values: "DiskWithVMGuestState", "NonPersistedTPM", "VMGuestStateOnly"
|
|
177
|
+
*/
|
|
178
|
+
securityEncryptionType?: SecurityEncryptionTypesOutput;
|
|
179
|
+
}
|
|
151
180
|
/** The configuration for container-enabled Pools. */
|
|
152
|
-
export interface
|
|
181
|
+
export interface BatchContainerConfigurationOutput {
|
|
153
182
|
/**
|
|
154
183
|
* The container technology to be used.
|
|
155
184
|
*
|
|
@@ -186,9 +215,25 @@ export interface BatchNodeIdentityReferenceOutput {
|
|
|
186
215
|
* Azure Compute Gallery Image.
|
|
187
216
|
*/
|
|
188
217
|
export interface DiskEncryptionConfigurationOutput {
|
|
218
|
+
/** The Customer Managed Key reference to encrypt the OS Disk. Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. */
|
|
219
|
+
customerManagedKey?: DiskCustomerManagedKeyOutput;
|
|
189
220
|
/** 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. */
|
|
190
221
|
targets?: DiskEncryptionTargetOutput[];
|
|
191
222
|
}
|
|
223
|
+
/** The Customer Managed Key reference to encrypt the Disk. */
|
|
224
|
+
export interface DiskCustomerManagedKeyOutput {
|
|
225
|
+
/** The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. */
|
|
226
|
+
identityReference?: BatchPoolIdentityReferenceOutput;
|
|
227
|
+
/** Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. */
|
|
228
|
+
keyUrl?: string;
|
|
229
|
+
/** Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. */
|
|
230
|
+
rotationToLatestKeyVersionEnabled?: boolean;
|
|
231
|
+
}
|
|
232
|
+
/** The reference of one of the pool identities to encrypt Disk. This identity will be used to access the key vault. */
|
|
233
|
+
export interface BatchPoolIdentityReferenceOutput {
|
|
234
|
+
/** The ARM resource id of the user assigned identity. This reference must be included in the pool identities. */
|
|
235
|
+
resourceId?: string;
|
|
236
|
+
}
|
|
192
237
|
/**
|
|
193
238
|
* For regional placement, nodes in the pool will be allocated in the same region.
|
|
194
239
|
* For zonal placement, nodes in the pool will be spread across different zones
|
|
@@ -198,7 +243,7 @@ export interface BatchNodePlacementConfigurationOutput {
|
|
|
198
243
|
/**
|
|
199
244
|
* 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
245
|
*
|
|
201
|
-
* Possible values: "
|
|
246
|
+
* Possible values: "regional", "zonal"
|
|
202
247
|
*/
|
|
203
248
|
policy?: BatchNodePlacementPolicyTypeOutput;
|
|
204
249
|
}
|
|
@@ -224,9 +269,9 @@ export interface VMExtensionOutput {
|
|
|
224
269
|
provisionAfterExtensions?: string[];
|
|
225
270
|
}
|
|
226
271
|
/** Settings for the operating system disk of the compute node (VM). */
|
|
227
|
-
export interface
|
|
272
|
+
export interface BatchOsDiskOutput {
|
|
228
273
|
/** Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). */
|
|
229
|
-
ephemeralOSDiskSettings?:
|
|
274
|
+
ephemeralOSDiskSettings?: BatchDiffDiskSettingsOutput;
|
|
230
275
|
/**
|
|
231
276
|
* Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
|
|
232
277
|
*
|
|
@@ -244,49 +289,51 @@ export interface OSDiskOutput {
|
|
|
244
289
|
* Specifies the ephemeral Disk Settings for the operating system disk used by the
|
|
245
290
|
* compute node (VM).
|
|
246
291
|
*/
|
|
247
|
-
export interface
|
|
292
|
+
export interface BatchDiffDiskSettingsOutput {
|
|
248
293
|
/**
|
|
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://
|
|
294
|
+
* 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
295
|
*
|
|
251
296
|
* Possible values: "cachedisk"
|
|
252
297
|
*/
|
|
253
298
|
placement?: DiffDiskPlacementOutput;
|
|
254
299
|
}
|
|
255
|
-
/** The managed disk parameters. */
|
|
256
|
-
export interface ManagedDiskOutput {
|
|
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?: VMDiskSecurityProfileOutput;
|
|
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 VMDiskSecurityProfileOutput {
|
|
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;
|
|
274
|
-
}
|
|
275
300
|
/** Specifies the security profile settings for the virtual machine or virtual machine scale set. */
|
|
276
301
|
export interface SecurityProfileOutput {
|
|
277
302
|
/** 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
|
|
303
|
+
encryptionAtHost?: boolean;
|
|
304
|
+
/** Specifies ProxyAgent settings while creating the virtual machine. */
|
|
305
|
+
proxyAgentSettings?: ProxyAgentSettingsOutput;
|
|
279
306
|
/**
|
|
280
307
|
* Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
|
|
281
308
|
*
|
|
282
309
|
* Possible values: "trustedLaunch", "confidentialVM"
|
|
283
310
|
*/
|
|
284
|
-
securityType
|
|
311
|
+
securityType?: SecurityTypesOutput;
|
|
285
312
|
/** 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. */
|
|
286
|
-
uefiSettings
|
|
313
|
+
uefiSettings?: BatchUefiSettingsOutput;
|
|
314
|
+
}
|
|
315
|
+
/** Specifies ProxyAgent settings while creating the virtual machine. */
|
|
316
|
+
export interface ProxyAgentSettingsOutput {
|
|
317
|
+
/** Specifies whether Metadata Security Protocol feature should be enabled on the virtual machine or virtual machine scale set. Default is False. */
|
|
318
|
+
enabled?: boolean;
|
|
319
|
+
/** Settings for the IMDS endpoint. */
|
|
320
|
+
imds?: HostEndpointSettingsOutput;
|
|
321
|
+
/** Settings for the WireServer endpoint. */
|
|
322
|
+
wireServer?: HostEndpointSettingsOutput;
|
|
323
|
+
}
|
|
324
|
+
/** Specifies particular host endpoint settings. */
|
|
325
|
+
export interface HostEndpointSettingsOutput {
|
|
326
|
+
/** Specifies the reference to the InVMAccessControlProfileVersion resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}. */
|
|
327
|
+
inVMAccessControlProfileReferenceId?: string;
|
|
328
|
+
/**
|
|
329
|
+
* Specifies the access control policy execution mode.
|
|
330
|
+
*
|
|
331
|
+
* Possible values: "Audit", "Enforce"
|
|
332
|
+
*/
|
|
333
|
+
mode?: HostEndpointSettingsModeTypesOutput;
|
|
287
334
|
}
|
|
288
335
|
/** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. */
|
|
289
|
-
export interface
|
|
336
|
+
export interface BatchUefiSettingsOutput {
|
|
290
337
|
/** Specifies whether secure boot should be enabled on the virtual machine. */
|
|
291
338
|
secureBootEnabled?: boolean;
|
|
292
339
|
/** Specifies whether vTPM should be enabled on the virtual machine. */
|
|
@@ -302,7 +349,7 @@ export interface ServiceArtifactReferenceOutput {
|
|
|
302
349
|
}
|
|
303
350
|
/** The network configuration for a Pool. */
|
|
304
351
|
export interface NetworkConfigurationOutput {
|
|
305
|
-
/** The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. 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
|
|
352
|
+
/** 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 */
|
|
306
353
|
subnetId?: string;
|
|
307
354
|
/**
|
|
308
355
|
* The scope of dynamic vnet assignment.
|
|
@@ -313,20 +360,20 @@ export interface NetworkConfigurationOutput {
|
|
|
313
360
|
/** The configuration for endpoints on Compute Nodes in the Batch Pool. */
|
|
314
361
|
endpointConfiguration?: BatchPoolEndpointConfigurationOutput;
|
|
315
362
|
/** The Public IPAddress configuration for Compute Nodes in the Batch Pool. */
|
|
316
|
-
publicIPAddressConfiguration?:
|
|
363
|
+
publicIPAddressConfiguration?: BatchPublicIpAddressConfigurationOutput;
|
|
317
364
|
/** 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. */
|
|
318
365
|
enableAcceleratedNetworking?: boolean;
|
|
319
366
|
}
|
|
320
367
|
/** The endpoint configuration for a Pool. */
|
|
321
368
|
export interface BatchPoolEndpointConfigurationOutput {
|
|
322
369
|
/** 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. */
|
|
323
|
-
inboundNATPools: Array<
|
|
370
|
+
inboundNATPools: Array<BatchInboundNatPoolOutput>;
|
|
324
371
|
}
|
|
325
372
|
/**
|
|
326
373
|
* A inbound NAT Pool that can be used to address specific ports on Compute Nodes
|
|
327
374
|
* in a Batch Pool externally.
|
|
328
375
|
*/
|
|
329
|
-
export interface
|
|
376
|
+
export interface BatchInboundNatPoolOutput {
|
|
330
377
|
/** 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. */
|
|
331
378
|
name: string;
|
|
332
379
|
/**
|
|
@@ -335,7 +382,7 @@ export interface InboundNatPoolOutput {
|
|
|
335
382
|
* Possible values: "tcp", "udp"
|
|
336
383
|
*/
|
|
337
384
|
protocol: InboundEndpointProtocolOutput;
|
|
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
|
|
385
|
+
/** 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. */
|
|
339
386
|
backendPort: number;
|
|
340
387
|
/** 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. */
|
|
341
388
|
frontendPortRangeStart: number;
|
|
@@ -360,15 +407,26 @@ export interface NetworkSecurityGroupRuleOutput {
|
|
|
360
407
|
sourcePortRanges?: string[];
|
|
361
408
|
}
|
|
362
409
|
/** The public IP Address configuration of the networking configuration of a Pool. */
|
|
363
|
-
export interface
|
|
410
|
+
export interface BatchPublicIpAddressConfigurationOutput {
|
|
364
411
|
/**
|
|
365
412
|
* The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged.
|
|
366
413
|
*
|
|
367
414
|
* Possible values: "batchmanaged", "usermanaged", "nopublicipaddresses"
|
|
368
415
|
*/
|
|
369
416
|
provision?: IpAddressProvisioningTypeOutput;
|
|
417
|
+
/** The IP families used to specify IP versions available to the pool. IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. */
|
|
418
|
+
ipFamilies?: IPFamilyOutput[];
|
|
370
419
|
/** 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}. */
|
|
371
420
|
ipAddressIds?: string[];
|
|
421
|
+
/** A list of IP tags associated with the public IP addresses of the Pool. IP tags are used to categorize and filter public IP addresses for billing and management purposes. */
|
|
422
|
+
ipTags?: Array<IPTagOutput>;
|
|
423
|
+
}
|
|
424
|
+
/** Contains the IP tag associated with the public IP address. */
|
|
425
|
+
export interface IPTagOutput {
|
|
426
|
+
/** The IP Tag type. Example: FirstPartyUsage. */
|
|
427
|
+
ipTagType?: string;
|
|
428
|
+
/** The value of the IP tag associated with the public IP. Example: SQL. */
|
|
429
|
+
tag?: string;
|
|
372
430
|
}
|
|
373
431
|
/**
|
|
374
432
|
* Batch will retry Tasks when a recovery operation is triggered on a Node.
|
|
@@ -386,7 +444,7 @@ export interface PublicIpAddressConfigurationOutput {
|
|
|
386
444
|
* block Batch from being able to re-run the StartTask.
|
|
387
445
|
*/
|
|
388
446
|
export interface BatchStartTaskOutput {
|
|
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://
|
|
447
|
+
/** 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). */
|
|
390
448
|
commandLine: string;
|
|
391
449
|
/** 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. */
|
|
392
450
|
containerSettings?: BatchTaskContainerSettingsOutput;
|
|
@@ -423,7 +481,7 @@ export interface ContainerHostBatchBindMountEntryOutput {
|
|
|
423
481
|
/**
|
|
424
482
|
* The path which be mounted to container customer can select.
|
|
425
483
|
*
|
|
426
|
-
* Possible values: "
|
|
484
|
+
* Possible values: "Shared", "Startup", "VfsMounts", "Task", "JobPrep", "Applications"
|
|
427
485
|
*/
|
|
428
486
|
source?: ContainerHostDataPathOutput;
|
|
429
487
|
/** 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. */
|
|
@@ -463,7 +521,7 @@ export interface UserIdentityOutput {
|
|
|
463
521
|
/** Specifies the options for the auto user that runs an Azure Batch Task. */
|
|
464
522
|
export interface AutoUserSpecificationOutput {
|
|
465
523
|
/**
|
|
466
|
-
* The scope for the auto user. The default value is pool. If the pool is running Windows
|
|
524
|
+
* 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.
|
|
467
525
|
*
|
|
468
526
|
* Possible values: "task", "pool"
|
|
469
527
|
*/
|
|
@@ -484,6 +542,12 @@ export interface BatchApplicationPackageReferenceOutput {
|
|
|
484
542
|
}
|
|
485
543
|
/** Specifies how Tasks should be distributed across Compute Nodes. */
|
|
486
544
|
export interface BatchTaskSchedulingPolicyOutput {
|
|
545
|
+
/**
|
|
546
|
+
* The order for scheduling tasks from different jobs with the same priority. If not specified, the default is none.
|
|
547
|
+
*
|
|
548
|
+
* Possible values: "none", "creationtime"
|
|
549
|
+
*/
|
|
550
|
+
jobDefaultOrder?: BatchJobDefaultOrderOutput;
|
|
487
551
|
/**
|
|
488
552
|
* How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.
|
|
489
553
|
*
|
|
@@ -533,7 +597,7 @@ export interface WindowsUserConfigurationOutput {
|
|
|
533
597
|
* The Batch service does not assign any meaning to this metadata; it is solely
|
|
534
598
|
* for the use of user code.
|
|
535
599
|
*/
|
|
536
|
-
export interface
|
|
600
|
+
export interface BatchMetadataItemOutput {
|
|
537
601
|
/** The name of the metadata item. */
|
|
538
602
|
name: string;
|
|
539
603
|
/** The value of the metadata item. */
|
|
@@ -593,10 +657,10 @@ export interface CifsMountConfigurationOutput {
|
|
|
593
657
|
export interface AzureFileShareConfigurationOutput {
|
|
594
658
|
/** The Azure Storage account name. */
|
|
595
659
|
accountName: string;
|
|
596
|
-
/** The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. */
|
|
597
|
-
azureFileUrl: string;
|
|
598
660
|
/** The Azure Storage account key. */
|
|
599
661
|
accountKey: string;
|
|
662
|
+
/** The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. */
|
|
663
|
+
azureFileUrl: string;
|
|
600
664
|
/** 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. */
|
|
601
665
|
relativeMountPath: string;
|
|
602
666
|
/** Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. */
|
|
@@ -653,25 +717,25 @@ export interface BatchPoolListResultOutput {
|
|
|
653
717
|
/** A Pool in the Azure Batch service. */
|
|
654
718
|
export interface BatchPoolOutput {
|
|
655
719
|
/** A string that uniquely identifies the Pool within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). */
|
|
656
|
-
readonly id
|
|
657
|
-
/** The display name
|
|
720
|
+
readonly id: string;
|
|
721
|
+
/** The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. */
|
|
658
722
|
readonly displayName?: string;
|
|
659
723
|
/** The URL of the Pool. */
|
|
660
|
-
readonly url
|
|
724
|
+
readonly url: string;
|
|
661
725
|
/** The ETag of the Pool. This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime. */
|
|
662
|
-
readonly eTag
|
|
726
|
+
readonly eTag: string;
|
|
663
727
|
/** The last modified time of the Pool. This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state. */
|
|
664
|
-
readonly lastModified
|
|
728
|
+
readonly lastModified: string;
|
|
665
729
|
/** The creation time of the Pool. */
|
|
666
|
-
readonly creationTime
|
|
730
|
+
readonly creationTime: string;
|
|
667
731
|
/**
|
|
668
732
|
* The current state of the Pool.
|
|
669
733
|
*
|
|
670
734
|
* Possible values: "active", "deleting"
|
|
671
735
|
*/
|
|
672
|
-
readonly state
|
|
736
|
+
readonly state: BatchPoolStateOutput;
|
|
673
737
|
/** The time at which the Pool entered its current state. */
|
|
674
|
-
readonly stateTransitionTime
|
|
738
|
+
readonly stateTransitionTime: string;
|
|
675
739
|
/**
|
|
676
740
|
* Whether the Pool is resizing.
|
|
677
741
|
*
|
|
@@ -680,20 +744,18 @@ export interface BatchPoolOutput {
|
|
|
680
744
|
readonly allocationState?: AllocationStateOutput;
|
|
681
745
|
/** The time at which the Pool entered its current allocation state. */
|
|
682
746
|
readonly allocationStateTransitionTime?: string;
|
|
683
|
-
/** The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available
|
|
684
|
-
readonly vmSize
|
|
747
|
+
/** 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://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). */
|
|
748
|
+
readonly vmSize: string;
|
|
685
749
|
/** The virtual machine configuration for the Pool. This property must be specified. */
|
|
686
750
|
readonly virtualMachineConfiguration?: VirtualMachineConfigurationOutput;
|
|
687
751
|
/** The timeout for allocation of Compute Nodes to the Pool. This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes. */
|
|
688
752
|
readonly resizeTimeout?: string;
|
|
689
753
|
/** A list of errors encountered while performing the last resize on the Pool. This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady. */
|
|
690
754
|
readonly resizeErrors?: Array<ResizeErrorOutput>;
|
|
691
|
-
/** The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. */
|
|
692
|
-
readonly resourceTags?: Record<string, string>;
|
|
693
755
|
/** The number of dedicated Compute Nodes currently in the Pool. */
|
|
694
|
-
readonly currentDedicatedNodes
|
|
756
|
+
readonly currentDedicatedNodes: number;
|
|
695
757
|
/** The number of Spot/Low-priority Compute Nodes currently in the Pool. Spot/Low-priority Compute Nodes which have been preempted are included in this count. */
|
|
696
|
-
readonly currentLowPriorityNodes
|
|
758
|
+
readonly currentLowPriorityNodes: number;
|
|
697
759
|
/** The desired number of dedicated Compute Nodes in the Pool. */
|
|
698
760
|
readonly targetDedicatedNodes?: number;
|
|
699
761
|
/** The desired number of Spot/Low-priority Compute Nodes in the Pool. */
|
|
@@ -706,7 +768,7 @@ export interface BatchPoolOutput {
|
|
|
706
768
|
readonly autoScaleEvaluationInterval?: string;
|
|
707
769
|
/** The results and errors from the last execution of the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true. */
|
|
708
770
|
readonly autoScaleRun?: AutoScaleRunOutput;
|
|
709
|
-
/** Whether the Pool permits direct communication between Compute Nodes.
|
|
771
|
+
/** Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false. */
|
|
710
772
|
readonly enableInterNodeCommunication?: boolean;
|
|
711
773
|
/** The network configuration for the Pool. */
|
|
712
774
|
readonly networkConfiguration?: NetworkConfigurationOutput;
|
|
@@ -721,25 +783,13 @@ export interface BatchPoolOutput {
|
|
|
721
783
|
/** The list of user Accounts to be created on each Compute Node in the Pool. */
|
|
722
784
|
readonly userAccounts?: Array<UserAccountOutput>;
|
|
723
785
|
/** A list of name-value pairs associated with the Pool as metadata. */
|
|
724
|
-
readonly metadata?: Array<
|
|
786
|
+
readonly metadata?: Array<BatchMetadataItemOutput>;
|
|
725
787
|
/** 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. */
|
|
726
788
|
readonly stats?: BatchPoolStatisticsOutput;
|
|
727
|
-
/**
|
|
789
|
+
/** Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system. */
|
|
728
790
|
readonly mountConfiguration?: Array<MountConfigurationOutput>;
|
|
729
791
|
/** 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}'. */
|
|
730
792
|
readonly identity?: BatchPoolIdentityOutput;
|
|
731
|
-
/**
|
|
732
|
-
* The desired node communication mode for the pool. If omitted, the default value is Default.
|
|
733
|
-
*
|
|
734
|
-
* Possible values: "default", "classic", "simplified"
|
|
735
|
-
*/
|
|
736
|
-
targetNodeCommunicationMode?: BatchNodeCommunicationModeOutput;
|
|
737
|
-
/**
|
|
738
|
-
* The current state of the pool communication mode.
|
|
739
|
-
*
|
|
740
|
-
* Possible values: "default", "classic", "simplified"
|
|
741
|
-
*/
|
|
742
|
-
readonly currentNodeCommunicationMode?: BatchNodeCommunicationModeOutput;
|
|
743
793
|
/** The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. */
|
|
744
794
|
upgradePolicy?: UpgradePolicyOutput;
|
|
745
795
|
}
|
|
@@ -816,9 +866,9 @@ export interface BatchPoolResourceStatisticsOutput {
|
|
|
816
866
|
/** The peak used disk space in GiB across all Compute Nodes in the Pool. */
|
|
817
867
|
peakDiskGiB: number;
|
|
818
868
|
/** The total number of disk read operations across all Compute Nodes in the Pool. */
|
|
819
|
-
diskReadIOps:
|
|
869
|
+
diskReadIOps: string;
|
|
820
870
|
/** The total number of disk write operations across all Compute Nodes in the Pool. */
|
|
821
|
-
diskWriteIOps:
|
|
871
|
+
diskWriteIOps: string;
|
|
822
872
|
/** The total amount of data in GiB of disk reads across all Compute Nodes in the Pool. */
|
|
823
873
|
diskReadGiB: number;
|
|
824
874
|
/** The total amount of data in GiB of disk writes across all Compute Nodes in the Pool. */
|
|
@@ -837,10 +887,10 @@ export interface BatchPoolIdentityOutput {
|
|
|
837
887
|
*/
|
|
838
888
|
type: BatchPoolIdentityTypeOutput;
|
|
839
889
|
/** 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}'. */
|
|
840
|
-
userAssignedIdentities?: Array<
|
|
890
|
+
userAssignedIdentities?: Array<BatchUserAssignedIdentityOutput>;
|
|
841
891
|
}
|
|
842
892
|
/** The user assigned Identity */
|
|
843
|
-
export interface
|
|
893
|
+
export interface BatchUserAssignedIdentityOutput {
|
|
844
894
|
/** The ARM resource id of the user assigned identity. */
|
|
845
895
|
resourceId: string;
|
|
846
896
|
/** The client id of the user assigned identity. */
|
|
@@ -863,7 +913,7 @@ export interface BatchSupportedImageOutput {
|
|
|
863
913
|
/** The ID of the Compute Node agent SKU which the Image supports. */
|
|
864
914
|
nodeAgentSKUId: string;
|
|
865
915
|
/** The reference to the Azure Virtual Machine's Marketplace Image. */
|
|
866
|
-
imageReference:
|
|
916
|
+
imageReference: BatchVmImageReferenceOutput;
|
|
867
917
|
/**
|
|
868
918
|
* The type of operating system (e.g. Windows or Linux) of the Image.
|
|
869
919
|
*
|
|
@@ -937,27 +987,27 @@ export interface BatchNodeCountsOutput {
|
|
|
937
987
|
/** An Azure Batch Job. */
|
|
938
988
|
export interface BatchJobOutput {
|
|
939
989
|
/** A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). */
|
|
940
|
-
readonly id
|
|
990
|
+
readonly id: string;
|
|
941
991
|
/** The display name for the Job. */
|
|
942
992
|
readonly displayName?: string;
|
|
943
993
|
/** Whether Tasks in the Job can define dependencies on each other. The default is false. */
|
|
944
994
|
readonly usesTaskDependencies?: boolean;
|
|
945
995
|
/** The URL of the Job. */
|
|
946
|
-
readonly url
|
|
996
|
+
readonly url: string;
|
|
947
997
|
/** The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime. */
|
|
948
|
-
readonly eTag
|
|
998
|
+
readonly eTag: string;
|
|
949
999
|
/** The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state. */
|
|
950
|
-
readonly lastModified
|
|
1000
|
+
readonly lastModified: string;
|
|
951
1001
|
/** The creation time of the Job. */
|
|
952
|
-
readonly creationTime
|
|
1002
|
+
readonly creationTime: string;
|
|
953
1003
|
/**
|
|
954
1004
|
* The current state of the Job.
|
|
955
1005
|
*
|
|
956
1006
|
* Possible values: "active", "disabling", "disabled", "enabling", "terminating", "completed", "deleting"
|
|
957
1007
|
*/
|
|
958
|
-
readonly state
|
|
1008
|
+
readonly state: BatchJobStateOutput;
|
|
959
1009
|
/** The time at which the Job entered its current state. */
|
|
960
|
-
readonly stateTransitionTime
|
|
1010
|
+
readonly stateTransitionTime: string;
|
|
961
1011
|
/**
|
|
962
1012
|
* The previous state of the Job. This property is not set if the Job is in its initial Active state.
|
|
963
1013
|
*
|
|
@@ -968,9 +1018,9 @@ export interface BatchJobOutput {
|
|
|
968
1018
|
readonly previousStateTransitionTime?: string;
|
|
969
1019
|
/** The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. */
|
|
970
1020
|
priority?: number;
|
|
971
|
-
/** Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. */
|
|
1021
|
+
/** Whether Tasks in this job can be preempted by other high priority jobs. (This property is not available by default. Please contact support for more information) If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. */
|
|
972
1022
|
allowTaskPreemption?: boolean;
|
|
973
|
-
/** The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. */
|
|
1023
|
+
/** The maximum number of tasks that can be executed in parallel for the job. (This property is not available by default. Please contact support for more information) The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. */
|
|
974
1024
|
maxParallelTasks?: number;
|
|
975
1025
|
/** The execution constraints for the Job. */
|
|
976
1026
|
constraints?: BatchJobConstraintsOutput;
|
|
@@ -989,17 +1039,17 @@ export interface BatchJobOutput {
|
|
|
989
1039
|
*
|
|
990
1040
|
* Possible values: "noaction", "terminatejob"
|
|
991
1041
|
*/
|
|
992
|
-
onAllTasksComplete?:
|
|
1042
|
+
onAllTasksComplete?: BatchAllTasksCompleteModeOutput;
|
|
993
1043
|
/**
|
|
994
1044
|
* 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.
|
|
995
1045
|
*
|
|
996
1046
|
* Possible values: "noaction", "performexitoptionsjobaction"
|
|
997
1047
|
*/
|
|
998
|
-
readonly onTaskFailure?:
|
|
999
|
-
/** The network configuration for the Job. */
|
|
1048
|
+
readonly onTaskFailure?: BatchTaskFailureModeOutput;
|
|
1049
|
+
/** (This property is not available by default. Please contact support for more information) The network configuration for the Job. */
|
|
1000
1050
|
readonly networkConfiguration?: BatchJobNetworkConfigurationOutput;
|
|
1001
1051
|
/** 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. */
|
|
1002
|
-
metadata?: Array<
|
|
1052
|
+
metadata?: Array<BatchMetadataItemOutput>;
|
|
1003
1053
|
/** The execution information for the Job. */
|
|
1004
1054
|
readonly executionInfo?: BatchJobExecutionInfoOutput;
|
|
1005
1055
|
/** 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. */
|
|
@@ -1042,7 +1092,7 @@ export interface BatchJobManagerTaskOutput {
|
|
|
1042
1092
|
id: string;
|
|
1043
1093
|
/** 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. */
|
|
1044
1094
|
displayName?: string;
|
|
1045
|
-
/** 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://
|
|
1095
|
+
/** 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). */
|
|
1046
1096
|
commandLine: string;
|
|
1047
1097
|
/** 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. */
|
|
1048
1098
|
containerSettings?: BatchTaskContainerSettingsOutput;
|
|
@@ -1100,11 +1150,11 @@ export interface OutputFileBlobContainerDestinationOutput {
|
|
|
1100
1150
|
containerUrl: string;
|
|
1101
1151
|
/** 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. */
|
|
1102
1152
|
identityReference?: BatchNodeIdentityReferenceOutput;
|
|
1103
|
-
/** 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://
|
|
1104
|
-
uploadHeaders?: Array<
|
|
1153
|
+
/** 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. */
|
|
1154
|
+
uploadHeaders?: Array<OutputFileUploadHeaderOutput>;
|
|
1105
1155
|
}
|
|
1106
1156
|
/** An HTTP header name-value pair */
|
|
1107
|
-
export interface
|
|
1157
|
+
export interface OutputFileUploadHeaderOutput {
|
|
1108
1158
|
/** The case-insensitive name of the header to be used while uploading output files. */
|
|
1109
1159
|
name: string;
|
|
1110
1160
|
/** The value of the header to be used while uploading output files. */
|
|
@@ -1137,7 +1187,7 @@ export interface BatchTaskConstraintsOutput {
|
|
|
1137
1187
|
*/
|
|
1138
1188
|
export interface AuthenticationTokenSettingsOutput {
|
|
1139
1189
|
/** 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. */
|
|
1140
|
-
access?:
|
|
1190
|
+
access?: BatchAccessScopeOutput[];
|
|
1141
1191
|
}
|
|
1142
1192
|
/**
|
|
1143
1193
|
* A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.
|
|
@@ -1170,7 +1220,7 @@ export interface AuthenticationTokenSettingsOutput {
|
|
|
1170
1220
|
export interface BatchJobPreparationTaskOutput {
|
|
1171
1221
|
/** 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). */
|
|
1172
1222
|
id?: string;
|
|
1173
|
-
/** 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://
|
|
1223
|
+
/** 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). */
|
|
1174
1224
|
commandLine: string;
|
|
1175
1225
|
/** 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. */
|
|
1176
1226
|
containerSettings?: BatchTaskContainerSettingsOutput;
|
|
@@ -1208,7 +1258,7 @@ export interface BatchJobPreparationTaskOutput {
|
|
|
1208
1258
|
export interface BatchJobReleaseTaskOutput {
|
|
1209
1259
|
/** 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). */
|
|
1210
1260
|
id?: string;
|
|
1211
|
-
/** 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://
|
|
1261
|
+
/** 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). */
|
|
1212
1262
|
commandLine: string;
|
|
1213
1263
|
/** 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. */
|
|
1214
1264
|
containerSettings?: BatchTaskContainerSettingsOutput;
|
|
@@ -1252,7 +1302,7 @@ export interface BatchAutoPoolSpecificationOutput {
|
|
|
1252
1302
|
export interface BatchPoolSpecificationOutput {
|
|
1253
1303
|
/** 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. */
|
|
1254
1304
|
displayName?: string;
|
|
1255
|
-
/** 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://
|
|
1305
|
+
/** 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). */
|
|
1256
1306
|
vmSize: string;
|
|
1257
1307
|
/** The virtual machine configuration for the Pool. This property must be specified. */
|
|
1258
1308
|
virtualMachineConfiguration?: VirtualMachineConfigurationOutput;
|
|
@@ -1262,8 +1312,6 @@ export interface BatchPoolSpecificationOutput {
|
|
|
1262
1312
|
taskSchedulingPolicy?: BatchTaskSchedulingPolicyOutput;
|
|
1263
1313
|
/** The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */
|
|
1264
1314
|
resizeTimeout?: string;
|
|
1265
|
-
/** The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. */
|
|
1266
|
-
resourceTags?: string;
|
|
1267
1315
|
/** The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. */
|
|
1268
1316
|
targetDedicatedNodes?: number;
|
|
1269
1317
|
/** The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both. */
|
|
@@ -1285,24 +1333,18 @@ export interface BatchPoolSpecificationOutput {
|
|
|
1285
1333
|
/** The list of user Accounts to be created on each Compute Node in the Pool. */
|
|
1286
1334
|
userAccounts?: Array<UserAccountOutput>;
|
|
1287
1335
|
/** 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. */
|
|
1288
|
-
metadata?: Array<
|
|
1336
|
+
metadata?: Array<BatchMetadataItemOutput>;
|
|
1289
1337
|
/** A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. */
|
|
1290
1338
|
mountConfiguration?: Array<MountConfigurationOutput>;
|
|
1291
|
-
/**
|
|
1292
|
-
* The desired node communication mode for the pool. If omitted, the default value is Default.
|
|
1293
|
-
*
|
|
1294
|
-
* Possible values: "default", "classic", "simplified"
|
|
1295
|
-
*/
|
|
1296
|
-
targetNodeCommunicationMode?: BatchNodeCommunicationModeOutput;
|
|
1297
1339
|
/** The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. */
|
|
1298
1340
|
upgradePolicy?: UpgradePolicyOutput;
|
|
1299
1341
|
}
|
|
1300
|
-
/** The network configuration for the Job. */
|
|
1342
|
+
/** (This property is not available by default. Please contact support for more information) The network configuration for the Job. */
|
|
1301
1343
|
export interface BatchJobNetworkConfigurationOutput {
|
|
1302
|
-
/** 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://
|
|
1344
|
+
/** 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. */
|
|
1303
1345
|
subnetId: string;
|
|
1304
1346
|
/** 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. */
|
|
1305
|
-
skipWithdrawFromVNet
|
|
1347
|
+
skipWithdrawFromVNet?: boolean;
|
|
1306
1348
|
}
|
|
1307
1349
|
/** Contains information about the execution of a Job in the Azure Batch service. */
|
|
1308
1350
|
export interface BatchJobExecutionInfoOutput {
|
|
@@ -1324,7 +1366,7 @@ export interface BatchJobSchedulingErrorOutput {
|
|
|
1324
1366
|
*
|
|
1325
1367
|
* Possible values: "usererror", "servererror"
|
|
1326
1368
|
*/
|
|
1327
|
-
category:
|
|
1369
|
+
category: BatchErrorSourceCategoryOutput;
|
|
1328
1370
|
/** An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. */
|
|
1329
1371
|
code?: string;
|
|
1330
1372
|
/** A message describing the Job scheduling error, intended to be suitable for display in a user interface. */
|
|
@@ -1347,19 +1389,19 @@ export interface BatchJobStatisticsOutput {
|
|
|
1347
1389
|
/** 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. */
|
|
1348
1390
|
wallClockTime: string;
|
|
1349
1391
|
/** The total number of disk read operations made by all Tasks in the Job. */
|
|
1350
|
-
readIOps:
|
|
1392
|
+
readIOps: string;
|
|
1351
1393
|
/** The total number of disk write operations made by all Tasks in the Job. */
|
|
1352
|
-
writeIOps:
|
|
1394
|
+
writeIOps: string;
|
|
1353
1395
|
/** The total amount of data in GiB read from disk by all Tasks in the Job. */
|
|
1354
1396
|
readIOGiB: number;
|
|
1355
1397
|
/** The total amount of data in GiB written to disk by all Tasks in the Job. */
|
|
1356
1398
|
writeIOGiB: number;
|
|
1357
1399
|
/** 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. */
|
|
1358
|
-
numSucceededTasks:
|
|
1400
|
+
numSucceededTasks: string;
|
|
1359
1401
|
/** 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. */
|
|
1360
|
-
numFailedTasks:
|
|
1402
|
+
numFailedTasks: string;
|
|
1361
1403
|
/** The total number of retries on all the Tasks in the Job during the given time range. */
|
|
1362
|
-
numTaskRetries:
|
|
1404
|
+
numTaskRetries: string;
|
|
1363
1405
|
/** 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. */
|
|
1364
1406
|
waitTime: string;
|
|
1365
1407
|
}
|
|
@@ -1445,7 +1487,7 @@ export interface BatchTaskFailureInfoOutput {
|
|
|
1445
1487
|
*
|
|
1446
1488
|
* Possible values: "usererror", "servererror"
|
|
1447
1489
|
*/
|
|
1448
|
-
category:
|
|
1490
|
+
category: BatchErrorSourceCategoryOutput;
|
|
1449
1491
|
/** An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. */
|
|
1450
1492
|
code?: string;
|
|
1451
1493
|
/** A message describing the Task error, intended to be suitable for display in a user interface. */
|
|
@@ -1524,25 +1566,25 @@ export interface BatchTaskSlotCountsOutput {
|
|
|
1524
1566
|
*/
|
|
1525
1567
|
export interface BatchJobScheduleOutput {
|
|
1526
1568
|
/** A string that uniquely identifies the schedule within the Account. */
|
|
1527
|
-
readonly id
|
|
1569
|
+
readonly id: string;
|
|
1528
1570
|
/** The display name for the schedule. */
|
|
1529
1571
|
readonly displayName?: string;
|
|
1530
1572
|
/** The URL of the Job Schedule. */
|
|
1531
|
-
readonly url
|
|
1573
|
+
readonly url: string;
|
|
1532
1574
|
/** The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime. */
|
|
1533
|
-
readonly eTag
|
|
1575
|
+
readonly eTag: string;
|
|
1534
1576
|
/** The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state. */
|
|
1535
|
-
readonly lastModified
|
|
1577
|
+
readonly lastModified: string;
|
|
1536
1578
|
/** The creation time of the Job Schedule. */
|
|
1537
|
-
readonly creationTime
|
|
1579
|
+
readonly creationTime: string;
|
|
1538
1580
|
/**
|
|
1539
1581
|
* The current state of the Job Schedule.
|
|
1540
1582
|
*
|
|
1541
1583
|
* Possible values: "active", "completed", "disabled", "terminating", "deleting"
|
|
1542
1584
|
*/
|
|
1543
|
-
readonly state
|
|
1585
|
+
readonly state: BatchJobScheduleStateOutput;
|
|
1544
1586
|
/** The time at which the Job Schedule entered the current state. */
|
|
1545
|
-
readonly stateTransitionTime
|
|
1587
|
+
readonly stateTransitionTime: string;
|
|
1546
1588
|
/**
|
|
1547
1589
|
* The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state.
|
|
1548
1590
|
*
|
|
@@ -1556,9 +1598,9 @@ export interface BatchJobScheduleOutput {
|
|
|
1556
1598
|
/** The details of the Jobs to be created on this schedule. */
|
|
1557
1599
|
jobSpecification: BatchJobSpecificationOutput;
|
|
1558
1600
|
/** Information about Jobs that have been and will be run under this schedule. */
|
|
1559
|
-
readonly executionInfo
|
|
1601
|
+
readonly executionInfo: BatchJobScheduleExecutionInfoOutput;
|
|
1560
1602
|
/** 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. */
|
|
1561
|
-
metadata?: Array<
|
|
1603
|
+
metadata?: Array<BatchMetadataItemOutput>;
|
|
1562
1604
|
/** 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. */
|
|
1563
1605
|
readonly stats?: BatchJobScheduleStatisticsOutput;
|
|
1564
1606
|
}
|
|
@@ -1580,9 +1622,9 @@ export interface BatchJobScheduleConfigurationOutput {
|
|
|
1580
1622
|
export interface BatchJobSpecificationOutput {
|
|
1581
1623
|
/** The priority of Jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API. */
|
|
1582
1624
|
priority?: number;
|
|
1583
|
-
/** Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. */
|
|
1625
|
+
/** Whether Tasks in this job can be preempted by other high priority jobs. (This property is not available by default. Please contact support for more information) If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API. */
|
|
1584
1626
|
allowTaskPreemption?: boolean;
|
|
1585
|
-
/** The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. */
|
|
1627
|
+
/** The maximum number of tasks that can be executed in parallel for the job. (This property is not available by default. Please contact support for more information) The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. */
|
|
1586
1628
|
maxParallelTasks?: number;
|
|
1587
1629
|
/** The display name for Jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024. */
|
|
1588
1630
|
displayName?: string;
|
|
@@ -1593,14 +1635,14 @@ export interface BatchJobSpecificationOutput {
|
|
|
1593
1635
|
*
|
|
1594
1636
|
* Possible values: "noaction", "terminatejob"
|
|
1595
1637
|
*/
|
|
1596
|
-
onAllTasksComplete?:
|
|
1638
|
+
onAllTasksComplete?: BatchAllTasksCompleteModeOutput;
|
|
1597
1639
|
/**
|
|
1598
1640
|
* 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.
|
|
1599
1641
|
*
|
|
1600
1642
|
* Possible values: "noaction", "performexitoptionsjobaction"
|
|
1601
1643
|
*/
|
|
1602
|
-
onTaskFailure?:
|
|
1603
|
-
/** The network configuration for the Job. */
|
|
1644
|
+
onTaskFailure?: BatchTaskFailureModeOutput;
|
|
1645
|
+
/** (This property is not available by default. Please contact support for more information) The network configuration for the Job. */
|
|
1604
1646
|
networkConfiguration?: BatchJobNetworkConfigurationOutput;
|
|
1605
1647
|
/** The execution constraints for Jobs created under this schedule. */
|
|
1606
1648
|
constraints?: BatchJobConstraintsOutput;
|
|
@@ -1615,7 +1657,7 @@ export interface BatchJobSpecificationOutput {
|
|
|
1615
1657
|
/** The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. */
|
|
1616
1658
|
poolInfo: BatchPoolInfoOutput;
|
|
1617
1659
|
/** 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. */
|
|
1618
|
-
metadata?: Array<
|
|
1660
|
+
metadata?: Array<BatchMetadataItemOutput>;
|
|
1619
1661
|
}
|
|
1620
1662
|
/**
|
|
1621
1663
|
* Contains information about Jobs that have been and will be run under a Job
|
|
@@ -1651,19 +1693,19 @@ export interface BatchJobScheduleStatisticsOutput {
|
|
|
1651
1693
|
/** 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. */
|
|
1652
1694
|
wallClockTime: string;
|
|
1653
1695
|
/** The total number of disk read operations made by all Tasks in all Jobs created under the schedule. */
|
|
1654
|
-
readIOps:
|
|
1696
|
+
readIOps: string;
|
|
1655
1697
|
/** The total number of disk write operations made by all Tasks in all Jobs created under the schedule. */
|
|
1656
|
-
writeIOps:
|
|
1698
|
+
writeIOps: string;
|
|
1657
1699
|
/** The total gibibytes read from disk by all Tasks in all Jobs created under the schedule. */
|
|
1658
1700
|
readIOGiB: number;
|
|
1659
1701
|
/** The total gibibytes written to disk by all Tasks in all Jobs created under the schedule. */
|
|
1660
1702
|
writeIOGiB: number;
|
|
1661
1703
|
/** 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. */
|
|
1662
|
-
numSucceededTasks:
|
|
1704
|
+
numSucceededTasks: string;
|
|
1663
1705
|
/** 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. */
|
|
1664
|
-
numFailedTasks:
|
|
1706
|
+
numFailedTasks: string;
|
|
1665
1707
|
/** The total number of retries during the given time range on all Tasks in all Jobs created under the schedule. */
|
|
1666
|
-
numTaskRetries:
|
|
1708
|
+
numTaskRetries: string;
|
|
1667
1709
|
/** 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. */
|
|
1668
1710
|
waitTime: string;
|
|
1669
1711
|
}
|
|
@@ -1704,7 +1746,7 @@ export interface ExitOptionsOutput {
|
|
|
1704
1746
|
*
|
|
1705
1747
|
* Possible values: "none", "disable", "terminate"
|
|
1706
1748
|
*/
|
|
1707
|
-
jobAction?:
|
|
1749
|
+
jobAction?: BatchJobActionKindOutput;
|
|
1708
1750
|
/**
|
|
1709
1751
|
* 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.
|
|
1710
1752
|
*
|
|
@@ -1728,7 +1770,7 @@ export interface ExitCodeRangeMappingOutput {
|
|
|
1728
1770
|
* A locality hint that can be used by the Batch service to select a Compute Node
|
|
1729
1771
|
* on which to start a Task.
|
|
1730
1772
|
*/
|
|
1731
|
-
export interface
|
|
1773
|
+
export interface BatchAffinityInfoOutput {
|
|
1732
1774
|
/** 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. */
|
|
1733
1775
|
affinityId: string;
|
|
1734
1776
|
}
|
|
@@ -1787,17 +1829,17 @@ export interface BatchTaskListResultOutput {
|
|
|
1787
1829
|
*/
|
|
1788
1830
|
export interface BatchTaskOutput {
|
|
1789
1831
|
/** A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. */
|
|
1790
|
-
readonly id
|
|
1832
|
+
readonly id: string;
|
|
1791
1833
|
/** A display name for the Task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. */
|
|
1792
1834
|
readonly displayName?: string;
|
|
1793
1835
|
/** The URL of the Task. */
|
|
1794
|
-
readonly url
|
|
1836
|
+
readonly url: string;
|
|
1795
1837
|
/** The ETag of the Task. This is an opaque string. You can use it to detect whether the Task has changed between requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect only if nobody else has modified the Task in the meantime. */
|
|
1796
|
-
readonly eTag
|
|
1838
|
+
readonly eTag: string;
|
|
1797
1839
|
/** The last modified time of the Task. */
|
|
1798
|
-
readonly lastModified
|
|
1840
|
+
readonly lastModified: string;
|
|
1799
1841
|
/** The creation time of the Task. */
|
|
1800
|
-
readonly creationTime
|
|
1842
|
+
readonly creationTime: string;
|
|
1801
1843
|
/** How the Batch service should respond when the Task completes. */
|
|
1802
1844
|
readonly exitConditions?: ExitConditionsOutput;
|
|
1803
1845
|
/**
|
|
@@ -1805,9 +1847,9 @@ export interface BatchTaskOutput {
|
|
|
1805
1847
|
*
|
|
1806
1848
|
* Possible values: "active", "preparing", "running", "completed"
|
|
1807
1849
|
*/
|
|
1808
|
-
readonly state
|
|
1850
|
+
readonly state: BatchTaskStateOutput;
|
|
1809
1851
|
/** The time at which the Task entered its current state. */
|
|
1810
|
-
readonly stateTransitionTime
|
|
1852
|
+
readonly stateTransitionTime: string;
|
|
1811
1853
|
/**
|
|
1812
1854
|
* The previous state of the Task. This property is not set if the Task is in its initial Active state.
|
|
1813
1855
|
*
|
|
@@ -1816,8 +1858,8 @@ export interface BatchTaskOutput {
|
|
|
1816
1858
|
readonly previousState?: BatchTaskStateOutput;
|
|
1817
1859
|
/** The time at which the Task entered its previous state. This property is not set if the Task is in its initial Active state. */
|
|
1818
1860
|
readonly previousStateTransitionTime?: string;
|
|
1819
|
-
/** 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://
|
|
1820
|
-
readonly commandLine
|
|
1861
|
+
/** 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). */
|
|
1862
|
+
readonly commandLine: string;
|
|
1821
1863
|
/** 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. */
|
|
1822
1864
|
readonly containerSettings?: BatchTaskContainerSettingsOutput;
|
|
1823
1865
|
/** A list of files that the Batch service will download to the Compute Node before running the command line. For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. */
|
|
@@ -1827,7 +1869,7 @@ export interface BatchTaskOutput {
|
|
|
1827
1869
|
/** A list of environment variable settings for the Task. */
|
|
1828
1870
|
readonly environmentSettings?: Array<EnvironmentSettingOutput>;
|
|
1829
1871
|
/** A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. */
|
|
1830
|
-
readonly affinityInfo?:
|
|
1872
|
+
readonly affinityInfo?: BatchAffinityInfoOutput;
|
|
1831
1873
|
/** The execution constraints that apply to this Task. */
|
|
1832
1874
|
constraints?: BatchTaskConstraintsOutput;
|
|
1833
1875
|
/** 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. */
|
|
@@ -1906,9 +1948,9 @@ export interface BatchTaskStatisticsOutput {
|
|
|
1906
1948
|
/** 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. */
|
|
1907
1949
|
wallClockTime: string;
|
|
1908
1950
|
/** The total number of disk read operations made by the Task. */
|
|
1909
|
-
readIOps:
|
|
1951
|
+
readIOps: string;
|
|
1910
1952
|
/** The total number of disk write operations made by the Task. */
|
|
1911
|
-
writeIOps:
|
|
1953
|
+
writeIOps: string;
|
|
1912
1954
|
/** The total gibibytes read from disk by the Task. */
|
|
1913
1955
|
readIOGiB: number;
|
|
1914
1956
|
/** The total gibibytes written to disk by the Task. */
|
|
@@ -1916,13 +1958,13 @@ export interface BatchTaskStatisticsOutput {
|
|
|
1916
1958
|
/** 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.). */
|
|
1917
1959
|
waitTime: string;
|
|
1918
1960
|
}
|
|
1919
|
-
/** The result of
|
|
1920
|
-
export interface
|
|
1921
|
-
/** The results of the
|
|
1922
|
-
value?: Array<
|
|
1961
|
+
/** The result of creating a collection of Tasks to a Job. */
|
|
1962
|
+
export interface BatchCreateTaskCollectionResultOutput {
|
|
1963
|
+
/** The results of the create Task collection operation. */
|
|
1964
|
+
value?: Array<BatchTaskCreateResultOutput>;
|
|
1923
1965
|
}
|
|
1924
|
-
/** Result for a single Task
|
|
1925
|
-
export interface
|
|
1966
|
+
/** Result for a single Task created as part of an add Task collection operation. */
|
|
1967
|
+
export interface BatchTaskCreateResultOutput {
|
|
1926
1968
|
/**
|
|
1927
1969
|
* The status of the add Task request.
|
|
1928
1970
|
*
|
|
@@ -2023,57 +2065,59 @@ export interface FilePropertiesOutput {
|
|
|
2023
2065
|
/** A Compute Node in the Batch service. */
|
|
2024
2066
|
export interface BatchNodeOutput {
|
|
2025
2067
|
/** The ID of the Compute Node. Every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes. */
|
|
2026
|
-
id
|
|
2068
|
+
readonly id: string;
|
|
2027
2069
|
/** The URL of the Compute Node. */
|
|
2028
|
-
url
|
|
2070
|
+
readonly url: string;
|
|
2029
2071
|
/**
|
|
2030
2072
|
* 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.
|
|
2031
2073
|
*
|
|
2032
2074
|
* Possible values: "idle", "rebooting", "reimaging", "running", "unusable", "creating", "starting", "waitingforstarttask", "starttaskfailed", "unknown", "leavingpool", "offline", "preempted", "upgradingos", "deallocated", "deallocating"
|
|
2033
2075
|
*/
|
|
2034
|
-
state
|
|
2076
|
+
readonly state: BatchNodeStateOutput;
|
|
2035
2077
|
/**
|
|
2036
2078
|
* Whether the Compute Node is available for Task scheduling.
|
|
2037
2079
|
*
|
|
2038
2080
|
* Possible values: "enabled", "disabled"
|
|
2039
2081
|
*/
|
|
2040
|
-
schedulingState?: SchedulingStateOutput;
|
|
2082
|
+
readonly schedulingState?: SchedulingStateOutput;
|
|
2041
2083
|
/** The time at which the Compute Node entered its current state. */
|
|
2042
|
-
stateTransitionTime
|
|
2084
|
+
readonly stateTransitionTime: string;
|
|
2043
2085
|
/** The last time at which the Compute Node was started. This property may not be present if the Compute Node state is unusable. */
|
|
2044
|
-
lastBootTime
|
|
2086
|
+
readonly lastBootTime: string;
|
|
2045
2087
|
/** The time at which this Compute Node was allocated to the Pool. This is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted. */
|
|
2046
|
-
allocationTime
|
|
2088
|
+
readonly allocationTime: string;
|
|
2047
2089
|
/** The IP address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes. */
|
|
2048
|
-
ipAddress
|
|
2090
|
+
readonly ipAddress: string;
|
|
2091
|
+
/** The IPv6 address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes. This property will not be present if the Pool is not configured for IPv6. */
|
|
2092
|
+
readonly ipv6Address: string;
|
|
2049
2093
|
/** 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. */
|
|
2050
|
-
affinityId
|
|
2051
|
-
/** 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://
|
|
2052
|
-
vmSize
|
|
2094
|
+
readonly affinityId: string;
|
|
2095
|
+
/** 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). */
|
|
2096
|
+
readonly vmSize: string;
|
|
2053
2097
|
/** 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. */
|
|
2054
|
-
totalTasksRun
|
|
2098
|
+
readonly totalTasksRun: number;
|
|
2055
2099
|
/** The total number of currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. */
|
|
2056
|
-
runningTasksCount?: number;
|
|
2100
|
+
readonly runningTasksCount?: number;
|
|
2057
2101
|
/** The total number of scheduling slots used by currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. */
|
|
2058
|
-
runningTaskSlotsCount?: number;
|
|
2102
|
+
readonly runningTaskSlotsCount?: number;
|
|
2059
2103
|
/** The total number of Job Tasks which completed successfully (with exitCode 0) on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. */
|
|
2060
|
-
totalTasksSucceeded?: number;
|
|
2104
|
+
readonly totalTasksSucceeded?: number;
|
|
2061
2105
|
/** A list of Tasks whose state has recently changed. This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool. */
|
|
2062
|
-
recentTasks?: Array<BatchTaskInfoOutput>;
|
|
2106
|
+
readonly recentTasks?: Array<BatchTaskInfoOutput>;
|
|
2063
2107
|
/** The Task specified to run on the Compute Node as it joins the Pool. */
|
|
2064
|
-
startTask?: BatchStartTaskOutput;
|
|
2108
|
+
readonly startTask?: BatchStartTaskOutput;
|
|
2065
2109
|
/** Runtime information about the execution of the StartTask on the Compute Node. */
|
|
2066
|
-
startTaskInfo?: BatchStartTaskInfoOutput;
|
|
2110
|
+
readonly startTaskInfo?: BatchStartTaskInfoOutput;
|
|
2067
2111
|
/** The list of errors that are currently being encountered by the Compute Node. */
|
|
2068
|
-
errors?: Array<BatchNodeErrorOutput>;
|
|
2112
|
+
readonly errors?: Array<BatchNodeErrorOutput>;
|
|
2069
2113
|
/** Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a Spot/Low-priority Compute Node. */
|
|
2070
|
-
isDedicated?: boolean;
|
|
2114
|
+
readonly isDedicated?: boolean;
|
|
2071
2115
|
/** The endpoint configuration for the Compute Node. */
|
|
2072
|
-
endpointConfiguration?: BatchNodeEndpointConfigurationOutput;
|
|
2116
|
+
readonly endpointConfiguration?: BatchNodeEndpointConfigurationOutput;
|
|
2073
2117
|
/** Information about the Compute Node agent version and the time the Compute Node upgraded to a new version. */
|
|
2074
|
-
nodeAgentInfo
|
|
2118
|
+
readonly nodeAgentInfo: BatchNodeAgentInfoOutput;
|
|
2075
2119
|
/** Info about the current state of the virtual machine. */
|
|
2076
|
-
virtualMachineInfo
|
|
2120
|
+
readonly virtualMachineInfo: VirtualMachineInfoOutput;
|
|
2077
2121
|
}
|
|
2078
2122
|
/** Information about a Task running on a Compute Node. */
|
|
2079
2123
|
export interface BatchTaskInfoOutput {
|
|
@@ -2169,12 +2213,16 @@ export interface BatchNodeAgentInfoOutput {
|
|
|
2169
2213
|
/** Info about the current state of the virtual machine. */
|
|
2170
2214
|
export interface VirtualMachineInfoOutput {
|
|
2171
2215
|
/** The reference to the Azure Virtual Machine's Marketplace Image. */
|
|
2172
|
-
imageReference?:
|
|
2216
|
+
imageReference?: BatchVmImageReferenceOutput;
|
|
2173
2217
|
/** 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'. */
|
|
2174
2218
|
scaleSetVmResourceId?: string;
|
|
2175
2219
|
}
|
|
2176
2220
|
/** The remote login settings for a Compute Node. */
|
|
2177
2221
|
export interface BatchNodeRemoteLoginSettingsOutput {
|
|
2222
|
+
/** The IPv6 address used for remote login to the Compute Node. */
|
|
2223
|
+
ipv6RemoteLoginIPAddress?: string;
|
|
2224
|
+
/** The port used for remote login to the Compute Node. */
|
|
2225
|
+
ipv6RemoteLoginPort?: number;
|
|
2178
2226
|
/** The IP address used for remote login to the Compute Node. */
|
|
2179
2227
|
remoteLoginIPAddress: string;
|
|
2180
2228
|
/** The port used for remote login to the Compute Node. */
|
|
@@ -2240,6 +2288,8 @@ export interface BatchNodeVMExtensionListResultOutput {
|
|
|
2240
2288
|
export type CachingTypeOutput = string;
|
|
2241
2289
|
/** Alias for StorageAccountTypeOutput */
|
|
2242
2290
|
export type StorageAccountTypeOutput = string;
|
|
2291
|
+
/** Alias for SecurityEncryptionTypesOutput */
|
|
2292
|
+
export type SecurityEncryptionTypesOutput = string;
|
|
2243
2293
|
/** Alias for ContainerTypeOutput */
|
|
2244
2294
|
export type ContainerTypeOutput = string;
|
|
2245
2295
|
/** Alias for DiskEncryptionTargetOutput */
|
|
@@ -2248,8 +2298,8 @@ export type DiskEncryptionTargetOutput = string;
|
|
|
2248
2298
|
export type BatchNodePlacementPolicyTypeOutput = string;
|
|
2249
2299
|
/** Alias for DiffDiskPlacementOutput */
|
|
2250
2300
|
export type DiffDiskPlacementOutput = string;
|
|
2251
|
-
/** Alias for
|
|
2252
|
-
export type
|
|
2301
|
+
/** Alias for HostEndpointSettingsModeTypesOutput */
|
|
2302
|
+
export type HostEndpointSettingsModeTypesOutput = string;
|
|
2253
2303
|
/** Alias for SecurityTypesOutput */
|
|
2254
2304
|
export type SecurityTypesOutput = string;
|
|
2255
2305
|
/** Alias for DynamicVNetAssignmentScopeOutput */
|
|
@@ -2260,6 +2310,8 @@ export type InboundEndpointProtocolOutput = string;
|
|
|
2260
2310
|
export type NetworkSecurityGroupRuleAccessOutput = string;
|
|
2261
2311
|
/** Alias for IpAddressProvisioningTypeOutput */
|
|
2262
2312
|
export type IpAddressProvisioningTypeOutput = string;
|
|
2313
|
+
/** Alias for IPFamilyOutput */
|
|
2314
|
+
export type IPFamilyOutput = string;
|
|
2263
2315
|
/** Alias for ContainerWorkingDirectoryOutput */
|
|
2264
2316
|
export type ContainerWorkingDirectoryOutput = string;
|
|
2265
2317
|
/** Alias for ContainerHostDataPathOutput */
|
|
@@ -2268,12 +2320,12 @@ export type ContainerHostDataPathOutput = string;
|
|
|
2268
2320
|
export type AutoUserScopeOutput = string;
|
|
2269
2321
|
/** Alias for ElevationLevelOutput */
|
|
2270
2322
|
export type ElevationLevelOutput = string;
|
|
2323
|
+
/** Alias for BatchJobDefaultOrderOutput */
|
|
2324
|
+
export type BatchJobDefaultOrderOutput = string;
|
|
2271
2325
|
/** Alias for BatchNodeFillTypeOutput */
|
|
2272
2326
|
export type BatchNodeFillTypeOutput = string;
|
|
2273
2327
|
/** Alias for LoginModeOutput */
|
|
2274
2328
|
export type LoginModeOutput = string;
|
|
2275
|
-
/** Alias for BatchNodeCommunicationModeOutput */
|
|
2276
|
-
export type BatchNodeCommunicationModeOutput = string;
|
|
2277
2329
|
/** Alias for UpgradeModeOutput */
|
|
2278
2330
|
export type UpgradeModeOutput = string;
|
|
2279
2331
|
/** Alias for BatchPoolStateOutput */
|
|
@@ -2290,16 +2342,16 @@ export type ImageVerificationTypeOutput = string;
|
|
|
2290
2342
|
export type BatchJobStateOutput = string;
|
|
2291
2343
|
/** Alias for OutputFileUploadConditionOutput */
|
|
2292
2344
|
export type OutputFileUploadConditionOutput = string;
|
|
2293
|
-
/** Alias for
|
|
2294
|
-
export type
|
|
2345
|
+
/** Alias for BatchAccessScopeOutput */
|
|
2346
|
+
export type BatchAccessScopeOutput = string;
|
|
2295
2347
|
/** Alias for BatchPoolLifetimeOptionOutput */
|
|
2296
2348
|
export type BatchPoolLifetimeOptionOutput = string;
|
|
2297
|
-
/** Alias for
|
|
2298
|
-
export type
|
|
2299
|
-
/** Alias for
|
|
2300
|
-
export type
|
|
2301
|
-
/** Alias for
|
|
2302
|
-
export type
|
|
2349
|
+
/** Alias for BatchAllTasksCompleteModeOutput */
|
|
2350
|
+
export type BatchAllTasksCompleteModeOutput = string;
|
|
2351
|
+
/** Alias for BatchTaskFailureModeOutput */
|
|
2352
|
+
export type BatchTaskFailureModeOutput = string;
|
|
2353
|
+
/** Alias for BatchErrorSourceCategoryOutput */
|
|
2354
|
+
export type BatchErrorSourceCategoryOutput = string;
|
|
2303
2355
|
/** Alias for BatchJobPreparationTaskStateOutput */
|
|
2304
2356
|
export type BatchJobPreparationTaskStateOutput = string;
|
|
2305
2357
|
/** Alias for BatchTaskExecutionResultOutput */
|
|
@@ -2308,8 +2360,8 @@ export type BatchTaskExecutionResultOutput = string;
|
|
|
2308
2360
|
export type BatchJobReleaseTaskStateOutput = string;
|
|
2309
2361
|
/** Alias for BatchJobScheduleStateOutput */
|
|
2310
2362
|
export type BatchJobScheduleStateOutput = string;
|
|
2311
|
-
/** Alias for
|
|
2312
|
-
export type
|
|
2363
|
+
/** Alias for BatchJobActionKindOutput */
|
|
2364
|
+
export type BatchJobActionKindOutput = string;
|
|
2313
2365
|
/** Alias for DependencyActionOutput */
|
|
2314
2366
|
export type DependencyActionOutput = string;
|
|
2315
2367
|
/** Alias for BatchTaskStateOutput */
|