-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Expand file tree
/
Copy pathmodels.tsp
More file actions
2489 lines (2158 loc) · 79.1 KB
/
Copy pathmodels.tsp
File metadata and controls
2489 lines (2158 loc) · 79.1 KB
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
import "@typespec/rest";
import "@typespec/http";
import "@azure-tools/typespec-azure-core";
import "@azure-tools/typespec-azure-resource-manager";
using Azure.ResourceManager;
using Azure.ResourceManager.Foundations;
namespace Microsoft.KeyVault;
/**
* The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
*/
union DeletionRecoveryLevel {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Purgeable: "Purgeable",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`Recoverable+Purgeable`: "Recoverable+Purgeable",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Recoverable: "Recoverable",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`Recoverable+ProtectedSubscription`: "Recoverable+ProtectedSubscription",
}
/**
* The type of the key. For valid values, see JsonWebKeyType.
*/
union JsonWebKeyType {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
EC: "EC",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`EC-HSM`: "EC-HSM",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
RSA: "RSA",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`RSA-HSM`: "RSA-HSM",
}
/**
* The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation.
*/
union JsonWebKeyOperation {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
encrypt: "encrypt",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
decrypt: "decrypt",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
sign: "sign",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
verify: "verify",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
wrapKey: "wrapKey",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
unwrapKey: "unwrapKey",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`import`: "import",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
release: "release",
}
/**
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
*/
union JsonWebKeyCurveName {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`P-256`: "P-256",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`P-384`: "P-384",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`P-521`: "P-521",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`P-256K`: "P-256K",
}
/**
* SKU family name
*/
union SkuFamily {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
A: "A",
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union KeyPermissions {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
all: "all",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
encrypt: "encrypt",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
decrypt: "decrypt",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
wrapKey: "wrapKey",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
unwrapKey: "unwrapKey",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
sign: "sign",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
verify: "verify",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
get: "get",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
list: "list",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
create: "create",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
update: "update",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`import`: "import",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
delete: "delete",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
backup: "backup",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
restore: "restore",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
recover: "recover",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
purge: "purge",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
release: "release",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
rotate: "rotate",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
getrotationpolicy: "getrotationpolicy",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
setrotationpolicy: "setrotationpolicy",
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union SecretPermissions {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
all: "all",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
get: "get",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
list: "list",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
set: "set",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
delete: "delete",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
backup: "backup",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
restore: "restore",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
recover: "recover",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
purge: "purge",
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union CertificatePermissions {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
all: "all",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
get: "get",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
list: "list",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
delete: "delete",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
create: "create",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
`import`: "import",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
update: "update",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
managecontacts: "managecontacts",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
getissuers: "getissuers",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
listissuers: "listissuers",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
setissuers: "setissuers",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
deleteissuers: "deleteissuers",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
manageissuers: "manageissuers",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
recover: "recover",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
purge: "purge",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
backup: "backup",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
restore: "restore",
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union StoragePermissions {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
all: "all",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
get: "get",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
list: "list",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
delete: "delete",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
set: "set",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
update: "update",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
regeneratekey: "regeneratekey",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
recover: "recover",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
purge: "purge",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
backup: "backup",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
restore: "restore",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
setsas: "setsas",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
listsas: "listsas",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
getsas: "getsas",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
deletesas: "deletesas",
}
/**
* Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
*/
union NetworkRuleBypassOptions {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
AzureServices: "AzureServices",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
None: "None",
}
/**
* Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
*/
union KeyVaultNetworkRuleBypassOption {
NetworkRuleBypassOptions,
}
/**
* Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
*/
union ManagedHsmNetworkRuleBypassOption {
NetworkRuleBypassOptions,
}
/**
* The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
*/
union NetworkRuleAction {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Allow: "Allow",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Deny: "Deny",
}
/**
* The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
*/
union KeyVaultNetworkRuleAction {
NetworkRuleAction,
}
/**
* The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
*/
union ManagedHsmNetworkRuleAction {
NetworkRuleAction,
}
/**
* Provisioning state of the vault.
*/
#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union VaultProvisioningState {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Succeeded: "Succeeded",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
RegisteringDns: "RegisteringDns",
}
/**
* The private endpoint connection status.
*/
union PrivateEndpointServiceConnectionStatus {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Pending: "Pending",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Approved: "Approved",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Rejected: "Rejected",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Disconnected: "Disconnected",
}
/**
* The private endpoint connection status.
*/
union ManagedHsmPrivateEndpointServiceConnectionStatus {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Pending: "Pending",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Approved: "Approved",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Rejected: "Rejected",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Disconnected: "Disconnected",
}
/**
* A message indicating if changes on the service provider require any updates on the consumer.
*/
union ActionsRequired {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
None: "None",
}
/**
* A message indicating if changes on the service provider require any updates on the consumer.
*/
union KeyVaultActionsRequiredMessage {
ActionsRequired,
}
/**
* A message indicating if changes on the service provider require any updates on the consumer.
*/
union ManagedHsmActionsRequiredMessage {
ActionsRequired,
}
/**
* The current provisioning state.
*/
#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union PrivateEndpointConnectionProvisioningState {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Succeeded: "Succeeded",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Creating: "Creating",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Updating: "Updating",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Deleting: "Deleting",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Failed: "Failed",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Disconnected: "Disconnected",
}
/**
* The current provisioning state.
*/
#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union ManagedHsmPrivateEndpointConnectionProvisioningState {
PrivateEndpointConnectionProvisioningState,
}
/**
* Provisioning state.
*/
#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union ProvisioningState {
string,
/**
* The managed HSM Pool has been full provisioned.
*/
Succeeded: "Succeeded",
/**
* The managed HSM Pool is currently being provisioned.
*/
Provisioning: "Provisioning",
/**
* Provisioning of the managed HSM Pool has failed.
*/
Failed: "Failed",
/**
* The managed HSM Pool is currently being updated.
*/
Updating: "Updating",
/**
* The managed HSM Pool is currently being deleted.
*/
Deleting: "Deleting",
/**
* The managed HSM pool is ready for normal use.
*/
Activated: "Activated",
/**
* The managed HSM pool is waiting for a security domain restore action.
*/
SecurityDomainRestore: "SecurityDomainRestore",
/**
* The managed HSM pool is being restored from full HSM backup.
*/
Restoring: "Restoring",
}
/**
* The current provisioning state.
*/
#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union GeoReplicationRegionProvisioningState {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Preprovisioning: "Preprovisioning",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Provisioning: "Provisioning",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Succeeded: "Succeeded",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Failed: "Failed",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Deleting: "Deleting",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Cleanup: "Cleanup",
}
/**
* Control permission to the managed HSM from public networks.
*/
union PublicNetworkAccess {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Enabled: "Enabled",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
Disabled: "Disabled",
}
/**
* Activation Status
*/
union ActivationStatus {
string,
/**
* The managed HSM Pool is active.
*/
Active: "Active",
/**
* The managed HSM Pool is not yet activated.
*/
NotActivated: "NotActivated",
/**
* An unknown error occurred while activating managed hsm.
*/
Unknown: "Unknown",
/**
* Failed to activate managed hsm.
*/
Failed: "Failed",
}
/**
* SKU Family of the managed HSM Pool
*/
union ManagedHsmSkuFamily {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
B: "B",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
C: "C",
}
/**
* This specifies whether token binding is disabled, enabled or enforced.
*/
@Versioning.added(KeyVault.Versions.v2026_03_01_preview)
union TokenBindingMode {
string,
/** Token binding is enforced for the vault. Only bounded tokens will be accepted. Bearer tokens will be rejected. */
Enforced: "Enforced",
/** Token binding is not enforced for the vault. Bounded tokens will be rejected. */
NotEnforced: "NotEnforced",
}
/**
* Must be one of the following values "NoValidation", "Unattested", "AttestedTrustedLaunch", "AttestedConfidential". Strength of the token binding increases with each value in that order.
*/
@Versioning.added(KeyVault.Versions.v2026_03_01_preview)
union TokenBindingStrength {
string,
/** This is default when token binding is not enabled. */
NoValidation: "NoValidation",
/** No attestation proof is required for the bounded token. */
Unattested: "Unattested",
/** Bounded Entra token must originate from a trusted launch VM with attestation proof from the attestation authority like Microsoft Azure Attestation. */
AttestedTrustedLaunch: "AttestedTrustedLaunch",
/** Bounded Entra token must originate from a confidential VM with attestation proof from the attestation authority like Microsoft Azure Attestation. */
AttestedConfidential: "AttestedConfidential",
}
/**
* The type of action.
*/
#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
enum KeyRotationPolicyActionType {
rotate,
notify,
}
/**
* SKU name to specify whether the key vault is a standard vault or a premium vault.
*/
#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
enum SkuName {
standard,
premium,
}
/**
* The vault's create mode to indicate whether the vault need to be recovered or not.
*/
#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
enum CreateMode {
recover,
default,
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
enum AccessPolicyUpdateKind {
add,
replace,
remove,
}
/**
* The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.
*/
#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union Reason {
string,
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
AccountNameInvalid: "AccountNameInvalid",
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
AlreadyExists: "AlreadyExists",
}
/**
* The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.
*/
#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
union ManagedHsmNameUnavailableReason {
Reason,
}
/**
* The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.
*/
#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
enum KeyVaultNameUnavailableReason {
AccountNameInvalid,
AlreadyExists,
}
/**
* SKU of the managed HSM Pool
*/
#suppress "@azure-tools/typespec-azure-core/no-enum" "Closed enum retained unchanged for already-released GA API versions 2025-05-01 and 2026-02-01 per Azure Breaking Changes Board guidance; superseded by the extensible union ManagedHsmSkuNameV2 starting in 2026-03-01-preview."
enum ManagedHsmSkuName {
Standard_B1,
Custom_B32,
Custom_B6,
Custom_C42,
Custom_C10,
}
/**
* SKU of the managed HSM Pool
*/
@Versioning.added(KeyVault.Versions.v2026_03_01_preview)
union ManagedHsmSkuNameV2 {
string,
/** Standard_B1 SKU */
Standard_B1: "Standard_B1",
/** Custom_B32 SKU */
Custom_B32: "Custom_B32",
/** Custom_B6 SKU */
Custom_B6: "Custom_B6",
/** Custom_C42 SKU */
Custom_C42: "Custom_C42",
/** Custom_C10 SKU */
Custom_C10: "Custom_C10",
}
/**
* The parameters used to create a key.
*/
model KeyCreateParameters {
/**
* The tags that will be assigned to the key.
*/
#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
tags?: Record<string>;
/**
* The properties of the key to be created.
*/
properties: KeyProperties;
}
/**
* The properties of the key.
*/
#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model KeyProperties {
/**
* The attributes of the key.
*/
attributes?: KeyAttributes;
/**
* The type of the key. For valid values, see JsonWebKeyType.
*/
@minLength(1)
kty?: JsonWebKeyType;
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
keyOps?: JsonWebKeyOperation[];
/**
* The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.
*/
keySize?: int32;
/**
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
*/
curveName?: JsonWebKeyCurveName;
/**
* The URI to retrieve the current version of the key.
*/
@visibility(Lifecycle.Read)
keyUri?: string;
/**
* The URI to retrieve the specific version of the key.
*/
@visibility(Lifecycle.Read)
keyUriWithVersion?: string;
/**
* Key rotation policy in response. It will be used for both output and input. Omitted if empty
*/
rotationPolicy?: RotationPolicy;
/**
* Key release policy in response. It will be used for both output and input. Omitted if empty
*/
#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
release_policy?: KeyReleasePolicy;
}
/**
* The object attributes managed by the Azure Key Vault service.
*/
model KeyAttributes {
/**
* Determines whether or not the object is enabled.
*/
enabled?: boolean;
/**
* Not before date in seconds since 1970-01-01T00:00:00Z.
*/
nbf?: int64;
/**
* Expiry date in seconds since 1970-01-01T00:00:00Z.
*/
exp?: int64;
/**
* Creation time in seconds since 1970-01-01T00:00:00Z.
*/
@visibility(Lifecycle.Read)
created?: int64;
/**
* Last updated time in seconds since 1970-01-01T00:00:00Z.
*/
@visibility(Lifecycle.Read)
updated?: int64;
/**
* The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
*/
@visibility(Lifecycle.Read)
recoveryLevel?: DeletionRecoveryLevel;
/**
* Indicates if the private key can be exported.
*/
exportable?: boolean = false;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model RotationPolicy {
/**
* The attributes of key rotation policy.
*/
attributes?: KeyRotationPolicyAttributes;
/**
* The lifetimeActions for key rotation action.
*/
@identifiers(#[])
lifetimeActions?: LifetimeAction[];
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model KeyRotationPolicyAttributes {
/**
* Creation time in seconds since 1970-01-01T00:00:00Z.
*/
@visibility(Lifecycle.Read)
created?: int64;
/**
* Last updated time in seconds since 1970-01-01T00:00:00Z.
*/
@visibility(Lifecycle.Read)
updated?: int64;
/**
* The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'.
*/
expiryTime?: string;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model LifetimeAction {
/**
* The trigger of key rotation policy lifetimeAction.
*/
trigger?: Trigger;
/**
* The action of key rotation policy lifetimeAction.
*/
action?: Action;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model Trigger {
/**
* The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
*/
timeAfterCreate?: string;
/**
* The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
*/
timeBeforeExpiry?: string;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model Action {
/**
* The type of action.
*/
type?: KeyRotationPolicyActionType;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model KeyReleasePolicy {
/**
* Content type and version of key release policy
*/
contentType?: string = "application/json; charset=utf-8";
/**
* Blob encoding the policy rules under which the key can be released.
*/
@encode("base64url")
data?: bytes;
}
/**
* The parameters used to create a key.
*/
model ManagedHsmKeyCreateParameters {
/**
* The tags that will be assigned to the key.
*/
#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
tags?: Record<string>;
/**
* The properties of the key to be created.
*/
properties: ManagedHsmKeyProperties;
}
/**
* The properties of the key.
*/
#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model ManagedHsmKeyProperties {
/**
* The attributes of the key.
*/
attributes?: ManagedHsmKeyAttributes;
/**
* The type of the key. For valid values, see JsonWebKeyType.
*/
@minLength(1)
kty?: JsonWebKeyType;
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
keyOps?: JsonWebKeyOperation[];
/**
* The key size in bits. For example: 2048, 3072, or 4096 for RSA. Default for RSA and RSA-HSM keys is 2048. Exception made for bring your own key (BYOK), key exchange keys default to 4096.
*/
keySize?: int32;
/**
* The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
*/
curveName?: JsonWebKeyCurveName;
/**
* The URI to retrieve the current version of the key.
*/
@visibility(Lifecycle.Read)
keyUri?: string;
/**
* The URI to retrieve the specific version of the key.
*/
@visibility(Lifecycle.Read)
keyUriWithVersion?: string;
/**
* Key rotation policy in response. It will be used for both output and input. Omitted if empty
*/
rotationPolicy?: ManagedHsmRotationPolicy;
/**
* Key release policy in response. It will be used for both output and input. Omitted if empty
*/
#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
release_policy?: ManagedHsmKeyReleasePolicy;
}
/**
* The object attributes managed by the Azure Key Vault service.
*/
model ManagedHsmKeyAttributes {
/**
* Determines whether or not the object is enabled.
*/
enabled?: boolean;
/**
* Not before date in seconds since 1970-01-01T00:00:00Z.
*/
nbf?: int64;
/**
* Expiry date in seconds since 1970-01-01T00:00:00Z.
*/
exp?: int64;
/**
* Creation time in seconds since 1970-01-01T00:00:00Z.
*/
@visibility(Lifecycle.Read)
created?: int64;
/**
* Last updated time in seconds since 1970-01-01T00:00:00Z.
*/
@visibility(Lifecycle.Read)
updated?: int64;
/**
* The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
*/
@visibility(Lifecycle.Read)
recoveryLevel?: DeletionRecoveryLevel;
/**
* Indicates if the private key can be exported.
*/
exportable?: boolean;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model ManagedHsmRotationPolicy {
/**
* The attributes of key rotation policy.
*/
attributes?: ManagedHsmKeyRotationPolicyAttributes;
/**
* The lifetimeActions for key rotation action.
*/
@identifiers(#[])
lifetimeActions?: ManagedHsmLifetimeAction[];
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model ManagedHsmKeyRotationPolicyAttributes {
/**
* Creation time in seconds since 1970-01-01T00:00:00Z.
*/
@visibility(Lifecycle.Read)
created?: int64;
/**
* Last updated time in seconds since 1970-01-01T00:00:00Z.
*/
@visibility(Lifecycle.Read)
updated?: int64;
/**
* The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'.
*/
expiryTime?: string;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model ManagedHsmLifetimeAction {
/**
* The trigger of key rotation policy lifetimeAction.
*/
trigger?: ManagedHsmTrigger;
/**
* The action of key rotation policy lifetimeAction.
*/
action?: ManagedHsmAction;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model ManagedHsmTrigger {
/**
* The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
*/
timeAfterCreate?: string;
/**
* The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
*/
timeBeforeExpiry?: string;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model ManagedHsmAction {
/**
* The type of action.
*/
type?: KeyRotationPolicyActionType;
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details"
model ManagedHsmKeyReleasePolicy {
/**
* Content type and version of key release policy