/
index.ts
7679 lines (7119 loc) · 216 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) Microsoft Corporation. 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.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
import * as msRest from "@azure/ms-rest-js";
export { BaseResource, CloudError };
/**
* Describes the properties of a Compute Operation value.
*/
export interface ComputeOperationValue {
/**
* The origin of the compute operation.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly origin?: string;
/**
* The name of the compute operation.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly name?: string;
/**
* The display name of the compute operation.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly operation?: string;
/**
* The display name of the resource the operation applies to.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly resource?: string;
/**
* The description of the operation.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly description?: string;
/**
* The resource provider for the operation.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly provider?: string;
}
/**
* Instance view status.
*/
export interface InstanceViewStatus {
/**
* The status code.
*/
code?: string;
/**
* The level code. Possible values include: 'Info', 'Warning', 'Error'
*/
level?: StatusLevelTypes;
/**
* The short localizable label for the status.
*/
displayStatus?: string;
/**
* The detailed status message, including for alerts and error messages.
*/
message?: string;
/**
* The time of the status.
*/
time?: Date;
}
/**
* An interface representing SubResource.
*/
export interface SubResource extends BaseResource {
/**
* Resource Id
*/
id?: string;
}
/**
* Describes a virtual machine scale set sku.
*/
export interface Sku {
/**
* The sku name.
*/
name?: string;
/**
* Specifies the tier of virtual machines in a scale set.<br /><br /> Possible Values:<br /><br
* /> **Standard**<br /><br /> **Basic**
*/
tier?: string;
/**
* Specifies the number of virtual machines in the scale set.
*/
capacity?: number;
}
/**
* The Resource model definition.
*/
export interface Resource extends BaseResource {
/**
* Resource Id
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly id?: string;
/**
* Resource name
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly name?: string;
/**
* Resource type
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly type?: string;
/**
* Resource location
*/
location: string;
/**
* Resource tags
*/
tags?: { [propertyName: string]: string };
}
/**
* Specifies information about the availability set that the virtual machine should be assigned to.
* Virtual machines specified in the same availability set are allocated to different nodes to
* maximize availability. For more information about availability sets, see [Manage the
* availability of virtual
* machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
* <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual
* machines in
* Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)
* <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM
* cannot be added to an availability set.
*/
export interface AvailabilitySet extends Resource {
/**
* Update Domain count.
*/
platformUpdateDomainCount?: number;
/**
* Fault Domain count.
*/
platformFaultDomainCount?: number;
/**
* A list of references to all virtual machines in the availability set.
*/
virtualMachines?: SubResource[];
/**
* The resource status information.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly statuses?: InstanceViewStatus[];
/**
* Sku of the availability set
*/
sku?: Sku;
}
/**
* The Update Resource model definition.
*/
export interface UpdateResource extends BaseResource {
/**
* Resource tags
*/
tags?: { [propertyName: string]: string };
}
/**
* Specifies information about the availability set that the virtual machine should be assigned to.
* Only tags may be updated.
*/
export interface AvailabilitySetUpdate extends UpdateResource {
/**
* Update Domain count.
*/
platformUpdateDomainCount?: number;
/**
* Fault Domain count.
*/
platformFaultDomainCount?: number;
/**
* A list of references to all virtual machines in the availability set.
*/
virtualMachines?: SubResource[];
/**
* The resource status information.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly statuses?: InstanceViewStatus[];
/**
* Sku of the availability set
*/
sku?: Sku;
}
/**
* Describes the properties of a VM size.
*/
export interface VirtualMachineSize {
/**
* The name of the virtual machine size.
*/
name?: string;
/**
* The number of cores supported by the virtual machine size.
*/
numberOfCores?: number;
/**
* The OS disk size, in MB, allowed by the virtual machine size.
*/
osDiskSizeInMB?: number;
/**
* The resource disk size, in MB, allowed by the virtual machine size.
*/
resourceDiskSizeInMB?: number;
/**
* The amount of memory, in MB, supported by the virtual machine size.
*/
memoryInMB?: number;
/**
* The maximum number of data disks that can be attached to the virtual machine size.
*/
maxDataDiskCount?: number;
}
/**
* Describes a Virtual Machine Extension Image.
*/
export interface VirtualMachineExtensionImage extends Resource {
/**
* The operating system this extension supports.
*/
operatingSystem: string;
/**
* The type of role (IaaS or PaaS) this extension supports.
*/
computeRole: string;
/**
* The schema defined by publisher, where extension consumers should provide settings in a
* matching schema.
*/
handlerSchema: string;
/**
* Whether the extension can be used on xRP VMScaleSets. By default existing extensions are
* usable on scalesets, but there might be cases where a publisher wants to explicitly indicate
* the extension is only enabled for CRP VMs but not VMSS.
*/
vmScaleSetEnabled?: boolean;
/**
* Whether the handler can support multiple extensions.
*/
supportsMultipleExtensions?: boolean;
}
/**
* Virtual machine image resource information.
*/
export interface VirtualMachineImageResource extends SubResource {
/**
* The name of the resource.
*/
name: string;
/**
* The supported Azure location of the resource.
*/
location: string;
/**
* Specifies the tags that are assigned to the virtual machine. For more information about using
* tags, see [Using tags to organize your Azure
* resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md).
*/
tags?: { [propertyName: string]: string };
}
/**
* The instance view of a virtual machine extension.
*/
export interface VirtualMachineExtensionInstanceView {
/**
* The virtual machine extension name.
*/
name?: string;
/**
* Specifies the type of the extension; an example is "CustomScriptExtension".
*/
type?: string;
/**
* Specifies the version of the script handler.
*/
typeHandlerVersion?: string;
/**
* The resource status information.
*/
substatuses?: InstanceViewStatus[];
/**
* The resource status information.
*/
statuses?: InstanceViewStatus[];
}
/**
* Describes a Virtual Machine Extension.
*/
export interface VirtualMachineExtension extends Resource {
/**
* How the extension handler should be forced to update even if the extension configuration has
* not changed.
*/
forceUpdateTag?: string;
/**
* The name of the extension handler publisher.
*/
publisher?: string;
/**
* Specifies the type of the extension; an example is "CustomScriptExtension".
*/
virtualMachineExtensionType?: string;
/**
* Specifies the version of the script handler.
*/
typeHandlerVersion?: string;
/**
* Indicates whether the extension should use a newer minor version if one is available at
* deployment time. Once deployed, however, the extension will not upgrade minor versions unless
* redeployed, even with this property set to true.
*/
autoUpgradeMinorVersion?: boolean;
/**
* Json formatted public settings for the extension.
*/
settings?: any;
/**
* The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no
* protected settings at all.
*/
protectedSettings?: any;
/**
* The provisioning state, which only appears in the response.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly provisioningState?: string;
/**
* The virtual machine extension instance view.
*/
instanceView?: VirtualMachineExtensionInstanceView;
}
/**
* Describes a Virtual Machine Extension.
*/
export interface VirtualMachineExtensionUpdate extends UpdateResource {
/**
* How the extension handler should be forced to update even if the extension configuration has
* not changed.
*/
forceUpdateTag?: string;
/**
* The name of the extension handler publisher.
*/
publisher?: string;
/**
* Specifies the type of the extension; an example is "CustomScriptExtension".
*/
type?: string;
/**
* Specifies the version of the script handler.
*/
typeHandlerVersion?: string;
/**
* Indicates whether the extension should use a newer minor version if one is available at
* deployment time. Once deployed, however, the extension will not upgrade minor versions unless
* redeployed, even with this property set to true.
*/
autoUpgradeMinorVersion?: boolean;
/**
* Json formatted public settings for the extension.
*/
settings?: any;
/**
* The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no
* protected settings at all.
*/
protectedSettings?: any;
}
/**
* The List Extension operation response
*/
export interface VirtualMachineExtensionsListResult {
/**
* The list of extensions
*/
value?: VirtualMachineExtension[];
}
/**
* Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
*/
export interface PurchasePlan {
/**
* The publisher ID.
*/
publisher: string;
/**
* The plan ID.
*/
name: string;
/**
* Specifies the product of the image from the marketplace. This is the same value as Offer under
* the imageReference element.
*/
product: string;
}
/**
* Contains the os disk image information.
*/
export interface OSDiskImage {
/**
* The operating system of the osDiskImage. Possible values include: 'Windows', 'Linux'
*/
operatingSystem: OperatingSystemTypes;
}
/**
* Contains the data disk images information.
*/
export interface DataDiskImage {
/**
* 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.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly lun?: number;
}
/**
* Describes a Virtual Machine Image.
*/
export interface VirtualMachineImage extends VirtualMachineImageResource {
plan?: PurchasePlan;
osDiskImage?: OSDiskImage;
dataDiskImages?: DataDiskImage[];
}
/**
* The Usage Names.
*/
export interface UsageName {
/**
* The name of the resource.
*/
value?: string;
/**
* The localized name of the resource.
*/
localizedValue?: string;
}
/**
* Describes Compute Resource Usage.
*/
export interface Usage {
/**
* The current usage of the resource.
*/
currentValue: number;
/**
* The maximum permitted usage of the resource.
*/
limit: number;
/**
* The name of the type of usage.
*/
name: UsageName;
}
/**
* Capture Virtual Machine parameters.
*/
export interface VirtualMachineCaptureParameters {
/**
* The captured virtual hard disk's name prefix.
*/
vhdPrefix: string;
/**
* The destination container name.
*/
destinationContainerName: string;
/**
* Specifies whether to overwrite the destination virtual hard disk, in case of conflict.
*/
overwriteVhds: boolean;
}
/**
* Resource Id.
*/
export interface VirtualMachineCaptureResult extends SubResource {
/**
* Operation output data (raw JSON)
*/
output?: any;
}
/**
* 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**.
*/
export interface Plan {
/**
* The plan ID.
*/
name?: string;
/**
* The publisher ID.
*/
publisher?: string;
/**
* Specifies the product of the image from the marketplace. This is the same value as Offer under
* the imageReference element.
*/
product?: string;
/**
* The promotion code.
*/
promotionCode?: string;
}
/**
* Specifies the hardware settings for the virtual machine.
*/
export interface HardwareProfile {
/**
* Specifies the size of the virtual machine. For more information about virtual machine sizes,
* see [Sizes for virtual
* machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
* <br><br> The available VM sizes depend on region and availability set. For a list of available
* sizes use 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/virtualmachinesizes/list) <br><br> [List
* all available virtual machine sizes for
* resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes).
* Possible values include: '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'
*/
vmSize?: VirtualMachineSizeTypes;
}
/**
* 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.
*/
export interface ImageReference extends SubResource {
/**
* The image publisher.
*/
publisher?: string;
/**
* Specifies the offer of the platform image or marketplace image used to create the virtual
* machine.
*/
offer?: string;
/**
* The image SKU.
*/
sku?: string;
/**
* 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.
*/
version?: string;
}
/**
* Describes a reference to Key Vault Secret
*/
export interface KeyVaultSecretReference {
/**
* The URL referencing a secret in a Key Vault.
*/
secretUrl: string;
/**
* The relative URL of the Key Vault containing the secret.
*/
sourceVault: SubResource;
}
/**
* Describes a reference to Key Vault Key
*/
export interface KeyVaultKeyReference {
/**
* The URL referencing a key encryption key in Key Vault.
*/
keyUrl: string;
/**
* The relative URL of the Key Vault containing the key.
*/
sourceVault: SubResource;
}
/**
* Describes a Encryption Settings for a Disk
*/
export interface DiskEncryptionSettings {
/**
* Specifies the location of the disk encryption key, which is a Key Vault Secret.
*/
diskEncryptionKey?: KeyVaultSecretReference;
/**
* Specifies the location of the key encryption key in Key Vault.
*/
keyEncryptionKey?: KeyVaultKeyReference;
/**
* Specifies whether disk encryption should be enabled on the virtual machine.
*/
enabled?: boolean;
}
/**
* Describes the uri of a disk.
*/
export interface VirtualHardDisk {
/**
* Specifies the virtual hard disk's uri.
*/
uri?: string;
}
/**
* The parameters of a managed disk.
*/
export interface ManagedDiskParameters extends SubResource {
/**
* Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or
* Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'
*/
storageAccountType?: StorageAccountTypes;
}
/**
* 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/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
*/
export interface OSDisk {
/**
* 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**. Possible values include: 'Windows', 'Linux'
*/
osType?: OperatingSystemTypes;
/**
* Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15
*/
encryptionSettings?: DiskEncryptionSettings;
/**
* The disk name.
*/
name?: string;
/**
* The virtual hard disk.
*/
vhd?: VirtualHardDisk;
/**
* 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.
*/
image?: VirtualHardDisk;
/**
* 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**. Possible values include: 'None', 'ReadOnly', 'ReadWrite'
*/
caching?: CachingTypes;
/**
* Specifies whether writeAccelerator should be enabled or disabled on the disk.
*/
writeAcceleratorEnabled?: boolean;
/**
* 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. Possible values include: 'FromImage', 'Empty', 'Attach'
*/
createOption: DiskCreateOptionTypes;
/**
* 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> This value cannot be larger than
* 1023 GB
*/
diskSizeGB?: number;
/**
* The managed disk parameters.
*/
managedDisk?: ManagedDiskParameters;
}
/**
* Describes a data disk.
*/
export interface DataDisk {
/**
* 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.
*/
lun: number;
/**
* The disk name.
*/
name?: string;
/**
* The virtual hard disk.
*/
vhd?: VirtualHardDisk;
/**
* 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.
*/
image?: VirtualHardDisk;
/**
* 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**. Possible values include: 'None', 'ReadOnly', 'ReadWrite'
*/
caching?: CachingTypes;
/**
* Specifies whether writeAccelerator should be enabled or disabled on the disk.
*/
writeAcceleratorEnabled?: boolean;
/**
* 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. Possible values include: 'FromImage', 'Empty', 'Attach'
*/
createOption: DiskCreateOptionTypes;
/**
* 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> This value cannot be larger than
* 1023 GB
*/
diskSizeGB?: number;
/**
* The managed disk parameters.
*/
managedDisk?: ManagedDiskParameters;
}
/**
* Specifies the storage settings for the virtual machine disks.
*/
export interface StorageProfile {
/**
* 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.
*/
imageReference?: ImageReference;
/**
* 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/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
*/
osDisk?: OSDisk;
/**
* Specifies the parameters that are used to add a data disk to a 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/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
*/
dataDisks?: DataDisk[];
}
/**
* Specifies additional XML formatted information that can be included in the Unattend.xml file,
* which is used by Windows Setup. Contents are defined by setting name, component name, and the
* pass in which the content is applied.
*/
export interface AdditionalUnattendContent {
/**
* The pass name. Currently, the only allowable value is OobeSystem. Possible values include:
* 'OobeSystem'
*/
passName?: PassNames;
/**
* The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
* Possible values include: 'Microsoft-Windows-Shell-Setup'
*/
componentName?: ComponentNames;
/**
* Specifies the name of the setting to which the content applies. Possible values are:
* FirstLogonCommands and AutoLogon. Possible values include: 'AutoLogon', 'FirstLogonCommands'
*/
settingName?: SettingNames;
/**
* Specifies the XML formatted content that is added to the unattend.xml file for the specified
* path and component. The XML must be less than 4KB and must include the root element for the
* setting or feature that is being inserted.
*/
content?: string;
}
/**
* Describes Protocol and thumbprint of Windows Remote Management listener
*/
export interface WinRMListener {
/**
* Specifies the protocol of listener. <br><br> Possible values are: <br>**http** <br><br>
* **https**. Possible values include: 'Http', 'Https'
*/
protocol?: ProtocolTypes;
/**
* This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a
* secret to the Key Vault, see [Add a key or secret to the key
* vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case,
* your certificate needs to be It is the Base64 encoding of the following JSON Object which is
* encoded in UTF-8: <br><br> {<br> "data":"<Base64-encoded-certificate>",<br>
* "dataType":"pfx",<br> "password":"<pfx-file-password>"<br>}
*/
certificateUrl?: string;
}
/**
* Describes Windows Remote Management configuration of the VM
*/
export interface WinRMConfiguration {
/**
* The list of Windows Remote Management listeners
*/
listeners?: WinRMListener[];
}
/**
* Specifies Windows operating system settings on the virtual machine.
*/
export interface WindowsConfiguration {
/**
* Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br>
* When this property is not specified in the request body, default behavior is to set it to
* true. This will ensure that VM Agent is installed on the VM so that extensions can be added
* to the VM later.
*/
provisionVMAgent?: boolean;
/**
* Indicates whether virtual machine is enabled for automatic updates.
*/
enableAutomaticUpdates?: boolean;
/**
* Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"
*/
timeZone?: string;
/**
* Specifies additional base-64 encoded XML formatted information that can be included in the
* Unattend.xml file, which is used by Windows Setup.
*/
additionalUnattendContent?: AdditionalUnattendContent[];
/**
* Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
*/
winRM?: WinRMConfiguration;
}
/**
* Contains information about SSH certificate public key and the path on the Linux VM where the
* public key is placed.
*/
export interface SshPublicKey {
/**
* Specifies the full path on the created VM where ssh public key is stored. If the file already
* exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys
*/
path?: string;
/**
* SSH public key certificate used to authenticate with the VM through ssh. The key needs to be
* at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys
* on Linux and Mac for Linux VMs in
* Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
*/
keyData?: string;
}
/**
* SSH configuration for Linux based VMs running on Azure
*/
export interface SshConfiguration {
/**
* The list of SSH public keys used to authenticate with linux based VMs.
*/
publicKeys?: SshPublicKey[];
}
/**
* Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of
* supported Linux distributions, see [Linux on Azure-Endorsed
* Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
* <br><br> For running non-endorsed distributions, see [Information for Non-Endorsed
* Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
*/
export interface LinuxConfiguration {
/**
* Specifies whether password authentication should be disabled.
*/
disablePasswordAuthentication?: boolean;
/**
* Specifies the ssh key configuration for a Linux OS.
*/
ssh?: SshConfiguration;
}
/**
* Describes a single certificate reference in a Key Vault, and where the certificate should reside
* on the VM.
*/
export interface VaultCertificate {
/**
* This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a
* secret to the Key Vault, see [Add a key or secret to the key
* vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case,
* your certificate needs to be It is the Base64 encoding of the following JSON Object which is
* encoded in UTF-8: <br><br> {<br> "data":"<Base64-encoded-certificate>",<br>
* "dataType":"pfx",<br> "password":"<pfx-file-password>"<br>}
*/
certificateUrl?: string;
/**
* For Windows VMs, specifies the certificate store on the Virtual Machine to which the
* certificate should be added. The specified certificate store is implicitly in the LocalMachine
* account. <br><br>For Linux VMs, the certificate file is placed under the /var/lib/waagent
* directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file
* and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
*/
certificateStore?: string;
}
/**
* Describes a set of certificates which are all in the same Key Vault.
*/
export interface VaultSecretGroup {
/**