UNPKG

103 kBTypeScriptView Raw
1import DistributedTaskCommonInterfaces = require("../interfaces/DistributedTaskCommonInterfaces");
2import FormInputInterfaces = require("../interfaces/common/FormInputInterfaces");
3import VSSInterfaces = require("../interfaces/common/VSSInterfaces");
4export declare enum AadLoginPromptOption {
5 /**
6 * Do not provide a prompt option
7 */
8 NoOption = 0,
9 /**
10 * Force the user to login again.
11 */
12 Login = 1,
13 /**
14 * Force the user to select which account they are logging in with instead of automatically picking the user up from the session state. NOTE: This does not work for switching between the variants of a dual-homed user.
15 */
16 SelectAccount = 2,
17 /**
18 * Force the user to login again. <remarks> Ignore current authentication state and force the user to authenticate again. This option should be used instead of Login. </remarks>
19 */
20 FreshLogin = 3,
21 /**
22 * Force the user to login again with mfa. <remarks> Ignore current authentication state and force the user to authenticate again. This option should be used instead of Login, if MFA is required. </remarks>
23 */
24 FreshLoginWithMfa = 4
25}
26export interface AadOauthTokenRequest {
27 refresh?: boolean;
28 resource?: string;
29 tenantId?: string;
30 token?: string;
31}
32export interface AadOauthTokenResult {
33 accessToken?: string;
34 refreshTokenCache?: string;
35}
36export interface AgentChangeEvent {
37 agent?: TaskAgent;
38 eventType?: string;
39 pool?: TaskAgentPoolReference;
40 poolId?: number;
41 timeStamp?: Date;
42}
43export interface AgentJobRequestMessage extends JobRequestMessage {
44 lockedUntil?: Date;
45 lockToken?: string;
46 requestId?: number;
47 tasks?: TaskInstance[];
48}
49export interface AgentPoolEvent {
50 eventType?: string;
51 pool?: TaskAgentPool;
52}
53export interface AgentQueueEvent {
54 eventType?: string;
55 queue?: TaskAgentQueue;
56}
57export interface AgentQueuesEvent {
58 eventType?: string;
59 queues?: TaskAgentQueue[];
60}
61export interface AgentRefreshMessage {
62 agentId?: number;
63 targetVersion?: string;
64 timeout?: any;
65}
66export declare enum AuditAction {
67 Add = 1,
68 Update = 2,
69 Delete = 3,
70 Undelete = 4
71}
72export interface AuthenticationSchemeReference {
73 inputs?: {
74 [key: string]: string;
75 };
76 type?: string;
77}
78export interface AuthorizationHeader {
79 /**
80 * Gets or sets the name of authorization header.
81 */
82 name?: string;
83 /**
84 * Gets or sets the value of authorization header.
85 */
86 value?: string;
87}
88export interface AzureKeyVaultPermission extends AzureResourcePermission {
89 vault?: string;
90}
91export interface AzureKeyVaultVariableGroupProviderData extends VariableGroupProviderData {
92 lastRefreshedOn?: Date;
93 serviceEndpointId?: string;
94 vault?: string;
95}
96export interface AzureKeyVaultVariableValue extends VariableValue {
97 contentType?: string;
98 enabled?: boolean;
99 expires?: Date;
100}
101/**
102 * Azure Management Group
103 */
104export interface AzureManagementGroup {
105 /**
106 * Display name of azure management group
107 */
108 displayName?: string;
109 /**
110 * Id of azure management group
111 */
112 id?: string;
113 /**
114 * Azure management group name
115 */
116 name?: string;
117 /**
118 * Id of tenant from which azure management group belongs
119 */
120 tenantId?: string;
121}
122/**
123 * Azure management group query result
124 */
125export interface AzureManagementGroupQueryResult {
126 /**
127 * Error message in case of an exception
128 */
129 errorMessage?: string;
130 /**
131 * List of azure management groups
132 */
133 value?: AzureManagementGroup[];
134}
135export interface AzurePermission {
136 provisioned?: boolean;
137 resourceProvider?: string;
138}
139export interface AzureResourcePermission extends AzurePermission {
140 resourceGroup?: string;
141}
142export interface AzureRoleAssignmentPermission extends AzurePermission {
143 roleAssignmentId?: string;
144}
145export interface AzureSpnOperationStatus {
146 state?: string;
147 statusMessage?: string;
148}
149export interface AzureSubscription {
150 displayName?: string;
151 subscriptionId?: string;
152 subscriptionTenantId?: string;
153 subscriptionTenantName?: string;
154}
155export interface AzureSubscriptionQueryResult {
156 errorMessage?: string;
157 value?: AzureSubscription[];
158}
159export interface ClientCertificate {
160 /**
161 * Gets or sets the value of client certificate.
162 */
163 value?: string;
164}
165export interface CounterVariable {
166 prefix?: string;
167 seed?: number;
168 value?: number;
169}
170export interface DataSource {
171 authenticationScheme?: AuthenticationSchemeReference;
172 endpointUrl?: string;
173 headers?: AuthorizationHeader[];
174 name?: string;
175 resourceUrl?: string;
176 resultSelector?: string;
177}
178export interface DataSourceBinding extends DistributedTaskCommonInterfaces.DataSourceBindingBase {
179}
180export interface DataSourceDetails {
181 dataSourceName?: string;
182 dataSourceUrl?: string;
183 headers?: AuthorizationHeader[];
184 parameters?: {
185 [key: string]: string;
186 };
187 resourceUrl?: string;
188 resultSelector?: string;
189}
190export interface Demand {
191 name?: string;
192 value?: string;
193}
194export interface DemandEquals extends Demand {
195}
196export interface DemandExists extends Demand {
197}
198export interface DemandMinimumVersion extends Demand {
199 source?: DemandSource;
200}
201export interface DemandSource {
202 sourceName?: string;
203 sourceType?: DemandSourceType;
204 sourceVersion?: string;
205}
206export declare enum DemandSourceType {
207 Task = 0,
208 Feature = 1
209}
210export interface DependencyBinding {
211 key?: string;
212 value?: string;
213}
214export interface DependencyData {
215 input?: string;
216 map?: {
217 key: string;
218 value: {
219 key: string;
220 value: string;
221 }[];
222 }[];
223}
224export interface DependsOn {
225 input?: string;
226 map?: DependencyBinding[];
227}
228export interface DeploymentGatesChangeEvent {
229 gateNames?: string[];
230}
231/**
232 * Deployment group.
233 */
234export interface DeploymentGroup extends DeploymentGroupReference {
235 /**
236 * Description of the deployment group.
237 */
238 description?: string;
239 /**
240 * Number of deployment targets in the deployment group.
241 */
242 machineCount?: number;
243 /**
244 * List of deployment targets in the deployment group.
245 */
246 machines?: DeploymentMachine[];
247 /**
248 * List of unique tags across all deployment targets in the deployment group.
249 */
250 machineTags?: string[];
251}
252/**
253 * This is useful in getting a list of deployment groups, filtered for which caller has permissions to take a particular action.
254 */
255export declare enum DeploymentGroupActionFilter {
256 /**
257 * All deployment groups.
258 */
259 None = 0,
260 /**
261 * Only deployment groups for which caller has **manage** permission.
262 */
263 Manage = 2,
264 /**
265 * Only deployment groups for which caller has **use** permission.
266 */
267 Use = 16
268}
269/**
270 * Properties to create Deployment group.
271 */
272export interface DeploymentGroupCreateParameter {
273 /**
274 * Description of the deployment group.
275 */
276 description?: string;
277 /**
278 * Name of the deployment group.
279 */
280 name?: string;
281 /**
282 * Deployment pool in which deployment agents are registered. This is obsolete. Kept for compatibility. Will be marked obsolete explicitly by M132.
283 */
284 pool?: DeploymentGroupCreateParameterPoolProperty;
285 /**
286 * Identifier of the deployment pool in which deployment agents are registered.
287 */
288 poolId?: number;
289}
290/**
291 * Properties of Deployment pool to create Deployment group.
292 */
293export interface DeploymentGroupCreateParameterPoolProperty {
294 /**
295 * Deployment pool identifier.
296 */
297 id?: number;
298}
299/**
300 * Properties to be included or expanded in deployment group objects. This is useful when getting a single or list of deployment grouops.
301 */
302export declare enum DeploymentGroupExpands {
303 /**
304 * No additional properties.
305 */
306 None = 0,
307 /**
308 * Deprecated: Include all the deployment targets.
309 */
310 Machines = 2,
311 /**
312 * Include unique list of tags across all deployment targets.
313 */
314 Tags = 4
315}
316/**
317 * Deployment group metrics.
318 */
319export interface DeploymentGroupMetrics {
320 /**
321 * List of deployment group properties. And types of metrics provided for those properties.
322 */
323 columnsHeader?: MetricsColumnsHeader;
324 /**
325 * Deployment group.
326 */
327 deploymentGroup?: DeploymentGroupReference;
328 /**
329 * Values of properties and the metrics. E.g. 1: total count of deployment targets for which 'TargetState' is 'offline'. E.g. 2: Average time of deployment to the deployment targets for which 'LastJobStatus' is 'passed' and 'TargetState' is 'online'.
330 */
331 rows?: MetricsRow[];
332}
333/**
334 * Deployment group reference. This is useful for referring a deployment group in another object.
335 */
336export interface DeploymentGroupReference {
337 /**
338 * Deployment group identifier.
339 */
340 id?: number;
341 /**
342 * Name of the deployment group.
343 */
344 name?: string;
345 /**
346 * Deployment pool in which deployment agents are registered.
347 */
348 pool?: TaskAgentPoolReference;
349 /**
350 * Project to which the deployment group belongs.
351 */
352 project?: ProjectReference;
353}
354/**
355 * Deployment group update parameter.
356 */
357export interface DeploymentGroupUpdateParameter {
358 /**
359 * Description of the deployment group.
360 */
361 description?: string;
362 /**
363 * Name of the deployment group.
364 */
365 name?: string;
366}
367/**
368 * Deployment target.
369 */
370export interface DeploymentMachine {
371 /**
372 * Deployment agent.
373 */
374 agent?: TaskAgent;
375 /**
376 * Deployment target Identifier.
377 */
378 id?: number;
379 /**
380 * Properties of the deployment target.
381 */
382 properties?: any;
383 /**
384 * Tags of the deployment target.
385 */
386 tags?: string[];
387}
388export interface DeploymentMachineChangedData extends DeploymentMachine {
389 addedTags?: string[];
390 deletedTags?: string[];
391}
392export declare enum DeploymentMachineExpands {
393 None = 0,
394 Capabilities = 2,
395 AssignedRequest = 4
396}
397export interface DeploymentMachineGroup extends DeploymentMachineGroupReference {
398 machines?: DeploymentMachine[];
399 size?: number;
400}
401export interface DeploymentMachineGroupReference {
402 id?: number;
403 name?: string;
404 pool?: TaskAgentPoolReference;
405 project?: ProjectReference;
406}
407export interface DeploymentMachinesChangeEvent {
408 machineGroupReference?: DeploymentGroupReference;
409 machines?: DeploymentMachineChangedData[];
410}
411/**
412 * Deployment pool summary.
413 */
414export interface DeploymentPoolSummary {
415 /**
416 * List of deployment groups referring to the deployment pool.
417 */
418 deploymentGroups?: DeploymentGroupReference[];
419 /**
420 * Number of deployment agents that are offline.
421 */
422 offlineAgentsCount?: number;
423 /**
424 * Number of deployment agents that are online.
425 */
426 onlineAgentsCount?: number;
427 /**
428 * Deployment pool.
429 */
430 pool?: TaskAgentPoolReference;
431 /**
432 * Virtual machine Resource referring in pool.
433 */
434 resource?: EnvironmentResourceReference;
435}
436/**
437 * Properties to be included or expanded in deployment pool summary objects. This is useful when getting a single or list of deployment pool summaries.
438 */
439export declare enum DeploymentPoolSummaryExpands {
440 /**
441 * No additional properties
442 */
443 None = 0,
444 /**
445 * Include deployment groups referring to the deployment pool.
446 */
447 DeploymentGroups = 2,
448 /**
449 * Include Resource referring to the deployment pool.
450 */
451 Resource = 4
452}
453/**
454 * Properties to be included or expanded in deployment target objects. This is useful when getting a single or list of deployment targets.
455 */
456export declare enum DeploymentTargetExpands {
457 /**
458 * No additional properties.
459 */
460 None = 0,
461 /**
462 * Include capabilities of the deployment agent.
463 */
464 Capabilities = 2,
465 /**
466 * Include the job request assigned to the deployment agent.
467 */
468 AssignedRequest = 4,
469 /**
470 * Include the last completed job request of the deployment agent.
471 */
472 LastCompletedRequest = 8
473}
474/**
475 * Deployment target update parameter.
476 */
477export interface DeploymentTargetUpdateParameter {
478 /**
479 * Identifier of the deployment target.
480 */
481 id?: number;
482 tags?: string[];
483}
484export interface DiagnosticLogMetadata {
485 agentId?: number;
486 agentName?: string;
487 fileName?: string;
488 phaseName?: string;
489 phaseResult?: string;
490 poolId?: number;
491}
492export interface ElasticAgentPoolResizedEvent {
493 newSize?: number;
494 poolId?: number;
495 poolName?: string;
496 previousSize?: number;
497 resourceId?: string;
498}
499export declare enum ElasticAgentState {
500 None = 0,
501 Enabled = 1,
502 Online = 2,
503 Assigned = 4
504}
505export declare enum ElasticComputeState {
506 None = 0,
507 Healthy = 1,
508 Creating = 2,
509 Deleting = 3,
510 Failed = 4,
511 Stopped = 5,
512 Reimaging = 6,
513 UnhealthyVm = 7,
514 UnhealthyVmssVm = 8
515}
516/**
517 * Data and settings for an elastic node
518 */
519export interface ElasticNode {
520 /**
521 * Distributed Task's Agent Id
522 */
523 agentId?: number;
524 /**
525 * Summary of the state of the agent
526 */
527 agentState?: ElasticAgentState;
528 /**
529 * Compute Id. VMSS's InstanceId
530 */
531 computeId?: string;
532 /**
533 * State of the compute host
534 */
535 computeState?: ElasticComputeState;
536 /**
537 * Users can force state changes to specific states (ToReimage, ToDelete, Save)
538 */
539 desiredState?: ElasticNodeState;
540 /**
541 * Unique identifier since the agent and/or VM may be null
542 */
543 id?: number;
544 /**
545 * Computer name. Used to match a scaleset VM with an agent
546 */
547 name?: string;
548 /**
549 * Pool Id that this node belongs to
550 */
551 poolId?: number;
552 /**
553 * Last job RequestId assigned to this agent
554 */
555 requestId?: number;
556 /**
557 * State of the ElasticNode
558 */
559 state?: ElasticNodeState;
560 /**
561 * Last state change. Only updated by SQL.
562 */
563 stateChangedOn?: Date;
564}
565/**
566 * Class used for updating an elastic node where only certain members are populated
567 */
568export interface ElasticNodeSettings {
569 /**
570 * State of the ElasticNode
571 */
572 state?: ElasticNodeState;
573}
574export declare enum ElasticNodeState {
575 None = 0,
576 New = 1,
577 CreatingCompute = 2,
578 StartingAgent = 3,
579 Idle = 4,
580 Assigned = 5,
581 Offline = 6,
582 PendingReimage = 7,
583 PendingDelete = 8,
584 Saved = 9,
585 DeletingCompute = 10,
586 Deleted = 11,
587 Lost = 12,
588 ReimagingCompute = 13,
589 RestartingAgent = 14,
590 FailedToStartPendingDelete = 15,
591 FailedToRestartPendingDelete = 16,
592 FailedVMPendingDelete = 17,
593 AssignedPendingDelete = 18,
594 RetryDelete = 19,
595 UnhealthyVm = 20,
596 UnhealthyVmPendingDelete = 21
597}
598/**
599 * Data and settings for an elastic pool
600 */
601export interface ElasticPool {
602 /**
603 * Set whether agents should be configured to run with interactive UI
604 */
605 agentInteractiveUI?: boolean;
606 /**
607 * Azure string representing to location of the resource
608 */
609 azureId?: string;
610 /**
611 * Number of agents to have ready waiting for jobs
612 */
613 desiredIdle?: number;
614 /**
615 * The desired size of the pool
616 */
617 desiredSize?: number;
618 /**
619 * Maximum number of nodes that will exist in the elastic pool
620 */
621 maxCapacity?: number;
622 /**
623 * Keep nodes in the pool on failure for investigation
624 */
625 maxSavedNodeCount?: number;
626 /**
627 * Timestamp the pool was first detected to be offline
628 */
629 offlineSince?: Date;
630 /**
631 * Operating system type of the nodes in the pool
632 */
633 orchestrationType?: OrchestrationType;
634 /**
635 * Operating system type of the nodes in the pool
636 */
637 osType?: OperatingSystemType;
638 /**
639 * Id of the associated TaskAgentPool
640 */
641 poolId?: number;
642 /**
643 * Discard node after each job completes
644 */
645 recycleAfterEachUse?: boolean;
646 /**
647 * Id of the Service Endpoint used to connect to Azure
648 */
649 serviceEndpointId?: string;
650 /**
651 * Scope the Service Endpoint belongs to
652 */
653 serviceEndpointScope?: string;
654 /**
655 * The number of sizing attempts executed while trying to achieve a desired size
656 */
657 sizingAttempts?: number;
658 /**
659 * State of the pool
660 */
661 state?: ElasticPoolState;
662 /**
663 * The minimum time in minutes to keep idle agents alive
664 */
665 timeToLiveMinutes?: number;
666}
667/**
668 * Returned result from creating a new elastic pool
669 */
670export interface ElasticPoolCreationResult {
671 /**
672 * Created agent pool
673 */
674 agentPool?: TaskAgentPool;
675 /**
676 * Created agent queue
677 */
678 agentQueue?: TaskAgentQueue;
679 /**
680 * Created elastic pool
681 */
682 elasticPool?: ElasticPool;
683}
684/**
685 * Log data for an Elastic Pool
686 */
687export interface ElasticPoolLog {
688 /**
689 * Log Id
690 */
691 id?: number;
692 /**
693 * E.g. error, warning, info
694 */
695 level?: LogLevel;
696 /**
697 * Log contents
698 */
699 message?: string;
700 /**
701 * Operation that triggered the message being logged
702 */
703 operation?: OperationType;
704 /**
705 * Id of the associated TaskAgentPool
706 */
707 poolId?: number;
708 /**
709 * Datetime that the log occurred
710 */
711 timestamp?: Date;
712}
713/**
714 * Class used for updating an elastic pool where only certain members are populated
715 */
716export interface ElasticPoolSettings {
717 /**
718 * Set whether agents should be configured to run with interactive UI
719 */
720 agentInteractiveUI?: boolean;
721 /**
722 * Azure string representing to location of the resource
723 */
724 azureId?: string;
725 /**
726 * Number of machines to have ready waiting for jobs
727 */
728 desiredIdle?: number;
729 /**
730 * Maximum number of machines that will exist in the elastic pool
731 */
732 maxCapacity?: number;
733 /**
734 * Keep machines in the pool on failure for investigation
735 */
736 maxSavedNodeCount?: number;
737 /**
738 * Operating system type of the machines in the pool
739 */
740 orchestrationType?: OrchestrationType;
741 /**
742 * Operating system type of the machines in the pool
743 */
744 osType?: OperatingSystemType;
745 /**
746 * Discard machines after each job completes
747 */
748 recycleAfterEachUse?: boolean;
749 /**
750 * Id of the Service Endpoint used to connect to Azure
751 */
752 serviceEndpointId?: string;
753 /**
754 * Scope the Service Endpoint belongs to
755 */
756 serviceEndpointScope?: string;
757 /**
758 * The minimum time in minutes to keep idle agents alive
759 */
760 timeToLiveMinutes?: number;
761}
762export declare enum ElasticPoolState {
763 /**
764 * Online and healthy
765 */
766 Online = 0,
767 Offline = 1,
768 Unhealthy = 2,
769 New = 3
770}
771export interface EndpointAuthorization {
772 /**
773 * Gets or sets the parameters for the selected authorization scheme.
774 */
775 parameters?: {
776 [key: string]: string;
777 };
778 /**
779 * Gets or sets the scheme used for service endpoint authentication.
780 */
781 scheme?: string;
782}
783/**
784 * Represents url of the service endpoint.
785 */
786export interface EndpointUrl {
787 /**
788 * Gets or sets the dependency bindings.
789 */
790 dependsOn?: DependsOn;
791 /**
792 * Gets or sets the display name of service endpoint url.
793 */
794 displayName?: string;
795 /**
796 * Gets or sets the help text of service endpoint url.
797 */
798 helpText?: string;
799 /**
800 * Gets or sets the visibility of service endpoint url.
801 */
802 isVisible?: string;
803 /**
804 * Gets or sets the value of service endpoint url.
805 */
806 value?: string;
807}
808/**
809 * This is useful in getting a list of Environments, filtered for which caller has permissions to take a particular action.
810 */
811export declare enum EnvironmentActionFilter {
812 /**
813 * All environments for which user has **view** permission.
814 */
815 None = 0,
816 /**
817 * Only environments for which caller has **manage** permission.
818 */
819 Manage = 2,
820 /**
821 * Only environments for which caller has **use** permission.
822 */
823 Use = 16
824}
825/**
826 * Properties to create Environment.
827 */
828export interface EnvironmentCreateParameter {
829 /**
830 * Description of the environment.
831 */
832 description?: string;
833 /**
834 * Name of the environment.
835 */
836 name?: string;
837}
838/**
839 * EnvironmentDeploymentExecutionRecord.
840 */
841export interface EnvironmentDeploymentExecutionRecord {
842 /**
843 * Definition of the environment deployment execution owner
844 */
845 definition?: TaskOrchestrationOwner;
846 /**
847 * Id of the Environment
848 */
849 environmentId?: number;
850 /**
851 * Finish time of the environment deployment execution
852 */
853 finishTime?: Date;
854 /**
855 * Id of the Environment deployment execution history record
856 */
857 id?: number;
858 /**
859 * Job Attempt
860 */
861 jobAttempt?: number;
862 /**
863 * Job name
864 */
865 jobName?: string;
866 /**
867 * Owner of the environment deployment execution record
868 */
869 owner?: TaskOrchestrationOwner;
870 /**
871 * Plan Id
872 */
873 planId?: string;
874 /**
875 * Plan type of the environment deployment execution record
876 */
877 planType?: string;
878 /**
879 * Queue time of the environment deployment execution
880 */
881 queueTime?: Date;
882 /**
883 * Request identifier of the Environment deployment execution history record
884 */
885 requestIdentifier?: string;
886 /**
887 * Resource Id
888 */
889 resourceId?: number;
890 /**
891 * Result of the environment deployment execution
892 */
893 result?: TaskResult;
894 /**
895 * Project Id
896 */
897 scopeId?: string;
898 /**
899 * Service owner Id
900 */
901 serviceOwner?: string;
902 /**
903 * Stage Attempt
904 */
905 stageAttempt?: number;
906 /**
907 * Stage name
908 */
909 stageName?: string;
910 /**
911 * Start time of the environment deployment execution
912 */
913 startTime?: Date;
914}
915/**
916 * Properties to be included or expanded in environment objects. This is useful when getting a single environment.
917 */
918export declare enum EnvironmentExpands {
919 /**
920 * No additional properties
921 */
922 None = 0,
923 /**
924 * Include resource references referring to the environment.
925 */
926 ResourceReferences = 1
927}
928/**
929 * Environment.
930 */
931export interface EnvironmentInstance {
932 /**
933 * Identity reference of the user who created the Environment.
934 */
935 createdBy?: VSSInterfaces.IdentityRef;
936 /**
937 * Creation time of the Environment
938 */
939 createdOn?: Date;
940 /**
941 * Description of the Environment.
942 */
943 description?: string;
944 /**
945 * Id of the Environment
946 */
947 id?: number;
948 /**
949 * Identity reference of the user who last modified the Environment.
950 */
951 lastModifiedBy?: VSSInterfaces.IdentityRef;
952 /**
953 * Last modified time of the Environment
954 */
955 lastModifiedOn?: Date;
956 /**
957 * Name of the Environment.
958 */
959 name?: string;
960 /**
961 * Project information for environment.
962 */
963 project?: ProjectReference;
964 resources?: EnvironmentResourceReference[];
965}
966/**
967 * EnvironmentLinkedResourceReference.
968 */
969export interface EnvironmentLinkedResourceReference {
970 /**
971 * Id of the resource.
972 */
973 id?: string;
974 /**
975 * Type of resource.
976 */
977 typeName?: string;
978}
979export interface EnvironmentReference {
980 id?: number;
981 name?: string;
982}
983export interface EnvironmentResource {
984 createdBy?: VSSInterfaces.IdentityRef;
985 createdOn?: Date;
986 environmentReference?: EnvironmentReference;
987 id?: number;
988 lastModifiedBy?: VSSInterfaces.IdentityRef;
989 lastModifiedOn?: Date;
990 name?: string;
991 /**
992 * Tags of the Environment Resource.
993 */
994 tags?: string[];
995 /**
996 * Environment resource type
997 */
998 type?: EnvironmentResourceType;
999}
1000/**
1001 * EnvironmentResourceDeploymentExecutionRecord.
1002 */
1003export interface EnvironmentResourceDeploymentExecutionRecord {
1004 /**
1005 * Id of the Environment
1006 */
1007 environmentId?: number;
1008 /**
1009 * Finish time of the environment resource deployment execution
1010 */
1011 finishTime?: Date;
1012 /**
1013 * Id of the Environment deployment execution history record
1014 */
1015 requestId?: number;
1016 /**
1017 * Resource Id
1018 */
1019 resourceId?: number;
1020 /**
1021 * Result of the environment deployment execution
1022 */
1023 result?: TaskResult;
1024 /**
1025 * Start time of the environment resource deployment execution
1026 */
1027 startTime?: Date;
1028}
1029/**
1030 * EnvironmentResourceReference.
1031 */
1032export interface EnvironmentResourceReference {
1033 /**
1034 * Id of the resource.
1035 */
1036 id?: number;
1037 /**
1038 * Name of the resource.
1039 */
1040 name?: string;
1041 /**
1042 * Tags of the Environment Resource Reference.
1043 */
1044 tags?: string[];
1045 /**
1046 * Type of the resource.
1047 */
1048 type?: EnvironmentResourceType;
1049}
1050/**
1051 * EnvironmentResourceType.
1052 */
1053export declare enum EnvironmentResourceType {
1054 Undefined = 0,
1055 /**
1056 * Unknown resource type
1057 */
1058 Generic = 1,
1059 /**
1060 * Virtual machine resource type
1061 */
1062 VirtualMachine = 2,
1063 /**
1064 * Kubernetes resource type
1065 */
1066 Kubernetes = 4
1067}
1068/**
1069 * Properties to update Environment.
1070 */
1071export interface EnvironmentUpdateParameter {
1072 /**
1073 * Description of the environment.
1074 */
1075 description?: string;
1076 /**
1077 * Name of the environment.
1078 */
1079 name?: string;
1080}
1081export interface EventsConfig {
1082}
1083export declare enum ExclusiveLockType {
1084 RunLatest = 0,
1085 Sequential = 1,
1086 BranchRunLatest = 2,
1087 Parallel = 3
1088}
1089export interface ExpressionValidationItem extends ValidationItem {
1090}
1091export interface HelpLink {
1092 text?: string;
1093 url?: string;
1094}
1095export interface InputBindingContext {
1096 /**
1097 * Value of the input
1098 */
1099 value?: string;
1100}
1101export interface InputValidationItem extends ValidationItem {
1102 /**
1103 * Provides binding context for the expression to evaluate
1104 */
1105 context?: InputBindingContext;
1106}
1107export interface InputValidationRequest {
1108 inputs?: {
1109 [key: string]: ValidationItem;
1110 };
1111}
1112/**
1113 * An issue (error, warning) associated with a pipeline run.
1114 */
1115export interface Issue {
1116 /**
1117 * The category of the issue. <br />Example: Code - refers to compilation errors <br />Example: General - refers to generic errors
1118 */
1119 category?: string;
1120 /**
1121 * A dictionary containing details about the issue.
1122 */
1123 data?: {
1124 [key: string]: string;
1125 };
1126 /**
1127 * A description of issue.
1128 */
1129 message?: string;
1130 /**
1131 * The type (error, warning) of the issue.
1132 */
1133 type?: IssueType;
1134}
1135/**
1136 * The type of issue based on severity.
1137 */
1138export declare enum IssueType {
1139 Error = 1,
1140 Warning = 2
1141}
1142export interface JobAssignedEvent extends JobEvent {
1143 /**
1144 * A pipeline job request for an agent.
1145 */
1146 request?: TaskAgentJobRequest;
1147}
1148export interface JobCanceledEvent extends JobEvent {
1149 /**
1150 * The reason for job cancellation.
1151 */
1152 reason?: string;
1153 /**
1154 * The job's timeout interval.
1155 */
1156 timeout?: any;
1157}
1158export interface JobCancelMessage {
1159 jobId?: string;
1160 timeout?: any;
1161}
1162export interface JobCompletedEvent extends JobEvent {
1163 /**
1164 * Indicates whether the agent is in the process of shutting down.
1165 */
1166 agentShuttingDown?: boolean;
1167 /**
1168 * The ID of the request.
1169 */
1170 requestId?: number;
1171 /**
1172 * The result of the request.
1173 */
1174 result?: TaskResult;
1175}
1176/**
1177 * Represents the context of variables and vectors for a job request.
1178 */
1179export interface JobEnvironment {
1180 endpoints?: ServiceEndpoint[];
1181 mask?: MaskHint[];
1182 options?: {
1183 [key: string]: JobOption;
1184 };
1185 secureFiles?: SecureFile[];
1186 /**
1187 * Gets or sets the endpoint used for communicating back to the calling service.
1188 */
1189 systemConnection?: ServiceEndpoint;
1190 variables?: {
1191 [key: string]: string;
1192 };
1193}
1194/**
1195 * A pipeline job event to be processed by the execution plan.
1196 */
1197export interface JobEvent {
1198 /**
1199 * The ID of the pipeline job affected by the event.
1200 */
1201 jobId?: string;
1202 /**
1203 * The name of the pipeline job event.
1204 */
1205 name?: string;
1206}
1207export interface JobEventConfig {
1208 timeout?: string;
1209}
1210export interface JobEventsConfig extends EventsConfig {
1211 jobAssigned?: JobEventConfig;
1212 jobCompleted?: JobEventConfig;
1213 jobStarted?: JobEventConfig;
1214}
1215export interface JobMetadataEvent extends JobEvent {
1216 /**
1217 * A message to be sent to an agent currently running the job.
1218 */
1219 message?: JobMetadataMessage;
1220}
1221/**
1222 * A message to be sent to an agent currently running the job.
1223 */
1224export interface JobMetadataMessage {
1225 /**
1226 * The id of the job.
1227 */
1228 jobId?: string;
1229 /**
1230 * The agent's frequency of posting lines to the logs console expressed in milliseconds. There are 2 modes: Slow (10 seconds) and Fast (half a second).
1231 */
1232 postLinesFrequencyMillis?: number;
1233}
1234/**
1235 * Represents an option that may affect the way an agent runs the job.
1236 */
1237export interface JobOption {
1238 data?: {
1239 [key: string]: string;
1240 };
1241 /**
1242 * Gets the id of the option.
1243 */
1244 id?: string;
1245}
1246export interface JobRequestMessage {
1247 environment?: JobEnvironment;
1248 jobId?: string;
1249 jobName?: string;
1250 jobRefName?: string;
1251 messageType?: string;
1252 plan?: TaskOrchestrationPlanReference;
1253 timeline?: TimelineReference;
1254}
1255export interface JobStartedEvent extends JobEvent {
1256}
1257export interface KubernetesResource extends EnvironmentResource {
1258 clusterName?: string;
1259 namespace?: string;
1260 serviceEndpointId?: string;
1261}
1262export interface KubernetesResourceCreateParameters {
1263 clusterName?: string;
1264 name?: string;
1265 namespace?: string;
1266 /**
1267 * Tags of the kubernetes resource.
1268 */
1269 tags?: string[];
1270}
1271export interface KubernetesResourceCreateParametersExistingEndpoint extends KubernetesResourceCreateParameters {
1272 serviceEndpointId?: string;
1273}
1274export interface KubernetesResourceCreateParametersNewEndpoint extends KubernetesResourceCreateParameters {
1275 endpoint?: ServiceEndpoint;
1276}
1277export interface KubernetesResourcePatchParameters {
1278 authorizationParameters?: {
1279 [key: string]: string;
1280 };
1281 /**
1282 * Provider type (CustomProvider or AzureKubernetesServiceProvider) of the resource to be updated
1283 */
1284 providerType?: string;
1285 resourceId?: number;
1286}
1287export declare enum LogLevel {
1288 Error = 0,
1289 Warning = 1,
1290 Info = 2
1291}
1292export declare enum MachineGroupActionFilter {
1293 None = 0,
1294 Manage = 2,
1295 Use = 16
1296}
1297/**
1298 * Represents a purchase of resource units in a secondary marketplace.
1299 */
1300export interface MarketplacePurchasedLicense {
1301 /**
1302 * The Marketplace display name.
1303 */
1304 marketplaceName?: string;
1305 /**
1306 * The name of the identity making the purchase as seen by the marketplace
1307 */
1308 purchaserName?: string;
1309 /**
1310 * The quantity purchased.
1311 */
1312 purchaseUnitCount?: number;
1313}
1314export interface MaskHint {
1315 type?: MaskType;
1316 value?: string;
1317}
1318export declare enum MaskType {
1319 Variable = 1,
1320 Regex = 2
1321}
1322/**
1323 * Meta data for a metrics column.
1324 */
1325export interface MetricsColumnMetaData {
1326 /**
1327 * Name.
1328 */
1329 columnName?: string;
1330 /**
1331 * Data type.
1332 */
1333 columnValueType?: string;
1334}
1335/**
1336 * Metrics columns header
1337 */
1338export interface MetricsColumnsHeader {
1339 /**
1340 * Properties of deployment group for which metrics are provided. E.g. 1: LastJobStatus E.g. 2: TargetState
1341 */
1342 dimensions?: MetricsColumnMetaData[];
1343 /**
1344 * The types of metrics. E.g. 1: total count of deployment targets. E.g. 2: Average time of deployment to the deployment targets.
1345 */
1346 metrics?: MetricsColumnMetaData[];
1347}
1348/**
1349 * Metrics row.
1350 */
1351export interface MetricsRow {
1352 /**
1353 * The values of the properties mentioned as 'Dimensions' in column header. E.g. 1: For a property 'LastJobStatus' - metrics will be provided for 'passed', 'failed', etc. E.g. 2: For a property 'TargetState' - metrics will be provided for 'online', 'offline' targets.
1354 */
1355 dimensions?: string[];
1356 /**
1357 * Metrics in serialized format. Should be deserialized based on the data type provided in header.
1358 */
1359 metrics?: string[];
1360}
1361export declare enum OperatingSystemType {
1362 Windows = 0,
1363 Linux = 1
1364}
1365export declare enum OperationType {
1366 ConfigurationJob = 0,
1367 SizingJob = 1,
1368 IncreaseCapacity = 2,
1369 Reimage = 3,
1370 DeleteVMs = 4
1371}
1372export declare enum OrchestrationType {
1373 Uniform = 0,
1374 Flexible = 1
1375}
1376/**
1377 * Represents a downloadable package.
1378 */
1379export interface PackageMetadata {
1380 /**
1381 * The date the package was created
1382 */
1383 createdOn?: Date;
1384 /**
1385 * A direct link to download the package.
1386 */
1387 downloadUrl?: string;
1388 /**
1389 * The UI uses this to display instructions, i.e. "unzip MyAgent.zip"
1390 */
1391 filename?: string;
1392 /**
1393 * MD5 hash as a base64 string
1394 */
1395 hashValue?: string;
1396 /**
1397 * A link to documentation
1398 */
1399 infoUrl?: string;
1400 /**
1401 * The platform (win7, linux, etc.)
1402 */
1403 platform?: string;
1404 /**
1405 * The type of package (e.g. "agent")
1406 */
1407 type?: string;
1408 /**
1409 * The package version.
1410 */
1411 version?: PackageVersion;
1412}
1413export interface PackageVersion {
1414 major?: number;
1415 minor?: number;
1416 patch?: number;
1417}
1418export interface PlanEnvironment {
1419 mask?: MaskHint[];
1420 options?: {
1421 [key: string]: JobOption;
1422 };
1423 variables?: {
1424 [key: string]: string;
1425 };
1426}
1427export declare enum PlanGroupStatus {
1428 Running = 1,
1429 Queued = 2,
1430 All = 3
1431}
1432export declare enum PlanGroupStatusFilter {
1433 Running = 1,
1434 Queued = 2,
1435 All = 3
1436}
1437export interface ProjectReference {
1438 id?: string;
1439 name?: string;
1440}
1441export interface PublishTaskGroupMetadata {
1442 comment?: string;
1443 parentDefinitionRevision?: number;
1444 preview?: boolean;
1445 taskGroupId?: string;
1446 taskGroupRevision?: number;
1447}
1448export interface ResourceFilterOptions {
1449 identities?: VSSInterfaces.IdentityRef[];
1450 resourceTypes?: string[];
1451}
1452export interface ResourceFilters {
1453 createdBy?: string[];
1454 resourceType?: string[];
1455 searchText?: string;
1456}
1457/**
1458 * Resources include Service Connections, Variable Groups and Secure Files.
1459 */
1460export interface ResourceItem {
1461 /**
1462 * Gets or sets the identity who created the resource.
1463 */
1464 createdBy?: VSSInterfaces.IdentityRef;
1465 /**
1466 * Gets or sets description of the resource.
1467 */
1468 description?: string;
1469 /**
1470 * Gets or sets icon url of the resource.
1471 */
1472 iconUrl?: string;
1473 /**
1474 * Gets or sets Id of the resource.
1475 */
1476 id?: string;
1477 /**
1478 * Indicates whether resource is outdated or not.
1479 */
1480 isOutdated?: boolean;
1481 /**
1482 * Indicates whether resource is shared with other projects or not.
1483 */
1484 isShared?: boolean;
1485 /**
1486 * Gets or sets name of the resource.
1487 */
1488 name?: string;
1489 /**
1490 * Gets or sets internal properties of the resource.
1491 */
1492 properties?: {
1493 [key: string]: string;
1494 };
1495 /**
1496 * Gets or sets resource type.
1497 */
1498 resourceType?: string;
1499}
1500export interface ResourceLimit {
1501 failedToReachAllProviders?: boolean;
1502 hostId?: string;
1503 isHosted?: boolean;
1504 isPremium?: boolean;
1505 parallelismTag?: string;
1506 resourceLimitsData?: {
1507 [key: string]: string;
1508 };
1509 totalCount?: number;
1510 totalMinutes?: number;
1511}
1512/**
1513 * A request for a resource's exclusive lock
1514 */
1515export interface ResourceLockRequest {
1516 /**
1517 * The date/time this request was assigned.
1518 */
1519 assignTime?: Date;
1520 /**
1521 * The branch the lock belongs to. It's used only by RunLatest exclusive locks of persisted stages.
1522 */
1523 branch?: string;
1524 /**
1525 * The ID of the check run waiting on this request
1526 */
1527 checkRunId?: string;
1528 /**
1529 * The ID of the pipeline that requested this resource
1530 */
1531 definitionId?: number;
1532 /**
1533 * The date/time this request was finished.
1534 */
1535 finishTime?: Date;
1536 /**
1537 * The behavior this request should exhibit in relation to other lock requests
1538 */
1539 lockType?: ExclusiveLockType;
1540 /**
1541 * Attempt of the graph node
1542 */
1543 nodeAttempt?: number;
1544 /**
1545 * Name of the graph node (currently stage) requesting this resource
1546 */
1547 nodeName?: string;
1548 /**
1549 * Internal ID for the orchestration plan connected with this request.
1550 */
1551 planId?: string;
1552 /**
1553 * The ID of the project of the check run and definition exist in
1554 */
1555 projectId?: string;
1556 /**
1557 * The date/time this request was queued.
1558 */
1559 queueTime?: Date;
1560 /**
1561 * ID of the request.
1562 */
1563 requestId?: number;
1564 /**
1565 * The id of the resource
1566 */
1567 resourceId?: string;
1568 /**
1569 * The type of the resource
1570 */
1571 resourceType?: string;
1572 /**
1573 * The result of this request.
1574 */
1575 status?: ResourceLockStatus;
1576}
1577export declare enum ResourceLockStatus {
1578 Queued = 0,
1579 InUse = 1,
1580 Finished = 2,
1581 TimedOut = 3,
1582 Canceled = 4,
1583 Abandoned = 5,
1584 WaitingOnChecks = 6
1585}
1586export interface ResourcesHubData {
1587 continuationToken?: string;
1588 hasProjectLevelManagePermission?: boolean;
1589 resourceFilterOptions?: ResourceFilterOptions;
1590 resourceFilters?: ResourceFilters;
1591 resourceItems?: ResourceItem[];
1592}
1593export interface ResourceUsage {
1594 resourceLimit?: ResourceLimit;
1595 runningRequests?: TaskAgentJobRequest[];
1596 usedCount?: number;
1597 usedMinutes?: number;
1598}
1599export interface ResultTransformationDetails {
1600 resultTemplate?: string;
1601}
1602export interface SecureFile {
1603 createdBy?: VSSInterfaces.IdentityRef;
1604 createdOn?: Date;
1605 id?: string;
1606 modifiedBy?: VSSInterfaces.IdentityRef;
1607 modifiedOn?: Date;
1608 name?: string;
1609 properties?: {
1610 [key: string]: string;
1611 };
1612 ticket?: string;
1613}
1614export declare enum SecureFileActionFilter {
1615 None = 0,
1616 Manage = 2,
1617 Use = 16
1618}
1619export interface SecureFileEvent {
1620 eventType?: string;
1621 projectId?: string;
1622 secureFiles?: SecureFile[];
1623}
1624export interface SendJobResponse {
1625 events?: JobEventsConfig;
1626 variables?: {
1627 [key: string]: string;
1628 };
1629}
1630export interface ServerExecutionDefinition {
1631 events?: EventsConfig;
1632 handlerName?: string;
1633}
1634export interface ServerTaskRequestMessage extends JobRequestMessage {
1635 taskDefinition?: TaskDefinition;
1636 taskInstance?: TaskInstance;
1637}
1638/**
1639 * Represents an endpoint which may be used by an orchestration job.
1640 */
1641export interface ServiceEndpoint {
1642 /**
1643 * Gets or sets the identity reference for the administrators group of the service endpoint.
1644 */
1645 administratorsGroup?: VSSInterfaces.IdentityRef;
1646 /**
1647 * Gets or sets the authorization data for talking to the endpoint.
1648 */
1649 authorization?: EndpointAuthorization;
1650 /**
1651 * Gets or sets the identity reference for the user who created the Service endpoint.
1652 */
1653 createdBy?: VSSInterfaces.IdentityRef;
1654 data?: {
1655 [key: string]: string;
1656 };
1657 /**
1658 * Gets or sets the description of endpoint.
1659 */
1660 description?: string;
1661 groupScopeId?: string;
1662 /**
1663 * Gets or sets the identifier of this endpoint.
1664 */
1665 id?: string;
1666 /**
1667 * If this endpoint is disabled.
1668 */
1669 isDisabled?: boolean;
1670 /**
1671 * EndPoint state indicator
1672 */
1673 isReady?: boolean;
1674 /**
1675 * Indicates whether service endpoint is shared with other projects or not.
1676 */
1677 isShared?: boolean;
1678 /**
1679 * Gets or sets the friendly name of the endpoint.
1680 */
1681 name?: string;
1682 /**
1683 * Error message during creation/deletion of endpoint
1684 */
1685 operationStatus?: any;
1686 /**
1687 * Gets or sets the owner of the endpoint.
1688 */
1689 owner?: string;
1690 /**
1691 * Gets or sets the identity reference for the readers group of the service endpoint.
1692 */
1693 readersGroup?: VSSInterfaces.IdentityRef;
1694 /**
1695 * Gets or sets the type of the endpoint.
1696 */
1697 type?: string;
1698 /**
1699 * Gets or sets the url of the endpoint.
1700 */
1701 url?: string;
1702}
1703export interface ServiceEndpointAuthenticationScheme {
1704 /**
1705 * Gets or sets the authorization headers of service endpoint authentication scheme.
1706 */
1707 authorizationHeaders?: AuthorizationHeader[];
1708 /**
1709 * Gets or sets the certificates of service endpoint authentication scheme.
1710 */
1711 clientCertificates?: ClientCertificate[];
1712 /**
1713 * Gets or sets the display name for the service endpoint authentication scheme.
1714 */
1715 displayName?: string;
1716 /**
1717 * Gets or sets the input descriptors for the service endpoint authentication scheme.
1718 */
1719 inputDescriptors?: FormInputInterfaces.InputDescriptor[];
1720 /**
1721 * Gets or sets the scheme for service endpoint authentication.
1722 */
1723 scheme?: string;
1724}
1725export interface ServiceEndpointDetails {
1726 authorization?: EndpointAuthorization;
1727 data?: {
1728 [key: string]: string;
1729 };
1730 type?: string;
1731 url?: string;
1732}
1733/**
1734 * Represents service endpoint execution data.
1735 */
1736export interface ServiceEndpointExecutionData {
1737 /**
1738 * Gets the definition of service endpoint execution owner.
1739 */
1740 definition?: TaskOrchestrationOwner;
1741 /**
1742 * Gets the finish time of service endpoint execution.
1743 */
1744 finishTime?: Date;
1745 /**
1746 * Gets the Id of service endpoint execution data.
1747 */
1748 id?: number;
1749 /**
1750 * Gets the owner of service endpoint execution data.
1751 */
1752 owner?: TaskOrchestrationOwner;
1753 /**
1754 * Gets the plan type of service endpoint execution data.
1755 */
1756 planType?: string;
1757 /**
1758 * Gets the result of service endpoint execution.
1759 */
1760 result?: TaskResult;
1761 /**
1762 * Gets the start time of service endpoint execution.
1763 */
1764 startTime?: Date;
1765}
1766export interface ServiceEndpointExecutionRecord {
1767 /**
1768 * Gets the execution data of service endpoint execution.
1769 */
1770 data?: ServiceEndpointExecutionData;
1771 /**
1772 * Gets the Id of service endpoint.
1773 */
1774 endpointId?: string;
1775}
1776export interface ServiceEndpointExecutionRecordsInput {
1777 data?: ServiceEndpointExecutionData;
1778 endpointIds?: string[];
1779}
1780export interface ServiceEndpointRequest {
1781 dataSourceDetails?: DataSourceDetails;
1782 resultTransformationDetails?: ResultTransformationDetails;
1783 serviceEndpointDetails?: ServiceEndpointDetails;
1784}
1785export interface ServiceEndpointRequestResult {
1786 errorMessage?: string;
1787 result?: any;
1788 statusCode?: string;
1789}
1790/**
1791 * Represents type of the service endpoint.
1792 */
1793export interface ServiceEndpointType {
1794 /**
1795 * Authentication scheme of service endpoint type.
1796 */
1797 authenticationSchemes?: ServiceEndpointAuthenticationScheme[];
1798 /**
1799 * Data sources of service endpoint type.
1800 */
1801 dataSources?: DataSource[];
1802 /**
1803 * Dependency data of service endpoint type.
1804 */
1805 dependencyData?: DependencyData[];
1806 /**
1807 * Gets or sets the description of service endpoint type.
1808 */
1809 description?: string;
1810 /**
1811 * Gets or sets the display name of service endpoint type.
1812 */
1813 displayName?: string;
1814 /**
1815 * Gets or sets the endpoint url of service endpoint type.
1816 */
1817 endpointUrl?: EndpointUrl;
1818 /**
1819 * Gets or sets the help link of service endpoint type.
1820 */
1821 helpLink?: HelpLink;
1822 helpMarkDown?: string;
1823 /**
1824 * Gets or sets the icon url of service endpoint type.
1825 */
1826 iconUrl?: string;
1827 /**
1828 * Input descriptor of service endpoint type.
1829 */
1830 inputDescriptors?: FormInputInterfaces.InputDescriptor[];
1831 /**
1832 * Gets or sets the name of service endpoint type.
1833 */
1834 name?: string;
1835 /**
1836 * Trusted hosts of a service endpoint type.
1837 */
1838 trustedHosts?: string[];
1839 /**
1840 * Gets or sets the ui contribution id of service endpoint type.
1841 */
1842 uiContributionId?: string;
1843}
1844/**
1845 * A task agent.
1846 */
1847export interface TaskAgent extends TaskAgentReference {
1848 /**
1849 * The agent cloud request that's currently associated with this agent.
1850 */
1851 assignedAgentCloudRequest?: TaskAgentCloudRequest;
1852 /**
1853 * The request which is currently assigned to this agent.
1854 */
1855 assignedRequest?: TaskAgentJobRequest;
1856 /**
1857 * Authorization information for this agent.
1858 */
1859 authorization?: TaskAgentAuthorization;
1860 /**
1861 * Date on which this agent was created.
1862 */
1863 createdOn?: Date;
1864 /**
1865 * The last request which was completed by this agent.
1866 */
1867 lastCompletedRequest?: TaskAgentJobRequest;
1868 /**
1869 * Maximum job parallelism allowed for this agent.
1870 */
1871 maxParallelism?: number;
1872 /**
1873 * Pending update for this agent.
1874 */
1875 pendingUpdate?: TaskAgentUpdate;
1876 properties?: any;
1877 /**
1878 * Date on which the last connectivity status change occurred.
1879 */
1880 statusChangedOn?: Date;
1881 /**
1882 * System-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.
1883 */
1884 systemCapabilities?: {
1885 [key: string]: string;
1886 };
1887 /**
1888 * User-defined capabilities supported by this agent's host. Warning: To set capabilities use the PUT method, PUT will completely overwrite existing capabilities.
1889 */
1890 userCapabilities?: {
1891 [key: string]: string;
1892 };
1893}
1894/**
1895 * Provides data necessary for authorizing the agent using OAuth 2.0 authentication flows.
1896 */
1897export interface TaskAgentAuthorization {
1898 /**
1899 * Endpoint used to obtain access tokens from the configured token service.
1900 */
1901 authorizationUrl?: string;
1902 /**
1903 * Client identifier for this agent.
1904 */
1905 clientId?: string;
1906 /**
1907 * Public key used to verify the identity of this agent.
1908 */
1909 publicKey?: TaskAgentPublicKey;
1910}
1911export interface TaskAgentCloud {
1912 /**
1913 * Gets or sets a AcquireAgentEndpoint using which a request can be made to acquire new agent
1914 */
1915 acquireAgentEndpoint?: string;
1916 acquisitionTimeout?: number;
1917 agentCloudId?: number;
1918 getAccountParallelismEndpoint?: string;
1919 getAgentDefinitionEndpoint?: string;
1920 getAgentRequestStatusEndpoint?: string;
1921 id?: string;
1922 /**
1923 * Signifies that this Agent Cloud is internal and should not be user-manageable
1924 */
1925 internal?: boolean;
1926 maxParallelism?: number;
1927 name?: string;
1928 releaseAgentEndpoint?: string;
1929 sharedSecret?: string;
1930 /**
1931 * Gets or sets the type of the endpoint.
1932 */
1933 type?: string;
1934}
1935export interface TaskAgentCloudRequest {
1936 agent?: TaskAgentReference;
1937 agentCloudId?: number;
1938 agentConnectedTime?: Date;
1939 agentData?: any;
1940 agentSpecification?: any;
1941 pool?: TaskAgentPoolReference;
1942 provisionedTime?: Date;
1943 provisionRequestTime?: Date;
1944 releaseRequestTime?: Date;
1945 requestId?: string;
1946}
1947export interface TaskAgentCloudType {
1948 /**
1949 * Gets or sets the display name of agent cloud type.
1950 */
1951 displayName?: string;
1952 /**
1953 * Gets or sets the input descriptors
1954 */
1955 inputDescriptors?: FormInputInterfaces.InputDescriptor[];
1956 /**
1957 * Gets or sets the name of agent cloud type.
1958 */
1959 name?: string;
1960}
1961export interface TaskAgentDowngrade extends TaskAgentUpdateReason {
1962}
1963export interface TaskAgentJob {
1964 container?: string;
1965 id?: string;
1966 name?: string;
1967 sidecarContainers?: {
1968 [key: string]: string;
1969 };
1970 steps?: TaskAgentJobStep[];
1971 variables?: TaskAgentJobVariable[];
1972}
1973/**
1974 * A job request for an agent.
1975 */
1976export interface TaskAgentJobRequest {
1977 agentSpecification?: any;
1978 /**
1979 * The date/time this request was assigned.
1980 */
1981 assignTime?: Date;
1982 /**
1983 * Additional data about the request.
1984 */
1985 data?: {
1986 [key: string]: string;
1987 };
1988 /**
1989 * The pipeline definition associated with this request
1990 */
1991 definition?: TaskOrchestrationOwner;
1992 /**
1993 * A list of demands required to fulfill this request.
1994 */
1995 demands?: Demand[];
1996 /**
1997 * The date/time this request was finished.
1998 */
1999 finishTime?: Date;
2000 /**
2001 * The host which triggered this request.
2002 */
2003 hostId?: string;
2004 /**
2005 * ID of the job resulting from this request.
2006 */
2007 jobId?: string;
2008 /**
2009 * Name of the job resulting from this request.
2010 */
2011 jobName?: string;
2012 /**
2013 * The deadline for the agent to renew the lock.
2014 */
2015 lockedUntil?: Date;
2016 matchedAgents?: TaskAgentReference[];
2017 matchesAllAgentsInPool?: boolean;
2018 orchestrationId?: string;
2019 /**
2020 * The pipeline associated with this request
2021 */
2022 owner?: TaskOrchestrationOwner;
2023 planGroup?: string;
2024 /**
2025 * Internal ID for the orchestration plan connected with this request.
2026 */
2027 planId?: string;
2028 /**
2029 * Internal detail representing the type of orchestration plan.
2030 */
2031 planType?: string;
2032 /**
2033 * The ID of the pool this request targets
2034 */
2035 poolId?: number;
2036 priority?: number;
2037 /**
2038 * The ID of the queue this request targets
2039 */
2040 queueId?: number;
2041 /**
2042 * The date/time this request was queued.
2043 */
2044 queueTime?: Date;
2045 /**
2046 * The date/time this request was receieved by an agent.
2047 */
2048 receiveTime?: Date;
2049 /**
2050 * ID of the request.
2051 */
2052 requestId?: number;
2053 /**
2054 * The agent allocated for this request.
2055 */
2056 reservedAgent?: TaskAgentReference;
2057 /**
2058 * The result of this request.
2059 */
2060 result?: TaskResult;
2061 /**
2062 * Scope of the pipeline; matches the project ID.
2063 */
2064 scopeId?: string;
2065 /**
2066 * The service which owns this request.
2067 */
2068 serviceOwner?: string;
2069 statusMessage?: string;
2070 userDelayed?: boolean;
2071}
2072/**
2073 * This is useful in getting a list of deployment targets, filtered by the result of their last job.
2074 */
2075export declare enum TaskAgentJobResultFilter {
2076 /**
2077 * Only those deployment targets on which last job failed (**Abandoned**, **Canceled**, **Failed**, **Skipped**).
2078 */
2079 Failed = 1,
2080 /**
2081 * Only those deployment targets on which last job Passed (**Succeeded**, **Succeeded with issues**).
2082 */
2083 Passed = 2,
2084 /**
2085 * Only those deployment targets that never executed a job.
2086 */
2087 NeverDeployed = 4,
2088 /**
2089 * All deployment targets.
2090 */
2091 All = 7
2092}
2093export interface TaskAgentJobStep {
2094 condition?: string;
2095 continueOnError?: boolean;
2096 enabled?: boolean;
2097 env?: {
2098 [key: string]: string;
2099 };
2100 id?: string;
2101 inputs?: {
2102 [key: string]: string;
2103 };
2104 name?: string;
2105 retryCountOnTaskFailure?: number;
2106 task?: TaskAgentJobTask;
2107 timeoutInMinutes?: number;
2108 type?: TaskAgentJobStepType;
2109}
2110export declare enum TaskAgentJobStepType {
2111 Task = 1,
2112 Action = 2
2113}
2114export interface TaskAgentJobTask {
2115 id?: string;
2116 name?: string;
2117 version?: string;
2118}
2119export interface TaskAgentJobVariable {
2120 name?: string;
2121 secret?: boolean;
2122 value?: string;
2123}
2124export interface TaskAgentManualUpdate extends TaskAgentUpdateReason {
2125}
2126/**
2127 * Provides a contract for receiving messages from the task orchestrator.
2128 */
2129export interface TaskAgentMessage {
2130 /**
2131 * Gets or sets the body of the message. If the <c>IV</c> property is provided the body will need to be decrypted using the <c>TaskAgentSession.EncryptionKey</c> value in addition to the <c>IV</c>.
2132 */
2133 body?: string;
2134 /**
2135 * Gets or sets the initialization vector used to encrypt this message.
2136 */
2137 iV?: number[];
2138 /**
2139 * Gets or sets the message identifier.
2140 */
2141 messageId?: number;
2142 /**
2143 * Gets or sets the message type, describing the data contract found in <c>TaskAgentMessage.Body</c>.
2144 */
2145 messageType?: string;
2146}
2147export interface TaskAgentMinAgentVersionRequiredUpdate extends TaskAgentUpdateReason {
2148 jobDefinition?: TaskOrchestrationOwner;
2149 jobOwner?: TaskOrchestrationOwner;
2150 minAgentVersion?: Demand;
2151}
2152/**
2153 * An organization-level grouping of agents.
2154 */
2155export interface TaskAgentPool extends TaskAgentPoolReference {
2156 /**
2157 * The ID of the associated agent cloud.
2158 */
2159 agentCloudId?: number;
2160 /**
2161 * Whether or not a queue should be automatically provisioned for each project collection.
2162 */
2163 autoProvision?: boolean;
2164 /**
2165 * Whether or not the pool should autosize itself based on the Agent Cloud Provider settings.
2166 */
2167 autoSize?: boolean;
2168 /**
2169 * Whether or not agents in this pool are allowed to automatically update
2170 */
2171 autoUpdate?: boolean;
2172 /**
2173 * Creator of the pool. The creator of the pool is automatically added into the administrators group for the pool on creation.
2174 */
2175 createdBy?: VSSInterfaces.IdentityRef;
2176 /**
2177 * The date/time of the pool creation.
2178 */
2179 createdOn?: Date;
2180 /**
2181 * Owner or administrator of the pool.
2182 */
2183 owner?: VSSInterfaces.IdentityRef;
2184 properties?: any;
2185 /**
2186 * Target parallelism - Only applies to agent pools that are backed by pool providers. It will be null for regular pools.
2187 */
2188 targetSize?: number;
2189}
2190/**
2191 * Filters pools based on whether the calling user has permission to use or manage the pool.
2192 */
2193export declare enum TaskAgentPoolActionFilter {
2194 None = 0,
2195 Manage = 2,
2196 Use = 16
2197}
2198export interface TaskAgentPoolMaintenanceDefinition {
2199 /**
2200 * Enable maintenance
2201 */
2202 enabled?: boolean;
2203 /**
2204 * Id
2205 */
2206 id?: number;
2207 /**
2208 * Maintenance job timeout per agent
2209 */
2210 jobTimeoutInMinutes?: number;
2211 /**
2212 * Max percentage of agents within a pool running maintenance job at given time
2213 */
2214 maxConcurrentAgentsPercentage?: number;
2215 options?: TaskAgentPoolMaintenanceOptions;
2216 /**
2217 * Pool reference for the maintenance definition
2218 */
2219 pool?: TaskAgentPoolReference;
2220 retentionPolicy?: TaskAgentPoolMaintenanceRetentionPolicy;
2221 scheduleSetting?: TaskAgentPoolMaintenanceSchedule;
2222}
2223export interface TaskAgentPoolMaintenanceJob {
2224 /**
2225 * The maintenance definition for the maintenance job
2226 */
2227 definitionId?: number;
2228 /**
2229 * The total error counts during the maintenance job
2230 */
2231 errorCount?: number;
2232 /**
2233 * Time that the maintenance job was completed
2234 */
2235 finishTime?: Date;
2236 /**
2237 * Id of the maintenance job
2238 */
2239 jobId?: number;
2240 /**
2241 * The log download url for the maintenance job
2242 */
2243 logsDownloadUrl?: string;
2244 /**
2245 * Orchestration/Plan Id for the maintenance job
2246 */
2247 orchestrationId?: string;
2248 /**
2249 * Pool reference for the maintenance job
2250 */
2251 pool?: TaskAgentPoolReference;
2252 /**
2253 * Time that the maintenance job was queued
2254 */
2255 queueTime?: Date;
2256 /**
2257 * The identity that queued the maintenance job
2258 */
2259 requestedBy?: VSSInterfaces.IdentityRef;
2260 /**
2261 * The maintenance job result
2262 */
2263 result?: TaskAgentPoolMaintenanceJobResult;
2264 /**
2265 * Time that the maintenance job was started
2266 */
2267 startTime?: Date;
2268 /**
2269 * Status of the maintenance job
2270 */
2271 status?: TaskAgentPoolMaintenanceJobStatus;
2272 targetAgents?: TaskAgentPoolMaintenanceJobTargetAgent[];
2273 /**
2274 * The total warning counts during the maintenance job
2275 */
2276 warningCount?: number;
2277}
2278export declare enum TaskAgentPoolMaintenanceJobResult {
2279 Succeeded = 1,
2280 Failed = 2,
2281 Canceled = 4
2282}
2283export declare enum TaskAgentPoolMaintenanceJobStatus {
2284 InProgress = 1,
2285 Completed = 2,
2286 Cancelling = 4,
2287 Queued = 8
2288}
2289export interface TaskAgentPoolMaintenanceJobTargetAgent {
2290 agent?: TaskAgentReference;
2291 jobId?: number;
2292 result?: TaskAgentPoolMaintenanceJobResult;
2293 status?: TaskAgentPoolMaintenanceJobStatus;
2294}
2295export interface TaskAgentPoolMaintenanceOptions {
2296 /**
2297 * time to consider a System.DefaultWorkingDirectory is stale
2298 */
2299 workingDirectoryExpirationInDays?: number;
2300}
2301export interface TaskAgentPoolMaintenanceRetentionPolicy {
2302 /**
2303 * Number of records to keep for maintenance job executed with this definition.
2304 */
2305 numberOfHistoryRecordsToKeep?: number;
2306}
2307export interface TaskAgentPoolMaintenanceSchedule {
2308 /**
2309 * Days for a build (flags enum for days of the week)
2310 */
2311 daysToBuild?: TaskAgentPoolMaintenanceScheduleDays;
2312 /**
2313 * The Job Id of the Scheduled job that will queue the pool maintenance job.
2314 */
2315 scheduleJobId?: string;
2316 /**
2317 * Local timezone hour to start
2318 */
2319 startHours?: number;
2320 /**
2321 * Local timezone minute to start
2322 */
2323 startMinutes?: number;
2324 /**
2325 * Time zone of the build schedule (string representation of the time zone id)
2326 */
2327 timeZoneId?: string;
2328}
2329export declare enum TaskAgentPoolMaintenanceScheduleDays {
2330 /**
2331 * Do not run.
2332 */
2333 None = 0,
2334 /**
2335 * Run on Monday.
2336 */
2337 Monday = 1,
2338 /**
2339 * Run on Tuesday.
2340 */
2341 Tuesday = 2,
2342 /**
2343 * Run on Wednesday.
2344 */
2345 Wednesday = 4,
2346 /**
2347 * Run on Thursday.
2348 */
2349 Thursday = 8,
2350 /**
2351 * Run on Friday.
2352 */
2353 Friday = 16,
2354 /**
2355 * Run on Saturday.
2356 */
2357 Saturday = 32,
2358 /**
2359 * Run on Sunday.
2360 */
2361 Sunday = 64,
2362 /**
2363 * Run on all days of the week.
2364 */
2365 All = 127
2366}
2367/**
2368 * Additional settings and descriptors for a TaskAgentPool
2369 */
2370export declare enum TaskAgentPoolOptions {
2371 None = 0,
2372 /**
2373 * TaskAgentPool backed by the Elastic pool service
2374 */
2375 ElasticPool = 1,
2376 /**
2377 * Set to true if agents are re-imaged after each TaskAgentJobRequest
2378 */
2379 SingleUseAgents = 2,
2380 /**
2381 * Set to true if agents are held for investigation after a TaskAgentJobRequest failure
2382 */
2383 PreserveAgentOnJobFailure = 4
2384}
2385export interface TaskAgentPoolReference {
2386 id?: number;
2387 /**
2388 * Gets or sets a value indicating whether or not this pool is managed by the service.
2389 */
2390 isHosted?: boolean;
2391 /**
2392 * Determines whether the pool is legacy.
2393 */
2394 isLegacy?: boolean;
2395 name?: string;
2396 /**
2397 * Additional pool settings and details
2398 */
2399 options?: TaskAgentPoolOptions;
2400 /**
2401 * Gets or sets the type of the pool
2402 */
2403 poolType?: TaskAgentPoolType;
2404 scope?: string;
2405 /**
2406 * Gets the current size of the pool.
2407 */
2408 size?: number;
2409}
2410export interface TaskAgentPoolStatus extends TaskAgentPoolReference {
2411 /**
2412 * Number of requests queued and assigned to an agent. Not running yet.
2413 */
2414 assignedRequestCount?: number;
2415 /**
2416 * Number of queued requests which are not assigned to any agents
2417 */
2418 queuedRequestCount?: number;
2419 /**
2420 * Number of currently running requests
2421 */
2422 runningRequestCount?: number;
2423}
2424export interface TaskAgentPoolSummary {
2425 columnsHeader?: MetricsColumnsHeader;
2426 deploymentGroups?: DeploymentGroupReference[];
2427 pool?: TaskAgentPoolReference;
2428 queues?: TaskAgentQueue[];
2429 rows?: MetricsRow[];
2430}
2431/**
2432 * The type of agent pool.
2433 */
2434export declare enum TaskAgentPoolType {
2435 /**
2436 * A typical pool of task agents
2437 */
2438 Automation = 1,
2439 /**
2440 * A deployment pool
2441 */
2442 Deployment = 2
2443}
2444/**
2445 * Represents the public key portion of an RSA asymmetric key.
2446 */
2447export interface TaskAgentPublicKey {
2448 /**
2449 * Gets or sets the exponent for the public key.
2450 */
2451 exponent?: number[];
2452 /**
2453 * Gets or sets the modulus for the public key.
2454 */
2455 modulus?: number[];
2456}
2457/**
2458 * An agent queue.
2459 */
2460export interface TaskAgentQueue {
2461 /**
2462 * ID of the queue
2463 */
2464 id?: number;
2465 /**
2466 * Name of the queue
2467 */
2468 name?: string;
2469 /**
2470 * Pool reference for this queue
2471 */
2472 pool?: TaskAgentPoolReference;
2473 /**
2474 * Project ID
2475 */
2476 projectId?: string;
2477}
2478/**
2479 * Filters queues based on whether the calling user has permission to use or manage the queue.
2480 */
2481export declare enum TaskAgentQueueActionFilter {
2482 None = 0,
2483 Manage = 2,
2484 Use = 16
2485}
2486/**
2487 * A reference to an agent.
2488 */
2489export interface TaskAgentReference {
2490 _links?: any;
2491 /**
2492 * This agent's access point.
2493 */
2494 accessPoint?: string;
2495 /**
2496 * Whether or not this agent should run jobs.
2497 */
2498 enabled?: boolean;
2499 /**
2500 * Identifier of the agent.
2501 */
2502 id?: number;
2503 /**
2504 * Name of the agent.
2505 */
2506 name?: string;
2507 /**
2508 * Agent OS.
2509 */
2510 oSDescription?: string;
2511 /**
2512 * Provisioning state of this agent.
2513 */
2514 provisioningState?: string;
2515 /**
2516 * Whether or not the agent is online.
2517 */
2518 status?: TaskAgentStatus;
2519 /**
2520 * Agent version.
2521 */
2522 version?: string;
2523}
2524export declare enum TaskAgentRequestUpdateOptions {
2525 None = 0,
2526 BumpRequestToTop = 1
2527}
2528/**
2529 * Represents a session for performing message exchanges from an agent.
2530 */
2531export interface TaskAgentSession {
2532 /**
2533 * Gets or sets the agent which is the target of the session.
2534 */
2535 agent?: TaskAgentReference;
2536 /**
2537 * Gets the key used to encrypt message traffic for this session.
2538 */
2539 encryptionKey?: TaskAgentSessionKey;
2540 /**
2541 * Gets or sets the owner name of this session. Generally this will be the machine of origination.
2542 */
2543 ownerName?: string;
2544 /**
2545 * Gets the unique identifier for this session.
2546 */
2547 sessionId?: string;
2548 systemCapabilities?: {
2549 [key: string]: string;
2550 };
2551}
2552/**
2553 * Represents a symmetric key used for message-level encryption for communication sent to an agent.
2554 */
2555export interface TaskAgentSessionKey {
2556 /**
2557 * Gets or sets a value indicating whether or not the key value is encrypted. If this value is true, the Value property should be decrypted using the <c>RSA</c> key exchanged with the server during registration.
2558 */
2559 encrypted?: boolean;
2560 /**
2561 * Gets or sets the symmetric key value.
2562 */
2563 value?: number[];
2564}
2565export declare enum TaskAgentStatus {
2566 Offline = 1,
2567 Online = 2
2568}
2569/**
2570 * This is useful in getting a list of deployment targets, filtered by the deployment agent status.
2571 */
2572export declare enum TaskAgentStatusFilter {
2573 /**
2574 * Only deployment targets that are offline.
2575 */
2576 Offline = 1,
2577 /**
2578 * Only deployment targets that are online.
2579 */
2580 Online = 2,
2581 /**
2582 * All deployment targets.
2583 */
2584 All = 3
2585}
2586/**
2587 * Details about an agent update.
2588 */
2589export interface TaskAgentUpdate {
2590 /**
2591 * Current state of this agent update.
2592 */
2593 currentState?: string;
2594 /**
2595 * Reason for this update.
2596 */
2597 reason?: TaskAgentUpdateReason;
2598 /**
2599 * Identity which requested this update.
2600 */
2601 requestedBy?: VSSInterfaces.IdentityRef;
2602 /**
2603 * Date on which this update was requested.
2604 */
2605 requestTime?: Date;
2606 /**
2607 * Source agent version of the update.
2608 */
2609 sourceVersion?: PackageVersion;
2610 /**
2611 * Target agent version of the update.
2612 */
2613 targetVersion?: PackageVersion;
2614}
2615export interface TaskAgentUpdateReason {
2616 code?: TaskAgentUpdateReasonType;
2617}
2618export declare enum TaskAgentUpdateReasonType {
2619 Manual = 1,
2620 MinAgentVersionRequired = 2,
2621 Downgrade = 3
2622}
2623export interface TaskAssignedEvent extends TaskEvent {
2624}
2625export interface TaskAttachment {
2626 _links?: any;
2627 createdOn?: Date;
2628 lastChangedBy?: string;
2629 lastChangedOn?: Date;
2630 name?: string;
2631 recordId?: string;
2632 timelineId?: string;
2633 type?: string;
2634}
2635export declare enum TaskCommandMode {
2636 Any = 0,
2637 Restricted = 1
2638}
2639export interface TaskCommandRestrictions {
2640 mode?: TaskCommandMode;
2641}
2642export interface TaskCompletedEvent extends TaskEvent {
2643 /**
2644 * The api request was no delivered successfully
2645 */
2646 deliveryFailed?: boolean;
2647 /**
2648 * The result of the task.
2649 */
2650 result?: TaskResult;
2651}
2652export interface TaskDefinition {
2653 _buildConfigMapping?: {
2654 [key: string]: string;
2655 };
2656 agentExecution?: TaskExecution;
2657 author?: string;
2658 category?: string;
2659 contentsUploaded?: boolean;
2660 contributionIdentifier?: string;
2661 contributionVersion?: string;
2662 dataSourceBindings?: DataSourceBinding[];
2663 definitionType?: string;
2664 demands?: Demand[];
2665 deprecated?: boolean;
2666 description?: string;
2667 disabled?: boolean;
2668 ecosystem?: string;
2669 execution?: {
2670 [key: string]: any;
2671 };
2672 friendlyName?: string;
2673 groups?: TaskGroupDefinition[];
2674 helpMarkDown?: string;
2675 helpUrl?: string;
2676 hostType?: string;
2677 iconUrl?: string;
2678 id?: string;
2679 inputs?: TaskInputDefinition[];
2680 instanceNameFormat?: string;
2681 minimumAgentVersion?: string;
2682 name?: string;
2683 outputVariables?: TaskOutputVariable[];
2684 packageLocation?: string;
2685 packageType?: string;
2686 postJobExecution?: {
2687 [key: string]: any;
2688 };
2689 preJobExecution?: {
2690 [key: string]: any;
2691 };
2692 preview?: boolean;
2693 releaseNotes?: string;
2694 restrictions?: TaskRestrictions;
2695 runsOn?: string[];
2696 satisfies?: string[];
2697 serverOwned?: boolean;
2698 showEnvironmentVariables?: boolean;
2699 sourceDefinitions?: TaskSourceDefinition[];
2700 sourceLocation?: string;
2701 version?: TaskVersion;
2702 visibility?: string[];
2703}
2704export interface TaskDefinitionEndpoint {
2705 /**
2706 * An ID that identifies a service connection to be used for authenticating endpoint requests.
2707 */
2708 connectionId?: string;
2709 /**
2710 * An Json based keyselector to filter response returned by fetching the endpoint <c>Url</c>.A Json based keyselector must be prefixed with "jsonpath:". KeySelector can be used to specify the filter to get the keys for the values specified with Selector. <example> The following keyselector defines an Json for extracting nodes named 'ServiceName'. <code> endpoint.KeySelector = "jsonpath://ServiceName"; </code></example>
2711 */
2712 keySelector?: string;
2713 /**
2714 * The scope as understood by Connected Services. Essentially, a project-id for now.
2715 */
2716 scope?: string;
2717 /**
2718 * An XPath/Json based selector to filter response returned by fetching the endpoint <c>Url</c>. An XPath based selector must be prefixed with the string "xpath:". A Json based selector must be prefixed with "jsonpath:". <example> The following selector defines an XPath for extracting nodes named 'ServiceName'. <code> endpoint.Selector = "xpath://ServiceName"; </code></example>
2719 */
2720 selector?: string;
2721 /**
2722 * TaskId that this endpoint belongs to.
2723 */
2724 taskId?: string;
2725 /**
2726 * URL to GET.
2727 */
2728 url?: string;
2729}
2730export interface TaskDefinitionReference {
2731 /**
2732 * Gets or sets the definition type. Values can be 'task' or 'metaTask'.
2733 */
2734 definitionType: string;
2735 /**
2736 * Gets or sets the unique identifier of task.
2737 */
2738 id: string;
2739 /**
2740 * Gets or sets the version specification of task.
2741 */
2742 versionSpec: string;
2743}
2744export declare enum TaskDefinitionStatus {
2745 Preinstalled = 1,
2746 ReceivedInstallOrUpdate = 2,
2747 Installed = 3,
2748 ReceivedUninstall = 4,
2749 Uninstalled = 5,
2750 RequestedUpdate = 6,
2751 Updated = 7,
2752 AlreadyUpToDate = 8,
2753 InlineUpdateReceived = 9
2754}
2755export interface TaskEvent extends JobEvent {
2756 /**
2757 * The ID of the task definition.
2758 */
2759 taskId?: string;
2760}
2761export interface TaskExecution {
2762 /**
2763 * The utility task to run. Specifying this means that this task definition is simply a meta task to call another task. This is useful for tasks that call utility tasks like powershell and commandline
2764 */
2765 execTask?: TaskReference;
2766 /**
2767 * If a task is going to run code, then this provides the type/script etc... information by platform. For example, it might look like. net45: { typeName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShellTask", assemblyName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShell.dll" } net20: { typeName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShellTask", assemblyName: "Microsoft.TeamFoundation.Automation.Tasks.PowerShell.dll" } java: { jar: "powershelltask.tasks.automation.teamfoundation.microsoft.com", } node: { script: "powershellhost.js", }
2768 */
2769 platformInstructions?: {
2770 [key: string]: {
2771 [key: string]: string;
2772 };
2773 };
2774}
2775export interface TaskGroup extends TaskDefinition {
2776 /**
2777 * Gets or sets comment.
2778 */
2779 comment?: string;
2780 /**
2781 * Gets or sets the identity who created.
2782 */
2783 createdBy?: VSSInterfaces.IdentityRef;
2784 /**
2785 * Gets or sets date on which it got created.
2786 */
2787 createdOn?: Date;
2788 /**
2789 * Gets or sets as 'true' to indicate as deleted, 'false' otherwise.
2790 */
2791 deleted?: boolean;
2792 /**
2793 * Gets or sets the identity who modified.
2794 */
2795 modifiedBy?: VSSInterfaces.IdentityRef;
2796 /**
2797 * Gets or sets date on which it got modified.
2798 */
2799 modifiedOn?: Date;
2800 /**
2801 * Gets or sets the owner.
2802 */
2803 owner?: string;
2804 /**
2805 * Gets or sets parent task group Id. This is used while creating a draft task group.
2806 */
2807 parentDefinitionId?: string;
2808 /**
2809 * Gets or sets revision.
2810 */
2811 revision?: number;
2812 /**
2813 * Gets or sets the tasks.
2814 */
2815 tasks?: TaskGroupStep[];
2816}
2817export interface TaskGroupCreateParameter {
2818 /**
2819 * Sets author name of the task group.
2820 */
2821 author?: string;
2822 /**
2823 * Sets category of the task group.
2824 */
2825 category?: string;
2826 /**
2827 * Sets description of the task group.
2828 */
2829 description?: string;
2830 /**
2831 * Sets friendly name of the task group.
2832 */
2833 friendlyName?: string;
2834 /**
2835 * Sets url icon of the task group.
2836 */
2837 iconUrl?: string;
2838 /**
2839 * Sets input for the task group.
2840 */
2841 inputs?: TaskInputDefinition[];
2842 /**
2843 * Sets display name of the task group.
2844 */
2845 instanceNameFormat?: string;
2846 /**
2847 * Sets name of the task group.
2848 */
2849 name?: string;
2850 /**
2851 * Sets parent task group Id. This is used while creating a draft task group.
2852 */
2853 parentDefinitionId?: string;
2854 /**
2855 * Sets RunsOn of the task group. Value can be 'Agent', 'Server' or 'DeploymentGroup'.
2856 */
2857 runsOn?: string[];
2858 /**
2859 * Sets tasks for the task group.
2860 */
2861 tasks?: TaskGroupStep[];
2862 /**
2863 * Sets version of the task group.
2864 */
2865 version?: TaskVersion;
2866}
2867export interface TaskGroupDefinition {
2868 displayName?: string;
2869 isExpanded?: boolean;
2870 name?: string;
2871 tags?: string[];
2872 visibleRule?: string;
2873}
2874export declare enum TaskGroupExpands {
2875 None = 0,
2876 Tasks = 2
2877}
2878export interface TaskGroupPublishPreviewParameter extends TaskGroupUpdatePropertiesBase {
2879 /**
2880 * This is to disable previous versions of task group upon publish
2881 */
2882 disablePriorVersions?: boolean;
2883 /**
2884 * Denotes if task group is in preview
2885 */
2886 preview?: boolean;
2887 /**
2888 * This is the revision of task group that is getting published
2889 */
2890 revision?: number;
2891 /**
2892 * This is the version of task group that is getting published
2893 */
2894 version?: TaskVersion;
2895}
2896/**
2897 * Specifies the desired ordering of taskGroups.
2898 */
2899export declare enum TaskGroupQueryOrder {
2900 /**
2901 * Order by createdon ascending.
2902 */
2903 CreatedOnAscending = 0,
2904 /**
2905 * Order by createdon descending.
2906 */
2907 CreatedOnDescending = 1
2908}
2909export interface TaskGroupRestoreParameter extends TaskGroupUpdatePropertiesBase {
2910 /**
2911 * This is to restore deleted Task Group
2912 */
2913 restore?: boolean;
2914}
2915export interface TaskGroupRevision {
2916 changedBy?: VSSInterfaces.IdentityRef;
2917 changedDate?: Date;
2918 changeType?: AuditAction;
2919 comment?: string;
2920 fileId?: number;
2921 majorVersion?: number;
2922 revision?: number;
2923 taskGroupId?: string;
2924}
2925/**
2926 * Represents tasks in the task group.
2927 */
2928export interface TaskGroupStep {
2929 /**
2930 * Gets or sets as 'true' to run the task always, 'false' otherwise.
2931 */
2932 alwaysRun?: boolean;
2933 /**
2934 * Gets or sets condition for the task.
2935 */
2936 condition?: string;
2937 /**
2938 * Gets or sets as 'true' to continue on error, 'false' otherwise.
2939 */
2940 continueOnError?: boolean;
2941 /**
2942 * Gets or sets the display name.
2943 */
2944 displayName?: string;
2945 /**
2946 * Gets or sets as task is enabled or not.
2947 */
2948 enabled?: boolean;
2949 /**
2950 * Gets dictionary of environment variables.
2951 */
2952 environment?: {
2953 [key: string]: string;
2954 };
2955 /**
2956 * Gets or sets dictionary of inputs.
2957 */
2958 inputs?: {
2959 [key: string]: string;
2960 };
2961 /**
2962 * Gets or sets the maximum number of retries
2963 */
2964 retryCountOnTaskFailure?: number;
2965 /**
2966 * Gets or sets the reference of the task.
2967 */
2968 task?: TaskDefinitionReference;
2969 /**
2970 * Gets or sets the maximum time, in minutes, that a task is allowed to execute on agent before being cancelled by server. A zero value indicates an infinite timeout.
2971 */
2972 timeoutInMinutes?: number;
2973}
2974export interface TaskGroupUpdateParameter {
2975 /**
2976 * Sets author name of the task group.
2977 */
2978 author?: string;
2979 /**
2980 * Sets category of the task group.
2981 */
2982 category?: string;
2983 /**
2984 * Sets comment of the task group.
2985 */
2986 comment?: string;
2987 /**
2988 * Sets description of the task group.
2989 */
2990 description?: string;
2991 /**
2992 * Sets friendly name of the task group.
2993 */
2994 friendlyName?: string;
2995 /**
2996 * Sets url icon of the task group.
2997 */
2998 iconUrl?: string;
2999 /**
3000 * Sets the unique identifier of this field.
3001 */
3002 id?: string;
3003 /**
3004 * Sets input for the task group.
3005 */
3006 inputs?: TaskInputDefinition[];
3007 /**
3008 * Sets display name of the task group.
3009 */
3010 instanceNameFormat?: string;
3011 /**
3012 * Sets name of the task group.
3013 */
3014 name?: string;
3015 /**
3016 * Gets or sets parent task group Id. This is used while creating a draft task group.
3017 */
3018 parentDefinitionId?: string;
3019 /**
3020 * Sets revision of the task group.
3021 */
3022 revision?: number;
3023 /**
3024 * Sets RunsOn of the task group. Value can be 'Agent', 'Server' or 'DeploymentGroup'.
3025 */
3026 runsOn?: string[];
3027 /**
3028 * Sets tasks for the task group.
3029 */
3030 tasks?: TaskGroupStep[];
3031 /**
3032 * Sets version of the task group.
3033 */
3034 version?: TaskVersion;
3035}
3036export interface TaskGroupUpdatePropertiesBase {
3037 /**
3038 * Comment for this update request
3039 */
3040 comment?: string;
3041}
3042export interface TaskHubLicenseDetails {
3043 enterpriseUsersCount?: number;
3044 failedToReachAllProviders?: boolean;
3045 freeHostedLicenseCount?: number;
3046 freeLicenseCount?: number;
3047 hasLicenseCountEverUpdated?: boolean;
3048 hostedAgentMinutesFreeCount?: number;
3049 hostedAgentMinutesUsedCount?: number;
3050 hostedLicensesArePremium?: boolean;
3051 msdnUsersCount?: number;
3052 /**
3053 * Microsoft-hosted licenses purchased from VSTS directly.
3054 */
3055 purchasedHostedLicenseCount?: number;
3056 /**
3057 * Self-hosted licenses purchased from VSTS directly.
3058 */
3059 purchasedLicenseCount?: number;
3060 totalHostedLicenseCount?: number;
3061 totalLicenseCount?: number;
3062 totalPrivateLicenseCount?: number;
3063}
3064export interface TaskHubOidcToken {
3065 oidcToken?: string;
3066}
3067export interface TaskInputDefinition extends DistributedTaskCommonInterfaces.TaskInputDefinitionBase {
3068}
3069export interface TaskInstance extends TaskReference {
3070 alwaysRun?: boolean;
3071 condition?: string;
3072 continueOnError?: boolean;
3073 displayName?: string;
3074 enabled?: boolean;
3075 environment?: {
3076 [key: string]: string;
3077 };
3078 instanceId?: string;
3079 refName?: string;
3080 retryCountOnTaskFailure?: number;
3081 timeoutInMinutes?: number;
3082}
3083/**
3084 * A task log connected to a timeline record.
3085 */
3086export interface TaskLog extends TaskLogReference {
3087 /**
3088 * The time of the task log creation.
3089 */
3090 createdOn?: Date;
3091 /**
3092 * The REST URL of the task log when indexed.
3093 */
3094 indexLocation?: string;
3095 /**
3096 * The time of the last modification of the task log.
3097 */
3098 lastChangedOn?: Date;
3099 /**
3100 * The number of the task log lines.
3101 */
3102 lineCount?: number;
3103 /**
3104 * The path of the task log.
3105 */
3106 path?: string;
3107}
3108/**
3109 * A reference to a task log. This class contains information about the output printed to the timeline record's logs console during pipeline run.
3110 */
3111export interface TaskLogReference {
3112 /**
3113 * The ID of the task log.
3114 */
3115 id?: number;
3116 /**
3117 * The REST URL of the task log.
3118 */
3119 location?: string;
3120}
3121export interface TaskOrchestrationContainer extends TaskOrchestrationItem {
3122 children?: TaskOrchestrationItem[];
3123 continueOnError?: boolean;
3124 data?: {
3125 [key: string]: string;
3126 };
3127 maxConcurrency?: number;
3128 parallel?: boolean;
3129 rollback?: TaskOrchestrationContainer;
3130}
3131export interface TaskOrchestrationItem {
3132 itemType?: TaskOrchestrationItemType;
3133}
3134export declare enum TaskOrchestrationItemType {
3135 Container = 0,
3136 Job = 1
3137}
3138export interface TaskOrchestrationJob extends TaskOrchestrationItem {
3139 demands?: Demand[];
3140 executeAs?: VSSInterfaces.IdentityRef;
3141 executionMode?: string;
3142 executionTimeout?: any;
3143 instanceId?: string;
3144 name?: string;
3145 refName?: string;
3146 tasks?: TaskInstance[];
3147 variables?: {
3148 [key: string]: string;
3149 };
3150}
3151export interface TaskOrchestrationOwner {
3152 _links?: any;
3153 id?: number;
3154 name?: string;
3155}
3156export interface TaskOrchestrationPlan extends TaskOrchestrationPlanReference {
3157 environment?: PlanEnvironment;
3158 expandedYaml?: TaskLogReference;
3159 finishTime?: Date;
3160 implementation?: TaskOrchestrationContainer;
3161 initializationLog?: TaskLogReference;
3162 requestedById?: string;
3163 requestedForId?: string;
3164 result?: TaskResult;
3165 resultCode?: string;
3166 startTime?: Date;
3167 state?: TaskOrchestrationPlanState;
3168 timeline?: TimelineReference;
3169}
3170export interface TaskOrchestrationPlanGroup {
3171 planGroup?: string;
3172 project?: ProjectReference;
3173 runningRequests?: TaskAgentJobRequest[];
3174}
3175export interface TaskOrchestrationPlanGroupsQueueMetrics {
3176 count?: number;
3177 status?: PlanGroupStatus;
3178}
3179export interface TaskOrchestrationPlanReference {
3180 artifactLocation?: string;
3181 artifactUri?: string;
3182 definition?: TaskOrchestrationOwner;
3183 owner?: TaskOrchestrationOwner;
3184 planGroup?: string;
3185 planId?: string;
3186 planType?: string;
3187 scopeIdentifier?: string;
3188 version?: number;
3189}
3190export declare enum TaskOrchestrationPlanState {
3191 InProgress = 1,
3192 Queued = 2,
3193 Completed = 4,
3194 Throttled = 8
3195}
3196export interface TaskOrchestrationQueuedPlan {
3197 assignTime?: Date;
3198 definition?: TaskOrchestrationOwner;
3199 owner?: TaskOrchestrationOwner;
3200 planGroup?: string;
3201 planId?: string;
3202 poolId?: number;
3203 queuePosition?: number;
3204 queueTime?: Date;
3205 scopeIdentifier?: string;
3206}
3207export interface TaskOrchestrationQueuedPlanGroup {
3208 definition?: TaskOrchestrationOwner;
3209 owner?: TaskOrchestrationOwner;
3210 planGroup?: string;
3211 plans?: TaskOrchestrationQueuedPlan[];
3212 project?: ProjectReference;
3213 queuePosition?: number;
3214}
3215export interface TaskOutputVariable {
3216 description?: string;
3217 name?: string;
3218}
3219export interface TaskPackageMetadata {
3220 /**
3221 * Gets the name of the package.
3222 */
3223 type?: string;
3224 /**
3225 * Gets the url of the package.
3226 */
3227 url?: string;
3228 /**
3229 * Gets the version of the package.
3230 */
3231 version?: string;
3232}
3233/**
3234 * A reference to a task.
3235 */
3236export interface TaskReference {
3237 /**
3238 * The ID of the task definition. Corresponds to the id value of task.json file. <br />Example: CmdLineV2 { "id": "D9BAFED4-0B18-4F58-968D-86655B4D2CE9" }
3239 */
3240 id?: string;
3241 /**
3242 * A dictionary of inputs specific to a task definition. Corresponds to inputs value of task.json file.
3243 */
3244 inputs?: {
3245 [key: string]: string;
3246 };
3247 /**
3248 * The name of the task definition. Corresponds to the name value of task.json file. <br />Example: CmdLineV2 { "name": "CmdLine" }
3249 */
3250 name?: string;
3251 /**
3252 * The version of the task definition. Corresponds to the version value of task.json file. <br />Example: CmdLineV2 { "version": { "Major": 2, "Minor": 212, "Patch": 0 } }
3253 */
3254 version?: string;
3255}
3256export interface TaskRestrictions {
3257 commands?: TaskCommandRestrictions;
3258 settableVariables?: TaskVariableRestrictions;
3259}
3260/**
3261 * The result of an operation tracked by a timeline record.
3262 */
3263export declare enum TaskResult {
3264 Succeeded = 0,
3265 SucceededWithIssues = 1,
3266 Failed = 2,
3267 Canceled = 3,
3268 Skipped = 4,
3269 Abandoned = 5
3270}
3271export interface TaskSourceDefinition extends DistributedTaskCommonInterfaces.TaskSourceDefinitionBase {
3272}
3273export interface TaskStartedEvent extends TaskEvent {
3274}
3275export interface TaskVariableRestrictions {
3276 allowed?: string[];
3277}
3278export interface TaskVersion {
3279 isTest?: boolean;
3280 major?: number;
3281 minor?: number;
3282 patch?: number;
3283}
3284export interface Timeline extends TimelineReference {
3285 lastChangedBy?: string;
3286 lastChangedOn?: Date;
3287 records?: TimelineRecord[];
3288}
3289/**
3290 * An attempt to update a TimelineRecord.
3291 */
3292export interface TimelineAttempt {
3293 /**
3294 * The attempt of the record.
3295 */
3296 attempt?: number;
3297 /**
3298 * The unique identifier for the record.
3299 */
3300 identifier?: string;
3301 /**
3302 * The record identifier located within the specified timeline.
3303 */
3304 recordId?: string;
3305 /**
3306 * The timeline identifier which owns the record representing this attempt.
3307 */
3308 timelineId?: string;
3309}
3310/**
3311 * Detailed information about the execution of different operations during pipeline run.
3312 */
3313export interface TimelineRecord {
3314 /**
3315 * The specification of an agent running a pipeline job, in binary format. Applicable when record is of type Job. <br />Example: { "VMImage" : "windows-2019" }
3316 */
3317 agentSpecification?: any;
3318 /**
3319 * The number of record attempts.
3320 */
3321 attempt?: number;
3322 /**
3323 * The ID connecting all records updated at the same time. This value is taken from timeline's ChangeId.
3324 */
3325 changeId?: number;
3326 /**
3327 * A string that indicates the current operation.
3328 */
3329 currentOperation?: string;
3330 /**
3331 * A reference to a sub-timeline.
3332 */
3333 details?: TimelineReference;
3334 /**
3335 * The number of errors produced by this operation.
3336 */
3337 errorCount?: number;
3338 /**
3339 * The finish time of the record.
3340 */
3341 finishTime?: Date;
3342 /**
3343 * The ID of the record.
3344 */
3345 id?: string;
3346 /**
3347 * String identifier that is consistent across attempts.
3348 */
3349 identifier?: string;
3350 /**
3351 * The list of issues produced by this operation.
3352 */
3353 issues?: Issue[];
3354 /**
3355 * The time the record was last modified.
3356 */
3357 lastModified?: Date;
3358 /**
3359 * The REST URL of the record.
3360 */
3361 location?: string;
3362 /**
3363 * A reference to the log produced by this operation.
3364 */
3365 log?: TaskLogReference;
3366 /**
3367 * The name of the record.
3368 */
3369 name?: string;
3370 /**
3371 * An ordinal value relative to other records within the timeline.
3372 */
3373 order?: number;
3374 /**
3375 * The ID of the record's parent. <br />Example: Stage is a parent of a Phase, Phase is a parent of a Job, Job is a parent of a Task.
3376 */
3377 parentId?: string;
3378 /**
3379 * The percentage of record completion.
3380 */
3381 percentComplete?: number;
3382 /**
3383 * The previous record attempts.
3384 */
3385 previousAttempts?: TimelineAttempt[];
3386 /**
3387 * The ID of the queue which connects projects to agent pools on which the operation ran on. Applicable when record is of type Job.
3388 */
3389 queueId?: number;
3390 /**
3391 * Name of the referenced record.
3392 */
3393 refName?: string;
3394 /**
3395 * The result of the record.
3396 */
3397 result?: TaskResult;
3398 /**
3399 * Evaluation of predefined conditions upon completion of record's operation. <br />Example: Evaluating `succeeded()`, Result = True <br />Example: Evaluating `and(succeeded(), eq(variables['system.debug'], False))`, Result = False
3400 */
3401 resultCode?: string;
3402 /**
3403 * The start time of the record.
3404 */
3405 startTime?: Date;
3406 /**
3407 * The state of the record.
3408 */
3409 state?: TimelineRecordState;
3410 /**
3411 * A reference to the task. Applicable when record is of type Task.
3412 */
3413 task?: TaskReference;
3414 /**
3415 * The type of operation being tracked by the record. <br />Example: Stage, Phase, Job, Task...
3416 */
3417 type?: string;
3418 /**
3419 * The variables of the record.
3420 */
3421 variables?: {
3422 [key: string]: VariableValue;
3423 };
3424 /**
3425 * The number of warnings produced by this operation.
3426 */
3427 warningCount?: number;
3428 /**
3429 * The name of the agent running the operation. Applicable when record is of type Job.
3430 */
3431 workerName?: string;
3432}
3433export interface TimelineRecordFeedLinesWrapper {
3434 count?: number;
3435 endLine?: number;
3436 startLine?: number;
3437 stepId?: string;
3438 value?: string[];
3439}
3440/**
3441 * A reference to a timeline record.
3442 */
3443export interface TimelineRecordReference {
3444 /**
3445 * The ID of the record.
3446 */
3447 id?: string;
3448 /**
3449 * String identifier that is consistent across attempts.
3450 */
3451 identifier?: string;
3452 /**
3453 * The state of the record.
3454 */
3455 state?: TimelineRecordState;
3456}
3457/**
3458 * The state of the timeline record.
3459 */
3460export declare enum TimelineRecordState {
3461 Pending = 0,
3462 InProgress = 1,
3463 Completed = 2
3464}
3465/**
3466 * A reference to a timeline.
3467 */
3468export interface TimelineReference {
3469 /**
3470 * The change ID.
3471 */
3472 changeId?: number;
3473 /**
3474 * The ID of the timeline.
3475 */
3476 id?: string;
3477 /**
3478 * The REST URL of the timeline.
3479 */
3480 location?: string;
3481}
3482export interface ValidationItem {
3483 /**
3484 * Tells whether the current input is valid or not
3485 */
3486 isValid?: boolean;
3487 /**
3488 * Reason for input validation failure
3489 */
3490 reason?: string;
3491 /**
3492 * Type of validation item
3493 */
3494 type?: string;
3495 /**
3496 * Value to validate. The conditional expression to validate for the input for "expression" type Eg:eq(variables['Build.SourceBranch'], 'refs/heads/master');eq(value, 'refs/heads/master')
3497 */
3498 value?: string;
3499}
3500/**
3501 * A variable group is a collection of related variables.
3502 */
3503export interface VariableGroup {
3504 /**
3505 * Gets or sets the identity who created the variable group.
3506 */
3507 createdBy?: VSSInterfaces.IdentityRef;
3508 /**
3509 * Gets or sets the time when variable group was created.
3510 */
3511 createdOn?: Date;
3512 /**
3513 * Gets or sets description of the variable group.
3514 */
3515 description?: string;
3516 /**
3517 * Gets or sets id of the variable group.
3518 */
3519 id?: number;
3520 /**
3521 * Indicates whether variable group is shared with other projects or not.
3522 */
3523 isShared?: boolean;
3524 /**
3525 * Gets or sets the identity who modified the variable group.
3526 */
3527 modifiedBy?: VSSInterfaces.IdentityRef;
3528 /**
3529 * Gets or sets the time when variable group was modified
3530 */
3531 modifiedOn?: Date;
3532 /**
3533 * Gets or sets name of the variable group.
3534 */
3535 name?: string;
3536 /**
3537 * Gets or sets provider data.
3538 */
3539 providerData?: VariableGroupProviderData;
3540 /**
3541 * Gets or sets type of the variable group.
3542 */
3543 type?: string;
3544 /**
3545 * all project references where the variable group is shared with other projects.
3546 */
3547 variableGroupProjectReferences?: VariableGroupProjectReference[];
3548 /**
3549 * Gets or sets variables contained in the variable group.
3550 */
3551 variables?: {
3552 [key: string]: VariableValue;
3553 };
3554}
3555export declare enum VariableGroupActionFilter {
3556 None = 0,
3557 Manage = 2,
3558 Use = 16
3559}
3560export interface VariableGroupParameters {
3561 /**
3562 * Sets description of the variable group.
3563 */
3564 description?: string;
3565 /**
3566 * Sets name of the variable group.
3567 */
3568 name?: string;
3569 /**
3570 * Sets provider data.
3571 */
3572 providerData?: VariableGroupProviderData;
3573 /**
3574 * Sets type of the variable group.
3575 */
3576 type?: string;
3577 variableGroupProjectReferences?: VariableGroupProjectReference[];
3578 /**
3579 * Sets variables contained in the variable group.
3580 */
3581 variables?: {
3582 [key: string]: VariableValue;
3583 };
3584}
3585/**
3586 * A variable group reference is a shallow reference to variable group.
3587 */
3588export interface VariableGroupProjectReference {
3589 /**
3590 * Gets or sets description of the variable group.
3591 */
3592 description?: string;
3593 /**
3594 * Gets or sets name of the variable group.
3595 */
3596 name?: string;
3597 /**
3598 * Gets or sets project reference of the variable group.
3599 */
3600 projectReference?: ProjectReference;
3601}
3602/**
3603 * Defines provider data of the variable group.
3604 */
3605export interface VariableGroupProviderData {
3606}
3607/**
3608 * Specifies the desired ordering of variableGroups.
3609 */
3610export declare enum VariableGroupQueryOrder {
3611 /**
3612 * Order by id ascending.
3613 */
3614 IdAscending = 0,
3615 /**
3616 * Order by id descending.
3617 */
3618 IdDescending = 1
3619}
3620/**
3621 * A wrapper class for a generic variable.
3622 */
3623export interface VariableValue {
3624 /**
3625 * Indicates whether the variable can be changed during script's execution runtime.
3626 */
3627 isReadOnly?: boolean;
3628 /**
3629 * Indicates whether the variable should be encrypted at rest.
3630 */
3631 isSecret?: boolean;
3632 /**
3633 * The value of the variable.
3634 */
3635 value?: string;
3636}
3637export interface VirtualMachine {
3638 agent?: TaskAgent;
3639 id?: number;
3640 tags?: string[];
3641}
3642export interface VirtualMachineGroup extends EnvironmentResource {
3643 poolId?: number;
3644}
3645export interface VirtualMachineGroupCreateParameters {
3646 name?: string;
3647}
3648export interface VirtualMachineResource extends EnvironmentResource {
3649 agent?: TaskAgent;
3650}
3651export interface VirtualMachineResourceCreateParameters {
3652 virtualMachineResource?: VirtualMachineResource;
3653}
3654export declare var TypeInfo: {
3655 AadLoginPromptOption: {
3656 enumValues: {
3657 noOption: number;
3658 login: number;
3659 selectAccount: number;
3660 freshLogin: number;
3661 freshLoginWithMfa: number;
3662 };
3663 };
3664 AgentChangeEvent: any;
3665 AgentJobRequestMessage: any;
3666 AgentPoolEvent: any;
3667 AgentQueueEvent: any;
3668 AgentQueuesEvent: any;
3669 AuditAction: {
3670 enumValues: {
3671 add: number;
3672 update: number;
3673 delete: number;
3674 undelete: number;
3675 };
3676 };
3677 AzureKeyVaultVariableGroupProviderData: any;
3678 AzureKeyVaultVariableValue: any;
3679 DemandMinimumVersion: any;
3680 DemandSource: any;
3681 DemandSourceType: {
3682 enumValues: {
3683 task: number;
3684 feature: number;
3685 };
3686 };
3687 DeploymentGroup: any;
3688 DeploymentGroupActionFilter: {
3689 enumValues: {
3690 none: number;
3691 manage: number;
3692 use: number;
3693 };
3694 };
3695 DeploymentGroupExpands: {
3696 enumValues: {
3697 none: number;
3698 machines: number;
3699 tags: number;
3700 };
3701 };
3702 DeploymentGroupMetrics: any;
3703 DeploymentGroupReference: any;
3704 DeploymentMachine: any;
3705 DeploymentMachineChangedData: any;
3706 DeploymentMachineExpands: {
3707 enumValues: {
3708 none: number;
3709 capabilities: number;
3710 assignedRequest: number;
3711 };
3712 };
3713 DeploymentMachineGroup: any;
3714 DeploymentMachineGroupReference: any;
3715 DeploymentMachinesChangeEvent: any;
3716 DeploymentPoolSummary: any;
3717 DeploymentPoolSummaryExpands: {
3718 enumValues: {
3719 none: number;
3720 deploymentGroups: number;
3721 resource: number;
3722 };
3723 };
3724 DeploymentTargetExpands: {
3725 enumValues: {
3726 none: number;
3727 capabilities: number;
3728 assignedRequest: number;
3729 lastCompletedRequest: number;
3730 };
3731 };
3732 ElasticAgentState: {
3733 enumValues: {
3734 none: number;
3735 enabled: number;
3736 online: number;
3737 assigned: number;
3738 };
3739 };
3740 ElasticComputeState: {
3741 enumValues: {
3742 none: number;
3743 healthy: number;
3744 creating: number;
3745 deleting: number;
3746 failed: number;
3747 stopped: number;
3748 reimaging: number;
3749 unhealthyVm: number;
3750 unhealthyVmssVm: number;
3751 };
3752 };
3753 ElasticNode: any;
3754 ElasticNodeSettings: any;
3755 ElasticNodeState: {
3756 enumValues: {
3757 none: number;
3758 new: number;
3759 creatingCompute: number;
3760 startingAgent: number;
3761 idle: number;
3762 assigned: number;
3763 offline: number;
3764 pendingReimage: number;
3765 pendingDelete: number;
3766 saved: number;
3767 deletingCompute: number;
3768 deleted: number;
3769 lost: number;
3770 reimagingCompute: number;
3771 restartingAgent: number;
3772 failedToStartPendingDelete: number;
3773 failedToRestartPendingDelete: number;
3774 failedVMPendingDelete: number;
3775 assignedPendingDelete: number;
3776 retryDelete: number;
3777 unhealthyVm: number;
3778 unhealthyVmPendingDelete: number;
3779 };
3780 };
3781 ElasticPool: any;
3782 ElasticPoolCreationResult: any;
3783 ElasticPoolLog: any;
3784 ElasticPoolSettings: any;
3785 ElasticPoolState: {
3786 enumValues: {
3787 online: number;
3788 offline: number;
3789 unhealthy: number;
3790 new: number;
3791 };
3792 };
3793 EnvironmentActionFilter: {
3794 enumValues: {
3795 none: number;
3796 manage: number;
3797 use: number;
3798 };
3799 };
3800 EnvironmentDeploymentExecutionRecord: any;
3801 EnvironmentExpands: {
3802 enumValues: {
3803 none: number;
3804 resourceReferences: number;
3805 };
3806 };
3807 EnvironmentInstance: any;
3808 EnvironmentResource: any;
3809 EnvironmentResourceDeploymentExecutionRecord: any;
3810 EnvironmentResourceReference: any;
3811 EnvironmentResourceType: {
3812 enumValues: {
3813 undefined: number;
3814 generic: number;
3815 virtualMachine: number;
3816 kubernetes: number;
3817 };
3818 };
3819 ExclusiveLockType: {
3820 enumValues: {
3821 runLatest: number;
3822 sequential: number;
3823 branchRunLatest: number;
3824 parallel: number;
3825 };
3826 };
3827 Issue: any;
3828 IssueType: {
3829 enumValues: {
3830 error: number;
3831 warning: number;
3832 };
3833 };
3834 JobAssignedEvent: any;
3835 JobCompletedEvent: any;
3836 JobEnvironment: any;
3837 JobRequestMessage: any;
3838 KubernetesResource: any;
3839 LogLevel: {
3840 enumValues: {
3841 error: number;
3842 warning: number;
3843 info: number;
3844 };
3845 };
3846 MachineGroupActionFilter: {
3847 enumValues: {
3848 none: number;
3849 manage: number;
3850 use: number;
3851 };
3852 };
3853 MaskHint: any;
3854 MaskType: {
3855 enumValues: {
3856 variable: number;
3857 regex: number;
3858 };
3859 };
3860 OperatingSystemType: {
3861 enumValues: {
3862 windows: number;
3863 linux: number;
3864 };
3865 };
3866 OperationType: {
3867 enumValues: {
3868 configurationJob: number;
3869 sizingJob: number;
3870 increaseCapacity: number;
3871 reimage: number;
3872 deleteVMs: number;
3873 };
3874 };
3875 OrchestrationType: {
3876 enumValues: {
3877 uniform: number;
3878 flexible: number;
3879 };
3880 };
3881 PackageMetadata: any;
3882 PlanEnvironment: any;
3883 PlanGroupStatus: {
3884 enumValues: {
3885 running: number;
3886 queued: number;
3887 all: number;
3888 };
3889 };
3890 PlanGroupStatusFilter: {
3891 enumValues: {
3892 running: number;
3893 queued: number;
3894 all: number;
3895 };
3896 };
3897 ResourceLockRequest: any;
3898 ResourceLockStatus: {
3899 enumValues: {
3900 queued: number;
3901 inUse: number;
3902 finished: number;
3903 timedOut: number;
3904 canceled: number;
3905 abandoned: number;
3906 waitingOnChecks: number;
3907 };
3908 };
3909 ResourceUsage: any;
3910 SecureFile: any;
3911 SecureFileActionFilter: {
3912 enumValues: {
3913 none: number;
3914 manage: number;
3915 use: number;
3916 };
3917 };
3918 SecureFileEvent: any;
3919 ServerTaskRequestMessage: any;
3920 ServiceEndpointAuthenticationScheme: any;
3921 ServiceEndpointExecutionData: any;
3922 ServiceEndpointExecutionRecord: any;
3923 ServiceEndpointExecutionRecordsInput: any;
3924 ServiceEndpointRequestResult: any;
3925 ServiceEndpointType: any;
3926 TaskAgent: any;
3927 TaskAgentCloudRequest: any;
3928 TaskAgentCloudType: any;
3929 TaskAgentDowngrade: any;
3930 TaskAgentJob: any;
3931 TaskAgentJobRequest: any;
3932 TaskAgentJobResultFilter: {
3933 enumValues: {
3934 failed: number;
3935 passed: number;
3936 neverDeployed: number;
3937 all: number;
3938 };
3939 };
3940 TaskAgentJobStep: any;
3941 TaskAgentJobStepType: {
3942 enumValues: {
3943 task: number;
3944 action: number;
3945 };
3946 };
3947 TaskAgentManualUpdate: any;
3948 TaskAgentMinAgentVersionRequiredUpdate: any;
3949 TaskAgentPool: any;
3950 TaskAgentPoolActionFilter: {
3951 enumValues: {
3952 none: number;
3953 manage: number;
3954 use: number;
3955 };
3956 };
3957 TaskAgentPoolMaintenanceDefinition: any;
3958 TaskAgentPoolMaintenanceJob: any;
3959 TaskAgentPoolMaintenanceJobResult: {
3960 enumValues: {
3961 succeeded: number;
3962 failed: number;
3963 canceled: number;
3964 };
3965 };
3966 TaskAgentPoolMaintenanceJobStatus: {
3967 enumValues: {
3968 inProgress: number;
3969 completed: number;
3970 cancelling: number;
3971 queued: number;
3972 };
3973 };
3974 TaskAgentPoolMaintenanceJobTargetAgent: any;
3975 TaskAgentPoolMaintenanceSchedule: any;
3976 TaskAgentPoolMaintenanceScheduleDays: {
3977 enumValues: {
3978 none: number;
3979 monday: number;
3980 tuesday: number;
3981 wednesday: number;
3982 thursday: number;
3983 friday: number;
3984 saturday: number;
3985 sunday: number;
3986 all: number;
3987 };
3988 };
3989 TaskAgentPoolOptions: {
3990 enumValues: {
3991 none: number;
3992 elasticPool: number;
3993 singleUseAgents: number;
3994 preserveAgentOnJobFailure: number;
3995 };
3996 };
3997 TaskAgentPoolReference: any;
3998 TaskAgentPoolStatus: any;
3999 TaskAgentPoolSummary: any;
4000 TaskAgentPoolType: {
4001 enumValues: {
4002 automation: number;
4003 deployment: number;
4004 };
4005 };
4006 TaskAgentQueue: any;
4007 TaskAgentQueueActionFilter: {
4008 enumValues: {
4009 none: number;
4010 manage: number;
4011 use: number;
4012 };
4013 };
4014 TaskAgentReference: any;
4015 TaskAgentRequestUpdateOptions: {
4016 enumValues: {
4017 none: number;
4018 bumpRequestToTop: number;
4019 };
4020 };
4021 TaskAgentSession: any;
4022 TaskAgentStatus: {
4023 enumValues: {
4024 offline: number;
4025 online: number;
4026 };
4027 };
4028 TaskAgentStatusFilter: {
4029 enumValues: {
4030 offline: number;
4031 online: number;
4032 all: number;
4033 };
4034 };
4035 TaskAgentUpdate: any;
4036 TaskAgentUpdateReason: any;
4037 TaskAgentUpdateReasonType: {
4038 enumValues: {
4039 manual: number;
4040 minAgentVersionRequired: number;
4041 downgrade: number;
4042 };
4043 };
4044 TaskAttachment: any;
4045 TaskCommandMode: {
4046 enumValues: {
4047 any: number;
4048 restricted: number;
4049 };
4050 };
4051 TaskCommandRestrictions: any;
4052 TaskCompletedEvent: any;
4053 TaskDefinition: any;
4054 TaskDefinitionStatus: {
4055 enumValues: {
4056 preinstalled: number;
4057 receivedInstallOrUpdate: number;
4058 installed: number;
4059 receivedUninstall: number;
4060 uninstalled: number;
4061 requestedUpdate: number;
4062 updated: number;
4063 alreadyUpToDate: number;
4064 inlineUpdateReceived: number;
4065 };
4066 };
4067 TaskGroup: any;
4068 TaskGroupExpands: {
4069 enumValues: {
4070 none: number;
4071 tasks: number;
4072 };
4073 };
4074 TaskGroupQueryOrder: {
4075 enumValues: {
4076 createdOnAscending: number;
4077 createdOnDescending: number;
4078 };
4079 };
4080 TaskGroupRevision: any;
4081 TaskLog: any;
4082 TaskOrchestrationContainer: any;
4083 TaskOrchestrationItem: any;
4084 TaskOrchestrationItemType: {
4085 enumValues: {
4086 container: number;
4087 job: number;
4088 };
4089 };
4090 TaskOrchestrationJob: any;
4091 TaskOrchestrationPlan: any;
4092 TaskOrchestrationPlanGroup: any;
4093 TaskOrchestrationPlanGroupsQueueMetrics: any;
4094 TaskOrchestrationPlanState: {
4095 enumValues: {
4096 inProgress: number;
4097 queued: number;
4098 completed: number;
4099 throttled: number;
4100 };
4101 };
4102 TaskOrchestrationQueuedPlan: any;
4103 TaskOrchestrationQueuedPlanGroup: any;
4104 TaskRestrictions: any;
4105 TaskResult: {
4106 enumValues: {
4107 succeeded: number;
4108 succeededWithIssues: number;
4109 failed: number;
4110 canceled: number;
4111 skipped: number;
4112 abandoned: number;
4113 };
4114 };
4115 Timeline: any;
4116 TimelineRecord: any;
4117 TimelineRecordReference: any;
4118 TimelineRecordState: {
4119 enumValues: {
4120 pending: number;
4121 inProgress: number;
4122 completed: number;
4123 };
4124 };
4125 VariableGroup: any;
4126 VariableGroupActionFilter: {
4127 enumValues: {
4128 none: number;
4129 manage: number;
4130 use: number;
4131 };
4132 };
4133 VariableGroupQueryOrder: {
4134 enumValues: {
4135 idAscending: number;
4136 idDescending: number;
4137 };
4138 };
4139 VirtualMachine: any;
4140 VirtualMachineGroup: any;
4141 VirtualMachineResource: any;
4142 VirtualMachineResourceCreateParameters: any;
4143};