-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
index.ts
2241 lines (2002 loc) · 113 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import * as coreClient from "@azure/core-client";
/** Parameters supplied to the Create operation. */
export interface BatchAccountCreateParameters {
/** The region in which to create the account. */
location: string;
/** The user-specified tags associated with the account. */
tags?: { [propertyName: string]: string };
/** The identity of the Batch account. */
identity?: BatchAccountIdentity;
/** The properties related to the auto-storage account. */
autoStorage?: AutoStorageBaseProperties;
/** The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService. */
poolAllocationMode?: PoolAllocationMode;
/** A reference to the Azure key vault associated with the Batch account. */
keyVaultReference?: KeyVaultReference;
/** If not specified, the default value is 'enabled'. */
publicNetworkAccess?: PublicNetworkAccessType;
/** The network profile only takes effect when publicNetworkAccess is enabled. */
networkProfile?: NetworkProfile;
/** Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. */
encryption?: EncryptionProperties;
/** List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. */
allowedAuthenticationModes?: AuthenticationMode[];
}
/** The properties related to the auto-storage account. */
export interface AutoStorageBaseProperties {
/** The resource ID of the storage account to be used for auto-storage account. */
storageAccountId: string;
/** The authentication mode which the Batch service will use to manage the auto-storage account. */
authenticationMode?: AutoStorageAuthenticationMode;
/** The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage. */
nodeIdentityReference?: ComputeNodeIdentityReference;
}
/** The reference to a user assigned identity associated with the Batch pool which a compute node will use. */
export interface ComputeNodeIdentityReference {
/** The ARM resource id of the user assigned identity. */
resourceId?: string;
}
/** Identifies the Azure key vault associated with a Batch account. */
export interface KeyVaultReference {
/** The resource ID of the Azure key vault associated with the Batch account. */
id: string;
/** The URL of the Azure key vault associated with the Batch account. */
url: string;
}
/** Network profile for Batch account, which contains network rule settings for each endpoint. */
export interface NetworkProfile {
/** Network access profile for batchAccount endpoint (Batch account data plane API). */
accountAccess?: EndpointAccessProfile;
/** Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). */
nodeManagementAccess?: EndpointAccessProfile;
}
/** Network access profile for Batch endpoint. */
export interface EndpointAccessProfile {
/** Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. */
defaultAction: EndpointAccessDefaultAction;
/** Array of IP ranges to filter client IP address. */
ipRules?: IPRule[];
}
/** Rule to filter client IP address. */
export interface IPRule {
/** Action when client IP address is matched. */
action: "Allow";
/** IPv4 address, or IPv4 address range in CIDR format. */
value: string;
}
/** Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. */
export interface EncryptionProperties {
/** Type of the key source. */
keySource?: KeySource;
/** Additional details when using Microsoft.KeyVault */
keyVaultProperties?: KeyVaultProperties;
}
/** KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. */
export interface KeyVaultProperties {
/**
* Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:
*
* The Batch Account has a System Assigned identity
* The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions
* The KeyVault has soft-delete and purge protection enabled
*/
keyIdentifier?: string;
}
/** The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when `ManagedIdentity` is selected as the auto-storage authentication mode. */
export interface BatchAccountIdentity {
/**
* The principal id of the Batch account. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly principalId?: string;
/**
* The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tenantId?: string;
/** The type of identity used for the Batch account. */
type: ResourceIdentityType;
/** The list of user identities associated with the Batch account. */
userAssignedIdentities?: { [propertyName: string]: UserAssignedIdentities };
}
/** The list of associated user identities. */
export interface UserAssignedIdentities {
/**
* The principal id of user assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly principalId?: string;
/**
* The client id of user assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly clientId?: string;
}
/** The private endpoint of the private endpoint connection. */
export interface PrivateEndpoint {
/**
* The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
}
/** The private link service connection state of the private endpoint connection */
export interface PrivateLinkServiceConnectionState {
/** The status of the Batch private endpoint connection */
status: PrivateLinkServiceConnectionStatus;
/** Description of the private Connection state */
description?: string;
/**
* Action required on the private connection state
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly actionsRequired?: string;
}
/** A definition of an Azure resource. */
export interface ProxyResource {
/**
* The ID of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* The name of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The type of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* The ETag of the resource, used for concurrency statements.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly etag?: string;
}
/** A VM Family and its associated core quota for the Batch account. */
export interface VirtualMachineFamilyCoreQuota {
/**
* The Virtual Machine family name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The core quota for the VM family for the Batch account.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly coreQuota?: number;
}
/** A definition of an Azure resource. */
export interface Resource {
/**
* The ID of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* The name of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The type of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* The location of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly location?: string;
/**
* The tags of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tags?: { [propertyName: string]: string };
}
/** An error response from the Batch service. */
export interface CloudError {
/** The body of the error response. */
error?: CloudErrorBody;
}
/** An error response from the Batch service. */
export interface CloudErrorBody {
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
code?: string;
/** A message describing the error, intended to be suitable for display in a user interface. */
message?: string;
/** The target of the particular error. For example, the name of the property in error. */
target?: string;
/** A list of additional details about the error. */
details?: CloudErrorBody[];
}
/** Parameters for updating an Azure Batch account. */
export interface BatchAccountUpdateParameters {
/** The user-specified tags associated with the account. */
tags?: { [propertyName: string]: string };
/** The identity of the Batch account. */
identity?: BatchAccountIdentity;
/** The properties related to the auto-storage account. */
autoStorage?: AutoStorageBaseProperties;
/** Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. */
encryption?: EncryptionProperties;
/** List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. */
allowedAuthenticationModes?: AuthenticationMode[];
/** If not specified, the default value is 'enabled'. */
publicNetworkAccess?: PublicNetworkAccessType;
/** The network profile only takes effect when publicNetworkAccess is enabled. */
networkProfile?: NetworkProfile;
}
/** Values returned by the List operation. */
export interface BatchAccountListResult {
/** The collection of Batch accounts returned by the listing operation. */
value?: BatchAccount[];
/** The continuation token. */
nextLink?: string;
}
/** Parameters supplied to the RegenerateKey operation. */
export interface BatchAccountRegenerateKeyParameters {
/** The type of account key to regenerate. */
keyName: AccountKeyType;
}
/** A set of Azure Batch account keys. */
export interface BatchAccountKeys {
/**
* The Batch account name.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly accountName?: string;
/**
* The primary key associated with the account.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly primary?: string;
/**
* The secondary key associated with the account.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly secondary?: string;
}
/** Parameters for an activating an application package. */
export interface ActivateApplicationPackageParameters {
/** The format of the application package binary file. */
format: string;
}
/** The result of performing list applications. */
export interface ListApplicationsResult {
/** The list of applications. */
value?: Application[];
/** The URL to get the next set of results. */
nextLink?: string;
}
/** The result of performing list application packages. */
export interface ListApplicationPackagesResult {
/** The list of application packages. */
value?: ApplicationPackage[];
/** The URL to get the next set of results. */
nextLink?: string;
}
/** Quotas associated with a Batch region for a particular subscription. */
export interface BatchLocationQuota {
/**
* The number of Batch accounts that may be created under the subscription in the specified region.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly accountQuota?: number;
}
/** The Batch List supported SKUs operation response. */
export interface SupportedSkusResult {
/** The list of SKUs available for the Batch service in the location. */
value: SupportedSku[];
/**
* The URL to use for getting the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Describes a Batch supported SKU. */
export interface SupportedSku {
/**
* The name of the SKU.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The family name of the SKU.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly familyName?: string;
/**
* A collection of capabilities which this SKU supports.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly capabilities?: SkuCapability[];
/**
* The time when Azure Batch service will retire this SKU.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly batchSupportEndOfLife?: Date;
}
/** A SKU capability, such as the number of cores. */
export interface SkuCapability {
/**
* The name of the feature.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The value of the feature.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: string;
}
/** Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results. */
export interface OperationListResult {
/** The list of operations supported by the resource provider. */
value?: Operation[];
/** The URL to get the next set of operation list results if there are any. */
nextLink?: string;
}
/** A REST API operation */
export interface Operation {
/** This is of the format {provider}/{resource}/{operation} */
name?: string;
/** Indicates whether the operation is a data action */
isDataAction?: boolean;
/** The object that describes the operation. */
display?: OperationDisplay;
/** The intended executor of the operation. */
origin?: string;
/** Properties of the operation. */
properties?: Record<string, unknown>;
}
/** The object that describes the operation. */
export interface OperationDisplay {
/** Friendly name of the resource provider. */
provider?: string;
/** For example: read, write, delete, or listKeys/action */
operation?: string;
/** The resource type on which the operation is performed. */
resource?: string;
/** The friendly name of the operation */
description?: string;
}
/** Parameters for a check name availability request. */
export interface CheckNameAvailabilityParameters {
/** The name to check for availability */
name: string;
/** The resource type. */
type: "Microsoft.Batch/batchAccounts";
}
/** The CheckNameAvailability operation response. */
export interface CheckNameAvailabilityResult {
/**
* Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nameAvailable?: boolean;
/**
* Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly reason?: NameAvailabilityReason;
/**
* Gets an error message explaining the Reason value in more detail.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly message?: string;
}
/** Values returned by the List operation. */
export interface ListCertificatesResult {
/** The collection of returned certificates. */
value?: Certificate[];
/** The continuation token. */
nextLink?: string;
}
/** An error response from the Batch service. */
export interface DeleteCertificateError {
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
code: string;
/** A message describing the error, intended to be suitable for display in a user interface. */
message: string;
/** The target of the particular error. For example, the name of the property in error. */
target?: string;
/** A list of additional details about the error. */
details?: DeleteCertificateError[];
}
/** Base certificate properties. */
export interface CertificateBaseProperties {
/** This must match the first portion of the certificate name. Currently required to be 'SHA1'. */
thumbprintAlgorithm?: string;
/** This must match the thumbprint from the name. */
thumbprint?: string;
/** The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. */
format?: CertificateFormat;
}
/** Values returned by the List operation. */
export interface DetectorListResult {
/** The collection of Batch account detectors returned by the listing operation. */
value?: DetectorResponse[];
/** The URL to get the next set of results. */
nextLink?: string;
}
/** Values returned by the List operation. */
export interface ListPrivateLinkResourcesResult {
/** The collection of returned private link resources. */
value?: PrivateLinkResource[];
/** The continuation token. */
nextLink?: string;
}
/** Values returned by the List operation. */
export interface ListPrivateEndpointConnectionsResult {
/** The collection of returned private endpoint connection. */
value?: PrivateEndpointConnection[];
/** The continuation token. */
nextLink?: string;
}
/** Values returned by the List operation. */
export interface ListPoolsResult {
/** The collection of returned pools. */
value?: Pool[];
/** The continuation token. */
nextLink?: string;
}
/** Deployment configuration properties. */
export interface DeploymentConfiguration {
/** This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'. */
cloudServiceConfiguration?: CloudServiceConfiguration;
/** This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. */
virtualMachineConfiguration?: VirtualMachineConfiguration;
}
/** The configuration for nodes in a pool based on the Azure Cloud Services platform. */
export interface CloudServiceConfiguration {
/** Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). */
osFamily: string;
/** The default value is * which specifies the latest operating system version for the specified OS family. */
osVersion?: string;
}
/** The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. */
export interface VirtualMachineConfiguration {
/** A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. */
imageReference: ImageReference;
/** The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. */
nodeAgentSkuId: string;
/** This property must not be specified if the imageReference specifies a Linux OS image. */
windowsConfiguration?: WindowsConfiguration;
/** This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. */
dataDisks?: DataDisk[];
/**
* This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:
*
* Windows_Server - The on-premises license is for Windows Server.
* Windows_Client - The on-premises license is for Windows Client.
*
*/
licenseType?: string;
/** If specified, setup is performed on each 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. */
containerConfiguration?: ContainerConfiguration;
/** If specified, encryption is performed on each node in the pool during node provisioning. */
diskEncryptionConfiguration?: DiskEncryptionConfiguration;
/** This configuration will specify rules on how nodes in the pool will be physically allocated. */
nodePlacementConfiguration?: NodePlacementConfiguration;
/** If specified, the extensions mentioned in this configuration will be installed on each node. */
extensions?: VMExtension[];
/** Contains configuration for ephemeral OSDisk settings. */
osDisk?: OSDisk;
/** Specifies the security profile settings for the virtual machine or virtual machine scale set. */
securityProfile?: SecurityProfile;
/** The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} */
serviceArtifactReference?: ServiceArtifactReference;
}
/** A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. */
export interface ImageReference {
/** For example, Canonical or MicrosoftWindowsServer. */
publisher?: string;
/** For example, UbuntuServer or WindowsServer. */
offer?: string;
/** For example, 18.04-LTS or 2022-datacenter. */
sku?: string;
/** A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. */
version?: string;
/** This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. */
id?: string;
}
/** Windows operating system settings to apply to the virtual machine. */
export interface WindowsConfiguration {
/** If omitted, the default value is true. */
enableAutomaticUpdates?: boolean;
}
/** Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them. */
export interface DataDisk {
/** The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. */
lun: number;
/**
* Values are:
*
* none - The caching mode for the disk is not enabled.
* readOnly - The caching mode for the disk is read only.
* readWrite - The caching mode for the disk is read and write.
*
* The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
*/
caching?: CachingType;
/** The initial disk size in GB when creating new data disk. */
diskSizeGB: number;
/**
* If omitted, the default is "Standard_LRS". Values are:
*
* Standard_LRS - The data disk should use standard locally redundant storage.
* Premium_LRS - The data disk should use premium locally redundant storage.
*/
storageAccountType?: StorageAccountType;
}
/** The configuration for container-enabled pools. */
export interface ContainerConfiguration {
/** The container technology to be used. */
type: ContainerType;
/** This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. */
containerImageNames?: string[];
/** If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. */
containerRegistries?: ContainerRegistry[];
}
/** A private container registry. */
export interface ContainerRegistry {
/** The user name to log into the registry server. */
userName?: string;
/** The password to log into the registry server. */
password?: string;
/** If omitted, the default is "docker.io". */
registryServer?: string;
/** The reference to a user assigned identity associated with the Batch pool which a compute node will use. */
identityReference?: ComputeNodeIdentityReference;
}
/** The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Azure Compute Gallery Image. */
export interface DiskEncryptionConfiguration {
/** On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. */
targets?: DiskEncryptionTarget[];
}
/** Allocation configuration used by Batch Service to provision the nodes. */
export interface NodePlacementConfiguration {
/** Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. */
policy?: NodePlacementPolicyType;
}
/** The configuration for virtual machine extensions. */
export interface VMExtension {
/** The name of the virtual machine extension. */
name: string;
/** The name of the extension handler publisher. */
publisher: string;
/** The type of the extensions. */
type: string;
/** The version of script handler. */
typeHandlerVersion?: string;
/** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */
autoUpgradeMinorVersion?: boolean;
/** Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */
enableAutomaticUpgrade?: boolean;
/** JSON formatted public settings for the extension. */
settings?: Record<string, unknown>;
/** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */
protectedSettings?: Record<string, unknown>;
/** Collection of extension names after which this extension needs to be provisioned. */
provisionAfterExtensions?: string[];
}
/** Settings for the operating system disk of the virtual machine. */
export interface OSDisk {
/** Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */
ephemeralOSDiskSettings?: DiffDiskSettings;
/** The type of caching to enable for the disk. */
caching?: CachingType;
managedDisk?: ManagedDisk;
/** The initial disk size in GB when creating new OS disk. */
diskSizeGB?: number;
/** Specifies whether writeAccelerator should be enabled or disabled on the disk. */
writeAcceleratorEnabled?: boolean;
}
/** Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */
export interface DiffDiskSettings {
/** This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. */
placement?: "CacheDisk";
}
export interface ManagedDisk {
/** The storage account type for use in creating data disks or OS disk. */
storageAccountType?: StorageAccountType;
}
/** Specifies the security profile settings for the virtual machine or virtual machine scale set. */
export interface SecurityProfile {
/** Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. */
securityType?: "trustedLaunch";
/** 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. */
encryptionAtHost?: boolean;
/** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. */
uefiSettings?: UefiSettings;
}
/** Specifies the security settings like secure boot and vTPM used while creating the virtual machine. */
export interface UefiSettings {
/** Specifies whether secure boot should be enabled on the virtual machine. */
secureBootEnabled?: boolean;
/** Specifies whether vTPM should be enabled on the virtual machine. */
vTpmEnabled?: boolean;
}
/** 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. */
export interface ServiceArtifactReference {
/** The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} */
id: string;
}
/** Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. */
export interface ScaleSettings {
/** This property and autoScale are mutually exclusive and one of the properties must be specified. */
fixedScale?: FixedScaleSettings;
/** This property and fixedScale are mutually exclusive and one of the properties must be specified. */
autoScale?: AutoScaleSettings;
}
/** Fixed scale settings for the pool. */
export interface FixedScaleSettings {
/** The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 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). */
resizeTimeout?: string;
/** At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. */
targetDedicatedNodes?: number;
/** At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. */
targetLowPriorityNodes?: number;
/** If omitted, the default value is Requeue. */
nodeDeallocationOption?: ComputeNodeDeallocationOption;
}
/** AutoScale settings for the pool. */
export interface AutoScaleSettings {
/** A formula for the desired number of compute nodes in the pool. */
formula: string;
/** If omitted, the default value is 15 minutes (PT15M). */
evaluationInterval?: string;
}
/** The results and errors from an execution of a pool autoscale formula. */
export interface AutoScaleRun {
/** The time at which the autoscale formula was last evaluated. */
evaluationTime: Date;
/** Each variable value is returned in the form $variable=value, and variables are separated by semicolons. */
results?: string;
/** An error that occurred when autoscaling a pool. */
error?: AutoScaleRunError;
}
/** An error that occurred when autoscaling a pool. */
export interface AutoScaleRunError {
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
code: string;
/** A message describing the error, intended to be suitable for display in a user interface. */
message: string;
/** Additional details about the error. */
details?: AutoScaleRunError[];
}
/** The network configuration for a pool. */
export interface NetworkConfiguration {
/** 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 nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute 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 compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration */
subnetId?: string;
/** The scope of dynamic vnet assignment. */
dynamicVnetAssignmentScope?: DynamicVNetAssignmentScope;
/** Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property. */
endpointConfiguration?: PoolEndpointConfiguration;
/** This property is only supported on Pools with the virtualMachineConfiguration property. */
publicIPAddressConfiguration?: PublicIPAddressConfiguration;
/** 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. */
enableAcceleratedNetworking?: boolean;
}
/** The endpoint configuration for a pool. */
export interface PoolEndpointConfiguration {
/** 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. */
inboundNatPools: InboundNatPool[];
}
/** A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally. */
export interface InboundNatPool {
/** 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. */
name: string;
/** The protocol of the endpoint. */
protocol: InboundEndpointProtocol;
/** This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. */
backendPort: number;
/** 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. If any reserved or overlapping values are provided the request fails with HTTP status code 400. */
frontendPortRangeStart: number;
/** Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. */
frontendPortRangeEnd: number;
/** The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. */
networkSecurityGroupRules?: NetworkSecurityGroupRule[];
}
/** A network security group rule to apply to an inbound endpoint. */
export interface NetworkSecurityGroupRule {
/** Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. */
priority: number;
/** The action that should be taken for a specified IP address, subnet range or tag. */
access: NetworkSecurityGroupRuleAccess;
/** Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. */
sourceAddressPrefix: string;
/** Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. */
sourcePortRanges?: string[];
}
/** The public IP Address configuration of the networking configuration of a Pool. */
export interface PublicIPAddressConfiguration {
/** The default value is BatchManaged */
provision?: IPAddressProvisioningType;
/** 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}. */
ipAddressIds?: string[];
}
/** Specifies how tasks should be distributed across compute nodes. */
export interface TaskSchedulingPolicy {
/** How tasks should be distributed across compute nodes. */
nodeFillType: ComputeNodeFillType;
}
/** Properties used to create a user on an Azure Batch node. */
export interface UserAccount {
/** The name of the user account. Names can contain any Unicode characters up to a maximum length of 20. */
name: string;
/** The password for the user account. */
password: string;
/** nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. */
elevationLevel?: ElevationLevel;
/** This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. */
linuxUserConfiguration?: LinuxUserConfiguration;
/** This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. */
windowsUserConfiguration?: WindowsUserConfiguration;
}
/** Properties used to create a user account on a Linux node. */
export interface LinuxUserConfiguration {
/** The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. */
uid?: number;
/** The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. */
gid?: number;
/** The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). */
sshPrivateKey?: string;
}
/** Properties used to create a user account on a Windows node. */
export interface WindowsUserConfiguration {
/** Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. */
loginMode?: LoginMode;
}
/** The Batch service does not assign any meaning to this metadata; it is solely for the use of user code. */
export interface MetadataItem {
/** The name of the metadata item. */
name: string;
/** The value of the metadata item. */
value: string;
}
/** In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. */
export interface 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. Required if any other properties of the startTask are specified. */
commandLine?: string;
/** A list of files that the Batch service will download to the compute node before running the command line. */
resourceFiles?: ResourceFile[];
/** A list of environment variable settings for the start task. */
environmentSettings?: EnvironmentSetting[];
/** If omitted, the task runs as a non-administrative user unique to the task. */
userIdentity?: UserIdentity;
/** The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 */
maxTaskRetryCount?: number;
/** If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. */
waitForSuccess?: boolean;
/** 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. */
containerSettings?: TaskContainerSettings;
}
/** A single file or multiple files to be downloaded to a compute node. */
export interface ResourceFile {
/** The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. */
autoStorageContainerName?: string;
/** The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. */
storageContainerUrl?: string;
/** The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. */
httpUrl?: string;
/** The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. */
blobPrefix?: string;
/** If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). */
filePath?: string;
/** This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. */
fileMode?: string;
/** The reference to a user assigned identity associated with the Batch pool which a compute node will use. */
identityReference?: ComputeNodeIdentityReference;
}
/** An environment variable to be set on a task process. */
export interface EnvironmentSetting {
/** The name of the environment variable. */
name: string;
/** The value of the environment variable. */
value?: string;
}
/** Specify either the userName or autoUser property, but not both. */
export interface UserIdentity {
/** The userName and autoUser properties are mutually exclusive; you must specify one but not both. */
userName?: string;
/** The userName and autoUser properties are mutually exclusive; you must specify one but not both. */
autoUser?: AutoUserSpecification;
}
/** Specifies the parameters for the auto user that runs a task on the Batch service. */
export interface AutoUserSpecification {
/** The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. */
scope?: AutoUserScope;
/** The default value is nonAdmin. */
elevationLevel?: ElevationLevel;
}
/** The container settings for a task. */
export interface TaskContainerSettings {
/** These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. */
containerRunOptions?: string;
/** This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. */
imageName: string;
/** This setting can be omitted if was already provided at pool creation. */
registry?: ContainerRegistry;
/** A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. */
workingDirectory?: ContainerWorkingDirectory;
}
/** Warning: This object is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead. */
export interface CertificateReference {
/** The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. */
id: string;
/** The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. */
storeLocation?: CertificateStoreLocation;
/** This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My. */
storeName?: string;
/** Which user accounts on the compute node should have access to the private data of the certificate. */
visibility?: CertificateVisibility[];
}
/** Link to an application package inside the batch account */
export interface ApplicationPackageReference {
/** The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. */
id: string;
/** If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. */
version?: string;
}
/** Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). */
export interface ResizeOperationStatus {
/** The desired number of dedicated compute nodes in the pool. */
targetDedicatedNodes?: number;
/** The desired number of Spot/low-priority compute nodes in the pool. */
targetLowPriorityNodes?: number;
/** 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). */
resizeTimeout?: string;
/** The default value is requeue. */
nodeDeallocationOption?: ComputeNodeDeallocationOption;
/** The time when this resize operation was started. */
startTime?: Date;
/** This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. */
errors?: ResizeError[];
}
/** An error that occurred when resizing a pool. */
export interface ResizeError {
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
code: string;
/** A message describing the error, intended to be suitable for display in a user interface. */
message: string;
/** Additional details about the error. */
details?: ResizeError[];
}
/** The file system to mount on each node. */
export interface MountConfiguration {
/** This property is mutually exclusive with all other properties. */
azureBlobFileSystemConfiguration?: AzureBlobFileSystemConfiguration;
/** This property is mutually exclusive with all other properties. */
nfsMountConfiguration?: NFSMountConfiguration;
/** This property is mutually exclusive with all other properties. */
cifsMountConfiguration?: CifsMountConfiguration;
/** This property is mutually exclusive with all other properties. */
azureFileShareConfiguration?: AzureFileShareConfiguration;
}
/** Information used to connect to an Azure Storage Container using Blobfuse. */
export interface AzureBlobFileSystemConfiguration {
/** The Azure Storage Account name. */
accountName: string;
/** The Azure Blob Storage Container name. */
containerName: string;
/** This property is mutually exclusive with both sasKey and identity; exactly one must be specified. */
accountKey?: string;
/** This property is mutually exclusive with both accountKey and identity; exactly one must be specified. */
sasKey?: string;
/** These are 'net use' options in Windows and 'mount' options in Linux. */
blobfuseOptions?: string;
/** All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */
relativeMountPath: string;
/** This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. */
identityReference?: ComputeNodeIdentityReference;
}
/** Information used to connect to an NFS file system. */
export interface NFSMountConfiguration {
/** The URI of the file system to mount. */
source: string;
/** All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */
relativeMountPath: string;
/** These are 'net use' options in Windows and 'mount' options in Linux. */
mountOptions?: string;
}