-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
azurefleet.json
3581 lines (3581 loc) · 145 KB
/
azurefleet.json
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
{
"swagger": "2.0",
"info": {
"title": "Microsoft.AzureFleet",
"version": "2024-11-01",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"host": "management.azure.com",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"tags": [
{
"name": "Operations"
},
{
"name": "Fleets"
}
],
"paths": {
"/providers/Microsoft.AzureFleet/operations": {
"get": {
"operationId": "Operations_List",
"tags": [
"Operations"
],
"description": "List the operations for the provider",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Operations_List": {
"$ref": "./examples/Operations_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.AzureFleet/fleets": {
"get": {
"operationId": "Fleets_ListBySubscription",
"tags": [
"Fleets"
],
"description": "List Fleet resources by subscription ID",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FleetListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Fleets_ListBySubscription": {
"$ref": "./examples/Fleets_ListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets": {
"get": {
"operationId": "Fleets_ListByResourceGroup",
"tags": [
"Fleets"
],
"description": "List Fleet resources by resource group",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FleetListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Fleets_ListByResourceGroup": {
"$ref": "./examples/Fleets_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}": {
"get": {
"operationId": "Fleets_Get",
"tags": [
"Fleets"
],
"description": "Get a Fleet",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "fleetName",
"in": "path",
"description": "The name of the Compute Fleet",
"required": true,
"type": "string",
"pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Fleet"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Fleets_Get": {
"$ref": "./examples/Fleets_Get.json"
}
}
},
"put": {
"operationId": "Fleets_CreateOrUpdate",
"tags": [
"Fleets"
],
"description": "Create a Fleet",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "fleetName",
"in": "path",
"description": "The name of the Compute Fleet",
"required": true,
"type": "string",
"pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$"
},
{
"name": "resource",
"in": "body",
"description": "Resource create parameters.",
"required": true,
"schema": {
"$ref": "#/definitions/Fleet"
}
}
],
"responses": {
"200": {
"description": "Resource 'Fleet' update operation succeeded",
"schema": {
"$ref": "#/definitions/Fleet"
}
},
"201": {
"description": "Resource 'Fleet' create operation succeeded",
"schema": {
"$ref": "#/definitions/Fleet"
},
"headers": {
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Fleets_CreateOrUpdate": {
"$ref": "./examples/Fleets_CreateOrUpdate.json"
},
"Fleets_CreateOrUpdate_MinimumSet": {
"$ref": "./examples/Fleets_CreateOrUpdate_MinimumSet.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "Fleets_Update",
"tags": [
"Fleets"
],
"description": "Update a Fleet",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "fleetName",
"in": "path",
"description": "The name of the Compute Fleet",
"required": true,
"type": "string",
"pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$"
},
{
"name": "properties",
"in": "body",
"description": "The resource properties to be updated.",
"required": true,
"schema": {
"$ref": "#/definitions/FleetUpdate"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Fleet"
}
},
"202": {
"description": "Resource update request accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Fleets_Update": {
"$ref": "./examples/Fleets_Update.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "Fleets_Delete",
"tags": [
"Fleets"
],
"description": "Delete a Fleet",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "fleetName",
"in": "path",
"description": "The name of the Compute Fleet",
"required": true,
"type": "string",
"pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$"
}
],
"responses": {
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Fleets_Delete": {
"$ref": "./examples/Fleets_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{name}/virtualMachineScaleSets": {
"get": {
"operationId": "Fleets_ListVirtualMachineScaleSets",
"tags": [
"Fleets"
],
"description": "List VirtualMachineScaleSet resources by Fleet",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the Fleet",
"required": true,
"type": "string",
"pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VirtualMachineScaleSetListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Fleets_ListVirtualMachineScaleSets": {
"$ref": "./examples/Fleets_ListVirtualMachineScaleSets.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"AcceleratorManufacturer": {
"type": "string",
"description": "Accelerator manufacturers supported by Azure VMs.",
"enum": [
"AMD",
"Nvidia",
"Xilinx"
],
"x-ms-enum": {
"name": "AcceleratorManufacturer",
"modelAsString": true,
"values": [
{
"name": "AMD",
"value": "AMD",
"description": "AMD GpuType"
},
{
"name": "Nvidia",
"value": "Nvidia",
"description": "Nvidia GpuType"
},
{
"name": "Xilinx",
"value": "Xilinx",
"description": "Xilinx GpuType"
}
]
}
},
"AcceleratorType": {
"type": "string",
"description": "Accelerator types supported by Azure VMs.",
"enum": [
"GPU",
"FPGA"
],
"x-ms-enum": {
"name": "AcceleratorType",
"modelAsString": true,
"values": [
{
"name": "GPU",
"value": "GPU",
"description": "GPU Accelerator"
},
{
"name": "FPGA",
"value": "FPGA",
"description": "FPGA Accelerator"
}
]
}
},
"AdditionalCapabilities": {
"type": "object",
"description": "AdditionalCapabilities for VM.",
"properties": {
"ultraSSDEnabled": {
"type": "boolean",
"description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS.\nManaged disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled."
},
"hibernationEnabled": {
"type": "boolean",
"description": "The flag that enables or disables hibernation capability on the VM."
}
}
},
"AdditionalLocationsProfile": {
"type": "object",
"description": "Represents the configuration for additional locations where Fleet resources may be deployed.",
"properties": {
"locationProfiles": {
"type": "array",
"description": "The list of location profiles.",
"items": {
"$ref": "#/definitions/LocationProfile"
},
"x-ms-identifiers": []
}
},
"required": [
"locationProfiles"
]
},
"AdditionalUnattendContent": {
"type": "object",
"description": "Specifies additional XML formatted information that can be included in the\nUnattend.xml file, which is used by Windows Setup. Contents are defined by\nsetting name, component name, and the pass in which the content is applied.",
"properties": {
"passName": {
"type": "string",
"description": "The pass name. Currently, the only allowable value is OobeSystem.",
"enum": [
"OobeSystem"
],
"x-ms-enum": {
"modelAsString": false
}
},
"componentName": {
"type": "string",
"description": "The component name. Currently, the only allowable value is\nMicrosoft-Windows-Shell-Setup.",
"enum": [
"Microsoft-Windows-Shell-Setup"
],
"x-ms-enum": {
"modelAsString": false
}
},
"settingName": {
"$ref": "#/definitions/SettingNames",
"description": "Specifies the name of the setting to which the content applies. Possible values\nare: FirstLogonCommands and AutoLogon."
},
"content": {
"type": "string",
"format": "password",
"description": "Specifies the XML formatted content that is added to the unattend.xml file for\nthe specified path and component. The XML must be less than 4KB and must\ninclude the root element for the setting or feature that is being inserted.",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
}
}
},
"ApiEntityReference": {
"type": "object",
"description": "The API entity reference.",
"properties": {
"id": {
"type": "string",
"format": "arm-id",
"description": "The ARM resource id in the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..."
}
}
},
"ApiError": {
"type": "object",
"description": "ApiError for Fleet",
"properties": {
"code": {
"type": "string",
"description": "The error code."
},
"target": {
"type": "string",
"description": "The target of the particular error."
},
"message": {
"type": "string",
"description": "The error message."
},
"details": {
"type": "array",
"description": "The API error details",
"items": {
"$ref": "#/definitions/ApiErrorBase"
},
"x-ms-identifiers": [
"message",
"target"
]
},
"innererror": {
"$ref": "#/definitions/InnerError",
"description": "The API inner error"
}
}
},
"ApiErrorBase": {
"type": "object",
"description": "API error base.",
"properties": {
"code": {
"type": "string",
"description": "The error code."
},
"target": {
"type": "string",
"description": "The target of the particular error."
},
"message": {
"type": "string",
"description": "The error message."
}
}
},
"ApplicationProfile": {
"type": "object",
"description": "Contains the list of gallery applications that should be made available to the\nVM/VMSS",
"properties": {
"galleryApplications": {
"type": "array",
"description": "Specifies the gallery applications that should be made available to the VM/VMSS",
"items": {
"$ref": "#/definitions/VMGalleryApplication"
},
"x-ms-identifiers": [
"packageReferenceId"
]
}
}
},
"ArchitectureType": {
"type": "string",
"description": "Architecture types supported by Azure VMs.",
"enum": [
"ARM64",
"X86"
],
"x-ms-enum": {
"name": "ArchitectureType",
"modelAsString": true,
"values": [
{
"name": "ARM64",
"value": "ARM64",
"description": "ARM64 Architecture"
},
{
"name": "X86",
"value": "X86",
"description": "X86 Architecture"
}
]
}
},
"BasePriorityProfile": {
"type": "object",
"description": "Contains common properties that are applicable to both Spot and Regular.",
"properties": {
"capacity": {
"type": "integer",
"format": "int32",
"description": "Total capacity to achieve. It is currently in terms of number of VMs.",
"minimum": 0
},
"minCapacity": {
"type": "integer",
"format": "int32",
"description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.",
"minimum": 0
}
}
},
"BaseVirtualMachineProfile": {
"type": "object",
"description": "Describes the base virtual machine profile for fleet",
"properties": {
"osProfile": {
"$ref": "#/definitions/VirtualMachineScaleSetOSProfile",
"description": "Specifies the operating system settings for the virtual machines in the scale\nset."
},
"storageProfile": {
"$ref": "#/definitions/VirtualMachineScaleSetStorageProfile",
"description": "Specifies the storage settings for the virtual machine disks."
},
"networkProfile": {
"$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile",
"description": "Specifies properties of the network interfaces of the virtual machines in the\nscale set."
},
"securityProfile": {
"$ref": "#/definitions/SecurityProfile",
"description": "Specifies the Security related profile settings for the virtual machines in the\nscale set."
},
"diagnosticsProfile": {
"$ref": "#/definitions/DiagnosticsProfile",
"description": "Specifies the boot diagnostic settings state."
},
"extensionProfile": {
"$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile",
"description": "Specifies a collection of settings for extensions installed on virtual machines\nin the scale set."
},
"licenseType": {
"type": "string",
"description": "Specifies that the image or disk that is being used was licensed on-premises.\n<br><br> Possible values for Windows Server operating system are: <br><br>\nWindows_Client <br><br> Windows_Server <br><br> Possible values for Linux\nServer operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS\n(for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for\nWindows\nServer](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)\n<br><br> [Azure Hybrid Use Benefit for Linux\nServer](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)\n<br><br> Minimum api-version: 2015-06-15"
},
"scheduledEventsProfile": {
"$ref": "#/definitions/ScheduledEventsProfile",
"description": "Specifies Scheduled Event related configurations."
},
"userData": {
"type": "string",
"description": "UserData for the virtual machines in the scale set, which must be base-64\nencoded. Customer should not pass any secrets in here. Minimum api-version:\n2021-03-01."
},
"capacityReservation": {
"$ref": "#/definitions/CapacityReservationProfile",
"description": "Specifies the capacity reservation related details of a scale set. Minimum\napi-version: 2021-04-01."
},
"applicationProfile": {
"$ref": "#/definitions/ApplicationProfile",
"description": "Specifies the gallery applications that should be made available to the VM/VMSS"
},
"hardwareProfile": {
"$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile",
"description": "Specifies the hardware profile related details of a scale set. Minimum\napi-version: 2021-11-01."
},
"serviceArtifactReference": {
"$ref": "#/definitions/ServiceArtifactReference",
"description": "Specifies the service artifact reference id used to set same image version for\nall virtual machines in the scale set when using 'latest' image version.\nMinimum api-version: 2022-11-01"
},
"securityPostureReference": {
"$ref": "#/definitions/SecurityPostureReference",
"description": "Specifies the security posture to be used for all virtual machines in the scale\nset. Minimum api-version: 2023-03-01"
},
"timeCreated": {
"type": "string",
"format": "date-time",
"description": "Specifies the time in which this VM profile for the Virtual Machine Scale Set\nwas created. Minimum API version for this property is 2023-09-01. This value\nwill be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile\nwith minimum api-version 2023-09-01. Examples: \"2024-07-01T00:00:01.1234567+00:00\"",
"readOnly": true
}
}
},
"BootDiagnostics": {
"type": "object",
"description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. You can easily view the output of your\nconsole log. Azure also enables you to see a screenshot of the VM from the\nhypervisor.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether boot diagnostics should be enabled on the Virtual Machine."
},
"storageUri": {
"type": "string",
"format": "uri",
"description": "Uri of the storage account to use for placing the console output and\nscreenshot. If storageUri is not specified while enabling boot diagnostics,\nmanaged storage will be used."
}
}
},
"CachingTypes": {
"type": "string",
"description": "Specifies the caching requirements.",
"enum": [
"None",
"ReadOnly",
"ReadWrite"
],
"x-ms-enum": {
"name": "CachingTypes",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "'None' is default for Standard Storage"
},
{
"name": "ReadOnly",
"value": "ReadOnly",
"description": "'ReadOnly' is default for Premium Storage"
},
{
"name": "ReadWrite",
"value": "ReadWrite",
"description": "'ReadWrite' is default for OS Disk"
}
]
}
},
"CapacityReservationProfile": {
"type": "object",
"description": "The parameters of a capacity reservation Profile.",
"properties": {
"capacityReservationGroup": {
"$ref": "#/definitions/SubResource",
"description": "Specifies the capacity reservation group resource id that should be used for\nallocating the virtual machine or scaleset vm instances provided enough\ncapacity has been reserved. Please refer to https://aka.ms/CapacityReservation\nfor more details."
}
}
},
"ComputeProfile": {
"type": "object",
"description": "Compute Profile to use for running user's workloads.",
"properties": {
"baseVirtualMachineProfile": {
"$ref": "#/definitions/BaseVirtualMachineProfile",
"description": "Base Virtual Machine Profile Properties to be specified according to \"specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile\""
},
"computeApiVersion": {
"type": "string",
"description": "Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines.\nThe default value will be the latest supported computeApiVersion by Compute Fleet."
},
"platformFaultDomainCount": {
"type": "integer",
"format": "int32",
"description": "Specifies the number of fault domains to use when creating the underlying VMSS.\nA fault domain is a logical group of hardware within an Azure datacenter.\nVMs in the same fault domain share a common power source and network switch.\nIf not specified, defaults to 1, which represents \"Max Spreading\" (using as many fault domains as possible).\nThis property cannot be updated."
},
"additionalVirtualMachineCapabilities": {
"$ref": "#/definitions/AdditionalCapabilities",
"description": "Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled.\nultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs.\nhibernationEnabled: Enables the hibernation capability on the VMSS VMs.\nDefault value is null if not specified. This property cannot be updated once set."
}
},
"required": [
"baseVirtualMachineProfile"
]
},
"CpuManufacturer": {
"type": "string",
"description": "Cpu Manufacturers supported by Azure VMs.",
"enum": [
"Intel",
"AMD",
"Microsoft",
"Ampere"
],
"x-ms-enum": {
"name": "CpuManufacturer",
"modelAsString": true,
"values": [
{
"name": "Intel",
"value": "Intel",
"description": "Intel CPU."
},
{
"name": "AMD",
"value": "AMD",
"description": "AMD CPU."
},
{
"name": "Microsoft",
"value": "Microsoft",
"description": "Microsoft CPU."
},
{
"name": "Ampere",
"value": "Ampere",
"description": "Ampere CPU."
}
]
}
},
"DeleteOptions": {
"type": "string",
"description": "Specify what happens to the network interface when the VM is deleted",
"enum": [
"Delete",
"Detach"
],
"x-ms-enum": {
"name": "DeleteOptions",
"modelAsString": true,
"values": [
{
"name": "Delete",
"value": "Delete",
"description": "Delete Option"
},
{
"name": "Detach",
"value": "Detach",
"description": "Detach Option"
}
]
}
},
"DiagnosticsProfile": {
"type": "object",
"description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.",
"properties": {
"bootDiagnostics": {
"$ref": "#/definitions/BootDiagnostics",
"description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. **NOTE**: If storageUri is being\nspecified then ensure that the storage account is in the same region and\nsubscription as the VM. You can easily view the output of your console log.\nAzure also enables you to see a screenshot of the VM from the hypervisor."
}
}
},
"DiffDiskOptions": {
"type": "string",
"description": "Specifies the ephemeral disk option for operating system disk.",
"enum": [
"Local"
],
"x-ms-enum": {
"name": "DiffDiskOptions",
"modelAsString": true,
"values": [
{
"name": "Local",
"value": "Local",
"description": "Local Option."
}
]
}
},
"DiffDiskPlacement": {
"type": "string",
"description": "Specifies the ephemeral disk placement for operating system disk. This property\ncan be used by user in the request to choose the location i.e, cache disk or\nresource disk space for Ephemeral OS disk provisioning. For more information on\nEphemeral OS disk size requirements, please refer Ephemeral OS disk size\nrequirements for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements\nand Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements\nMinimum api-version for NvmeDisk: 2024-03-01.",
"enum": [
"CacheDisk",
"ResourceDisk",
"NvmeDisk"
],
"x-ms-enum": {
"name": "DiffDiskPlacement",
"modelAsString": true,
"values": [
{
"name": "CacheDisk",
"value": "CacheDisk",
"description": "CacheDisk option."
},
{
"name": "ResourceDisk",
"value": "ResourceDisk",
"description": "Resource Disk option."
},
{
"name": "NvmeDisk",
"value": "NvmeDisk",
"description": "NvmeDisk option."
}
]
}
},
"DiffDiskSettings": {
"type": "object",
"description": "Describes the parameters of ephemeral disk settings that can be specified for\noperating system disk. **Note:** The ephemeral disk settings can only be\nspecified for managed disk.",
"properties": {
"option": {
"$ref": "#/definitions/DiffDiskOptions",
"description": "Specifies the ephemeral disk settings for operating system disk."
},
"placement": {
"$ref": "#/definitions/DiffDiskPlacement",
"description": "Specifies the ephemeral disk placement for operating system disk. Possible\nvalues are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is:\n**CacheDisk** if one is configured for the VM size otherwise **ResourceDisk**\nis used. Refer to the VM size documentation for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM\nsizes exposes a cache disk."
}
}
},
"DiskControllerTypes": {
"type": "string",
"description": "Specifies the disk controller type configured for the VM and\nVirtualMachineScaleSet. This property is only supported for virtual machines\nwhose operating system disk and VM sku supports Generation 2\n(https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please\ncheck the HyperVGenerations capability returned as part of VM sku capabilities\nin the response of Microsoft.Compute SKUs api for the region contains V2\n(https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more\ninformation about Disk Controller Types supported please refer to\nhttps://aka.ms/azure-diskcontrollertypes.",
"enum": [