@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
package/dist/esm/models.d.ts
CHANGED
|
@@ -1,24 +1,22 @@
|
|
|
1
1
|
/** Parameters for creating an Azure Batch Pool. */
|
|
2
|
-
export interface
|
|
2
|
+
export interface BatchPoolCreateOptions {
|
|
3
3
|
/** 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 Pool IDs within an Account that differ only by case). */
|
|
4
4
|
id: string;
|
|
5
5
|
/** 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. */
|
|
6
6
|
displayName?: string;
|
|
7
|
-
/** The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available VM sizes for Pools using Images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration), see Sizes for Virtual Machines
|
|
7
|
+
/** The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available VM sizes for Pools using Images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration), see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). */
|
|
8
8
|
vmSize: string;
|
|
9
9
|
/** The virtual machine configuration for the Pool. This property must be specified. */
|
|
10
10
|
virtualMachineConfiguration?: VirtualMachineConfiguration;
|
|
11
11
|
/** 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 returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */
|
|
12
12
|
resizeTimeout?: string;
|
|
13
|
-
/** 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'. */
|
|
14
|
-
resourceTags?: Record<string, string>;
|
|
15
13
|
/** 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. */
|
|
16
14
|
targetDedicatedNodes?: number;
|
|
17
15
|
/** 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. */
|
|
18
16
|
targetLowPriorityNodes?: number;
|
|
19
17
|
/** Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false. */
|
|
20
18
|
enableAutoScale?: boolean;
|
|
21
|
-
/** A formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://
|
|
19
|
+
/** A formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling). */
|
|
22
20
|
autoScaleFormula?: string;
|
|
23
21
|
/** The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */
|
|
24
22
|
autoScaleEvaluationInterval?: string;
|
|
@@ -37,15 +35,9 @@ export interface BatchPoolCreateContent {
|
|
|
37
35
|
/** The list of user Accounts to be created on each Compute Node in the Pool. */
|
|
38
36
|
userAccounts?: Array<UserAccount>;
|
|
39
37
|
/** 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. */
|
|
40
|
-
metadata?: Array<
|
|
38
|
+
metadata?: Array<BatchMetadataItem>;
|
|
41
39
|
/** 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. */
|
|
42
40
|
mountConfiguration?: Array<MountConfiguration>;
|
|
43
|
-
/**
|
|
44
|
-
* The desired node communication mode for the pool. If omitted, the default value is Default.
|
|
45
|
-
*
|
|
46
|
-
* Possible values: "default", "classic", "simplified"
|
|
47
|
-
*/
|
|
48
|
-
targetNodeCommunicationMode?: BatchNodeCommunicationMode;
|
|
49
41
|
/** The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. */
|
|
50
42
|
upgradePolicy?: UpgradePolicy;
|
|
51
43
|
}
|
|
@@ -55,12 +47,12 @@ export interface BatchPoolCreateContent {
|
|
|
55
47
|
*/
|
|
56
48
|
export interface VirtualMachineConfiguration {
|
|
57
49
|
/** A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. */
|
|
58
|
-
imageReference:
|
|
50
|
+
imageReference: BatchVmImageReference;
|
|
59
51
|
/** 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. */
|
|
60
52
|
nodeAgentSKUId: string;
|
|
61
53
|
/** Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image. */
|
|
62
54
|
windowsConfiguration?: WindowsConfiguration;
|
|
63
|
-
/** 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://
|
|
55
|
+
/** 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. */
|
|
64
56
|
dataDisks?: Array<DataDisk>;
|
|
65
57
|
/**
|
|
66
58
|
* This only applies to Images that contain the Windows operating system, and
|
|
@@ -75,7 +67,7 @@ export interface VirtualMachineConfiguration {
|
|
|
75
67
|
*/
|
|
76
68
|
licenseType?: string;
|
|
77
69
|
/** 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. */
|
|
78
|
-
containerConfiguration?:
|
|
70
|
+
containerConfiguration?: BatchContainerConfiguration;
|
|
79
71
|
/** The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning. */
|
|
80
72
|
diskEncryptionConfiguration?: DiskEncryptionConfiguration;
|
|
81
73
|
/** The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated. */
|
|
@@ -83,7 +75,7 @@ export interface VirtualMachineConfiguration {
|
|
|
83
75
|
/** The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node. */
|
|
84
76
|
extensions?: Array<VMExtension>;
|
|
85
77
|
/** Settings for the operating system disk of the Virtual Machine. */
|
|
86
|
-
osDisk?:
|
|
78
|
+
osDisk?: BatchOsDisk;
|
|
87
79
|
/** Specifies the security profile settings for the virtual machine or virtual machine scale set. */
|
|
88
80
|
securityProfile?: SecurityProfile;
|
|
89
81
|
/** 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} */
|
|
@@ -94,7 +86,7 @@ export interface VirtualMachineConfiguration {
|
|
|
94
86
|
* To get the list of all Azure Marketplace Image references verified by Azure Batch, see the
|
|
95
87
|
* ' List Supported Images ' operation.
|
|
96
88
|
*/
|
|
97
|
-
export interface
|
|
89
|
+
export interface BatchVmImageReference {
|
|
98
90
|
/** The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. */
|
|
99
91
|
publisher?: string;
|
|
100
92
|
/** The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. */
|
|
@@ -103,7 +95,7 @@ export interface ImageReference {
|
|
|
103
95
|
sku?: string;
|
|
104
96
|
/** 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'. */
|
|
105
97
|
version?: string;
|
|
106
|
-
/** 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://
|
|
98
|
+
/** 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. */
|
|
107
99
|
virtualMachineImageId?: string;
|
|
108
100
|
/** The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. */
|
|
109
101
|
sharedGalleryImageId?: string;
|
|
@@ -131,6 +123,8 @@ export interface DataDisk {
|
|
|
131
123
|
caching?: CachingType;
|
|
132
124
|
/** The initial disk size in gigabytes. */
|
|
133
125
|
diskSizeGB: number;
|
|
126
|
+
/** The managed disk parameters. */
|
|
127
|
+
managedDisk?: ManagedDisk;
|
|
134
128
|
/**
|
|
135
129
|
* The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs".
|
|
136
130
|
*
|
|
@@ -138,8 +132,35 @@ export interface DataDisk {
|
|
|
138
132
|
*/
|
|
139
133
|
storageAccountType?: StorageAccountType;
|
|
140
134
|
}
|
|
135
|
+
/** The managed disk parameters. */
|
|
136
|
+
export interface ManagedDisk {
|
|
137
|
+
/** Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. */
|
|
138
|
+
diskEncryptionSet?: DiskEncryptionSetParameters;
|
|
139
|
+
/**
|
|
140
|
+
* The storage account type for managed disk.
|
|
141
|
+
*
|
|
142
|
+
* Possible values: "standard_lrs", "premium_lrs", "standardssd_lrs"
|
|
143
|
+
*/
|
|
144
|
+
storageAccountType?: StorageAccountType;
|
|
145
|
+
/** Specifies the security profile settings for the managed disk. */
|
|
146
|
+
securityProfile?: BatchVmDiskSecurityProfile;
|
|
147
|
+
}
|
|
148
|
+
/** The ARM resource id of the disk encryption set. */
|
|
149
|
+
export interface DiskEncryptionSetParameters {
|
|
150
|
+
/** The ARM resource id of the disk encryption set. The resource must be in the same subscription as the Batch account. */
|
|
151
|
+
id?: string;
|
|
152
|
+
}
|
|
153
|
+
/** Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and required when using Confidential VMs. */
|
|
154
|
+
export interface BatchVmDiskSecurityProfile {
|
|
155
|
+
/**
|
|
156
|
+
* 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.
|
|
157
|
+
*
|
|
158
|
+
* Possible values: "DiskWithVMGuestState", "NonPersistedTPM", "VMGuestStateOnly"
|
|
159
|
+
*/
|
|
160
|
+
securityEncryptionType?: SecurityEncryptionTypes;
|
|
161
|
+
}
|
|
141
162
|
/** The configuration for container-enabled Pools. */
|
|
142
|
-
export interface
|
|
163
|
+
export interface BatchContainerConfiguration {
|
|
143
164
|
/**
|
|
144
165
|
* The container technology to be used.
|
|
145
166
|
*
|
|
@@ -176,9 +197,25 @@ export interface BatchNodeIdentityReference {
|
|
|
176
197
|
* Azure Compute Gallery Image.
|
|
177
198
|
*/
|
|
178
199
|
export interface DiskEncryptionConfiguration {
|
|
200
|
+
/** 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. */
|
|
201
|
+
customerManagedKey?: DiskCustomerManagedKey;
|
|
179
202
|
/** 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. */
|
|
180
203
|
targets?: DiskEncryptionTarget[];
|
|
181
204
|
}
|
|
205
|
+
/** The Customer Managed Key reference to encrypt the Disk. */
|
|
206
|
+
export interface DiskCustomerManagedKey {
|
|
207
|
+
/** The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. */
|
|
208
|
+
identityReference?: BatchPoolIdentityReference;
|
|
209
|
+
/** Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. */
|
|
210
|
+
keyUrl?: string;
|
|
211
|
+
/** Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. */
|
|
212
|
+
rotationToLatestKeyVersionEnabled?: boolean;
|
|
213
|
+
}
|
|
214
|
+
/** The reference of one of the pool identities to encrypt Disk. This identity will be used to access the key vault. */
|
|
215
|
+
export interface BatchPoolIdentityReference {
|
|
216
|
+
/** The ARM resource id of the user assigned identity. This reference must be included in the pool identities. */
|
|
217
|
+
resourceId?: string;
|
|
218
|
+
}
|
|
182
219
|
/**
|
|
183
220
|
* For regional placement, nodes in the pool will be allocated in the same region.
|
|
184
221
|
* For zonal placement, nodes in the pool will be spread across different zones
|
|
@@ -188,7 +225,7 @@ export interface BatchNodePlacementConfiguration {
|
|
|
188
225
|
/**
|
|
189
226
|
* 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.
|
|
190
227
|
*
|
|
191
|
-
* Possible values: "
|
|
228
|
+
* Possible values: "regional", "zonal"
|
|
192
229
|
*/
|
|
193
230
|
policy?: BatchNodePlacementPolicyType;
|
|
194
231
|
}
|
|
@@ -214,9 +251,9 @@ export interface VMExtension {
|
|
|
214
251
|
provisionAfterExtensions?: string[];
|
|
215
252
|
}
|
|
216
253
|
/** Settings for the operating system disk of the compute node (VM). */
|
|
217
|
-
export interface
|
|
254
|
+
export interface BatchOsDisk {
|
|
218
255
|
/** Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). */
|
|
219
|
-
ephemeralOSDiskSettings?:
|
|
256
|
+
ephemeralOSDiskSettings?: BatchDiffDiskSettings;
|
|
220
257
|
/**
|
|
221
258
|
* Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage.
|
|
222
259
|
*
|
|
@@ -234,49 +271,51 @@ export interface OSDisk {
|
|
|
234
271
|
* Specifies the ephemeral Disk Settings for the operating system disk used by the
|
|
235
272
|
* compute node (VM).
|
|
236
273
|
*/
|
|
237
|
-
export interface
|
|
274
|
+
export interface BatchDiffDiskSettings {
|
|
238
275
|
/**
|
|
239
|
-
* 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://
|
|
276
|
+
* 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.
|
|
240
277
|
*
|
|
241
278
|
* Possible values: "cachedisk"
|
|
242
279
|
*/
|
|
243
280
|
placement?: DiffDiskPlacement;
|
|
244
281
|
}
|
|
245
|
-
/** The managed disk parameters. */
|
|
246
|
-
export interface ManagedDisk {
|
|
247
|
-
/**
|
|
248
|
-
* The storage account type for managed disk.
|
|
249
|
-
*
|
|
250
|
-
* Possible values: "standard_lrs", "premium_lrs", "standardssd_lrs"
|
|
251
|
-
*/
|
|
252
|
-
storageAccountType?: StorageAccountType;
|
|
253
|
-
/** Specifies the security profile settings for the managed disk. */
|
|
254
|
-
securityProfile?: VMDiskSecurityProfile;
|
|
255
|
-
}
|
|
256
|
-
/** Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and required when using Confidential VMs. */
|
|
257
|
-
export interface VMDiskSecurityProfile {
|
|
258
|
-
/**
|
|
259
|
-
* 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.
|
|
260
|
-
*
|
|
261
|
-
* Possible values: "NonPersistedTPM", "VMGuestStateOnly"
|
|
262
|
-
*/
|
|
263
|
-
securityEncryptionType?: SecurityEncryptionTypes;
|
|
264
|
-
}
|
|
265
282
|
/** Specifies the security profile settings for the virtual machine or virtual machine scale set. */
|
|
266
283
|
export interface SecurityProfile {
|
|
267
284
|
/** 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. */
|
|
268
|
-
encryptionAtHost
|
|
285
|
+
encryptionAtHost?: boolean;
|
|
286
|
+
/** Specifies ProxyAgent settings while creating the virtual machine. */
|
|
287
|
+
proxyAgentSettings?: ProxyAgentSettings;
|
|
269
288
|
/**
|
|
270
289
|
* Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
|
|
271
290
|
*
|
|
272
291
|
* Possible values: "trustedLaunch", "confidentialVM"
|
|
273
292
|
*/
|
|
274
|
-
securityType
|
|
293
|
+
securityType?: SecurityTypes;
|
|
275
294
|
/** 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. */
|
|
276
|
-
uefiSettings
|
|
295
|
+
uefiSettings?: BatchUefiSettings;
|
|
296
|
+
}
|
|
297
|
+
/** Specifies ProxyAgent settings while creating the virtual machine. */
|
|
298
|
+
export interface ProxyAgentSettings {
|
|
299
|
+
/** Specifies whether Metadata Security Protocol feature should be enabled on the virtual machine or virtual machine scale set. Default is False. */
|
|
300
|
+
enabled?: boolean;
|
|
301
|
+
/** Settings for the IMDS endpoint. */
|
|
302
|
+
imds?: HostEndpointSettings;
|
|
303
|
+
/** Settings for the WireServer endpoint. */
|
|
304
|
+
wireServer?: HostEndpointSettings;
|
|
305
|
+
}
|
|
306
|
+
/** Specifies particular host endpoint settings. */
|
|
307
|
+
export interface HostEndpointSettings {
|
|
308
|
+
/** 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}. */
|
|
309
|
+
inVMAccessControlProfileReferenceId?: string;
|
|
310
|
+
/**
|
|
311
|
+
* Specifies the access control policy execution mode.
|
|
312
|
+
*
|
|
313
|
+
* Possible values: "Audit", "Enforce"
|
|
314
|
+
*/
|
|
315
|
+
mode?: HostEndpointSettingsModeTypes;
|
|
277
316
|
}
|
|
278
317
|
/** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. */
|
|
279
|
-
export interface
|
|
318
|
+
export interface BatchUefiSettings {
|
|
280
319
|
/** Specifies whether secure boot should be enabled on the virtual machine. */
|
|
281
320
|
secureBootEnabled?: boolean;
|
|
282
321
|
/** Specifies whether vTPM should be enabled on the virtual machine. */
|
|
@@ -292,7 +331,7 @@ export interface ServiceArtifactReference {
|
|
|
292
331
|
}
|
|
293
332
|
/** The network configuration for a Pool. */
|
|
294
333
|
export interface NetworkConfiguration {
|
|
295
|
-
/** 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
|
|
334
|
+
/** 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 */
|
|
296
335
|
subnetId?: string;
|
|
297
336
|
/**
|
|
298
337
|
* The scope of dynamic vnet assignment.
|
|
@@ -303,20 +342,20 @@ export interface NetworkConfiguration {
|
|
|
303
342
|
/** The configuration for endpoints on Compute Nodes in the Batch Pool. */
|
|
304
343
|
endpointConfiguration?: BatchPoolEndpointConfiguration;
|
|
305
344
|
/** The Public IPAddress configuration for Compute Nodes in the Batch Pool. */
|
|
306
|
-
publicIPAddressConfiguration?:
|
|
345
|
+
publicIPAddressConfiguration?: BatchPublicIpAddressConfiguration;
|
|
307
346
|
/** 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. */
|
|
308
347
|
enableAcceleratedNetworking?: boolean;
|
|
309
348
|
}
|
|
310
349
|
/** The endpoint configuration for a Pool. */
|
|
311
350
|
export interface BatchPoolEndpointConfiguration {
|
|
312
351
|
/** 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. */
|
|
313
|
-
inboundNATPools: Array<
|
|
352
|
+
inboundNATPools: Array<BatchInboundNatPool>;
|
|
314
353
|
}
|
|
315
354
|
/**
|
|
316
355
|
* A inbound NAT Pool that can be used to address specific ports on Compute Nodes
|
|
317
356
|
* in a Batch Pool externally.
|
|
318
357
|
*/
|
|
319
|
-
export interface
|
|
358
|
+
export interface BatchInboundNatPool {
|
|
320
359
|
/** 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. */
|
|
321
360
|
name: string;
|
|
322
361
|
/**
|
|
@@ -325,7 +364,7 @@ export interface InboundNatPool {
|
|
|
325
364
|
* Possible values: "tcp", "udp"
|
|
326
365
|
*/
|
|
327
366
|
protocol: InboundEndpointProtocol;
|
|
328
|
-
/** The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for
|
|
367
|
+
/** 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. */
|
|
329
368
|
backendPort: number;
|
|
330
369
|
/** 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. */
|
|
331
370
|
frontendPortRangeStart: number;
|
|
@@ -350,15 +389,26 @@ export interface NetworkSecurityGroupRule {
|
|
|
350
389
|
sourcePortRanges?: string[];
|
|
351
390
|
}
|
|
352
391
|
/** The public IP Address configuration of the networking configuration of a Pool. */
|
|
353
|
-
export interface
|
|
392
|
+
export interface BatchPublicIpAddressConfiguration {
|
|
354
393
|
/**
|
|
355
394
|
* The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged.
|
|
356
395
|
*
|
|
357
396
|
* Possible values: "batchmanaged", "usermanaged", "nopublicipaddresses"
|
|
358
397
|
*/
|
|
359
398
|
provision?: IpAddressProvisioningType;
|
|
399
|
+
/** 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. */
|
|
400
|
+
ipFamilies?: IPFamily[];
|
|
360
401
|
/** 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}. */
|
|
361
402
|
ipAddressIds?: string[];
|
|
403
|
+
/** 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. */
|
|
404
|
+
ipTags?: Array<IPTag>;
|
|
405
|
+
}
|
|
406
|
+
/** Contains the IP tag associated with the public IP address. */
|
|
407
|
+
export interface IPTag {
|
|
408
|
+
/** The IP Tag type. Example: FirstPartyUsage. */
|
|
409
|
+
ipTagType?: string;
|
|
410
|
+
/** The value of the IP tag associated with the public IP. Example: SQL. */
|
|
411
|
+
tag?: string;
|
|
362
412
|
}
|
|
363
413
|
/**
|
|
364
414
|
* Batch will retry Tasks when a recovery operation is triggered on a Node.
|
|
@@ -376,7 +426,7 @@ export interface PublicIpAddressConfiguration {
|
|
|
376
426
|
* block Batch from being able to re-run the StartTask.
|
|
377
427
|
*/
|
|
378
428
|
export interface BatchStartTask {
|
|
379
|
-
/** 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://
|
|
429
|
+
/** 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). */
|
|
380
430
|
commandLine: string;
|
|
381
431
|
/** 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. */
|
|
382
432
|
containerSettings?: BatchTaskContainerSettings;
|
|
@@ -413,7 +463,7 @@ export interface ContainerHostBatchBindMountEntry {
|
|
|
413
463
|
/**
|
|
414
464
|
* The path which be mounted to container customer can select.
|
|
415
465
|
*
|
|
416
|
-
* Possible values: "
|
|
466
|
+
* Possible values: "Shared", "Startup", "VfsMounts", "Task", "JobPrep", "Applications"
|
|
417
467
|
*/
|
|
418
468
|
source?: ContainerHostDataPath;
|
|
419
469
|
/** 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. */
|
|
@@ -453,7 +503,7 @@ export interface UserIdentity {
|
|
|
453
503
|
/** Specifies the options for the auto user that runs an Azure Batch Task. */
|
|
454
504
|
export interface AutoUserSpecification {
|
|
455
505
|
/**
|
|
456
|
-
* The scope for the auto user. The default value is pool. If the pool is running Windows
|
|
506
|
+
* 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.
|
|
457
507
|
*
|
|
458
508
|
* Possible values: "task", "pool"
|
|
459
509
|
*/
|
|
@@ -474,6 +524,12 @@ export interface BatchApplicationPackageReference {
|
|
|
474
524
|
}
|
|
475
525
|
/** Specifies how Tasks should be distributed across Compute Nodes. */
|
|
476
526
|
export interface BatchTaskSchedulingPolicy {
|
|
527
|
+
/**
|
|
528
|
+
* The order for scheduling tasks from different jobs with the same priority. If not specified, the default is none.
|
|
529
|
+
*
|
|
530
|
+
* Possible values: "none", "creationtime"
|
|
531
|
+
*/
|
|
532
|
+
jobDefaultOrder?: BatchJobDefaultOrder;
|
|
477
533
|
/**
|
|
478
534
|
* How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.
|
|
479
535
|
*
|
|
@@ -523,7 +579,7 @@ export interface WindowsUserConfiguration {
|
|
|
523
579
|
* The Batch service does not assign any meaning to this metadata; it is solely
|
|
524
580
|
* for the use of user code.
|
|
525
581
|
*/
|
|
526
|
-
export interface
|
|
582
|
+
export interface BatchMetadataItem {
|
|
527
583
|
/** The name of the metadata item. */
|
|
528
584
|
name: string;
|
|
529
585
|
/** The value of the metadata item. */
|
|
@@ -583,10 +639,10 @@ export interface CifsMountConfiguration {
|
|
|
583
639
|
export interface AzureFileShareConfiguration {
|
|
584
640
|
/** The Azure Storage account name. */
|
|
585
641
|
accountName: string;
|
|
586
|
-
/** The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. */
|
|
587
|
-
azureFileUrl: string;
|
|
588
642
|
/** The Azure Storage account key. */
|
|
589
643
|
accountKey: string;
|
|
644
|
+
/** The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'. */
|
|
645
|
+
azureFileUrl: string;
|
|
590
646
|
/** 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. */
|
|
591
647
|
relativeMountPath: string;
|
|
592
648
|
/** Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux. */
|
|
@@ -641,10 +697,10 @@ export interface NameValuePair {
|
|
|
641
697
|
value?: string;
|
|
642
698
|
}
|
|
643
699
|
/** Parameters for updating an Azure Batch Pool. */
|
|
644
|
-
export interface
|
|
700
|
+
export interface BatchPoolUpdateOptions {
|
|
645
701
|
/** 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. This field can be updated only when the pool is empty. */
|
|
646
702
|
displayName?: string;
|
|
647
|
-
/** The size of virtual machines in the Pool. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://
|
|
703
|
+
/** The size of virtual machines in the Pool. 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).<br /><br />This field can be updated only when the pool is empty. */
|
|
648
704
|
vmSize?: string;
|
|
649
705
|
/** 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.<br /><br />This field can be updated only when the pool is empty. */
|
|
650
706
|
enableInterNodeCommunication?: boolean;
|
|
@@ -653,23 +709,15 @@ export interface BatchPoolUpdateContent {
|
|
|
653
709
|
/** A list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. If this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package references are removed from the Pool. If omitted, any existing Package references are left unchanged. */
|
|
654
710
|
applicationPackageReferences?: Array<BatchApplicationPackageReference>;
|
|
655
711
|
/** A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged. */
|
|
656
|
-
metadata?: Array<
|
|
712
|
+
metadata?: Array<BatchMetadataItem>;
|
|
657
713
|
/** The virtual machine configuration for the Pool. This property must be specified.<br /><br />This field can be updated only when the pool is empty. */
|
|
658
714
|
virtualMachineConfiguration?: VirtualMachineConfiguration;
|
|
659
|
-
/**
|
|
660
|
-
* The desired node communication mode for the pool. If this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing metadata is left unchanged.
|
|
661
|
-
*
|
|
662
|
-
* Possible values: "default", "classic", "simplified"
|
|
663
|
-
*/
|
|
664
|
-
targetNodeCommunicationMode?: BatchNodeCommunicationMode;
|
|
665
715
|
/** The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.<br /><br />This field can be updated only when the pool is empty. */
|
|
666
716
|
taskSlotsPerNode?: number;
|
|
667
717
|
/** How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.<br /><br />This field can be updated only when the pool is empty. */
|
|
668
718
|
taskSchedulingPolicy?: BatchTaskSchedulingPolicy;
|
|
669
719
|
/** The network configuration for the Pool. This field can be updated only when the pool is empty. */
|
|
670
720
|
networkConfiguration?: NetworkConfiguration;
|
|
671
|
-
/** 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'.<br /><br />This field can be updated only when the pool is empty. */
|
|
672
|
-
resourceTags?: Record<string, string>;
|
|
673
721
|
/** The list of user Accounts to be created on each Compute Node in the Pool. This field can be updated only when the pool is empty. */
|
|
674
722
|
userAccounts?: Array<UserAccount>;
|
|
675
723
|
/** 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.<br /><br />This field can be updated only when the pool is empty. */
|
|
@@ -678,19 +726,19 @@ export interface BatchPoolUpdateContent {
|
|
|
678
726
|
upgradePolicy?: UpgradePolicy;
|
|
679
727
|
}
|
|
680
728
|
/** Parameters for enabling automatic scaling on an Azure Batch Pool. */
|
|
681
|
-
export interface
|
|
729
|
+
export interface BatchPoolEnableAutoScaleOptions {
|
|
682
730
|
/** The formula for the desired number of Compute Nodes in the Pool. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued. */
|
|
683
731
|
autoScaleFormula?: string;
|
|
684
732
|
/** The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued. */
|
|
685
733
|
autoScaleEvaluationInterval?: string;
|
|
686
734
|
}
|
|
687
735
|
/** Parameters for evaluating an automatic scaling formula on an Azure Batch Pool. */
|
|
688
|
-
export interface
|
|
689
|
-
/** The formula for the desired number of Compute Nodes in the Pool. The formula is validated and its results calculated, but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://
|
|
736
|
+
export interface BatchPoolEvaluateAutoScaleOptions {
|
|
737
|
+
/** The formula for the desired number of Compute Nodes in the Pool. The formula is validated and its results calculated, but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling). */
|
|
690
738
|
autoScaleFormula: string;
|
|
691
739
|
}
|
|
692
740
|
/** Parameters for changing the size of an Azure Batch Pool. */
|
|
693
|
-
export interface
|
|
741
|
+
export interface BatchPoolResizeOptions {
|
|
694
742
|
/** The desired number of dedicated Compute Nodes in the Pool. */
|
|
695
743
|
targetDedicatedNodes?: number;
|
|
696
744
|
/** The desired number of Spot/Low-priority Compute Nodes in the Pool. */
|
|
@@ -705,22 +753,16 @@ export interface BatchPoolResizeContent {
|
|
|
705
753
|
nodeDeallocationOption?: BatchNodeDeallocationOption;
|
|
706
754
|
}
|
|
707
755
|
/** Parameters for replacing properties on an Azure Batch Pool. */
|
|
708
|
-
export interface
|
|
756
|
+
export interface BatchPoolReplaceOptions {
|
|
709
757
|
/** A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is removed from the Pool. */
|
|
710
758
|
startTask?: BatchStartTask;
|
|
711
759
|
/** The list of Application Packages to be installed on each Compute Node in the Pool. The list replaces any existing Application Package references on the Pool. Changes to Application Package references affect all new Compute Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Application Package references on any given Pool. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool. */
|
|
712
760
|
applicationPackageReferences: Array<BatchApplicationPackageReference>;
|
|
713
761
|
/** A list of name-value pairs associated with the Pool as metadata. This list replaces any existing metadata configured on the Pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the Pool. */
|
|
714
|
-
metadata: Array<
|
|
715
|
-
/**
|
|
716
|
-
* The desired node communication mode for the pool. This setting replaces any existing targetNodeCommunication setting on the Pool. If omitted, the existing setting is default.
|
|
717
|
-
*
|
|
718
|
-
* Possible values: "default", "classic", "simplified"
|
|
719
|
-
*/
|
|
720
|
-
targetNodeCommunicationMode?: BatchNodeCommunicationMode;
|
|
762
|
+
metadata: Array<BatchMetadataItem>;
|
|
721
763
|
}
|
|
722
764
|
/** Parameters for removing nodes from an Azure Batch Pool. */
|
|
723
|
-
export interface
|
|
765
|
+
export interface BatchNodeRemoveOptions {
|
|
724
766
|
/** A list containing the IDs of the Compute Nodes to be removed from the specified Pool. A maximum of 100 nodes may be removed per request. */
|
|
725
767
|
nodeList: string[];
|
|
726
768
|
/** The timeout for removal of Compute Nodes to the Pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */
|
|
@@ -736,9 +778,9 @@ export interface BatchNodeRemoveContent {
|
|
|
736
778
|
export interface BatchJob {
|
|
737
779
|
/** 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. */
|
|
738
780
|
priority?: number;
|
|
739
|
-
/** 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. */
|
|
781
|
+
/** 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. */
|
|
740
782
|
allowTaskPreemption?: boolean;
|
|
741
|
-
/** 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. */
|
|
783
|
+
/** 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. */
|
|
742
784
|
maxParallelTasks?: number;
|
|
743
785
|
/** The execution constraints for the Job. */
|
|
744
786
|
constraints?: BatchJobConstraints;
|
|
@@ -749,9 +791,9 @@ export interface BatchJob {
|
|
|
749
791
|
*
|
|
750
792
|
* Possible values: "noaction", "terminatejob"
|
|
751
793
|
*/
|
|
752
|
-
onAllTasksComplete?:
|
|
794
|
+
onAllTasksComplete?: BatchAllTasksCompleteMode;
|
|
753
795
|
/** 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. */
|
|
754
|
-
metadata?: Array<
|
|
796
|
+
metadata?: Array<BatchMetadataItem>;
|
|
755
797
|
}
|
|
756
798
|
/** The execution constraints for a Job. */
|
|
757
799
|
export interface BatchJobConstraints {
|
|
@@ -790,7 +832,7 @@ export interface BatchJobManagerTask {
|
|
|
790
832
|
id: string;
|
|
791
833
|
/** 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. */
|
|
792
834
|
displayName?: string;
|
|
793
|
-
/** 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://
|
|
835
|
+
/** 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). */
|
|
794
836
|
commandLine: string;
|
|
795
837
|
/** 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. */
|
|
796
838
|
containerSettings?: BatchTaskContainerSettings;
|
|
@@ -848,11 +890,11 @@ export interface OutputFileBlobContainerDestination {
|
|
|
848
890
|
containerUrl: string;
|
|
849
891
|
/** 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. */
|
|
850
892
|
identityReference?: BatchNodeIdentityReference;
|
|
851
|
-
/** 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://
|
|
852
|
-
uploadHeaders?: Array<
|
|
893
|
+
/** 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. */
|
|
894
|
+
uploadHeaders?: Array<OutputFileUploadHeader>;
|
|
853
895
|
}
|
|
854
896
|
/** An HTTP header name-value pair */
|
|
855
|
-
export interface
|
|
897
|
+
export interface OutputFileUploadHeader {
|
|
856
898
|
/** The case-insensitive name of the header to be used while uploading output files. */
|
|
857
899
|
name: string;
|
|
858
900
|
/** The value of the header to be used while uploading output files. */
|
|
@@ -885,7 +927,7 @@ export interface BatchTaskConstraints {
|
|
|
885
927
|
*/
|
|
886
928
|
export interface AuthenticationTokenSettings {
|
|
887
929
|
/** 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. */
|
|
888
|
-
access?:
|
|
930
|
+
access?: BatchAccessScope[];
|
|
889
931
|
}
|
|
890
932
|
/**
|
|
891
933
|
* A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.
|
|
@@ -918,7 +960,7 @@ export interface AuthenticationTokenSettings {
|
|
|
918
960
|
export interface BatchJobPreparationTask {
|
|
919
961
|
/** 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). */
|
|
920
962
|
id?: string;
|
|
921
|
-
/** 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://
|
|
963
|
+
/** 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). */
|
|
922
964
|
commandLine: string;
|
|
923
965
|
/** 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. */
|
|
924
966
|
containerSettings?: BatchTaskContainerSettings;
|
|
@@ -956,7 +998,7 @@ export interface BatchJobPreparationTask {
|
|
|
956
998
|
export interface BatchJobReleaseTask {
|
|
957
999
|
/** 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). */
|
|
958
1000
|
id?: string;
|
|
959
|
-
/** 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://
|
|
1001
|
+
/** 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). */
|
|
960
1002
|
commandLine: string;
|
|
961
1003
|
/** 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. */
|
|
962
1004
|
containerSettings?: BatchTaskContainerSettings;
|
|
@@ -1000,7 +1042,7 @@ export interface BatchAutoPoolSpecification {
|
|
|
1000
1042
|
export interface BatchPoolSpecification {
|
|
1001
1043
|
/** 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. */
|
|
1002
1044
|
displayName?: string;
|
|
1003
|
-
/** 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://
|
|
1045
|
+
/** 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). */
|
|
1004
1046
|
vmSize: string;
|
|
1005
1047
|
/** The virtual machine configuration for the Pool. This property must be specified. */
|
|
1006
1048
|
virtualMachineConfiguration?: VirtualMachineConfiguration;
|
|
@@ -1010,8 +1052,6 @@ export interface BatchPoolSpecification {
|
|
|
1010
1052
|
taskSchedulingPolicy?: BatchTaskSchedulingPolicy;
|
|
1011
1053
|
/** 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). */
|
|
1012
1054
|
resizeTimeout?: string;
|
|
1013
|
-
/** 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'. */
|
|
1014
|
-
resourceTags?: string;
|
|
1015
1055
|
/** 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. */
|
|
1016
1056
|
targetDedicatedNodes?: number;
|
|
1017
1057
|
/** 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. */
|
|
@@ -1033,24 +1073,18 @@ export interface BatchPoolSpecification {
|
|
|
1033
1073
|
/** The list of user Accounts to be created on each Compute Node in the Pool. */
|
|
1034
1074
|
userAccounts?: Array<UserAccount>;
|
|
1035
1075
|
/** 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. */
|
|
1036
|
-
metadata?: Array<
|
|
1076
|
+
metadata?: Array<BatchMetadataItem>;
|
|
1037
1077
|
/** A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. */
|
|
1038
1078
|
mountConfiguration?: Array<MountConfiguration>;
|
|
1039
|
-
/**
|
|
1040
|
-
* The desired node communication mode for the pool. If omitted, the default value is Default.
|
|
1041
|
-
*
|
|
1042
|
-
* Possible values: "default", "classic", "simplified"
|
|
1043
|
-
*/
|
|
1044
|
-
targetNodeCommunicationMode?: BatchNodeCommunicationMode;
|
|
1045
1079
|
/** The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. */
|
|
1046
1080
|
upgradePolicy?: UpgradePolicy;
|
|
1047
1081
|
}
|
|
1048
|
-
/** The network configuration for the Job. */
|
|
1082
|
+
/** (This property is not available by default. Please contact support for more information) The network configuration for the Job. */
|
|
1049
1083
|
export interface BatchJobNetworkConfiguration {
|
|
1050
|
-
/** 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://
|
|
1084
|
+
/** 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. */
|
|
1051
1085
|
subnetId: string;
|
|
1052
1086
|
/** 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. */
|
|
1053
|
-
skipWithdrawFromVNet
|
|
1087
|
+
skipWithdrawFromVNet?: boolean;
|
|
1054
1088
|
}
|
|
1055
1089
|
/** Contains information about the execution of a Job in the Azure Batch service. */
|
|
1056
1090
|
export interface BatchJobExecutionInfo {
|
|
@@ -1072,7 +1106,7 @@ export interface BatchJobSchedulingError {
|
|
|
1072
1106
|
*
|
|
1073
1107
|
* Possible values: "usererror", "servererror"
|
|
1074
1108
|
*/
|
|
1075
|
-
category:
|
|
1109
|
+
category: BatchErrorSourceCategory;
|
|
1076
1110
|
/** An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. */
|
|
1077
1111
|
code?: string;
|
|
1078
1112
|
/** A message describing the Job scheduling error, intended to be suitable for display in a user interface. */
|
|
@@ -1095,29 +1129,29 @@ export interface BatchJobStatistics {
|
|
|
1095
1129
|
/** 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. */
|
|
1096
1130
|
wallClockTime: string;
|
|
1097
1131
|
/** The total number of disk read operations made by all Tasks in the Job. */
|
|
1098
|
-
readIOps:
|
|
1132
|
+
readIOps: string;
|
|
1099
1133
|
/** The total number of disk write operations made by all Tasks in the Job. */
|
|
1100
|
-
writeIOps:
|
|
1134
|
+
writeIOps: string;
|
|
1101
1135
|
/** The total amount of data in GiB read from disk by all Tasks in the Job. */
|
|
1102
1136
|
readIOGiB: number;
|
|
1103
1137
|
/** The total amount of data in GiB written to disk by all Tasks in the Job. */
|
|
1104
1138
|
writeIOGiB: number;
|
|
1105
1139
|
/** 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. */
|
|
1106
|
-
numSucceededTasks:
|
|
1140
|
+
numSucceededTasks: string;
|
|
1107
1141
|
/** 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. */
|
|
1108
|
-
numFailedTasks:
|
|
1142
|
+
numFailedTasks: string;
|
|
1109
1143
|
/** The total number of retries on all the Tasks in the Job during the given time range. */
|
|
1110
|
-
numTaskRetries:
|
|
1144
|
+
numTaskRetries: string;
|
|
1111
1145
|
/** 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. */
|
|
1112
1146
|
waitTime: string;
|
|
1113
1147
|
}
|
|
1114
1148
|
/** Parameters for updating an Azure Batch Job. */
|
|
1115
|
-
export interface
|
|
1149
|
+
export interface BatchJobUpdateOptions {
|
|
1116
1150
|
/** 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. If omitted, the priority of the Job is left unchanged. */
|
|
1117
1151
|
priority?: number;
|
|
1118
|
-
/** 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. */
|
|
1152
|
+
/** 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. */
|
|
1119
1153
|
allowTaskPreemption?: boolean;
|
|
1120
|
-
/** 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. */
|
|
1154
|
+
/** 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. */
|
|
1121
1155
|
maxParallelTasks?: number;
|
|
1122
1156
|
/** The execution constraints for the Job. If omitted, the existing execution constraints are left unchanged. */
|
|
1123
1157
|
constraints?: BatchJobConstraints;
|
|
@@ -1128,14 +1162,14 @@ export interface BatchJobUpdateContent {
|
|
|
1128
1162
|
*
|
|
1129
1163
|
* Possible values: "noaction", "terminatejob"
|
|
1130
1164
|
*/
|
|
1131
|
-
onAllTasksComplete?:
|
|
1165
|
+
onAllTasksComplete?: BatchAllTasksCompleteMode;
|
|
1132
1166
|
/** A list of name-value pairs associated with the Job as metadata. If omitted, the existing Job metadata is left unchanged. */
|
|
1133
|
-
metadata?: Array<
|
|
1134
|
-
/** The network configuration for the Job. */
|
|
1167
|
+
metadata?: Array<BatchMetadataItem>;
|
|
1168
|
+
/** (This property is not available by default. Please contact support for more information) The network configuration for the Job. */
|
|
1135
1169
|
networkConfiguration?: BatchJobNetworkConfiguration;
|
|
1136
1170
|
}
|
|
1137
1171
|
/** Parameters for disabling an Azure Batch Job. */
|
|
1138
|
-
export interface
|
|
1172
|
+
export interface BatchJobDisableOptions {
|
|
1139
1173
|
/**
|
|
1140
1174
|
* What to do with active Tasks associated with the Job.
|
|
1141
1175
|
*
|
|
@@ -1144,12 +1178,12 @@ export interface BatchJobDisableContent {
|
|
|
1144
1178
|
disableTasks: DisableBatchJobOption;
|
|
1145
1179
|
}
|
|
1146
1180
|
/** Parameters for terminating an Azure Batch Job. */
|
|
1147
|
-
export interface
|
|
1181
|
+
export interface BatchJobTerminateOptions {
|
|
1148
1182
|
/** The text you want to appear as the Job's TerminationReason. The default is 'UserTerminate'. */
|
|
1149
1183
|
terminateReason?: string;
|
|
1150
1184
|
}
|
|
1151
1185
|
/** Parameters for creating an Azure Batch Job. */
|
|
1152
|
-
export interface
|
|
1186
|
+
export interface BatchJobCreateOptions {
|
|
1153
1187
|
/** A string that uniquely identifies the Job 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). */
|
|
1154
1188
|
id: string;
|
|
1155
1189
|
/** The display name for the Job. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. */
|
|
@@ -1158,9 +1192,9 @@ export interface BatchJobCreateContent {
|
|
|
1158
1192
|
usesTaskDependencies?: boolean;
|
|
1159
1193
|
/** 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. */
|
|
1160
1194
|
priority?: number;
|
|
1161
|
-
/** 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. */
|
|
1195
|
+
/** 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. */
|
|
1162
1196
|
allowTaskPreemption?: boolean;
|
|
1163
|
-
/** 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. */
|
|
1197
|
+
/** 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. */
|
|
1164
1198
|
maxParallelTasks?: number;
|
|
1165
1199
|
/** The execution constraints for the Job. */
|
|
1166
1200
|
constraints?: BatchJobConstraints;
|
|
@@ -1179,17 +1213,17 @@ export interface BatchJobCreateContent {
|
|
|
1179
1213
|
*
|
|
1180
1214
|
* Possible values: "noaction", "terminatejob"
|
|
1181
1215
|
*/
|
|
1182
|
-
onAllTasksComplete?:
|
|
1216
|
+
onAllTasksComplete?: BatchAllTasksCompleteMode;
|
|
1183
1217
|
/**
|
|
1184
1218
|
* 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.
|
|
1185
1219
|
*
|
|
1186
1220
|
* Possible values: "noaction", "performexitoptionsjobaction"
|
|
1187
1221
|
*/
|
|
1188
|
-
onTaskFailure?:
|
|
1189
|
-
/** The network configuration for the Job. */
|
|
1222
|
+
onTaskFailure?: BatchTaskFailureMode;
|
|
1223
|
+
/** (This property is not available by default. Please contact support for more information) The network configuration for the Job. */
|
|
1190
1224
|
networkConfiguration?: BatchJobNetworkConfiguration;
|
|
1191
1225
|
/** 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. */
|
|
1192
|
-
metadata?: Array<
|
|
1226
|
+
metadata?: Array<BatchMetadataItem>;
|
|
1193
1227
|
}
|
|
1194
1228
|
/** Contains information about the container which a Task is executing. */
|
|
1195
1229
|
export interface BatchTaskContainerExecutionInfo {
|
|
@@ -1207,7 +1241,7 @@ export interface BatchTaskFailureInfo {
|
|
|
1207
1241
|
*
|
|
1208
1242
|
* Possible values: "usererror", "servererror"
|
|
1209
1243
|
*/
|
|
1210
|
-
category:
|
|
1244
|
+
category: BatchErrorSourceCategory;
|
|
1211
1245
|
/** An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. */
|
|
1212
1246
|
code?: string;
|
|
1213
1247
|
/** A message describing the Task error, intended to be suitable for display in a user interface. */
|
|
@@ -1225,7 +1259,7 @@ export interface BatchJobSchedule {
|
|
|
1225
1259
|
/** The details of the Jobs to be created on this schedule. */
|
|
1226
1260
|
jobSpecification: BatchJobSpecification;
|
|
1227
1261
|
/** 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. */
|
|
1228
|
-
metadata?: Array<
|
|
1262
|
+
metadata?: Array<BatchMetadataItem>;
|
|
1229
1263
|
}
|
|
1230
1264
|
/**
|
|
1231
1265
|
* The schedule according to which Jobs will be created. All times are fixed
|
|
@@ -1245,9 +1279,9 @@ export interface BatchJobScheduleConfiguration {
|
|
|
1245
1279
|
export interface BatchJobSpecification {
|
|
1246
1280
|
/** 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. */
|
|
1247
1281
|
priority?: number;
|
|
1248
|
-
/** 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. */
|
|
1282
|
+
/** 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. */
|
|
1249
1283
|
allowTaskPreemption?: boolean;
|
|
1250
|
-
/** 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. */
|
|
1284
|
+
/** 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. */
|
|
1251
1285
|
maxParallelTasks?: number;
|
|
1252
1286
|
/** 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. */
|
|
1253
1287
|
displayName?: string;
|
|
@@ -1258,14 +1292,14 @@ export interface BatchJobSpecification {
|
|
|
1258
1292
|
*
|
|
1259
1293
|
* Possible values: "noaction", "terminatejob"
|
|
1260
1294
|
*/
|
|
1261
|
-
onAllTasksComplete?:
|
|
1295
|
+
onAllTasksComplete?: BatchAllTasksCompleteMode;
|
|
1262
1296
|
/**
|
|
1263
1297
|
* 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.
|
|
1264
1298
|
*
|
|
1265
1299
|
* Possible values: "noaction", "performexitoptionsjobaction"
|
|
1266
1300
|
*/
|
|
1267
|
-
onTaskFailure?:
|
|
1268
|
-
/** The network configuration for the Job. */
|
|
1301
|
+
onTaskFailure?: BatchTaskFailureMode;
|
|
1302
|
+
/** (This property is not available by default. Please contact support for more information) The network configuration for the Job. */
|
|
1269
1303
|
networkConfiguration?: BatchJobNetworkConfiguration;
|
|
1270
1304
|
/** The execution constraints for Jobs created under this schedule. */
|
|
1271
1305
|
constraints?: BatchJobConstraints;
|
|
@@ -1280,7 +1314,7 @@ export interface BatchJobSpecification {
|
|
|
1280
1314
|
/** The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. */
|
|
1281
1315
|
poolInfo: BatchPoolInfo;
|
|
1282
1316
|
/** 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. */
|
|
1283
|
-
metadata?: Array<
|
|
1317
|
+
metadata?: Array<BatchMetadataItem>;
|
|
1284
1318
|
}
|
|
1285
1319
|
/**
|
|
1286
1320
|
* Contains information about Jobs that have been and will be run under a Job
|
|
@@ -1316,33 +1350,33 @@ export interface BatchJobScheduleStatistics {
|
|
|
1316
1350
|
/** 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. */
|
|
1317
1351
|
wallClockTime: string;
|
|
1318
1352
|
/** The total number of disk read operations made by all Tasks in all Jobs created under the schedule. */
|
|
1319
|
-
readIOps:
|
|
1353
|
+
readIOps: string;
|
|
1320
1354
|
/** The total number of disk write operations made by all Tasks in all Jobs created under the schedule. */
|
|
1321
|
-
writeIOps:
|
|
1355
|
+
writeIOps: string;
|
|
1322
1356
|
/** The total gibibytes read from disk by all Tasks in all Jobs created under the schedule. */
|
|
1323
1357
|
readIOGiB: number;
|
|
1324
1358
|
/** The total gibibytes written to disk by all Tasks in all Jobs created under the schedule. */
|
|
1325
1359
|
writeIOGiB: number;
|
|
1326
1360
|
/** 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. */
|
|
1327
|
-
numSucceededTasks:
|
|
1361
|
+
numSucceededTasks: string;
|
|
1328
1362
|
/** 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. */
|
|
1329
|
-
numFailedTasks:
|
|
1363
|
+
numFailedTasks: string;
|
|
1330
1364
|
/** The total number of retries during the given time range on all Tasks in all Jobs created under the schedule. */
|
|
1331
|
-
numTaskRetries:
|
|
1365
|
+
numTaskRetries: string;
|
|
1332
1366
|
/** 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. */
|
|
1333
1367
|
waitTime: string;
|
|
1334
1368
|
}
|
|
1335
1369
|
/** Parameters for updating an Azure Batch Job Schedule. */
|
|
1336
|
-
export interface
|
|
1370
|
+
export interface BatchJobScheduleUpdateOptions {
|
|
1337
1371
|
/** The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. If you do not specify this element, the existing schedule is left unchanged. */
|
|
1338
1372
|
schedule?: BatchJobScheduleConfiguration;
|
|
1339
1373
|
/** The details of the Jobs to be created on this schedule. Updates affect only Jobs that are started after the update has taken place. Any currently active Job continues with the older specification. */
|
|
1340
1374
|
jobSpecification?: BatchJobSpecification;
|
|
1341
1375
|
/** A list of name-value pairs associated with the Job Schedule as metadata. If you do not specify this element, existing metadata is left unchanged. */
|
|
1342
|
-
metadata?: Array<
|
|
1376
|
+
metadata?: Array<BatchMetadataItem>;
|
|
1343
1377
|
}
|
|
1344
1378
|
/** Parameters for creating an Azure Batch Job Schedule */
|
|
1345
|
-
export interface
|
|
1379
|
+
export interface BatchJobScheduleCreateOptions {
|
|
1346
1380
|
/** A string that uniquely identifies the schedule 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). */
|
|
1347
1381
|
id: string;
|
|
1348
1382
|
/** The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. */
|
|
@@ -1352,17 +1386,17 @@ export interface BatchJobScheduleCreateContent {
|
|
|
1352
1386
|
/** The details of the Jobs to be created on this schedule. */
|
|
1353
1387
|
jobSpecification: BatchJobSpecification;
|
|
1354
1388
|
/** 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. */
|
|
1355
|
-
metadata?: Array<
|
|
1389
|
+
metadata?: Array<BatchMetadataItem>;
|
|
1356
1390
|
}
|
|
1357
1391
|
/** Parameters for creating an Azure Batch Task. */
|
|
1358
|
-
export interface
|
|
1392
|
+
export interface BatchTaskCreateOptions {
|
|
1359
1393
|
/** 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. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a Job that differ only by case). */
|
|
1360
1394
|
id: string;
|
|
1361
1395
|
/** 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. */
|
|
1362
1396
|
displayName?: string;
|
|
1363
1397
|
/** How the Batch service should respond when the Task completes. */
|
|
1364
1398
|
exitConditions?: ExitConditions;
|
|
1365
|
-
/** 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://
|
|
1399
|
+
/** 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). */
|
|
1366
1400
|
commandLine: string;
|
|
1367
1401
|
/** 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. */
|
|
1368
1402
|
containerSettings?: BatchTaskContainerSettings;
|
|
@@ -1373,7 +1407,7 @@ export interface BatchTaskCreateContent {
|
|
|
1373
1407
|
/** A list of environment variable settings for the Task. */
|
|
1374
1408
|
environmentSettings?: Array<EnvironmentSetting>;
|
|
1375
1409
|
/** A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. */
|
|
1376
|
-
affinityInfo?:
|
|
1410
|
+
affinityInfo?: BatchAffinityInfo;
|
|
1377
1411
|
/** The execution constraints that apply to this Task. If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the Job, the maxWallClockTime is infinite, and the retentionTime is 7 days. */
|
|
1378
1412
|
constraints?: BatchTaskConstraints;
|
|
1379
1413
|
/** The number of scheduling slots that the Task required 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. */
|
|
@@ -1419,7 +1453,7 @@ export interface ExitOptions {
|
|
|
1419
1453
|
*
|
|
1420
1454
|
* Possible values: "none", "disable", "terminate"
|
|
1421
1455
|
*/
|
|
1422
|
-
jobAction?:
|
|
1456
|
+
jobAction?: BatchJobActionKind;
|
|
1423
1457
|
/**
|
|
1424
1458
|
* 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.
|
|
1425
1459
|
*
|
|
@@ -1443,7 +1477,7 @@ export interface ExitCodeRangeMapping {
|
|
|
1443
1477
|
* A locality hint that can be used by the Batch service to select a Compute Node
|
|
1444
1478
|
* on which to start a Task.
|
|
1445
1479
|
*/
|
|
1446
|
-
export interface
|
|
1480
|
+
export interface BatchAffinityInfo {
|
|
1447
1481
|
/** 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. */
|
|
1448
1482
|
affinityId: string;
|
|
1449
1483
|
}
|
|
@@ -1554,9 +1588,9 @@ export interface BatchTaskStatistics {
|
|
|
1554
1588
|
/** 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. */
|
|
1555
1589
|
wallClockTime: string;
|
|
1556
1590
|
/** The total number of disk read operations made by the Task. */
|
|
1557
|
-
readIOps:
|
|
1591
|
+
readIOps: string;
|
|
1558
1592
|
/** The total number of disk write operations made by the Task. */
|
|
1559
|
-
writeIOps:
|
|
1593
|
+
writeIOps: string;
|
|
1560
1594
|
/** The total gibibytes read from disk by the Task. */
|
|
1561
1595
|
readIOGiB: number;
|
|
1562
1596
|
/** The total gibibytes written to disk by the Task. */
|
|
@@ -1567,10 +1601,10 @@ export interface BatchTaskStatistics {
|
|
|
1567
1601
|
/** A collection of Azure Batch Tasks to add. */
|
|
1568
1602
|
export interface BatchTaskGroup {
|
|
1569
1603
|
/** The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks. */
|
|
1570
|
-
value: Array<
|
|
1604
|
+
value: Array<BatchTaskCreateOptions>;
|
|
1571
1605
|
}
|
|
1572
1606
|
/** Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node. */
|
|
1573
|
-
export interface
|
|
1607
|
+
export interface BatchNodeUserCreateOptions {
|
|
1574
1608
|
/** The user name of the Account. */
|
|
1575
1609
|
name: string;
|
|
1576
1610
|
/** Whether the Account should be an administrator on the Compute Node. The default value is false. */
|
|
@@ -1583,7 +1617,7 @@ export interface BatchNodeUserCreateContent {
|
|
|
1583
1617
|
sshPublicKey?: string;
|
|
1584
1618
|
}
|
|
1585
1619
|
/** Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node. */
|
|
1586
|
-
export interface
|
|
1620
|
+
export interface BatchNodeUserUpdateOptions {
|
|
1587
1621
|
/** The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed. */
|
|
1588
1622
|
password?: string;
|
|
1589
1623
|
/** The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day. */
|
|
@@ -1592,16 +1626,16 @@ export interface BatchNodeUserUpdateContent {
|
|
|
1592
1626
|
sshPublicKey?: string;
|
|
1593
1627
|
}
|
|
1594
1628
|
/** Parameters for rebooting an Azure Batch Compute Node. */
|
|
1595
|
-
export interface
|
|
1629
|
+
export interface BatchNodeRebootOptions {
|
|
1596
1630
|
/**
|
|
1597
1631
|
* When to reboot the Compute Node and what to do with currently running Tasks. The default value is requeue.
|
|
1598
1632
|
*
|
|
1599
1633
|
* Possible values: "requeue", "terminate", "taskcompletion", "retaineddata"
|
|
1600
1634
|
*/
|
|
1601
|
-
nodeRebootOption?:
|
|
1635
|
+
nodeRebootOption?: BatchNodeRebootKind;
|
|
1602
1636
|
}
|
|
1603
1637
|
/** Options for deallocating a Compute Node. */
|
|
1604
|
-
export interface
|
|
1638
|
+
export interface BatchNodeDeallocateOptions {
|
|
1605
1639
|
/**
|
|
1606
1640
|
* When to deallocate the Compute Node and what to do with currently running Tasks. The default value is requeue.
|
|
1607
1641
|
*
|
|
@@ -1610,7 +1644,7 @@ export interface BatchNodeDeallocateContent {
|
|
|
1610
1644
|
nodeDeallocateOption?: BatchNodeDeallocateOption;
|
|
1611
1645
|
}
|
|
1612
1646
|
/** Parameters for reimaging an Azure Batch Compute Node. */
|
|
1613
|
-
export interface
|
|
1647
|
+
export interface BatchNodeReimageOptions {
|
|
1614
1648
|
/**
|
|
1615
1649
|
* When to reimage the Compute Node and what to do with currently running Tasks. The default value is requeue.
|
|
1616
1650
|
*
|
|
@@ -1619,7 +1653,7 @@ export interface BatchNodeReimageContent {
|
|
|
1619
1653
|
nodeReimageOption?: BatchNodeReimageOption;
|
|
1620
1654
|
}
|
|
1621
1655
|
/** Parameters for disabling scheduling on an Azure Batch Compute Node. */
|
|
1622
|
-
export interface
|
|
1656
|
+
export interface BatchNodeDisableSchedulingOptions {
|
|
1623
1657
|
/**
|
|
1624
1658
|
* What to do with currently running Tasks when disabling Task scheduling on the Compute Node. The default value is requeue.
|
|
1625
1659
|
*
|
|
@@ -1628,7 +1662,7 @@ export interface BatchNodeDisableSchedulingContent {
|
|
|
1628
1662
|
nodeDisableSchedulingOption?: BatchNodeDisableSchedulingOption;
|
|
1629
1663
|
}
|
|
1630
1664
|
/** The Azure Batch service log files upload parameters for a Compute Node. */
|
|
1631
|
-
export interface
|
|
1665
|
+
export interface UploadBatchServiceLogsOptions {
|
|
1632
1666
|
/** The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If a user assigned managed identity is not being used, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified. */
|
|
1633
1667
|
containerUrl: string;
|
|
1634
1668
|
/** The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. */
|
|
@@ -1642,6 +1676,8 @@ export interface UploadBatchServiceLogsContent {
|
|
|
1642
1676
|
export type CachingType = string;
|
|
1643
1677
|
/** Alias for StorageAccountType */
|
|
1644
1678
|
export type StorageAccountType = string;
|
|
1679
|
+
/** Alias for SecurityEncryptionTypes */
|
|
1680
|
+
export type SecurityEncryptionTypes = string;
|
|
1645
1681
|
/** Alias for ContainerType */
|
|
1646
1682
|
export type ContainerType = string;
|
|
1647
1683
|
/** Alias for DiskEncryptionTarget */
|
|
@@ -1650,8 +1686,8 @@ export type DiskEncryptionTarget = string;
|
|
|
1650
1686
|
export type BatchNodePlacementPolicyType = string;
|
|
1651
1687
|
/** Alias for DiffDiskPlacement */
|
|
1652
1688
|
export type DiffDiskPlacement = string;
|
|
1653
|
-
/** Alias for
|
|
1654
|
-
export type
|
|
1689
|
+
/** Alias for HostEndpointSettingsModeTypes */
|
|
1690
|
+
export type HostEndpointSettingsModeTypes = string;
|
|
1655
1691
|
/** Alias for SecurityTypes */
|
|
1656
1692
|
export type SecurityTypes = string;
|
|
1657
1693
|
/** Alias for DynamicVNetAssignmentScope */
|
|
@@ -1662,6 +1698,8 @@ export type InboundEndpointProtocol = string;
|
|
|
1662
1698
|
export type NetworkSecurityGroupRuleAccess = string;
|
|
1663
1699
|
/** Alias for IpAddressProvisioningType */
|
|
1664
1700
|
export type IpAddressProvisioningType = string;
|
|
1701
|
+
/** Alias for IPFamily */
|
|
1702
|
+
export type IPFamily = string;
|
|
1665
1703
|
/** Alias for ContainerWorkingDirectory */
|
|
1666
1704
|
export type ContainerWorkingDirectory = string;
|
|
1667
1705
|
/** Alias for ContainerHostDataPath */
|
|
@@ -1670,12 +1708,12 @@ export type ContainerHostDataPath = string;
|
|
|
1670
1708
|
export type AutoUserScope = string;
|
|
1671
1709
|
/** Alias for ElevationLevel */
|
|
1672
1710
|
export type ElevationLevel = string;
|
|
1711
|
+
/** Alias for BatchJobDefaultOrder */
|
|
1712
|
+
export type BatchJobDefaultOrder = string;
|
|
1673
1713
|
/** Alias for BatchNodeFillType */
|
|
1674
1714
|
export type BatchNodeFillType = string;
|
|
1675
1715
|
/** Alias for LoginMode */
|
|
1676
1716
|
export type LoginMode = string;
|
|
1677
|
-
/** Alias for BatchNodeCommunicationMode */
|
|
1678
|
-
export type BatchNodeCommunicationMode = string;
|
|
1679
1717
|
/** Alias for UpgradeMode */
|
|
1680
1718
|
export type UpgradeMode = string;
|
|
1681
1719
|
/** Alias for BatchNodeDeallocationOption */
|
|
@@ -1684,30 +1722,30 @@ export type BatchNodeDeallocationOption = string;
|
|
|
1684
1722
|
export type BatchJobState = string;
|
|
1685
1723
|
/** Alias for OutputFileUploadCondition */
|
|
1686
1724
|
export type OutputFileUploadCondition = string;
|
|
1687
|
-
/** Alias for
|
|
1688
|
-
export type
|
|
1725
|
+
/** Alias for BatchAccessScope */
|
|
1726
|
+
export type BatchAccessScope = string;
|
|
1689
1727
|
/** Alias for BatchPoolLifetimeOption */
|
|
1690
1728
|
export type BatchPoolLifetimeOption = string;
|
|
1691
|
-
/** Alias for
|
|
1692
|
-
export type
|
|
1693
|
-
/** Alias for
|
|
1694
|
-
export type
|
|
1695
|
-
/** Alias for
|
|
1696
|
-
export type
|
|
1729
|
+
/** Alias for BatchAllTasksCompleteMode */
|
|
1730
|
+
export type BatchAllTasksCompleteMode = string;
|
|
1731
|
+
/** Alias for BatchTaskFailureMode */
|
|
1732
|
+
export type BatchTaskFailureMode = string;
|
|
1733
|
+
/** Alias for BatchErrorSourceCategory */
|
|
1734
|
+
export type BatchErrorSourceCategory = string;
|
|
1697
1735
|
/** Alias for DisableBatchJobOption */
|
|
1698
1736
|
export type DisableBatchJobOption = string;
|
|
1699
1737
|
/** Alias for BatchTaskExecutionResult */
|
|
1700
1738
|
export type BatchTaskExecutionResult = string;
|
|
1701
1739
|
/** Alias for BatchJobScheduleState */
|
|
1702
1740
|
export type BatchJobScheduleState = string;
|
|
1703
|
-
/** Alias for
|
|
1704
|
-
export type
|
|
1741
|
+
/** Alias for BatchJobActionKind */
|
|
1742
|
+
export type BatchJobActionKind = string;
|
|
1705
1743
|
/** Alias for DependencyAction */
|
|
1706
1744
|
export type DependencyAction = string;
|
|
1707
1745
|
/** Alias for BatchTaskState */
|
|
1708
1746
|
export type BatchTaskState = string;
|
|
1709
|
-
/** Alias for
|
|
1710
|
-
export type
|
|
1747
|
+
/** Alias for BatchNodeRebootKind */
|
|
1748
|
+
export type BatchNodeRebootKind = string;
|
|
1711
1749
|
/** Alias for BatchNodeDeallocateOption */
|
|
1712
1750
|
export type BatchNodeDeallocateOption = string;
|
|
1713
1751
|
/** Alias for BatchNodeReimageOption */
|