/
index.ts
2477 lines (2177 loc) · 88.8 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.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import * as coreClient from "@azure/core-client";
/** Result of the list devcenters operation */
export interface DevCenterListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: DevCenter[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Managed service identity (system assigned and/or user assigned identities) */
export interface ManagedServiceIdentity {
/**
* The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly principalId?: string;
/**
* The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly tenantId?: string;
/** Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */
type: ManagedServiceIdentityType;
/** The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */
userAssignedIdentities?: { [propertyName: string]: UserAssignedIdentity };
}
/** User assigned identity properties */
export interface UserAssignedIdentity {
/**
* The principal ID of the assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly principalId?: string;
/**
* The client ID of the assigned identity.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly clientId?: string;
}
/** Common fields that are returned in the response for all Azure Resource Manager resources */
export interface Resource {
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* The name of the resource
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly systemData?: SystemData;
}
/** Metadata pertaining to creation and last modification of the resource. */
export interface SystemData {
/** The identity that created the resource. */
createdBy?: string;
/** The type of identity that created the resource. */
createdByType?: CreatedByType;
/** The timestamp of resource creation (UTC). */
createdAt?: Date;
/** The identity that last modified the resource. */
lastModifiedBy?: string;
/** The type of identity that last modified the resource. */
lastModifiedByType?: CreatedByType;
/** The timestamp of resource last modification (UTC) */
lastModifiedAt?: Date;
}
/** An error response from the DevCenter service. */
export interface CloudError {
/** Error body */
error: CloudErrorBody;
}
/** An error response from the DevCenter service. */
export interface CloudErrorBody {
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
code: string;
/** A message describing the error, intended to be suitable for display in a user interface. */
message: string;
/** The target of the particular error. For example, the name of the property in error. */
target?: string;
/** A list of additional details about the error. */
details?: CloudErrorBody[];
}
/** Base tracked resource type for PATCH updates */
export interface TrackedResourceUpdate {
/** Resource tags. */
tags?: { [propertyName: string]: string };
/** The geo-location where the resource lives */
location?: string;
}
/** Results of the project list operation. */
export interface ProjectListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Project[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Properties of a project. These properties can be updated after the resource has been created. */
export interface ProjectUpdateProperties {
/** Resource Id of an associated DevCenter */
devCenterId?: string;
/** Description of the project. */
description?: string;
}
/** Results of the Attached Networks list operation. */
export interface AttachedNetworkListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: AttachedNetworkConnection[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Results of the gallery list operation. */
export interface GalleryListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Gallery[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Results of the image list operation. */
export interface ImageListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Image[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Properties for a recommended machine configuration. */
export interface RecommendedMachineConfiguration {
/**
* Recommended memory range.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly memory?: ResourceRange;
/**
* Recommended vCPU range.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly vCPUs?: ResourceRange;
}
/** Properties for a range of values. */
export interface ResourceRange {
/**
* Minimum value.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly min?: number;
/**
* Maximum value.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly max?: number;
}
/** Results of the image version list operation. */
export interface ImageVersionListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: ImageVersion[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Results of the catalog list operation. */
export interface CatalogListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Catalog[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Properties of a catalog. These properties can be updated after the resource has been created. */
export interface CatalogUpdateProperties {
/** Properties for a GitHub catalog type. */
gitHub?: GitCatalog;
/** Properties for an Azure DevOps catalog type. */
adoGit?: GitCatalog;
}
/** Properties for a Git repository catalog. */
export interface GitCatalog {
/** Git URI. */
uri?: string;
/** Git branch. */
branch?: string;
/** A reference to the Key Vault secret containing a security token to authenticate to a Git repository. */
secretIdentifier?: string;
/** The folder where the catalog items can be found inside the repository. */
path?: string;
}
/** The catalog's properties for partial update. Properties not provided in the update request will not be changed. */
export interface CatalogUpdate {
/** Resource tags. */
tags?: { [propertyName: string]: string };
/** Properties for a GitHub catalog type. */
gitHub?: GitCatalog;
/** Properties for an Azure DevOps catalog type. */
adoGit?: GitCatalog;
}
/** Result of the environment type list operation. */
export interface EnvironmentTypeListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: EnvironmentType[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** The environment type for partial update. Properties not provided in the update request will not be changed. */
export interface EnvironmentTypeUpdate {
/** Resource tags. */
tags?: { [propertyName: string]: string };
}
/** Result of the allowed environment type list operation. */
export interface AllowedEnvironmentTypeListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: AllowedEnvironmentType[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Result of the project environment type list operation. */
export interface ProjectEnvironmentTypeListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: ProjectEnvironmentType[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Properties of a project environment type. These properties can be updated after the resource has been created. */
export interface ProjectEnvironmentTypeUpdateProperties {
/** Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription. */
deploymentTargetId?: string;
/** Defines whether this Environment Type can be used in this Project. */
status?: EnableStatus;
/** The role definition assigned to the environment creator on backing resources. */
creatorRoleAssignment?: ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment;
/** Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs. */
userRoleAssignments?: { [propertyName: string]: UserRoleAssignmentValue };
}
/** The role definition assigned to the environment creator on backing resources. */
export interface ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment {
/** A map of roles to assign to the environment creator. */
roles?: { [propertyName: string]: EnvironmentRole };
}
/** A role that can be assigned to a user. */
export interface EnvironmentRole {
/**
* The common name of the Role Assignment. This is a descriptive name such as 'AcrPush'.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly roleName?: string;
/**
* This is a description of the Role Assignment.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly description?: string;
}
/** Mapping of user object ID to role assignments. */
export interface UserRoleAssignmentValue {
/** A map of roles to assign to the parent user. */
roles?: { [propertyName: string]: EnvironmentRole };
}
/** The project environment type for partial update. Properties not provided in the update request will not be changed. */
export interface ProjectEnvironmentTypeUpdate {
/** Resource tags. */
tags?: { [propertyName: string]: string };
/** Managed identity properties */
identity?: ManagedServiceIdentity;
/** Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription. */
deploymentTargetId?: string;
/** Defines whether this Environment Type can be used in this Project. */
status?: EnableStatus;
/** The role definition assigned to the environment creator on backing resources. */
creatorRoleAssignment?: ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment;
/** Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs. */
userRoleAssignments?: { [propertyName: string]: UserRoleAssignmentValue };
}
/** Results of the Dev Box definition list operation. */
export interface DevBoxDefinitionListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: DevBoxDefinition[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Image validation error details */
export interface ImageValidationErrorDetails {
/** An identifier for the error. */
code?: string;
/** A message describing the error. */
message?: string;
}
/** Image reference information */
export interface ImageReference {
/** Image ID, or Image version ID. When Image ID is provided, its latest version will be used. */
id?: string;
/**
* The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly exactVersion?: string;
/** The image publisher. */
publisher?: string;
/** The image offer. */
offer?: string;
/** The image sku. */
sku?: string;
}
/** Properties of a Dev Box definition. These properties can be updated after the resource has been created. */
export interface DevBoxDefinitionUpdateProperties {
/** Image reference information. */
imageReference?: ImageReference;
/** The SKU for Dev Boxes created using this definition. */
sku?: Sku;
/** The storage type used for the Operating System disk of Dev Boxes created using this definition. */
osStorageType?: string;
}
/** The resource model definition representing SKU */
export interface Sku {
/** The name of the SKU. Ex - P3. It is typically a letter+number code */
name: string;
/** This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */
tier?: SkuTier;
/** The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */
size?: string;
/** If the service has different generations of hardware, for the same SKU, then that can be captured here. */
family?: string;
/** If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */
capacity?: number;
}
/** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
export interface OperationListResult {
/**
* List of operations supported by the resource provider
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Operation[];
/**
* URL to get the next set of operation list results (if there are any).
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Details of a REST API operation, returned from the Resource Provider Operations API */
export interface Operation {
/**
* The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly isDataAction?: boolean;
/** Localized display information for this particular operation. */
display?: OperationDisplay;
/**
* The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly origin?: Origin;
/**
* Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly actionType?: ActionType;
}
/** Localized display information for this particular operation. */
export interface OperationDisplay {
/**
* The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provider?: string;
/**
* The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly resource?: string;
/**
* The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly operation?: string;
/**
* The short, localized friendly description of the operation; suitable for tool tips and detailed views.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly description?: string;
}
/** The current status of an async operation. */
export interface OperationStatusResult {
/** Fully qualified ID for the async operation. */
id?: string;
/** Name of the async operation. */
name?: string;
/** Operation status. */
status: string;
/** Percent of the operation that is complete. */
percentComplete?: number;
/** The start time of the operation. */
startTime?: Date;
/** The end time of the operation. */
endTime?: Date;
/** The operations list. */
operations?: OperationStatusResult[];
/** If present, details of the operation error. */
error?: ErrorDetail;
}
/** The error detail. */
export interface ErrorDetail {
/**
* The error code.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly code?: string;
/**
* The error message.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly message?: string;
/**
* The error target.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly target?: string;
/**
* The error details.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly details?: ErrorDetail[];
/**
* The error additional info.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly additionalInfo?: ErrorAdditionalInfo[];
}
/** The resource management error additional info. */
export interface ErrorAdditionalInfo {
/**
* The additional info type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* The additional info.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly info?: Record<string, unknown>;
}
/** List of Core Usages. */
export interface ListUsagesResult {
/**
* The array page of Usages.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Usage[];
/**
* The link to get the next page of Usage result.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** The core usage details. */
export interface Usage {
/** The current usage. */
currentValue?: number;
/** The limit integer. */
limit?: number;
/** The unit details. */
unit?: UsageUnit;
/** The name. */
name?: UsageName;
}
/** The Usage Names. */
export interface UsageName {
/** The localized name of the resource. */
localizedValue?: string;
/** The name of the resource. */
value?: string;
}
/** Results of the Microsoft.DevCenter SKU list operation. */
export interface SkuListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: DevCenterSku[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** A name/value pair to describe a capability. */
export interface Capability {
/**
* Name of the capability.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* Value of the capability.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: string;
}
/** Results of the machine pool list operation. */
export interface PoolListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Pool[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Properties of a Pool. These properties can be updated after the resource has been created. */
export interface PoolUpdateProperties {
/** Name of a Dev Box definition in parent Project of this Pool */
devBoxDefinitionName?: string;
/** Name of a Network Connection in parent Project of this Pool */
networkConnectionName?: string;
/** Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. */
licenseType?: LicenseType;
/** Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. */
localAdministrator?: LocalAdminStatus;
}
/** Result of the schedule list operation. */
export interface ScheduleListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Schedule[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Updatable properties of a Schedule. */
export interface ScheduleUpdateProperties {
/** Supported type this scheduled task represents. */
type?: ScheduledType;
/** The frequency of this scheduled task. */
frequency?: ScheduledFrequency;
/** The target time to trigger the action. The format is HH:MM. */
time?: string;
/** The IANA timezone id at which the schedule should execute. */
timeZone?: string;
/** Indicates whether or not this scheduled task is enabled. */
state?: EnableStatus;
}
/** Result of the network connection list operation. */
export interface NetworkConnectionListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: NetworkConnection[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Properties of network connection. These properties can be updated after the resource has been created. */
export interface NetworkConnectionUpdateProperties {
/** The subnet to attach Virtual Machines to */
subnetId?: string;
/** Active Directory domain name */
domainName?: string;
/** Active Directory domain Organization Unit (OU) */
organizationUnit?: string;
/** The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com. */
domainUsername?: string;
/** The password for the account used to join domain */
domainPassword?: string;
}
/** Result of the network health check list operation. */
export interface HealthCheckStatusDetailsListResult {
/**
* Current page of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: HealthCheckStatusDetails[];
/**
* URL to get the next set of results if there are any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** An individual health check item */
export interface HealthCheck {
/**
* The status of the health check item.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly status?: HealthCheckStatus;
/**
* The display name of this health check item.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly displayName?: string;
/**
* Start time of health check item.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly startDateTime?: Date;
/**
* End time of the health check item.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly endDateTime?: Date;
/**
* The type of error that occurred during this health check.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly errorType?: string;
/**
* The recommended action to fix the corresponding error.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly recommendedAction?: string;
/**
* Additional details about the health check or the recommended action.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly additionalDetails?: string;
}
/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
export interface TrackedResource extends Resource {
/** Resource tags. */
tags?: { [propertyName: string]: string };
/** The geo-location where the resource lives */
location: string;
}
/** Represents an attached NetworkConnection. */
export interface AttachedNetworkConnection extends Resource {
/**
* The provisioning state of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** The resource ID of the NetworkConnection you want to attach. */
networkConnectionId?: string;
/**
* The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly networkConnectionLocation?: string;
/**
* Health check status values
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly healthCheckStatus?: HealthCheckStatus;
/**
* AAD Join type of the network. This is populated based on the referenced Network Connection.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly domainJoinType?: DomainJoinType;
}
/** Represents a gallery. */
export interface Gallery extends Resource {
/**
* The provisioning state of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/** The resource ID of the backing Azure Compute Gallery. */
galleryResourceId?: string;
}
/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
export interface ProxyResource extends Resource {}
/** Represents a catalog. */
export interface Catalog extends Resource {
/** Properties for a GitHub catalog type. */
gitHub?: GitCatalog;
/** Properties for an Azure DevOps catalog type. */
adoGit?: GitCatalog;
/**
* The provisioning state of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The synchronization state of the catalog.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly syncState?: CatalogSyncState;
/**
* When the catalog was last synced.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastSyncTime?: Date;
}
/** Represents an environment type. */
export interface EnvironmentType extends Resource {
/** Resource tags. */
tags?: { [propertyName: string]: string };
/**
* The provisioning state of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
}
/** Represents an allowed environment type. */
export interface AllowedEnvironmentType extends Resource {
/**
* The provisioning state of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
}
/** Represents an environment type. */
export interface ProjectEnvironmentType extends Resource {
/** Resource tags. */
tags?: { [propertyName: string]: string };
/** Managed identity properties */
identity?: ManagedServiceIdentity;
/** The geo-location for the environment type */
location?: string;
/** Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription. */
deploymentTargetId?: string;
/** Defines whether this Environment Type can be used in this Project. */
status?: EnableStatus;
/** The role definition assigned to the environment creator on backing resources. */
creatorRoleAssignment?: ProjectEnvironmentTypeUpdatePropertiesCreatorRoleAssignment;
/** Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs. */
userRoleAssignments?: { [propertyName: string]: UserRoleAssignmentValue };
/**
* The provisioning state of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
}
/** Represents a Schedule to execute a task. */
export interface Schedule extends Resource {
/** Supported type this scheduled task represents. */
typePropertiesType?: ScheduledType;
/** The frequency of this scheduled task. */
frequency?: ScheduledFrequency;
/** The target time to trigger the action. The format is HH:MM. */
time?: string;
/** The IANA timezone id at which the schedule should execute. */
timeZone?: string;
/** Indicates whether or not this scheduled task is enabled. */
state?: EnableStatus;
/**
* The provisioning state of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
}
/** Health Check details. */
export interface HealthCheckStatusDetails extends Resource {
/**
* Start time of last execution of the health checks.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly startDateTime?: Date;
/**
* End time of last execution of the health checks.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly endDateTime?: Date;
/**
* Details for each health check item.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly healthChecks?: HealthCheck[];
}
/** The devcenter resource for partial updates. Properties not provided in the update request will not be changed. */
export interface DevCenterUpdate extends TrackedResourceUpdate {
/** Managed identity properties */
identity?: ManagedServiceIdentity;
}
/** The project properties for partial update. Properties not provided in the update request will not be changed. */
export interface ProjectUpdate extends TrackedResourceUpdate {
/** Resource Id of an associated DevCenter */
devCenterId?: string;
/** Description of the project. */
description?: string;
}
/** Partial update of a Dev Box definition resource. */
export interface DevBoxDefinitionUpdate extends TrackedResourceUpdate {
/** Image reference information. */
imageReference?: ImageReference;
/** The SKU for Dev Boxes created using this definition. */
sku?: Sku;
/** The storage type used for the Operating System disk of Dev Boxes created using this definition. */
osStorageType?: string;
}
/** The pool properties for partial update. Properties not provided in the update request will not be changed. */
export interface PoolUpdate extends TrackedResourceUpdate {
/** Name of a Dev Box definition in parent Project of this Pool */
devBoxDefinitionName?: string;
/** Name of a Network Connection in parent Project of this Pool */
networkConnectionName?: string;
/** Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. */
licenseType?: LicenseType;
/** Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. */
localAdministrator?: LocalAdminStatus;
}
/** The schedule properties for partial update. Properties not provided in the update request will not be changed. */
export interface ScheduleUpdate extends TrackedResourceUpdate {
/** Supported type this scheduled task represents. */
type?: ScheduledType;
/** The frequency of this scheduled task. */
frequency?: ScheduledFrequency;
/** The target time to trigger the action. The format is HH:MM. */
time?: string;
/** The IANA timezone id at which the schedule should execute. */
timeZone?: string;
/** Indicates whether or not this scheduled task is enabled. */
state?: EnableStatus;
}
/** The network connection properties for partial update. Properties not provided in the update request will not be changed. */
export interface NetworkConnectionUpdate extends TrackedResourceUpdate {
/** The subnet to attach Virtual Machines to */
subnetId?: string;
/** Active Directory domain name */
domainName?: string;
/** Active Directory domain Organization Unit (OU) */
organizationUnit?: string;
/** The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com. */
domainUsername?: string;
/** The password for the account used to join domain */
domainPassword?: string;
}
/** Properties of a project. */
export interface ProjectProperties extends ProjectUpdateProperties {
/**
* The provisioning state of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
}
/** Properties of a catalog. */
export interface CatalogProperties extends CatalogUpdateProperties {
/**
* The provisioning state of the resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: string;
/**
* The synchronization state of the catalog.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly syncState?: CatalogSyncState;
/**
* When the catalog was last synced.