-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
computeRPCommon.json
1888 lines (1888 loc) · 85.9 KB
/
computeRPCommon.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": "ComputeManagementClient",
"description": "The Compute Management Client.",
"version": "2022-11-01"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/providers/Microsoft.Compute/operations": {
"get": {
"tags": [
"ComputeOperations"
],
"operationId": "Operations_List",
"description": "Gets a list of compute operations.",
"parameters": [
{
"$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ComputeOperationListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
},
"x-ms-examples": {
"Operations_List_MaximumSet_Gen": {
"$ref": "./examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json"
},
"Operations_List_MinimumSet_Gen": {
"$ref": "./examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": {
"get": {
"tags": [
"Usage"
],
"operationId": "Usage_List",
"description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.",
"parameters": [
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The location for which resource usage is queried.",
"pattern": "^[-\\w\\._]+$"
},
{
"$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ListUsagesResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"Usage_List_MaximumSet_Gen": {
"$ref": "./examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json"
},
"Usage_List_MinimumSet_Gen": {
"$ref": "./examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": {
"get": {
"tags": [
"VirtualMachineSizes"
],
"operationId": "VirtualMachineSizes_List",
"description": "This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/rest/api/compute/resourceskus/list)",
"parameters": [
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The location upon which virtual-machine-sizes is queried.",
"pattern": "^[-\\w\\._]+$"
},
{
"$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VirtualMachineSizeListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
},
"x-ms-examples": {
"VirtualMachineSizes_List_MaximumSet_Gen": {
"$ref": "./examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json"
},
"VirtualMachineSizes_List_MinimumSet_Gen": {
"$ref": "./examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json"
}
}
}
}
},
"definitions": {
"ComputeOperationListResult": {
"properties": {
"value": {
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/ComputeOperationValue"
},
"x-ms-identifiers": [
"name"
],
"description": "The list of compute operations"
}
},
"description": "The List Compute Operation operation response."
},
"ComputeOperationValue": {
"properties": {
"origin": {
"type": "string",
"readOnly": true,
"description": "The origin of the compute operation."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the compute operation."
},
"display": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/ComputeOperationValueDisplay"
}
},
"description": "Describes the properties of a Compute Operation value."
},
"ComputeOperationValueDisplay": {
"properties": {
"operation": {
"type": "string",
"readOnly": true,
"description": "The display name of the compute operation."
},
"resource": {
"type": "string",
"readOnly": true,
"description": "The display name of the resource the operation applies to."
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the operation."
},
"provider": {
"type": "string",
"readOnly": true,
"description": "The resource provider for the operation."
}
},
"description": "Describes the properties of a Compute Operation Value Display."
},
"UsageName": {
"properties": {
"value": {
"type": "string",
"description": "The name of the resource."
},
"localizedValue": {
"type": "string",
"description": "The localized name of the resource."
}
},
"description": "The Usage Names."
},
"Usage": {
"properties": {
"unit": {
"type": "string",
"description": "An enum describing the unit of usage measurement.",
"enum": [
"Count"
],
"x-ms-enum": {
"name": "UsageUnit",
"modelAsString": false
}
},
"currentValue": {
"type": "integer",
"format": "int32",
"description": "The current usage of the resource."
},
"limit": {
"type": "integer",
"format": "int64",
"description": "The maximum permitted usage of the resource."
},
"name": {
"$ref": "#/definitions/UsageName",
"description": "The name of the type of usage."
}
},
"required": [
"unit",
"currentValue",
"limit",
"name"
],
"description": "Describes Compute Resource Usage."
},
"ListUsagesResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Usage"
},
"x-ms-identifiers": [],
"description": "The list of compute resource usages."
},
"nextLink": {
"type": "string",
"description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information."
}
},
"required": [
"value"
],
"description": "The List Usages operation response."
},
"HyperVGenerationType": {
"type": "string",
"description": "Specifies the HyperVGeneration Type",
"enum": [
"V1",
"V2"
],
"x-ms-enum": {
"name": "HyperVGenerationTypes",
"modelAsString": true
}
},
"InstanceViewStatus": {
"properties": {
"code": {
"type": "string",
"description": "The status code."
},
"level": {
"type": "string",
"description": "The level code.",
"enum": [
"Info",
"Warning",
"Error"
],
"x-ms-enum": {
"name": "StatusLevelTypes",
"modelAsString": false
}
},
"displayStatus": {
"type": "string",
"description": "The short localizable label for the status."
},
"message": {
"type": "string",
"description": "The detailed status message, including for alerts and error messages."
},
"time": {
"type": "string",
"format": "date-time",
"description": "The time of the status."
}
},
"description": "Instance view status."
},
"SubResourceWithColocationStatus": {
"allOf": [
{
"$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
}
],
"properties": {
"colocationStatus": {
"$ref": "#/definitions/InstanceViewStatus",
"description": "Describes colocation status of a resource in the Proximity Placement Group."
}
}
},
"VirtualMachineSize": {
"properties": {
"name": {
"type": "string",
"description": "The name of the virtual machine size."
},
"numberOfCores": {
"type": "integer",
"format": "int32",
"description": "The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list"
},
"osDiskSizeInMB": {
"type": "integer",
"format": "int32",
"description": "The OS disk size, in MB, allowed by the virtual machine size."
},
"resourceDiskSizeInMB": {
"type": "integer",
"format": "int32",
"description": "The resource disk size, in MB, allowed by the virtual machine size."
},
"memoryInMB": {
"type": "integer",
"format": "int32",
"description": "The amount of memory, in MB, supported by the virtual machine size."
},
"maxDataDiskCount": {
"type": "integer",
"format": "int32",
"description": "The maximum number of data disks that can be attached to the virtual machine size."
}
},
"description": "Describes the properties of a VM size."
},
"VirtualMachineSizeListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/VirtualMachineSize"
},
"x-ms-identifiers": [
"name"
],
"description": "The list of virtual machine sizes."
}
},
"description": "The List Virtual Machine operation response."
},
"Plan": {
"properties": {
"name": {
"type": "string",
"description": "The plan ID."
},
"publisher": {
"type": "string",
"description": "The publisher ID."
},
"product": {
"type": "string",
"description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element."
},
"promotionCode": {
"type": "string",
"description": "The promotion code."
}
},
"description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**."
},
"HardwareProfile": {
"properties": {
"vmSize": {
"type": "string",
"description": "Specifies the size of the virtual machine. <br><br> The enum data type is currently deprecated and will be removed by December 23rd 2023. <br><br> Recommended way to get the list of available sizes is using these APIs: <br><br> [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) <br><br> [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list) <br><br> [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). <br><br> The available VM sizes depend on region and availability set.",
"enum": [
"Basic_A0",
"Basic_A1",
"Basic_A2",
"Basic_A3",
"Basic_A4",
"Standard_A0",
"Standard_A1",
"Standard_A2",
"Standard_A3",
"Standard_A4",
"Standard_A5",
"Standard_A6",
"Standard_A7",
"Standard_A8",
"Standard_A9",
"Standard_A10",
"Standard_A11",
"Standard_A1_v2",
"Standard_A2_v2",
"Standard_A4_v2",
"Standard_A8_v2",
"Standard_A2m_v2",
"Standard_A4m_v2",
"Standard_A8m_v2",
"Standard_B1s",
"Standard_B1ms",
"Standard_B2s",
"Standard_B2ms",
"Standard_B4ms",
"Standard_B8ms",
"Standard_D1",
"Standard_D2",
"Standard_D3",
"Standard_D4",
"Standard_D11",
"Standard_D12",
"Standard_D13",
"Standard_D14",
"Standard_D1_v2",
"Standard_D2_v2",
"Standard_D3_v2",
"Standard_D4_v2",
"Standard_D5_v2",
"Standard_D2_v3",
"Standard_D4_v3",
"Standard_D8_v3",
"Standard_D16_v3",
"Standard_D32_v3",
"Standard_D64_v3",
"Standard_D2s_v3",
"Standard_D4s_v3",
"Standard_D8s_v3",
"Standard_D16s_v3",
"Standard_D32s_v3",
"Standard_D64s_v3",
"Standard_D11_v2",
"Standard_D12_v2",
"Standard_D13_v2",
"Standard_D14_v2",
"Standard_D15_v2",
"Standard_DS1",
"Standard_DS2",
"Standard_DS3",
"Standard_DS4",
"Standard_DS11",
"Standard_DS12",
"Standard_DS13",
"Standard_DS14",
"Standard_DS1_v2",
"Standard_DS2_v2",
"Standard_DS3_v2",
"Standard_DS4_v2",
"Standard_DS5_v2",
"Standard_DS11_v2",
"Standard_DS12_v2",
"Standard_DS13_v2",
"Standard_DS14_v2",
"Standard_DS15_v2",
"Standard_DS13-4_v2",
"Standard_DS13-2_v2",
"Standard_DS14-8_v2",
"Standard_DS14-4_v2",
"Standard_E2_v3",
"Standard_E4_v3",
"Standard_E8_v3",
"Standard_E16_v3",
"Standard_E32_v3",
"Standard_E64_v3",
"Standard_E2s_v3",
"Standard_E4s_v3",
"Standard_E8s_v3",
"Standard_E16s_v3",
"Standard_E32s_v3",
"Standard_E64s_v3",
"Standard_E32-16_v3",
"Standard_E32-8s_v3",
"Standard_E64-32s_v3",
"Standard_E64-16s_v3",
"Standard_F1",
"Standard_F2",
"Standard_F4",
"Standard_F8",
"Standard_F16",
"Standard_F1s",
"Standard_F2s",
"Standard_F4s",
"Standard_F8s",
"Standard_F16s",
"Standard_F2s_v2",
"Standard_F4s_v2",
"Standard_F8s_v2",
"Standard_F16s_v2",
"Standard_F32s_v2",
"Standard_F64s_v2",
"Standard_F72s_v2",
"Standard_G1",
"Standard_G2",
"Standard_G3",
"Standard_G4",
"Standard_G5",
"Standard_GS1",
"Standard_GS2",
"Standard_GS3",
"Standard_GS4",
"Standard_GS5",
"Standard_GS4-8",
"Standard_GS4-4",
"Standard_GS5-16",
"Standard_GS5-8",
"Standard_H8",
"Standard_H16",
"Standard_H8m",
"Standard_H16m",
"Standard_H16r",
"Standard_H16mr",
"Standard_L4s",
"Standard_L8s",
"Standard_L16s",
"Standard_L32s",
"Standard_M64s",
"Standard_M64ms",
"Standard_M128s",
"Standard_M128ms",
"Standard_M64-32ms",
"Standard_M64-16ms",
"Standard_M128-64ms",
"Standard_M128-32ms",
"Standard_NC6",
"Standard_NC12",
"Standard_NC24",
"Standard_NC24r",
"Standard_NC6s_v2",
"Standard_NC12s_v2",
"Standard_NC24s_v2",
"Standard_NC24rs_v2",
"Standard_NC6s_v3",
"Standard_NC12s_v3",
"Standard_NC24s_v3",
"Standard_NC24rs_v3",
"Standard_ND6s",
"Standard_ND12s",
"Standard_ND24s",
"Standard_ND24rs",
"Standard_NV6",
"Standard_NV12",
"Standard_NV24"
],
"x-ms-enum": {
"name": "VirtualMachineSizeTypes",
"modelAsString": true
}
},
"vmSizeProperties": {
"$ref": "#/definitions/VMSizeProperties",
"description": "Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. <br><br> This feature is still in preview mode and is not supported for VirtualMachineScaleSet. <br><br> Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details."
}
},
"description": "Specifies the hardware settings for the virtual machine."
},
"VMSizeProperties": {
"type": "object",
"properties": {
"vCPUsAvailable": {
"type": "integer",
"format": "int32",
"description": "Specifies the number of vCPUs available for the VM. <br><br> When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) ."
},
"vCPUsPerCore": {
"type": "integer",
"format": "int32",
"description": "Specifies the vCPU to physical core ratio. <br><br> When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list) <br><br> Setting this property to 1 also means that hyper-threading is disabled."
}
},
"description": "Specifies VM Size Property settings on the virtual machine."
},
"ImageReference": {
"properties": {
"publisher": {
"type": "string",
"description": "The image publisher."
},
"offer": {
"type": "string",
"description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine."
},
"sku": {
"type": "string",
"description": "The image SKU."
},
"version": {
"type": "string",
"description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input."
},
"exactVersion": {
"type": "string",
"readOnly": true,
"description": "Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'."
},
"sharedGalleryImageId": {
"type": "string",
"description": "Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call."
},
"communityGalleryImageId": {
"type": "string",
"description": "Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call."
}
},
"allOf": [
{
"$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
}
],
"description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set."
},
"DiskControllerType": {
"type": "string",
"enum": [
"SCSI",
"NVMe"
],
"x-ms-enum": {
"name": "DiskControllerTypes",
"modelAsString": true
},
"description": "Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list) . <br> For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes."
},
"KeyVaultSecretReference": {
"properties": {
"secretUrl": {
"type": "string",
"description": "The URL referencing a secret in a Key Vault."
},
"sourceVault": {
"$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
"description": "The relative URL of the Key Vault containing the secret."
}
},
"required": [
"secretUrl",
"sourceVault"
],
"description": "Describes a reference to Key Vault Secret"
},
"DiskEncryptionSetParameters": {
"allOf": [
{
"$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
}
],
"description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. <br><br> NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details."
},
"KeyVaultKeyReference": {
"properties": {
"keyUrl": {
"type": "string",
"description": "The URL referencing a key encryption key in Key Vault."
},
"sourceVault": {
"$ref": "../../../common-types/v1/common.json#/definitions/SubResource",
"description": "The relative URL of the Key Vault containing the key."
}
},
"required": [
"keyUrl",
"sourceVault"
],
"description": "Describes a reference to Key Vault Key"
},
"DiskEncryptionSettings": {
"properties": {
"diskEncryptionKey": {
"$ref": "#/definitions/KeyVaultSecretReference",
"description": "Specifies the location of the disk encryption key, which is a Key Vault Secret."
},
"keyEncryptionKey": {
"$ref": "#/definitions/KeyVaultKeyReference",
"description": "Specifies the location of the key encryption key in Key Vault."
},
"enabled": {
"type": "boolean",
"description": "Specifies whether disk encryption should be enabled on the virtual machine."
}
},
"description": "Describes a Encryption Settings for a Disk"
},
"VMDiskSecurityProfile": {
"type": "object",
"properties": {
"securityEncryptionType": {
"type": "string",
"description": "Specifies the EncryptionType of the managed disk. <br> It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. <br><br> NOTE: It can be set for only Confidential VMs.",
"enum": [
"VMGuestStateOnly",
"DiskWithVMGuestState"
],
"x-ms-enum": {
"name": "securityEncryptionTypes",
"modelAsString": true
}
},
"diskEncryptionSet": {
"$ref": "#/definitions/DiskEncryptionSetParameters",
"description": "Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob."
}
},
"description": "Specifies the security profile settings for the managed disk. <br><br> NOTE: It can only be set for Confidential VMs"
},
"VirtualHardDisk": {
"properties": {
"uri": {
"type": "string",
"description": "Specifies the virtual hard disk's uri."
}
},
"description": "Describes the uri of a disk."
},
"Caching": {
"type": "string",
"description": "Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**",
"enum": [
"None",
"ReadOnly",
"ReadWrite"
],
"x-ms-enum": {
"name": "CachingTypes",
"modelAsString": false
}
},
"CreateOption": {
"type": "string",
"description": "Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.",
"enum": [
"FromImage",
"Empty",
"Attach"
],
"x-ms-enum": {
"name": "DiskCreateOptionTypes",
"modelAsString": true
}
},
"DetachOption": {
"type": "string",
"description": "Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach**. <br><br> detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. <br><br> This feature is still in preview mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.",
"enum": [
"ForceDetach"
],
"x-ms-enum": {
"name": "DiskDetachOptionTypes",
"modelAsString": true
}
},
"DeleteOption": {
"type": "string",
"description": "Specifies the behavior of the managed disk when the VM gets deleted i.e whether the managed disk is deleted or detached. Supported values:<br><br> **Delete** If this value is used, the managed disk is deleted when VM gets deleted.<br><br> **Detach** If this value is used, the managed disk is retained after VM gets deleted.<br><br> Minimum api-version: 2021-03-01",
"enum": [
"Delete",
"Detach"
],
"x-ms-enum": {
"name": "DiskDeleteOptionTypes",
"modelAsString": true
}
},
"StorageAccountType": {
"type": "string",
"description": "Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types",
"enum": [
"Standard_LRS",
"Premium_LRS",
"StandardSSD_LRS",
"UltraSSD_LRS",
"Premium_ZRS",
"StandardSSD_ZRS",
"PremiumV2_LRS"
],
"x-ms-enum": {
"name": "StorageAccountTypes",
"modelAsString": true
}
},
"DiffDiskOption": {
"type": "string",
"description": "Specifies the ephemeral disk option for operating system disk.",
"enum": [
"Local"
],
"x-ms-enum": {
"name": "DiffDiskOptions",
"modelAsString": true
}
},
"DiffDiskPlacement": {
"type": "string",
"description": "Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements",
"enum": [
"CacheDisk",
"ResourceDisk"
],
"x-ms-enum": {
"name": "DiffDiskPlacement",
"modelAsString": true
}
},
"DiffDiskSettings": {
"properties": {
"option": {
"$ref": "#/definitions/DiffDiskOption",
"description": "Specifies the ephemeral disk settings for operating system disk."
},
"placement": {
"$ref": "#/definitions/DiffDiskPlacement",
"description": "Specifies the ephemeral disk placement for operating system disk.<br><br> Possible values are: <br><br> **CacheDisk** <br><br> **ResourceDisk** <br><br> Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used.<br><br> Refer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk."
}
},
"description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk. <br><br> NOTE: The ephemeral disk settings can only be specified for managed disk."
},
"ManagedDiskParameters": {
"properties": {
"storageAccountType": {
"$ref": "#/definitions/StorageAccountType",
"description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk."
},
"diskEncryptionSet": {
"$ref": "#/definitions/DiskEncryptionSetParameters",
"description": "Specifies the customer managed disk encryption set resource id for the managed disk."
},
"securityProfile": {
"$ref": "#/definitions/VMDiskSecurityProfile",
"description": "Specifies the security profile for the managed disk."
}
},
"allOf": [
{
"$ref": "../../../common-types/v1/common.json#/definitions/SubResource"
}
],
"description": "The parameters of a managed disk."
},
"OSDisk": {
"properties": {
"osType": {
"type": "string",
"description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**",
"enum": [
"Windows",
"Linux"
],
"x-ms-enum": {
"name": "OperatingSystemTypes",
"modelAsString": false
}
},
"encryptionSettings": {
"$ref": "#/definitions/DiskEncryptionSettings",
"description": "Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15"
},
"name": {
"type": "string",
"description": "The disk name."
},
"vhd": {
"$ref": "#/definitions/VirtualHardDisk",
"description": "The virtual hard disk."
},
"image": {
"$ref": "#/definitions/VirtualHardDisk",
"description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist."
},
"caching": {
"$ref": "#/definitions/Caching",
"description": "Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None** for Standard storage. **ReadOnly** for Premium storage."
},
"writeAcceleratorEnabled": {
"type": "boolean",
"description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
},
"diffDiskSettings": {
"$ref": "#/definitions/DiffDiskSettings",
"description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine."
},
"createOption": {
"$ref": "#/definitions/CreateOption",
"description": "Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described."
},
"diskSizeGB": {
"type": "integer",
"format": "int32",
"description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023"
},
"managedDisk": {
"description": "The managed disk parameters.",
"$ref": "#/definitions/ManagedDiskParameters"
},
"deleteOption": {
"$ref": "#/definitions/DeleteOption",
"description": "Specifies whether OS Disk should be deleted or detached upon VM deletion. <br><br> Possible values: <br><br> **Delete** If this value is used, the OS disk is deleted when VM is deleted.<br><br> **Detach** If this value is used, the os disk is retained after VM is deleted. <br><br> The default value is set to **detach**. For an ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for ephemeral OS Disk."
}
},
"required": [
"createOption"
],
"description": "Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)."
},
"DataDisk": {
"properties": {
"lun": {
"type": "integer",
"format": "int32",
"description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM."
},
"name": {
"type": "string",
"description": "The disk name."
},
"vhd": {
"$ref": "#/definitions/VirtualHardDisk",
"description": "The virtual hard disk."
},
"image": {
"$ref": "#/definitions/VirtualHardDisk",
"description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist."
},
"caching": {
"$ref": "#/definitions/Caching",
"description": "Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**"
},
"writeAcceleratorEnabled": {
"type": "boolean",
"description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
},
"createOption": {
"$ref": "#/definitions/CreateOption",
"description": "Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described."
},
"diskSizeGB": {
"type": "integer",