/
models.go
1874 lines (1448 loc) · 77.9 KB
/
models.go
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
//go:build go1.18
// +build go1.18
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// Code generated by Microsoft (R) AutoRest Code Generator. DO NOT EDIT.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
package armbatch
import "time"
// Account - Contains information about an Azure Batch account.
type Account struct {
// The identity of the Batch account.
Identity *AccountIdentity
// The properties associated with the account.
Properties *AccountProperties
// READ-ONLY; The ID of the resource.
ID *string
// READ-ONLY; The location of the resource.
Location *string
// READ-ONLY; The name of the resource.
Name *string
// READ-ONLY; The tags of the resource.
Tags map[string]*string
// READ-ONLY; The type of the resource.
Type *string
}
// AccountCreateParameters - Parameters supplied to the Create operation.
type AccountCreateParameters struct {
// REQUIRED; The region in which to create the account.
Location *string
// The identity of the Batch account.
Identity *AccountIdentity
// The properties of the Batch account.
Properties *AccountCreateProperties
// The user-specified tags associated with the account.
Tags map[string]*string
}
// AccountCreateProperties - The properties of a Batch account.
type AccountCreateProperties struct {
// 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.
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
// A reference to the Azure key vault associated with the Batch account.
KeyVaultReference *KeyVaultReference
// The network profile only takes effect when publicNetworkAccess is enabled.
NetworkProfile *NetworkProfile
// 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
// If not specified, the default value is 'enabled'.
PublicNetworkAccess *PublicNetworkAccessType
}
// AccountIdentity - 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.
type AccountIdentity struct {
// REQUIRED; The type of identity used for the Batch account.
Type *ResourceIdentityType
// The list of user identities associated with the Batch account.
UserAssignedIdentities map[string]*UserAssignedIdentities
// READ-ONLY; The principal id of the Batch account. This property will only be provided for a system assigned identity.
PrincipalID *string
// READ-ONLY; The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
TenantID *string
}
// AccountKeys - A set of Azure Batch account keys.
type AccountKeys struct {
// READ-ONLY; The Batch account name.
AccountName *string
// READ-ONLY; The primary key associated with the account.
Primary *string
// READ-ONLY; The secondary key associated with the account.
Secondary *string
}
// AccountListResult - Values returned by the List operation.
type AccountListResult struct {
// The continuation token.
NextLink *string
// The collection of Batch accounts returned by the listing operation.
Value []*Account
}
// AccountProperties - Account specific properties.
type AccountProperties struct {
// The network profile only takes effect when publicNetworkAccess is enabled.
NetworkProfile *NetworkProfile
// If not specified, the default value is 'enabled'.
PublicNetworkAccess *PublicNetworkAccessType
// READ-ONLY; The account endpoint used to interact with the Batch service.
AccountEndpoint *string
// READ-ONLY; The active job and job schedule quota for the Batch account.
ActiveJobAndJobScheduleQuota *int32
// READ-ONLY; 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
// READ-ONLY; Contains information about the auto-storage account associated with a Batch account.
AutoStorage *AutoStorageProperties
// READ-ONLY; For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value
// is not returned.
DedicatedCoreQuota *int32
// READ-ONLY; A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode
// set to UserSubscription, quota is managed on the subscription so this value is
// not returned.
DedicatedCoreQuotaPerVMFamily []*VirtualMachineFamilyCoreQuota
// READ-ONLY; If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota
// properties on the account. If this flag is false, dedicated core quota is
// enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.
DedicatedCoreQuotaPerVMFamilyEnforced *bool
// READ-ONLY; 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
// READ-ONLY; Identifies the Azure key vault associated with a Batch account.
KeyVaultReference *KeyVaultReference
// READ-ONLY; For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value
// is not returned.
LowPriorityCoreQuota *int32
// READ-ONLY; The endpoint used by compute node to connect to the Batch node management service.
NodeManagementEndpoint *string
// READ-ONLY; The allocation mode for creating pools in the Batch account.
PoolAllocationMode *PoolAllocationMode
// READ-ONLY; The pool quota for the Batch account.
PoolQuota *int32
// READ-ONLY; List of private endpoint connections associated with the Batch account
PrivateEndpointConnections []*PrivateEndpointConnection
// READ-ONLY; The provisioned state of the resource
ProvisioningState *ProvisioningState
}
// AccountRegenerateKeyParameters - Parameters supplied to the RegenerateKey operation.
type AccountRegenerateKeyParameters struct {
// REQUIRED; The type of account key to regenerate.
KeyName *AccountKeyType
}
// AccountUpdateParameters - Parameters for updating an Azure Batch account.
type AccountUpdateParameters struct {
// The identity of the Batch account.
Identity *AccountIdentity
// The properties of the account.
Properties *AccountUpdateProperties
// The user-specified tags associated with the account.
Tags map[string]*string
}
// AccountUpdateProperties - The properties of a Batch account.
type AccountUpdateProperties struct {
// 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.
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
// The network profile only takes effect when publicNetworkAccess is enabled.
NetworkProfile *NetworkProfile
// If not specified, the default value is 'enabled'.
PublicNetworkAccess *PublicNetworkAccessType
}
// ActivateApplicationPackageParameters - Parameters for an activating an application package.
type ActivateApplicationPackageParameters struct {
// REQUIRED; The format of the application package binary file.
Format *string
}
// Application - Contains information about an application in a Batch account.
type Application struct {
// The properties associated with the Application.
Properties *ApplicationProperties
// READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string
// READ-ONLY; The ID of the resource.
ID *string
// READ-ONLY; The name of the resource.
Name *string
// READ-ONLY; The type of the resource.
Type *string
}
// ApplicationPackage - An application package which represents a particular version of an application.
type ApplicationPackage struct {
// The properties associated with the Application Package.
Properties *ApplicationPackageProperties
// READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string
// READ-ONLY; The ID of the resource.
ID *string
// READ-ONLY; The name of the resource.
Name *string
// READ-ONLY; The type of the resource.
Type *string
}
// ApplicationPackageProperties - Properties of an application package
type ApplicationPackageProperties struct {
// READ-ONLY; The format of the application package, if the package is active.
Format *string
// READ-ONLY; The time at which the package was last activated, if the package is active.
LastActivationTime *time.Time
// READ-ONLY; The current state of the application package.
State *PackageState
// READ-ONLY; The URL for the application package in Azure Storage.
StorageURL *string
// READ-ONLY; The UTC time at which the Azure Storage URL will expire.
StorageURLExpiry *time.Time
}
// ApplicationPackageReference - Link to an application package inside the batch account
type ApplicationPackageReference struct {
// REQUIRED; 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
}
// ApplicationProperties - The properties associated with the Application.
type ApplicationProperties struct {
// A value indicating whether packages within the application may be overwritten using the same version string.
AllowUpdates *bool
// The package to use if a client requests the application but does not specify a version. This property can only be set to
// the name of an existing package.
DefaultVersion *string
// The display name for the application.
DisplayName *string
}
// AutoScaleRun - The results and errors from an execution of a pool autoscale formula.
type AutoScaleRun struct {
// REQUIRED; The time at which the autoscale formula was last evaluated.
EvaluationTime *time.Time
// An error that occurred when autoscaling a pool.
Error *AutoScaleRunError
// Each variable value is returned in the form $variable=value, and variables are separated by semicolons.
Results *string
}
// AutoScaleRunError - An error that occurred when autoscaling a pool.
type AutoScaleRunError struct {
// REQUIRED; An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
Code *string
// REQUIRED; A message describing the error, intended to be suitable for display in a user interface.
Message *string
// Additional details about the error.
Details []*AutoScaleRunError
}
// AutoScaleSettings - AutoScale settings for the pool.
type AutoScaleSettings struct {
// REQUIRED; 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
}
// AutoStorageBaseProperties - The properties related to the auto-storage account.
type AutoStorageBaseProperties struct {
// REQUIRED; 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
}
// AutoStorageProperties - Contains information about the auto-storage account associated with a Batch account.
type AutoStorageProperties struct {
// REQUIRED; The UTC time at which storage keys were last synchronized with the Batch account.
LastKeySync *time.Time
// REQUIRED; 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
}
// AutoUserSpecification - Specifies the parameters for the auto user that runs a task on the Batch service.
type AutoUserSpecification struct {
// The default value is nonAdmin.
ElevationLevel *ElevationLevel
// 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
}
// AutomaticOSUpgradePolicy - The configuration parameters used for performing automatic OS upgrade.
type AutomaticOSUpgradePolicy struct {
// Whether OS image rollback feature should be disabled.
DisableAutomaticRollback *bool
// Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer
// version of the OS image becomes available.
// If this is set to true for Windows based pools, WindowsConfiguration.enableAutomaticUpdates [https://learn.microsoft.com/en-us/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration]
// cannot be set to true.
EnableAutomaticOSUpgrade *bool
// Defer OS upgrades on the TVMs if they are running tasks.
OSRollingUpgradeDeferral *bool
// Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default
// policy if no policy is defined on the VMSS.
UseRollingUpgradePolicy *bool
}
// AzureBlobFileSystemConfiguration - Information used to connect to an Azure Storage Container using Blobfuse.
type AzureBlobFileSystemConfiguration struct {
// REQUIRED; The Azure Storage Account name.
AccountName *string
// REQUIRED; The Azure Blob Storage Container name.
ContainerName *string
// REQUIRED; All file systems are mounted relative to the Batch mounts directory, accessible via the AZBATCHNODEMOUNTSDIR
// environment variable.
RelativeMountPath *string
// This property is mutually exclusive with both sasKey and identity; exactly one must be specified.
AccountKey *string
// These are 'net use' options in Windows and 'mount' options in Linux.
BlobfuseOptions *string
// This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.
IdentityReference *ComputeNodeIdentityReference
// This property is mutually exclusive with both accountKey and identity; exactly one must be specified.
SasKey *string
}
// AzureFileShareConfiguration - Information used to connect to an Azure Fileshare.
type AzureFileShareConfiguration struct {
// REQUIRED; The Azure Storage account key.
AccountKey *string
// REQUIRED; The Azure Storage account name.
AccountName *string
// REQUIRED; This is of the form 'https://{account}.file.core.windows.net/'.
AzureFileURL *string
// REQUIRED; All file systems are mounted relative to the Batch mounts directory, accessible via the AZBATCHNODEMOUNTSDIR
// environment variable.
RelativeMountPath *string
// These are 'net use' options in Windows and 'mount' options in Linux.
MountOptions *string
}
// CIFSMountConfiguration - Information used to connect to a CIFS file system.
type CIFSMountConfiguration struct {
// REQUIRED; The password to use for authentication against the CIFS file system.
Password *string
// REQUIRED; All file systems are mounted relative to the Batch mounts directory, accessible via the AZBATCHNODEMOUNTSDIR
// environment variable.
RelativeMountPath *string
// REQUIRED; The URI of the file system to mount.
Source *string
// REQUIRED; The user to use for authentication against the CIFS file system.
Username *string
// These are 'net use' options in Windows and 'mount' options in Linux.
MountOptions *string
}
// Certificate - Contains information about a certificate.
type Certificate struct {
// The properties associated with the certificate.
Properties *CertificateProperties
// READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string
// READ-ONLY; The ID of the resource.
ID *string
// READ-ONLY; The name of the resource.
Name *string
// READ-ONLY; The type of the resource.
Type *string
}
// CertificateBaseProperties - Base certificate properties.
type CertificateBaseProperties struct {
// The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.
Format *CertificateFormat
// This must match the thumbprint from the name.
Thumbprint *string
// This must match the first portion of the certificate name. Currently required to be 'SHA1'.
ThumbprintAlgorithm *string
}
// CertificateCreateOrUpdateParameters - Contains information about a certificate.
type CertificateCreateOrUpdateParameters struct {
// The properties associated with the certificate.
Properties *CertificateCreateOrUpdateProperties
// READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string
// READ-ONLY; The ID of the resource.
ID *string
// READ-ONLY; The name of the resource.
Name *string
// READ-ONLY; The type of the resource.
Type *string
}
// CertificateCreateOrUpdateProperties - Certificate properties for create operations
type CertificateCreateOrUpdateProperties struct {
// REQUIRED; The maximum size is 10KB.
Data *string
// The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.
Format *CertificateFormat
// This must not be specified if the certificate format is Cer.
Password *string
// This must match the thumbprint from the name.
Thumbprint *string
// This must match the first portion of the certificate name. Currently required to be 'SHA1'.
ThumbprintAlgorithm *string
}
// CertificateProperties - Certificate properties.
type CertificateProperties struct {
// The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.
Format *CertificateFormat
// This must match the thumbprint from the name.
Thumbprint *string
// This must match the first portion of the certificate name. Currently required to be 'SHA1'.
ThumbprintAlgorithm *string
// READ-ONLY; This is only returned when the certificate provisioningState is 'Failed'.
DeleteCertificateError *DeleteCertificateError
// READ-ONLY; The previous provisioned state of the resource
PreviousProvisioningState *CertificateProvisioningState
// READ-ONLY; The time at which the certificate entered its previous state.
PreviousProvisioningStateTransitionTime *time.Time
// READ-ONLY
ProvisioningState *CertificateProvisioningState
// READ-ONLY; The time at which the certificate entered its current state.
ProvisioningStateTransitionTime *time.Time
// READ-ONLY; The public key of the certificate.
PublicData *string
}
// CertificateReference - 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.
type CertificateReference struct {
// REQUIRED; 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 AZBATCHCERTIFICATES_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
}
// CheckNameAvailabilityParameters - Parameters for a check name availability request.
type CheckNameAvailabilityParameters struct {
// REQUIRED; The name to check for availability
Name *string
// CONSTANT; The resource type.
// Field has constant value "Microsoft.Batch/batchAccounts", any specified value is ignored.
Type *string
}
// CheckNameAvailabilityResult - The CheckNameAvailability operation response.
type CheckNameAvailabilityResult struct {
// READ-ONLY; Gets an error message explaining the Reason value in more detail.
Message *string
// READ-ONLY; 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.
NameAvailable *bool
// READ-ONLY; Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable
// is false.
Reason *NameAvailabilityReason
}
// CloudServiceConfiguration - The configuration for nodes in a pool based on the Azure Cloud Services platform.
type CloudServiceConfiguration struct {
// REQUIRED; 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
}
// ComputeNodeIdentityReference - The reference to a user assigned identity associated with the Batch pool which a compute
// node will use.
type ComputeNodeIdentityReference struct {
// The ARM resource id of the user assigned identity.
ResourceID *string
}
// ContainerConfiguration - The configuration for container-enabled pools.
type ContainerConfiguration struct {
// REQUIRED; 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
}
// ContainerRegistry - A private container registry.
type ContainerRegistry struct {
// The reference to a user assigned identity associated with the Batch pool which a compute node will use.
IdentityReference *ComputeNodeIdentityReference
// The password to log into the registry server.
Password *string
// If omitted, the default is "docker.io".
RegistryServer *string
// The user name to log into the registry server.
UserName *string
}
// DataDisk - 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.
type DataDisk struct {
// REQUIRED; The initial disk size in GB when creating new data disk.
DiskSizeGB *int32
// REQUIRED; 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 *int32
// 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
// If omitted, the default is "Standard_LRS". Values are:
// StandardLRS - The data disk should use standard locally redundant storage. PremiumLRS - The data disk should use premium
// locally redundant storage.
StorageAccountType *StorageAccountType
}
// DeleteCertificateError - An error response from the Batch service.
type DeleteCertificateError struct {
// REQUIRED; An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
Code *string
// REQUIRED; A message describing the error, intended to be suitable for display in a user interface.
Message *string
// A list of additional details about the error.
Details []*DeleteCertificateError
// The target of the particular error. For example, the name of the property in error.
Target *string
}
// DeploymentConfiguration - Deployment configuration properties.
type DeploymentConfiguration struct {
// 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
}
// DetectorListResult - Values returned by the List operation.
type DetectorListResult struct {
// The URL to get the next set of results.
NextLink *string
// The collection of Batch account detectors returned by the listing operation.
Value []*DetectorResponse
}
// DetectorResponse - Contains the information for a detector.
type DetectorResponse struct {
// The properties associated with the detector.
Properties *DetectorResponseProperties
// READ-ONLY; The ETag of the resource, used for concurrency statements.
Etag *string
// READ-ONLY; The ID of the resource.
ID *string
// READ-ONLY; The name of the resource.
Name *string
// READ-ONLY; The type of the resource.
Type *string
}
// DetectorResponseProperties - Detector response properties.
type DetectorResponseProperties struct {
// A base64 encoded string that represents the content of a detector.
Value *string
}
// DiffDiskSettings - Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
type DiffDiskSettings struct {
// 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 *string
}
// DiskEncryptionConfiguration - 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.
type DiskEncryptionConfiguration struct {
// On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified.
Targets []*DiskEncryptionTarget
}
// EncryptionProperties - 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.
type EncryptionProperties struct {
// Type of the key source.
KeySource *KeySource
// Additional details when using Microsoft.KeyVault
KeyVaultProperties *KeyVaultProperties
}
// EndpointAccessProfile - Network access profile for Batch endpoint.
type EndpointAccessProfile struct {
// REQUIRED; 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
}
// EndpointDependency - A domain name and connection details used to access a dependency.
type EndpointDependency struct {
// READ-ONLY; Human-readable supplemental information about the dependency and when it is applicable.
Description *string
// READ-ONLY; The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard.
DomainName *string
// READ-ONLY; The list of connection details for this endpoint.
EndpointDetails []*EndpointDetail
}
// EndpointDetail - Details about the connection between the Batch service and the endpoint.
type EndpointDetail struct {
// READ-ONLY; The port an endpoint is connected to.
Port *int32
}
// EnvironmentSetting - An environment variable to be set on a task process.
type EnvironmentSetting struct {
// REQUIRED; The name of the environment variable.
Name *string
// The value of the environment variable.
Value *string
}
// FixedScaleSettings - Fixed scale settings for the pool.
type FixedScaleSettings struct {
// If omitted, the default value is Requeue.
NodeDeallocationOption *ComputeNodeDeallocationOption
// 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 *int32
// At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.
TargetLowPriorityNodes *int32
}
// IPRule - Rule to filter client IP address.
type IPRule struct {
// CONSTANT; Action when client IP address is matched.
// Field has constant value "Allow", any specified value is ignored.
Action *string
// REQUIRED; IPv4 address, or IPv4 address range in CIDR format.
Value *string
}
// ImageReference - 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.
type ImageReference struct {
// 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
// For example, UbuntuServer or WindowsServer.
Offer *string
// For example, Canonical or MicrosoftWindowsServer.
Publisher *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
}
// InboundNatPool - A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.
type InboundNatPool struct {
// REQUIRED; 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 *int32
// REQUIRED; 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 *int32
// REQUIRED; 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 *int32
// REQUIRED; 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
// REQUIRED; The protocol of the endpoint.
Protocol *InboundEndpointProtocol
// 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
}
// KeyVaultProperties - KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
type KeyVaultProperties struct {
// 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
}
// KeyVaultReference - Identifies the Azure key vault associated with a Batch account.
type KeyVaultReference struct {
// REQUIRED; The resource ID of the Azure key vault associated with the Batch account.
ID *string
// REQUIRED; The URL of the Azure key vault associated with the Batch account.
URL *string
}
// LinuxUserConfiguration - Properties used to create a user account on a Linux node.
type LinuxUserConfiguration struct {
// The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks
// the gid.
Gid *int32
// 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
// The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks
// the uid.
UID *int32
}
// ListApplicationPackagesResult - The result of performing list application packages.
type ListApplicationPackagesResult struct {
// The URL to get the next set of results.
NextLink *string
// The list of application packages.
Value []*ApplicationPackage
}
// ListApplicationsResult - The result of performing list applications.
type ListApplicationsResult struct {
// The URL to get the next set of results.
NextLink *string
// The list of applications.
Value []*Application
}
// ListCertificatesResult - Values returned by the List operation.
type ListCertificatesResult struct {
// The continuation token.
NextLink *string
// The collection of returned certificates.
Value []*Certificate
}
// ListPoolsResult - Values returned by the List operation.
type ListPoolsResult struct {
// The continuation token.
NextLink *string
// The collection of returned pools.
Value []*Pool
}
// ListPrivateEndpointConnectionsResult - Values returned by the List operation.
type ListPrivateEndpointConnectionsResult struct {
// The continuation token.
NextLink *string
// The collection of returned private endpoint connection.
Value []*PrivateEndpointConnection
}
// ListPrivateLinkResourcesResult - Values returned by the List operation.
type ListPrivateLinkResourcesResult struct {
// The continuation token.
NextLink *string
// The collection of returned private link resources.
Value []*PrivateLinkResource
}
// LocationQuota - Quotas associated with a Batch region for a particular subscription.
type LocationQuota struct {
// READ-ONLY; The number of Batch accounts that may be created under the subscription in the specified region.
AccountQuota *int32
}
type ManagedDisk struct {
// The storage account type for use in creating data disks or OS disk.
StorageAccountType *StorageAccountType
}
// MetadataItem - The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
type MetadataItem struct {
// REQUIRED; The name of the metadata item.
Name *string
// REQUIRED; The value of the metadata item.
Value *string
}
// MountConfiguration - The file system to mount on each node.
type MountConfiguration struct {
// This property is mutually exclusive with all other properties.
AzureBlobFileSystemConfiguration *AzureBlobFileSystemConfiguration
// This property is mutually exclusive with all other properties.
AzureFileShareConfiguration *AzureFileShareConfiguration