UNPKG

108 kBTypeScriptView Raw
1import DistributedTaskCommonInterfaces = require("../interfaces/DistributedTaskCommonInterfaces");
2import FormInputInterfaces = require("../interfaces/common/FormInputInterfaces");
3import VSSInterfaces = require("../interfaces/common/VSSInterfaces");
4export interface AgentArtifactDefinition {
5 /**
6 * Gets or sets the artifact definition alias.
7 */
8 alias?: string;
9 /**
10 * Gets or sets the artifact type.
11 */
12 artifactType?: AgentArtifactType;
13 /**
14 * Gets or sets the artifact definition details.
15 */
16 details?: string;
17 /**
18 * Gets or sets the name of artifact definition.
19 */
20 name?: string;
21 /**
22 * Gets or sets the version of artifact definition.
23 */
24 version?: string;
25}
26export declare enum AgentArtifactType {
27 /**
28 * Indicates XamlBuild artifact
29 */
30 XamlBuild = 0,
31 /**
32 * Indicates Build artifact
33 */
34 Build = 1,
35 /**
36 * Indicates Jenkins artifact
37 */
38 Jenkins = 2,
39 /**
40 * Indicates FileShare artifact
41 */
42 FileShare = 3,
43 /**
44 * Indicates Nuget artifact
45 */
46 Nuget = 4,
47 /**
48 * Indicates TfsOnPrem artifact
49 */
50 TfsOnPrem = 5,
51 /**
52 * Indicates GitHub artifact
53 */
54 GitHub = 6,
55 /**
56 * Indicates TFGit artifact
57 */
58 TFGit = 7,
59 /**
60 * Indicates ExternalTfsBuild artifact
61 */
62 ExternalTfsBuild = 8,
63 /**
64 * Indicates Custom artifact
65 */
66 Custom = 9,
67 /**
68 * Indicates Tfvc artifact
69 */
70 Tfvc = 10
71}
72export interface AgentBasedDeployPhase extends DeployPhase {
73 /**
74 * Gets and sets the agent job deployment input
75 */
76 deploymentInput?: AgentDeploymentInput;
77}
78export interface AgentDeploymentInput extends DeploymentInput {
79 /**
80 * Specification for an agent on which a job gets executed.
81 */
82 agentSpecification?: AgentSpecification;
83 /**
84 * Gets or sets the image ID.
85 */
86 imageId?: number;
87 /**
88 * Gets or sets the parallel execution input.
89 */
90 parallelExecution?: ExecutionInput;
91}
92/**
93 * Represents a reference to an agent queue.
94 */
95export interface AgentPoolQueueReference extends ResourceReference {
96 /**
97 * The ID of the queue.
98 */
99 id?: number;
100}
101/**
102 * Specification of the agent defined by the pool provider.
103 */
104export interface AgentSpecification {
105 /**
106 * Agent specification unique identifier.
107 */
108 identifier?: string;
109}
110export declare enum ApprovalExecutionOrder {
111 /**
112 * Approvals shown before gates.
113 */
114 BeforeGates = 1,
115 /**
116 * Approvals shown after successful execution of gates.
117 */
118 AfterSuccessfulGates = 2,
119 /**
120 * Approvals shown always after execution of gates.
121 */
122 AfterGatesAlways = 4
123}
124export declare enum ApprovalFilters {
125 /**
126 * No approvals or approval snapshots.
127 */
128 None = 0,
129 /**
130 * Manual approval steps but no approval snapshots (Use with ApprovalSnapshots for snapshots).
131 */
132 ManualApprovals = 1,
133 /**
134 * Automated approval steps but no approval snapshots (Use with ApprovalSnapshots for snapshots).
135 */
136 AutomatedApprovals = 2,
137 /**
138 * No approval steps, but approval snapshots (Use with either ManualApprovals or AutomatedApprovals for approval steps).
139 */
140 ApprovalSnapshots = 4,
141 /**
142 * All approval steps and approval snapshots.
143 */
144 All = 7
145}
146export interface ApprovalOptions {
147 /**
148 * Specify whether the approval can be skipped if the same approver approved the previous stage.
149 */
150 autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped?: boolean;
151 /**
152 * Specify whether revalidate identity of approver before completing the approval.
153 */
154 enforceIdentityRevalidation?: boolean;
155 /**
156 * Approvals execution order.
157 */
158 executionOrder?: ApprovalExecutionOrder;
159 /**
160 * Specify whether the user requesting a release or deployment should allow to approver.
161 */
162 releaseCreatorCanBeApprover?: boolean;
163 /**
164 * The number of approvals required to move release forward. '0' means all approvals required.
165 */
166 requiredApproverCount?: number;
167 /**
168 * Approval timeout. Approval default timeout is 30 days. Maximum allowed timeout is 365 days. '0' means default timeout i.e 30 days.
169 */
170 timeoutInMinutes?: number;
171}
172export declare enum ApprovalStatus {
173 /**
174 * Indicates the approval does not have the status set.
175 */
176 Undefined = 0,
177 /**
178 * Indicates the approval is pending.
179 */
180 Pending = 1,
181 /**
182 * Indicates the approval is approved.
183 */
184 Approved = 2,
185 /**
186 * Indicates the approval is rejected.
187 */
188 Rejected = 4,
189 /**
190 * Indicates the approval is reassigned.
191 */
192 Reassigned = 6,
193 /**
194 * Indicates the approval is canceled.
195 */
196 Canceled = 7,
197 /**
198 * Indicates the approval is skipped.
199 */
200 Skipped = 8
201}
202export declare enum ApprovalType {
203 /**
204 * Indicates the approval type does not set.
205 */
206 Undefined = 0,
207 /**
208 * Indicates the approvals which executed before deployment.
209 */
210 PreDeploy = 1,
211 /**
212 * Indicates the approvals which executed after deployment.
213 */
214 PostDeploy = 2,
215 /**
216 * Indicates all approvals.
217 */
218 All = 3
219}
220export interface Artifact {
221 /**
222 * Gets or sets alias.
223 */
224 alias?: string;
225 /**
226 * Gets or sets definition reference. e.g. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}.
227 */
228 definitionReference?: {
229 [key: string]: ArtifactSourceReference;
230 };
231 /**
232 * Indicates whether artifact is primary or not.
233 */
234 isPrimary?: boolean;
235 /**
236 * Indicates whether artifact is retained by release or not.
237 */
238 isRetained?: boolean;
239 sourceId?: string;
240 /**
241 * Gets or sets type. It can have value as 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (external)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'.
242 */
243 type?: string;
244}
245export interface ArtifactContributionDefinition {
246 artifactTriggerConfiguration?: ArtifactTriggerConfiguration;
247 artifactType?: string;
248 artifactTypeStreamMapping?: {
249 [key: string]: string;
250 };
251 browsableArtifactTypeMapping?: {
252 [key: string]: string;
253 };
254 dataSourceBindings?: DataSourceBinding[];
255 displayName?: string;
256 downloadTaskId?: string;
257 endpointTypeId?: string;
258 inputDescriptors?: FormInputInterfaces.InputDescriptor[];
259 isCommitsTraceabilitySupported?: boolean;
260 isWorkitemsTraceabilitySupported?: boolean;
261 name?: string;
262 taskInputMapping?: {
263 [key: string]: string;
264 };
265 uniqueSourceIdentifier?: string;
266}
267export interface ArtifactDownloadInputBase {
268 /**
269 * Gets or sets the alias of artifact.
270 */
271 alias?: string;
272 /**
273 * Gets or sets the name of artifact definition. Valid values are 'Skip', 'Selective', 'All'.
274 */
275 artifactDownloadMode?: string;
276 /**
277 * Gets or sets the artifact items of the input.
278 */
279 artifactItems?: string[];
280 /**
281 * Gets or sets the type of artifact.
282 */
283 artifactType?: string;
284}
285export interface ArtifactFilter {
286 /**
287 * Gets or sets whether a release should be created on build tagging.
288 */
289 createReleaseOnBuildTagging?: boolean;
290 /**
291 * Gets or sets the branch for the filter.
292 */
293 sourceBranch?: string;
294 /**
295 * Gets or sets the regex based tag filter.
296 */
297 tagFilter?: TagFilter;
298 /**
299 * Gets or sets the list of tags for the filter.
300 */
301 tags?: string[];
302 /**
303 * Gets or sets whether filter should default to build definition branch.
304 */
305 useBuildDefinitionBranch?: boolean;
306}
307export interface ArtifactInstanceData {
308 accountName?: string;
309 authenticationToken?: string;
310 tfsUrl?: string;
311 version?: string;
312}
313export interface ArtifactMetadata {
314 /**
315 * Sets alias of artifact.
316 */
317 alias?: string;
318 /**
319 * Sets instance reference of artifact. e.g. for build artifact it is build number.
320 */
321 instanceReference?: BuildVersion;
322}
323export interface ArtifactProvider {
324 /**
325 * Gets or sets the id of artifact provider.
326 */
327 id?: number;
328 /**
329 * Gets or sets the name of artifact provider.
330 */
331 name?: string;
332 /**
333 * Gets or sets the link of artifact provider.
334 */
335 sourceUri?: string;
336 /**
337 * Gets or sets the version of artifact provider.
338 */
339 version?: string;
340}
341export interface ArtifactsDownloadInput {
342 downloadInputs?: ArtifactDownloadInputBase[];
343}
344export interface ArtifactSourceId {
345 /**
346 * Gets or sets the artifact type of artifact source.
347 */
348 artifactTypeId?: string;
349 /**
350 * Gets or sets the list of sourceIdInput of artifact source.
351 */
352 sourceIdInputs?: SourceIdInput[];
353}
354export interface ArtifactSourceIdsQueryResult {
355 /**
356 * Gets or sets the list of artifactsourceIds.
357 */
358 artifactSourceIds?: ArtifactSourceId[];
359}
360export interface ArtifactSourceReference {
361 /**
362 * ID of the artifact source.
363 */
364 id?: string;
365 /**
366 * Name of the artifact source.
367 */
368 name?: string;
369}
370export interface ArtifactSourceTrigger extends ReleaseTriggerBase {
371 /**
372 * Artifact source alias for Artifact Source trigger type
373 */
374 artifactAlias?: string;
375 triggerConditions?: ArtifactFilter[];
376}
377export interface ArtifactTriggerConfiguration {
378 /**
379 * Gets or sets the whether trigger is supported or not.
380 */
381 isTriggerSupported?: boolean;
382 /**
383 * Gets or sets the whether trigger is supported only on hosted environment.
384 */
385 isTriggerSupportedOnlyInHosted?: boolean;
386 /**
387 * Gets or sets the whether webhook is supported at server level.
388 */
389 isWebhookSupportedAtServerLevel?: boolean;
390 /**
391 * Gets or sets the payload hash header name for the artifact trigger configuration.
392 */
393 payloadHashHeaderName?: string;
394 /**
395 * Gets or sets the resources for artifact trigger configuration.
396 */
397 resources?: {
398 [key: string]: string;
399 };
400 /**
401 * Gets or sets the webhook payload mapping for artifact trigger configuration.
402 */
403 webhookPayloadMapping?: {
404 [key: string]: string;
405 };
406}
407export interface ArtifactTypeDefinition {
408 /**
409 * Gets or sets the artifact trigger configuration of artifact type definition.
410 */
411 artifactTriggerConfiguration?: ArtifactTriggerConfiguration;
412 /**
413 * Gets or sets the artifact type of artifact type definition. Valid values are 'Build', 'Package', 'Source' or 'ContainerImage'.
414 */
415 artifactType?: string;
416 /**
417 * Gets or sets the display name of artifact type definition.
418 */
419 displayName?: string;
420 /**
421 * Gets or sets the endpoint type id of artifact type definition.
422 */
423 endpointTypeId?: string;
424 /**
425 * Gets or sets the input descriptors of artifact type definition.
426 */
427 inputDescriptors?: FormInputInterfaces.InputDescriptor[];
428 /**
429 * Gets or sets the is commits tracebility supported value of artifact type defintion.
430 */
431 isCommitsTraceabilitySupported?: boolean;
432 /**
433 * Gets or sets the is workitems tracebility supported value of artifact type defintion.
434 */
435 isWorkitemsTraceabilitySupported?: boolean;
436 /**
437 * Gets or sets the name of artifact type definition.
438 */
439 name?: string;
440 /**
441 * Gets or sets the unique source identifier of artifact type definition.
442 */
443 uniqueSourceIdentifier?: string;
444}
445export interface ArtifactVersion {
446 /**
447 * Gets or sets the alias of artifact.
448 */
449 alias?: string;
450 /**
451 * Gets or sets the default version of artifact.
452 */
453 defaultVersion?: BuildVersion;
454 /**
455 * Gets or sets the error message encountered during querying of versions for artifact.
456 */
457 errorMessage?: string;
458 sourceId?: string;
459 /**
460 * Gets or sets the list of build versions of artifact.
461 */
462 versions?: BuildVersion[];
463}
464export interface ArtifactVersionQueryResult {
465 /**
466 * Gets or sets the list for artifact versions of artifact version query result.
467 */
468 artifactVersions?: ArtifactVersion[];
469}
470export declare enum AuditAction {
471 /**
472 * Indicates the audit add.
473 */
474 Add = 1,
475 /**
476 * Indicates the audit update.
477 */
478 Update = 2,
479 /**
480 * Indicates the audit delete.
481 */
482 Delete = 3,
483 /**
484 * Indicates the audit undelete.
485 */
486 Undelete = 4
487}
488export declare enum AuthorizationHeaderFor {
489 RevalidateApproverIdentity = 0,
490 OnBehalfOf = 1
491}
492export interface AutoTriggerIssue {
493 issue?: Issue;
494 issueSource?: IssueSource;
495 project?: ProjectReference;
496 releaseDefinitionReference?: ReleaseDefinitionShallowReference;
497 releaseTriggerType?: ReleaseTriggerType;
498}
499export interface AzureKeyVaultVariableGroupProviderData extends VariableGroupProviderData {
500 /**
501 * Gets or sets last refreshed time.
502 */
503 lastRefreshedOn?: Date;
504 /**
505 * Gets or sets the service endpoint ID.
506 */
507 serviceEndpointId?: string;
508 /**
509 * Gets or sets the vault name.
510 */
511 vault?: string;
512}
513export interface AzureKeyVaultVariableValue extends VariableValue {
514 /**
515 * Gets or sets the content type of key vault variable value.
516 */
517 contentType?: string;
518 /**
519 * Indicates the vault variable value enabled or not.
520 */
521 enabled?: boolean;
522 /**
523 * Gets or sets the expire time of key vault variable value.
524 */
525 expires?: Date;
526}
527export interface BaseDeploymentInput {
528 /**
529 * Gets or sets the job condition.
530 */
531 condition?: string;
532 /**
533 * Gets or sets the job cancel timeout in minutes for deployment which are cancelled by user for this release environment.
534 */
535 jobCancelTimeoutInMinutes?: number;
536 /**
537 * Gets or sets the override inputs.
538 */
539 overrideInputs?: {
540 [key: string]: string;
541 };
542 /**
543 * Gets or sets the job execution timeout in minutes for deployment which are queued against this release environment.
544 */
545 timeoutInMinutes?: number;
546}
547export interface BuildArtifactDownloadInput extends ArtifactDownloadInputBase {
548}
549export interface BuildVersion {
550 /**
551 * Gets or sets the commit message for the artifact.
552 */
553 commitMessage?: string;
554 /**
555 * Gets or sets the definition id.
556 */
557 definitionId?: string;
558 /**
559 * Gets or sets the definition name.
560 */
561 definitionName?: string;
562 /**
563 * Gets or sets the build id.
564 */
565 id?: string;
566 /**
567 * Gets or sets if the artifact supports multiple definitions.
568 */
569 isMultiDefinitionType?: boolean;
570 /**
571 * Gets or sets the build number.
572 */
573 name?: string;
574 /**
575 * Gets or sets the source branch for the artifact.
576 */
577 sourceBranch?: string;
578 /**
579 * Gets or sets the source pull request version for the artifact.
580 */
581 sourcePullRequestVersion?: SourcePullRequestVersion;
582 /**
583 * Gets or sets the repository id for the artifact.
584 */
585 sourceRepositoryId?: string;
586 /**
587 * Gets or sets the repository type for the artifact.
588 */
589 sourceRepositoryType?: string;
590 /**
591 * Gets or sets the source version for the artifact.
592 */
593 sourceVersion?: string;
594}
595/**
596 * Represents a change associated with a build.
597 */
598export interface Change {
599 /**
600 * The author of the change.
601 */
602 author?: VSSInterfaces.IdentityRef;
603 /**
604 * The type of source. "TfsVersionControl", "TfsGit", etc.
605 */
606 changeType?: string;
607 /**
608 * The location of a user-friendly representation of the resource.
609 */
610 displayUri?: string;
611 /**
612 * Something that identifies the change. For a commit, this would be the SHA1. For a TFVC changeset, this would be the changeset id.
613 */
614 id?: string;
615 /**
616 * The location of the full representation of the resource.
617 */
618 location?: string;
619 /**
620 * A description of the change. This might be a commit message or changeset description.
621 */
622 message?: string;
623 /**
624 * The person or process that pushed the change.
625 */
626 pushedBy?: VSSInterfaces.IdentityRef;
627 /**
628 * The person or process that pushed the change.
629 */
630 pusher?: string;
631 /**
632 * A timestamp for the change.
633 */
634 timestamp?: Date;
635}
636export interface CheckConfigurationReference {
637 /**
638 * Check configuration Id of generated gate.
639 */
640 id?: number;
641 /**
642 * Name of the resource for which gate was generated.
643 */
644 resourceName?: string;
645 /**
646 * Type of the resource for which the gate was generated.
647 */
648 resourceType?: string;
649 /**
650 * Version of the check configuration gate was generated with.
651 */
652 version?: number;
653}
654export interface CodeRepositoryReference {
655 /**
656 * Gets and sets the repository references.
657 */
658 repositoryReference?: {
659 [key: string]: ReleaseManagementInputValue;
660 };
661 /**
662 * It can have value as ‘GitHub’, ‘Vsts’.
663 */
664 systemType?: PullRequestSystemType;
665}
666export interface ComplianceSettings {
667 /**
668 * Scan the release definition for secrets
669 */
670 checkForCredentialsAndOtherSecrets?: boolean;
671}
672export interface Condition {
673 /**
674 * Gets or sets the condition type.
675 */
676 conditionType?: ConditionType;
677 /**
678 * Gets or sets the name of the condition. e.g. 'ReleaseStarted'.
679 */
680 name?: string;
681 /**
682 * The release condition result.
683 */
684 result?: boolean;
685 /**
686 * Gets or set value of the condition.
687 */
688 value?: string;
689}
690export declare enum ConditionType {
691 /**
692 * The condition type is undefined.
693 */
694 Undefined = 0,
695 /**
696 * The condition type is event.
697 */
698 Event = 1,
699 /**
700 * The condition type is environment state.
701 */
702 EnvironmentState = 2,
703 /**
704 * The condition type is artifact.
705 */
706 Artifact = 4
707}
708export interface ConfigurationVariableValue {
709 /**
710 * Gets and sets if a variable can be overridden at deployment time or not.
711 */
712 allowOverride?: boolean;
713 /**
714 * Gets or sets as variable is secret or not.
715 */
716 isSecret?: boolean;
717 /**
718 * Gets and sets value of the configuration variable.
719 */
720 value?: string;
721}
722export interface Consumer {
723 /**
724 * ID of the consumer.
725 */
726 consumerId?: number;
727 /**
728 * Name of the consumer.
729 */
730 consumerName?: string;
731}
732export interface ContainerImageTrigger extends ReleaseTriggerBase {
733 /**
734 * Alias of the trigger.
735 */
736 alias?: string;
737 /**
738 * List tag filters applied while trigger.
739 */
740 tagFilters?: TagFilter[];
741}
742export interface ContinuousDeploymentTriggerIssue extends AutoTriggerIssue {
743 /**
744 * Artifact type.
745 */
746 artifactType?: string;
747 /**
748 * ArtifactVersion ID.
749 */
750 artifactVersionId?: string;
751 /**
752 * Artifact source ID.
753 */
754 sourceId?: string;
755}
756export interface ControlOptions {
757 /**
758 * Always run the job.
759 */
760 alwaysRun?: boolean;
761 /**
762 * Indicates whether to continue job on error or not.
763 */
764 continueOnError?: boolean;
765 /**
766 * Indicates the job enabled or not.
767 */
768 enabled?: boolean;
769}
770export interface CustomArtifactDownloadInput extends ArtifactDownloadInputBase {
771}
772export interface DataSourceBinding {
773 /**
774 * Pagination format supported by this data source(ContinuationToken/SkipTop).
775 */
776 callbackContextTemplate?: string;
777 /**
778 * Subsequent calls needed?
779 */
780 callBackRequiredTemplate?: string;
781 /**
782 * Name of the datasource.
783 */
784 dataSourceName?: string;
785 /**
786 * Endpoint ID of the datasource.
787 */
788 endpointId?: string;
789 /**
790 * Endpoint URL of the datasource.
791 */
792 endpointUrl?: string;
793 /**
794 * Defines the initial value of the query params
795 */
796 initialContextTemplate?: string;
797 /**
798 * Parameters of the datasource.
799 */
800 parameters?: {
801 [key: string]: string;
802 };
803 /**
804 * Gets or sets http request body
805 */
806 requestContent?: string;
807 /**
808 * Gets or sets http request verb
809 */
810 requestVerb?: string;
811 /**
812 * Result selector applied on output of datasource result, for example jsonpath:$.value[?(@.properties.isEnabled == true)].
813 */
814 resultSelector?: string;
815 /**
816 * Format of the return results, for example. { "Value" : "{{{id}}}", "DisplayValue" : "{{{name}}}" }.
817 */
818 resultTemplate?: string;
819 /**
820 * Target of the datasource.
821 */
822 target?: string;
823}
824export interface DefinitionEnvironmentReference {
825 /**
826 * Definition environment ID.
827 */
828 definitionEnvironmentId?: number;
829 /**
830 * Definition environment name.
831 */
832 definitionEnvironmentName?: string;
833 /**
834 * ReleaseDefinition ID.
835 */
836 releaseDefinitionId?: number;
837 /**
838 * ReleaseDefinition name.
839 */
840 releaseDefinitionName?: string;
841}
842export interface Demand {
843 /**
844 * Gets and sets the name of demand.
845 */
846 name?: string;
847 /**
848 * Gets and sets the value of demand.
849 */
850 value?: string;
851}
852export interface Deployment {
853 /**
854 * Gets links to access the deployment.
855 */
856 _links?: any;
857 /**
858 * Gets attempt number.
859 */
860 attempt?: number;
861 /**
862 * Gets the date on which deployment is complete.
863 */
864 completedOn?: Date;
865 /**
866 * Gets the list of condition associated with deployment.
867 */
868 conditions?: Condition[];
869 /**
870 * Gets release definition environment id.
871 */
872 definitionEnvironmentId?: number;
873 /**
874 * Gets status of the deployment.
875 */
876 deploymentStatus?: DeploymentStatus;
877 /**
878 * Gets the unique identifier for deployment.
879 */
880 id?: number;
881 /**
882 * Gets the identity who last modified the deployment.
883 */
884 lastModifiedBy?: VSSInterfaces.IdentityRef;
885 /**
886 * Gets the date on which deployment is last modified.
887 */
888 lastModifiedOn?: Date;
889 /**
890 * Gets operation status of deployment.
891 */
892 operationStatus?: DeploymentOperationStatus;
893 /**
894 * Gets list of PostDeployApprovals.
895 */
896 postDeployApprovals?: ReleaseApproval[];
897 /**
898 * Gets list of PreDeployApprovals.
899 */
900 preDeployApprovals?: ReleaseApproval[];
901 /**
902 * Gets or sets project reference.
903 */
904 projectReference?: ProjectReference;
905 /**
906 * Gets the date on which deployment is queued.
907 */
908 queuedOn?: Date;
909 /**
910 * Gets reason of deployment.
911 */
912 reason?: DeploymentReason;
913 /**
914 * Gets the reference of release.
915 */
916 release?: ReleaseReference;
917 /**
918 * Gets releaseDefinitionReference which specifies the reference of the release definition to which the deployment is associated.
919 */
920 releaseDefinition?: ReleaseDefinitionShallowReference;
921 /**
922 * Gets releaseEnvironmentReference which specifies the reference of the release environment to which the deployment is associated.
923 */
924 releaseEnvironment?: ReleaseEnvironmentShallowReference;
925 /**
926 * Gets the identity who requested.
927 */
928 requestedBy?: VSSInterfaces.IdentityRef;
929 /**
930 * Gets the identity for whom deployment is requested.
931 */
932 requestedFor?: VSSInterfaces.IdentityRef;
933 /**
934 * Gets the date on which deployment is scheduled.
935 */
936 scheduledDeploymentTime?: Date;
937 /**
938 * Gets the date on which deployment is started.
939 */
940 startedOn?: Date;
941}
942export interface DeploymentApprovalCompletedEvent extends DeploymentEvent {
943 approval?: ReleaseApproval;
944 project?: ProjectReference;
945 release?: Release;
946}
947export interface DeploymentApprovalPendingEvent extends DeploymentEvent {
948 approval?: ReleaseApproval;
949 approvalOptions?: ApprovalOptions;
950 completedApprovals?: ReleaseApproval[];
951 data?: {
952 [key: string]: any;
953 };
954 deployment?: Deployment;
955 isMultipleRankApproval?: boolean;
956 pendingApprovals?: ReleaseApproval[];
957 project?: ProjectReference;
958 release?: Release;
959}
960export interface DeploymentAttempt {
961 /**
962 * Deployment attempt.
963 */
964 attempt?: number;
965 /**
966 * ID of the deployment.
967 */
968 deploymentId?: number;
969 /**
970 * Error log to show any unexpected error that occurred during executing deploy step
971 */
972 errorLog?: string;
973 /**
974 * Specifies whether deployment has started or not.
975 */
976 hasStarted?: boolean;
977 /**
978 * ID of deployment.
979 */
980 id?: number;
981 /**
982 * All the issues related to the deployment.
983 */
984 issues?: Issue[];
985 job?: ReleaseTask;
986 /**
987 * Identity who last modified this deployment.
988 */
989 lastModifiedBy?: VSSInterfaces.IdentityRef;
990 /**
991 * Time when this deployment last modified.
992 */
993 lastModifiedOn?: Date;
994 /**
995 * Deployment operation status.
996 */
997 operationStatus?: DeploymentOperationStatus;
998 /**
999 * Post deployment gates that executed in this deployment.
1000 */
1001 postDeploymentGates?: ReleaseGates;
1002 /**
1003 * Pre deployment gates that executed in this deployment.
1004 */
1005 preDeploymentGates?: ReleaseGates;
1006 /**
1007 * When this deployment queued on.
1008 */
1009 queuedOn?: Date;
1010 /**
1011 * Reason for the deployment.
1012 */
1013 reason?: DeploymentReason;
1014 /**
1015 * List of release deployphases executed in this deployment.
1016 */
1017 releaseDeployPhases?: ReleaseDeployPhase[];
1018 /**
1019 * Identity who requested this deployment.
1020 */
1021 requestedBy?: VSSInterfaces.IdentityRef;
1022 /**
1023 * Identity for this deployment requested.
1024 */
1025 requestedFor?: VSSInterfaces.IdentityRef;
1026 runPlanId?: string;
1027 /**
1028 * status of the deployment.
1029 */
1030 status?: DeploymentStatus;
1031 tasks?: ReleaseTask[];
1032}
1033export interface DeploymentAuthorizationInfo {
1034 /**
1035 * Authorization header type, typically either RevalidateApproverIdentity or OnBehalfOf.
1036 */
1037 authorizationHeaderFor?: AuthorizationHeaderFor;
1038 /**
1039 * List of resources.
1040 */
1041 resources?: string[];
1042 /**
1043 * ID of the tenant.
1044 */
1045 tenantId?: string;
1046 /**
1047 * Access token key.
1048 */
1049 vstsAccessTokenKey?: string;
1050}
1051export declare enum DeploymentAuthorizationOwner {
1052 Automatic = 0,
1053 DeploymentSubmitter = 1,
1054 FirstPreDeploymentApprover = 2
1055}
1056export interface DeploymentCompletedEvent extends DeploymentEvent {
1057 comment?: string;
1058 data?: {
1059 [key: string]: any;
1060 };
1061 deployment?: Deployment;
1062 environment?: ReleaseEnvironment;
1063 project?: ProjectReference;
1064}
1065export interface DeploymentEvent extends ReleaseEvent {
1066 attemptId?: number;
1067 stageName?: string;
1068}
1069export declare enum DeploymentExpands {
1070 All = 0,
1071 DeploymentOnly = 1,
1072 Approvals = 2,
1073 Artifacts = 4
1074}
1075export interface DeploymentInput extends BaseDeploymentInput {
1076 /**
1077 * Artifacts that downloaded during job execution.
1078 */
1079 artifactsDownloadInput?: ArtifactsDownloadInput;
1080 /**
1081 * List demands that needs to meet to execute the job.
1082 */
1083 demands?: Demand[];
1084 /**
1085 * Indicates whether to include access token in deployment job or not.
1086 */
1087 enableAccessToken?: boolean;
1088 /**
1089 * Id of the pool on which job get executed.
1090 */
1091 queueId?: number;
1092 /**
1093 * Indicates whether artifacts downloaded while job execution or not.
1094 */
1095 skipArtifactsDownload?: boolean;
1096}
1097export interface DeploymentJob {
1098 /**
1099 * Parent task of all executed tasks.
1100 */
1101 job?: ReleaseTask;
1102 /**
1103 * List of executed tasks with in job.
1104 */
1105 tasks?: ReleaseTask[];
1106}
1107export interface DeploymentManualInterventionPendingEvent {
1108 approval?: ReleaseApproval;
1109 deployment?: Deployment;
1110 emailRecipients?: string[];
1111 environmentOwner?: VSSInterfaces.IdentityRef;
1112 manualIntervention?: ManualIntervention;
1113 project?: ProjectReference;
1114 release?: Release;
1115}
1116export declare enum DeploymentOperationStatus {
1117 /**
1118 * The deployment operation status is undefined.
1119 */
1120 Undefined = 0,
1121 /**
1122 * The deployment operation status is queued.
1123 */
1124 Queued = 1,
1125 /**
1126 * The deployment operation status is scheduled.
1127 */
1128 Scheduled = 2,
1129 /**
1130 * The deployment operation status is pending.
1131 */
1132 Pending = 4,
1133 /**
1134 * The deployment operation status is approved.
1135 */
1136 Approved = 8,
1137 /**
1138 * The deployment operation status is rejected.
1139 */
1140 Rejected = 16,
1141 /**
1142 * The deployment operation status is deferred.
1143 */
1144 Deferred = 32,
1145 /**
1146 * The deployment operation status is queued for agent.
1147 */
1148 QueuedForAgent = 64,
1149 /**
1150 * The deployment operation status is phase in progress.
1151 */
1152 PhaseInProgress = 128,
1153 /**
1154 * The deployment operation status is phase succeeded.
1155 */
1156 PhaseSucceeded = 256,
1157 /**
1158 * The deployment operation status is phase partially succeeded.
1159 */
1160 PhasePartiallySucceeded = 512,
1161 /**
1162 * The deployment operation status is phase failed.
1163 */
1164 PhaseFailed = 1024,
1165 /**
1166 * The deployment operation status is canceled.
1167 */
1168 Canceled = 2048,
1169 /**
1170 * The deployment operation status is phase canceled.
1171 */
1172 PhaseCanceled = 4096,
1173 /**
1174 * The deployment operation status is manualintervention pending.
1175 */
1176 ManualInterventionPending = 8192,
1177 /**
1178 * The deployment operation status is queued for pipeline.
1179 */
1180 QueuedForPipeline = 16384,
1181 /**
1182 * The deployment operation status is cancelling.
1183 */
1184 Cancelling = 32768,
1185 /**
1186 * The deployment operation status is EvaluatingGates.
1187 */
1188 EvaluatingGates = 65536,
1189 /**
1190 * The deployment operation status is GateFailed.
1191 */
1192 GateFailed = 131072,
1193 /**
1194 * The deployment operation status is all.
1195 */
1196 All = 258047
1197}
1198export interface DeploymentQueryParameters {
1199 /**
1200 * Query deployments based specified artifact source id.
1201 */
1202 artifactSourceId?: string;
1203 /**
1204 * Query deployments based specified artifact type id.
1205 */
1206 artifactTypeId?: string;
1207 /**
1208 * Query deployments based specified artifact versions.
1209 */
1210 artifactVersions?: string[];
1211 /**
1212 * Query deployments number of deployments per environment.
1213 */
1214 deploymentsPerEnvironment?: number;
1215 /**
1216 * Query deployment based on deployment status.
1217 */
1218 deploymentStatus?: DeploymentStatus;
1219 /**
1220 * Query deployments of specified environments.
1221 */
1222 environments?: DefinitionEnvironmentReference[];
1223 /**
1224 * Query deployments based specified expands.
1225 */
1226 expands?: DeploymentExpands;
1227 /**
1228 * Specify deleted deployments should return or not.
1229 */
1230 isDeleted?: boolean;
1231 latestDeploymentsOnly?: boolean;
1232 maxDeploymentsPerEnvironment?: number;
1233 maxModifiedTime?: Date;
1234 minModifiedTime?: Date;
1235 /**
1236 * Query deployment based on deployment operation status.
1237 */
1238 operationStatus?: DeploymentOperationStatus;
1239 queryOrder?: ReleaseQueryOrder;
1240 /**
1241 * Query deployments based query type.
1242 */
1243 queryType?: DeploymentsQueryType;
1244 /**
1245 * Query deployments based specified source branch.
1246 */
1247 sourceBranch?: string;
1248}
1249export declare enum DeploymentReason {
1250 /**
1251 * The deployment reason is none.
1252 */
1253 None = 0,
1254 /**
1255 * The deployment reason is manual.
1256 */
1257 Manual = 1,
1258 /**
1259 * The deployment reason is automated.
1260 */
1261 Automated = 2,
1262 /**
1263 * The deployment reason is scheduled.
1264 */
1265 Scheduled = 4,
1266 /**
1267 * The deployment reason is RedeployTrigger.
1268 */
1269 RedeployTrigger = 8
1270}
1271export declare enum DeploymentsQueryType {
1272 Regular = 1,
1273 FailingSince = 2
1274}
1275export interface DeploymentStartedEvent extends DeploymentEvent {
1276 environment?: ReleaseEnvironment;
1277 project?: ProjectReference;
1278 release?: Release;
1279}
1280export declare enum DeploymentStatus {
1281 /**
1282 * The deployment status is undefined.
1283 */
1284 Undefined = 0,
1285 /**
1286 * The deployment status is not deployed.
1287 */
1288 NotDeployed = 1,
1289 /**
1290 * The deployment status is in progress.
1291 */
1292 InProgress = 2,
1293 /**
1294 * The deployment status is succeeded.
1295 */
1296 Succeeded = 4,
1297 /**
1298 * The deployment status is partiallysucceeded.
1299 */
1300 PartiallySucceeded = 8,
1301 /**
1302 * The deployment status is failed.
1303 */
1304 Failed = 16,
1305 /**
1306 * The deployment status is all.
1307 */
1308 All = 31
1309}
1310export interface DeployPhase {
1311 /**
1312 * Gets and sets the name of deploy phase.
1313 */
1314 name?: string;
1315 /**
1316 * Indicates the deploy phase type.
1317 */
1318 phaseType?: DeployPhaseTypes;
1319 /**
1320 * Gets and sets the rank of deploy phase.
1321 */
1322 rank?: number;
1323 /**
1324 * Gets and sets the reference name of deploy phase.
1325 */
1326 refName?: string;
1327 /**
1328 * Gets and sets the workflow tasks for the deploy phase.
1329 */
1330 workflowTasks?: WorkflowTask[];
1331}
1332export declare enum DeployPhaseStatus {
1333 /**
1334 * Phase status not set.
1335 */
1336 Undefined = 0,
1337 /**
1338 * Phase execution not started.
1339 */
1340 NotStarted = 1,
1341 /**
1342 * Phase execution in progress.
1343 */
1344 InProgress = 2,
1345 /**
1346 * Phase execution partially succeeded.
1347 */
1348 PartiallySucceeded = 4,
1349 /**
1350 * Phase execution succeeded.
1351 */
1352 Succeeded = 8,
1353 /**
1354 * Phase execution failed.
1355 */
1356 Failed = 16,
1357 /**
1358 * Phase execution canceled.
1359 */
1360 Canceled = 32,
1361 /**
1362 * Phase execution skipped.
1363 */
1364 Skipped = 64,
1365 /**
1366 * Phase is in cancelling state.
1367 */
1368 Cancelling = 128
1369}
1370export declare enum DeployPhaseTypes {
1371 /**
1372 * Phase type not defined. Don't use this.
1373 */
1374 Undefined = 0,
1375 /**
1376 * Phase type which contains tasks executed on agent.
1377 */
1378 AgentBasedDeployment = 1,
1379 /**
1380 * Phase type which contains tasks executed by server.
1381 */
1382 RunOnServer = 2,
1383 /**
1384 * Phase type which contains tasks executed on deployment group machines.
1385 */
1386 MachineGroupBasedDeployment = 4,
1387 /**
1388 * Phase type which contains tasks which acts as Gates for the deployment to go forward.
1389 */
1390 DeploymentGates = 8
1391}
1392export interface EmailRecipients {
1393 /**
1394 * List of email addresses.
1395 */
1396 emailAddresses?: string[];
1397 /**
1398 * List of TFS IDs guids.
1399 */
1400 tfsIds?: string[];
1401}
1402/**
1403 * Defines policy on environment queuing at Release Management side queue. We will send to Environment Runner [creating pre-deploy and other steps] only when the policies mentioned are satisfied.
1404 */
1405export interface EnvironmentExecutionPolicy {
1406 /**
1407 * This policy decides, how many environments would be with Environment Runner.
1408 */
1409 concurrencyCount?: number;
1410 /**
1411 * Queue depth in the EnvironmentQueue table, this table keeps the environment entries till Environment Runner is free [as per it's policy] to take another environment for running.
1412 */
1413 queueDepthCount?: number;
1414}
1415export interface EnvironmentOptions {
1416 /**
1417 * Gets and sets as the auto link workitems or not.
1418 */
1419 autoLinkWorkItems?: boolean;
1420 /**
1421 * Gets and sets as the badge enabled or not.
1422 */
1423 badgeEnabled?: boolean;
1424 emailNotificationType?: string;
1425 emailRecipients?: string;
1426 enableAccessToken?: boolean;
1427 /**
1428 * Gets and sets as the publish deployment status or not.
1429 */
1430 publishDeploymentStatus?: boolean;
1431 /**
1432 * Gets and sets as the.pull request deployment enabled or not.
1433 */
1434 pullRequestDeploymentEnabled?: boolean;
1435 skipArtifactsDownload?: boolean;
1436 timeoutInMinutes?: number;
1437}
1438export interface EnvironmentRetentionPolicy {
1439 /**
1440 * Gets and sets the number of days to keep environment.
1441 */
1442 daysToKeep?: number;
1443 /**
1444 * Gets and sets the number of releases to keep.
1445 */
1446 releasesToKeep?: number;
1447 /**
1448 * Gets and sets as the build to be retained or not.
1449 */
1450 retainBuild?: boolean;
1451}
1452export declare enum EnvironmentStatus {
1453 /**
1454 * Environment status not set.
1455 */
1456 Undefined = 0,
1457 /**
1458 * Environment is in not started state.
1459 */
1460 NotStarted = 1,
1461 /**
1462 * Environment is in progress state.
1463 */
1464 InProgress = 2,
1465 /**
1466 * Environment is in succeeded state.
1467 */
1468 Succeeded = 4,
1469 /**
1470 * Environment is in canceled state.
1471 */
1472 Canceled = 8,
1473 /**
1474 * Environment is in rejected state.
1475 */
1476 Rejected = 16,
1477 /**
1478 * Environment is in queued state.
1479 */
1480 Queued = 32,
1481 /**
1482 * Environment is in scheduled state.
1483 */
1484 Scheduled = 64,
1485 /**
1486 * Environment is in partially succeeded state.
1487 */
1488 PartiallySucceeded = 128
1489}
1490export interface EnvironmentTrigger {
1491 /**
1492 * Definition environment ID on which this trigger applicable.
1493 */
1494 definitionEnvironmentId?: number;
1495 /**
1496 * ReleaseDefinition ID on which this trigger applicable.
1497 */
1498 releaseDefinitionId?: number;
1499 /**
1500 * Gets or sets the trigger content.
1501 */
1502 triggerContent?: string;
1503 /**
1504 * Gets or sets the trigger type.
1505 */
1506 triggerType?: EnvironmentTriggerType;
1507}
1508export interface EnvironmentTriggerContent {
1509 /**
1510 * Gets or sets action.
1511 */
1512 action?: string;
1513 /**
1514 * Gets or sets list of event types.
1515 */
1516 eventTypes?: string[];
1517}
1518export declare enum EnvironmentTriggerType {
1519 /**
1520 * Environment trigger type undefined.
1521 */
1522 Undefined = 0,
1523 /**
1524 * Environment trigger type is deployment group redeploy.
1525 */
1526 DeploymentGroupRedeploy = 1,
1527 /**
1528 * Environment trigger type is Rollback.
1529 */
1530 RollbackRedeploy = 2
1531}
1532export interface ExecutionInput {
1533 /**
1534 * Parallel execution type, for example MultiConfiguration or MultiMachine.
1535 */
1536 parallelExecutionType?: ParallelExecutionTypes;
1537}
1538/**
1539 * Class to represent favorite entry.
1540 */
1541export interface FavoriteItem {
1542 /**
1543 * Application specific data for the entry.
1544 */
1545 data?: string;
1546 /**
1547 * Unique Id of the entry.
1548 */
1549 id?: string;
1550 /**
1551 * Display text for favorite entry.
1552 */
1553 name?: string;
1554 /**
1555 * Application specific favorite entry type. Empty or Null represents that Favorite item is a Folder.
1556 */
1557 type?: string;
1558}
1559export interface Folder {
1560 /**
1561 * Identity who created this folder.
1562 */
1563 createdBy?: VSSInterfaces.IdentityRef;
1564 /**
1565 * Time when this folder created.
1566 */
1567 createdOn?: Date;
1568 /**
1569 * Description of the folder.
1570 */
1571 description?: string;
1572 /**
1573 * Identity who last changed this folder.
1574 */
1575 lastChangedBy?: VSSInterfaces.IdentityRef;
1576 /**
1577 * Time when this folder last changed.
1578 */
1579 lastChangedDate?: Date;
1580 /**
1581 * path of the folder.
1582 */
1583 path?: string;
1584}
1585/**
1586 * Specifies the desired ordering of folders.
1587 */
1588export declare enum FolderPathQueryOrder {
1589 /**
1590 * No order.
1591 */
1592 None = 0,
1593 /**
1594 * Order by folder name and path ascending.
1595 */
1596 Ascending = 1,
1597 /**
1598 * Order by folder name and path descending.
1599 */
1600 Descending = 2
1601}
1602export interface GatesDeploymentInput extends BaseDeploymentInput {
1603 /**
1604 * Gates minimum success duration.
1605 */
1606 minimumSuccessDuration?: number;
1607 /**
1608 * Gates sampling interval.
1609 */
1610 samplingInterval?: number;
1611 /**
1612 * Gates stabilization time.
1613 */
1614 stabilizationTime?: number;
1615}
1616export interface GatesDeployPhase extends DeployPhase {
1617 /**
1618 * Gets and sets the gate job input.
1619 */
1620 deploymentInput?: GatesDeploymentInput;
1621}
1622export declare enum GateStatus {
1623 /**
1624 * The gate does not have the status set.
1625 */
1626 None = 0,
1627 /**
1628 * The gate is in pending state.
1629 */
1630 Pending = 1,
1631 /**
1632 * The gate is currently in progress.
1633 */
1634 InProgress = 2,
1635 /**
1636 * The gate completed successfully.
1637 */
1638 Succeeded = 4,
1639 /**
1640 * The gate execution failed.
1641 */
1642 Failed = 8,
1643 /**
1644 * The gate execution cancelled.
1645 */
1646 Canceled = 16
1647}
1648export interface GateUpdateMetadata {
1649 /**
1650 * Comment.
1651 */
1652 comment?: string;
1653 /**
1654 * Name of gate to be ignored.
1655 */
1656 gatesToIgnore?: string[];
1657}
1658export interface GitArtifactDownloadInput extends ArtifactDownloadInputBase {
1659}
1660export interface GitHubArtifactDownloadInput extends ArtifactDownloadInputBase {
1661}
1662export interface IgnoredGate {
1663 /**
1664 * Gets the date on which gate is last ignored.
1665 */
1666 lastModifiedOn?: Date;
1667 /**
1668 * Name of gate ignored.
1669 */
1670 name?: string;
1671}
1672export interface Issue {
1673 /**
1674 * Issue data.
1675 */
1676 data?: {
1677 [key: string]: string;
1678 };
1679 /**
1680 * Issue type, for example error, warning or info.
1681 */
1682 issueType?: string;
1683 /**
1684 * Issue message.
1685 */
1686 message?: string;
1687}
1688export declare enum IssueSource {
1689 None = 0,
1690 User = 1,
1691 System = 2
1692}
1693export interface JenkinsArtifactDownloadInput extends ArtifactDownloadInputBase {
1694}
1695export interface MachineGroupBasedDeployPhase extends DeployPhase {
1696 /**
1697 * Gets and sets the deployment group job input
1698 */
1699 deploymentInput?: MachineGroupDeploymentInput;
1700}
1701export interface MachineGroupDeploymentInput extends DeploymentInput {
1702 /**
1703 * Deployment group health option.
1704 */
1705 deploymentHealthOption?: string;
1706 /**
1707 * Minimum percentage of the targets guaranteed to be healthy.
1708 */
1709 healthPercent?: number;
1710 /**
1711 * Deployment target tag filter.
1712 */
1713 tags?: string[];
1714}
1715export interface MailMessage {
1716 /**
1717 * Body of mail.
1718 */
1719 body?: string;
1720 /**
1721 * Mail CC recipients.
1722 */
1723 cC?: EmailRecipients;
1724 /**
1725 * Reply to.
1726 */
1727 inReplyTo?: string;
1728 /**
1729 * Message ID of the mail.
1730 */
1731 messageId?: string;
1732 /**
1733 * Data when should be replied to mail.
1734 */
1735 replyBy?: Date;
1736 /**
1737 * Reply to Email recipients.
1738 */
1739 replyTo?: EmailRecipients;
1740 /**
1741 * List of mail section types.
1742 */
1743 sections?: MailSectionType[];
1744 /**
1745 * Mail sender type.
1746 */
1747 senderType?: SenderType;
1748 /**
1749 * Subject of the mail.
1750 */
1751 subject?: string;
1752 /**
1753 * Mail To recipients.
1754 */
1755 to?: EmailRecipients;
1756}
1757export declare enum MailSectionType {
1758 Details = 0,
1759 Environments = 1,
1760 Issues = 2,
1761 TestResults = 3,
1762 WorkItems = 4,
1763 ReleaseInfo = 5
1764}
1765export interface ManualIntervention {
1766 /**
1767 * Gets or sets the identity who should approve.
1768 */
1769 approver?: VSSInterfaces.IdentityRef;
1770 /**
1771 * Gets or sets comments for approval.
1772 */
1773 comments?: string;
1774 /**
1775 * Gets date on which it got created.
1776 */
1777 createdOn?: Date;
1778 /**
1779 * Gets the unique identifier for manual intervention.
1780 */
1781 id?: number;
1782 /**
1783 * Gets or sets instructions for approval.
1784 */
1785 instructions?: string;
1786 /**
1787 * Gets date on which it got modified.
1788 */
1789 modifiedOn?: Date;
1790 /**
1791 * Gets or sets the name.
1792 */
1793 name?: string;
1794 /**
1795 * Gets releaseReference for manual intervention.
1796 */
1797 release?: ReleaseShallowReference;
1798 /**
1799 * Gets releaseDefinitionReference for manual intervention.
1800 */
1801 releaseDefinition?: ReleaseDefinitionShallowReference;
1802 /**
1803 * Gets releaseEnvironmentReference for manual intervention.
1804 */
1805 releaseEnvironment?: ReleaseEnvironmentShallowReference;
1806 /**
1807 * Gets or sets the status of the manual intervention.
1808 */
1809 status?: ManualInterventionStatus;
1810 /**
1811 * Get task instance identifier.
1812 */
1813 taskInstanceId?: string;
1814 /**
1815 * Gets url to access the manual intervention.
1816 */
1817 url?: string;
1818}
1819/**
1820 * Describes manual intervention status
1821 */
1822export declare enum ManualInterventionStatus {
1823 /**
1824 * The manual intervention does not have the status set.
1825 */
1826 Unknown = 0,
1827 /**
1828 * The manual intervention is pending.
1829 */
1830 Pending = 1,
1831 /**
1832 * The manual intervention is rejected.
1833 */
1834 Rejected = 2,
1835 /**
1836 * The manual intervention is approved.
1837 */
1838 Approved = 4,
1839 /**
1840 * The manual intervention is canceled.
1841 */
1842 Canceled = 8
1843}
1844export interface ManualInterventionUpdateMetadata {
1845 /**
1846 * Sets the comment for manual intervention update.
1847 */
1848 comment?: string;
1849 /**
1850 * Sets the status of the manual intervention.
1851 */
1852 status?: ManualInterventionStatus;
1853}
1854export interface MappingDetails {
1855 mappings?: {
1856 [key: string]: FormInputInterfaces.InputValue;
1857 };
1858}
1859export interface Metric {
1860 /**
1861 * Name of the Metric.
1862 */
1863 name?: string;
1864 /**
1865 * Value of the Metric.
1866 */
1867 value?: number;
1868}
1869export interface MultiConfigInput extends ParallelExecutionInputBase {
1870 /**
1871 * Multipliers for parallel execution of deployment, for example x86,x64.
1872 */
1873 multipliers?: string;
1874}
1875export interface MultiMachineInput extends ParallelExecutionInputBase {
1876}
1877export interface OrgPipelineReleaseSettings {
1878 /**
1879 * Defines whether user can manage pipeline settings.
1880 */
1881 hasManagePipelinePoliciesPermission?: boolean;
1882 /**
1883 * EnforceJobAuthScope setting at organisaion level. If enabled, scope of access for all release pipelines in the organisation reduces to the current project.
1884 */
1885 orgEnforceJobAuthScope?: boolean;
1886}
1887export interface OrgPipelineReleaseSettingsUpdateParameters {
1888 /**
1889 * EnforceJobAuthScope setting at organisaion level. If enabled, scope of access for all release pipelines in the organisation reduces to the current project.
1890 */
1891 orgEnforceJobAuthScope?: boolean;
1892}
1893export interface PackageTrigger extends ReleaseTriggerBase {
1894 /**
1895 * Package trigger alias.
1896 */
1897 alias?: string;
1898}
1899export interface ParallelExecutionInputBase extends ExecutionInput {
1900 /**
1901 * Indicate whether continue execution of deployment on error or not.
1902 */
1903 continueOnError?: boolean;
1904 /**
1905 * Maximum number of agents used while parallel execution.
1906 */
1907 maxNumberOfAgents?: number;
1908}
1909export declare enum ParallelExecutionTypes {
1910 None = 0,
1911 MultiConfiguration = 1,
1912 MultiMachine = 2
1913}
1914export interface PipelineProcess {
1915 /**
1916 * Pipeline process type.
1917 */
1918 type?: PipelineProcessTypes;
1919}
1920export declare enum PipelineProcessTypes {
1921 Designer = 1,
1922 Yaml = 2
1923}
1924export interface ProjectPipelineReleaseSettings {
1925 /**
1926 * EnforceJobAuthScope setting at project level. If enabled, scope of access for all release pipelines reduces to the current project.
1927 */
1928 enforceJobAuthScope?: boolean;
1929 /**
1930 * Defines whether user can manage pipeline settings.
1931 */
1932 hasManageSettingsPermission?: boolean;
1933 /**
1934 * EnforceJobAuthScope setting at organisaion level. If enabled, scope of access for all release pipelines in the organisation reduces to the current project.
1935 */
1936 orgEnforceJobAuthScope?: boolean;
1937 /**
1938 * Defines whether project is public.
1939 */
1940 publicProject?: boolean;
1941}
1942export interface ProjectPipelineReleaseSettingsUpdateParameters {
1943 /**
1944 * EnforceJobAuthScope setting at project level. If enabled, scope of access for all release pipelines reduces to the current project.
1945 */
1946 enforceJobAuthScope?: boolean;
1947}
1948export interface ProjectReference {
1949 /**
1950 * Gets the unique identifier of this field.
1951 */
1952 id?: string;
1953 /**
1954 * Gets name of project.
1955 */
1956 name?: string;
1957}
1958export interface PropertySelector {
1959 /**
1960 * List of properties.
1961 */
1962 properties?: string[];
1963 /**
1964 * Property selector type.
1965 */
1966 selectorType?: PropertySelectorType;
1967}
1968export declare enum PropertySelectorType {
1969 /**
1970 * Include in property selector.
1971 */
1972 Inclusion = 0,
1973 /**
1974 * Exclude in property selector.
1975 */
1976 Exclusion = 1
1977}
1978export interface PullRequestConfiguration {
1979 /**
1980 * Code repository reference.
1981 */
1982 codeRepositoryReference?: CodeRepositoryReference;
1983 /**
1984 * In case of Source based artifacts, Code reference will be present in Artifact details.
1985 */
1986 useArtifactReference?: boolean;
1987}
1988export interface PullRequestFilter {
1989 /**
1990 * List of tags.
1991 */
1992 tags?: string[];
1993 /**
1994 * Target branch of pull request.
1995 */
1996 targetBranch?: string;
1997}
1998export declare enum PullRequestSystemType {
1999 None = 0,
2000 TfsGit = 1,
2001 GitHub = 2
2002}
2003export interface PullRequestTrigger extends ReleaseTriggerBase {
2004 /**
2005 * Artifact alias trigger is linked to.
2006 */
2007 artifactAlias?: string;
2008 /**
2009 * Code reference details of pull request.
2010 */
2011 pullRequestConfiguration?: PullRequestConfiguration;
2012 /**
2013 * Policy name using which status will be published to pull request.
2014 */
2015 statusPolicyName?: string;
2016 /**
2017 * List of filters applied while trigger.
2018 */
2019 triggerConditions?: PullRequestFilter[];
2020}
2021export interface QueuedReleaseData {
2022 /**
2023 * Project ID of the release.
2024 */
2025 projectId?: string;
2026 /**
2027 * Release queue position.
2028 */
2029 queuePosition?: number;
2030 /**
2031 * Queued release ID.
2032 */
2033 releaseId?: number;
2034}
2035export interface RealtimeReleaseDefinitionEvent {
2036 definitionId?: number;
2037 projectId?: string;
2038}
2039export interface RealtimeReleaseEvent {
2040 environmentId?: number;
2041 projectId?: string;
2042 releaseId?: number;
2043}
2044export interface Release {
2045 /**
2046 * Gets links to access the release.
2047 */
2048 _links?: any;
2049 /**
2050 * Gets or sets the list of artifacts.
2051 */
2052 artifacts?: Artifact[];
2053 /**
2054 * Gets or sets comment.
2055 */
2056 comment?: string;
2057 /**
2058 * Gets or sets the identity who created.
2059 */
2060 createdBy?: VSSInterfaces.IdentityRef;
2061 /**
2062 * Gets or sets the identity for whom release was created.
2063 */
2064 createdFor?: VSSInterfaces.IdentityRef;
2065 /**
2066 * Gets date on which it got created.
2067 */
2068 createdOn?: Date;
2069 /**
2070 * Gets revision number of definition snapshot.
2071 */
2072 definitionSnapshotRevision?: number;
2073 /**
2074 * Gets or sets description of release.
2075 */
2076 description?: string;
2077 /**
2078 * Gets list of environments.
2079 */
2080 environments?: ReleaseEnvironment[];
2081 /**
2082 * Gets the unique identifier of this field.
2083 */
2084 id?: number;
2085 /**
2086 * Whether to exclude the release from retention policies.
2087 */
2088 keepForever?: boolean;
2089 /**
2090 * Gets logs container url.
2091 */
2092 logsContainerUrl?: string;
2093 /**
2094 * Gets or sets the identity who modified.
2095 */
2096 modifiedBy?: VSSInterfaces.IdentityRef;
2097 /**
2098 * Gets date on which it got modified.
2099 */
2100 modifiedOn?: Date;
2101 /**
2102 * Gets name.
2103 */
2104 name?: string;
2105 /**
2106 * Gets pool name.
2107 */
2108 poolName?: string;
2109 /**
2110 * Gets or sets project reference.
2111 */
2112 projectReference?: ProjectReference;
2113 properties?: any;
2114 /**
2115 * Gets reason of release.
2116 */
2117 reason?: ReleaseReason;
2118 /**
2119 * Gets releaseDefinitionReference which specifies the reference of the release definition to which this release is associated.
2120 */
2121 releaseDefinition?: ReleaseDefinitionShallowReference;
2122 /**
2123 * Gets or sets the release definition revision.
2124 */
2125 releaseDefinitionRevision?: number;
2126 /**
2127 * Gets release name format.
2128 */
2129 releaseNameFormat?: string;
2130 /**
2131 * Gets status.
2132 */
2133 status?: ReleaseStatus;
2134 /**
2135 * Gets or sets list of tags.
2136 */
2137 tags?: string[];
2138 triggeringArtifactAlias?: string;
2139 url?: string;
2140 /**
2141 * Gets the list of variable groups.
2142 */
2143 variableGroups?: VariableGroup[];
2144 /**
2145 * Gets or sets the dictionary of variables.
2146 */
2147 variables?: {
2148 [key: string]: ConfigurationVariableValue;
2149 };
2150}
2151export interface ReleaseAbandonedEvent extends ReleaseEvent {
2152 project?: ProjectReference;
2153 release?: Release;
2154}
2155export interface ReleaseApproval {
2156 /**
2157 * Gets or sets the type of approval.
2158 */
2159 approvalType?: ApprovalType;
2160 /**
2161 * Gets the identity who approved.
2162 */
2163 approvedBy?: VSSInterfaces.IdentityRef;
2164 /**
2165 * Gets or sets the identity who should approve.
2166 */
2167 approver?: VSSInterfaces.IdentityRef;
2168 /**
2169 * Gets or sets attempt which specifies as which deployment attempt it belongs.
2170 */
2171 attempt?: number;
2172 /**
2173 * Gets or sets comments for approval.
2174 */
2175 comments?: string;
2176 /**
2177 * Gets date on which it got created.
2178 */
2179 createdOn?: Date;
2180 /**
2181 * Gets history which specifies all approvals associated with this approval.
2182 */
2183 history?: ReleaseApprovalHistory[];
2184 /**
2185 * Gets the unique identifier of this field.
2186 */
2187 id?: number;
2188 /**
2189 * Gets or sets as approval is automated or not.
2190 */
2191 isAutomated?: boolean;
2192 isNotificationOn?: boolean;
2193 /**
2194 * Gets date on which it got modified.
2195 */
2196 modifiedOn?: Date;
2197 /**
2198 * Gets or sets rank which specifies the order of the approval. e.g. Same rank denotes parallel approval.
2199 */
2200 rank?: number;
2201 /**
2202 * Gets releaseReference which specifies the reference of the release to which this approval is associated.
2203 */
2204 release?: ReleaseShallowReference;
2205 /**
2206 * Gets releaseDefinitionReference which specifies the reference of the release definition to which this approval is associated.
2207 */
2208 releaseDefinition?: ReleaseDefinitionShallowReference;
2209 /**
2210 * Gets releaseEnvironmentReference which specifies the reference of the release environment to which this approval is associated.
2211 */
2212 releaseEnvironment?: ReleaseEnvironmentShallowReference;
2213 /**
2214 * Gets the revision number.
2215 */
2216 revision?: number;
2217 /**
2218 * Gets or sets the status of the approval.
2219 */
2220 status?: ApprovalStatus;
2221 trialNumber?: number;
2222 /**
2223 * Gets url to access the approval.
2224 */
2225 url?: string;
2226}
2227export interface ReleaseApprovalHistory {
2228 /**
2229 * Identity of the approver.
2230 */
2231 approver?: VSSInterfaces.IdentityRef;
2232 /**
2233 * Identity of the object who changed approval.
2234 */
2235 changedBy?: VSSInterfaces.IdentityRef;
2236 /**
2237 * Approval history comments.
2238 */
2239 comments?: string;
2240 /**
2241 * Time when this approval created.
2242 */
2243 createdOn?: Date;
2244 /**
2245 * Time when this approval modified.
2246 */
2247 modifiedOn?: Date;
2248 /**
2249 * Approval history revision.
2250 */
2251 revision?: number;
2252}
2253export interface ReleaseApprovalPendingEvent {
2254 approval?: ReleaseApproval;
2255 approvalOptions?: ApprovalOptions;
2256 completedApprovals?: ReleaseApproval[];
2257 definitionName?: string;
2258 deployment?: Deployment;
2259 environmentId?: number;
2260 environmentName?: string;
2261 environments?: ReleaseEnvironment[];
2262 isMultipleRankApproval?: boolean;
2263 pendingApprovals?: ReleaseApproval[];
2264 releaseCreator?: string;
2265 releaseName?: string;
2266 title?: string;
2267 webAccessUri?: string;
2268}
2269export interface ReleaseArtifact {
2270 /**
2271 * Gets or sets the artifact provider of ReleaseArtifact.
2272 */
2273 artifactProvider?: ArtifactProvider;
2274 /**
2275 * Gets or sets the artifact type of ReleaseArtifact.
2276 */
2277 artifactType?: string;
2278 /**
2279 * Gets or sets the definition json of ReleaseArtifact.
2280 */
2281 definitionData?: string;
2282 /**
2283 * Gets or sets the definition id of ReleaseArtifact.
2284 */
2285 definitionId?: number;
2286 /**
2287 * Gets or sets the description of ReleaseArtifact.
2288 */
2289 description?: string;
2290 /**
2291 * Gets or sets the id of ReleaseArtifact.
2292 */
2293 id?: number;
2294 /**
2295 * Gets or sets the name of ReleaseArtifact.
2296 */
2297 name?: string;
2298 /**
2299 * Gets or sets the release id.
2300 */
2301 releaseId?: number;
2302}
2303export interface ReleaseCondition extends Condition {
2304}
2305export interface ReleaseCreatedEvent extends ReleaseEvent {
2306 project?: ProjectReference;
2307 release?: Release;
2308}
2309export interface ReleaseDefinition extends ReleaseDefinitionShallowReference {
2310 /**
2311 * Gets or sets the list of artifacts.
2312 */
2313 artifacts?: Artifact[];
2314 /**
2315 * Gets or sets comment.
2316 */
2317 comment?: string;
2318 /**
2319 * Gets or sets the identity who created.
2320 */
2321 createdBy?: VSSInterfaces.IdentityRef;
2322 /**
2323 * Gets date on which it got created.
2324 */
2325 createdOn?: Date;
2326 /**
2327 * Gets or sets the description.
2328 */
2329 description?: string;
2330 /**
2331 * Gets or sets the list of environments.
2332 */
2333 environments?: ReleaseDefinitionEnvironment[];
2334 /**
2335 * Whether release definition is deleted.
2336 */
2337 isDeleted?: boolean;
2338 /**
2339 * Whether release definition is disabled.
2340 */
2341 isDisabled?: boolean;
2342 /**
2343 * Gets the reference of last release.
2344 */
2345 lastRelease?: ReleaseReference;
2346 /**
2347 * Gets or sets the identity who modified.
2348 */
2349 modifiedBy?: VSSInterfaces.IdentityRef;
2350 /**
2351 * Gets date on which it got modified.
2352 */
2353 modifiedOn?: Date;
2354 /**
2355 * Gets or sets pipeline process.
2356 */
2357 pipelineProcess?: PipelineProcess;
2358 /**
2359 * Gets or sets properties.
2360 */
2361 properties?: any;
2362 /**
2363 * Gets or sets the release name format.
2364 */
2365 releaseNameFormat?: string;
2366 retentionPolicy?: RetentionPolicy;
2367 /**
2368 * Gets the revision number.
2369 */
2370 revision?: number;
2371 /**
2372 * Gets or sets source of release definition.
2373 */
2374 source?: ReleaseDefinitionSource;
2375 /**
2376 * Gets or sets list of tags.
2377 */
2378 tags?: string[];
2379 /**
2380 * Gets or sets the list of triggers.
2381 */
2382 triggers?: ReleaseTriggerBase[];
2383 /**
2384 * Gets or sets the list of variable groups.
2385 */
2386 variableGroups?: number[];
2387 /**
2388 * Gets or sets the dictionary of variables.
2389 */
2390 variables?: {
2391 [key: string]: ConfigurationVariableValue;
2392 };
2393}
2394export interface ReleaseDefinitionApprovals {
2395 /**
2396 * Gets or sets the approval options.
2397 */
2398 approvalOptions?: ApprovalOptions;
2399 /**
2400 * Gets or sets the approvals.
2401 */
2402 approvals?: ReleaseDefinitionApprovalStep[];
2403}
2404export interface ReleaseDefinitionApprovalStep extends ReleaseDefinitionEnvironmentStep {
2405 /**
2406 * Gets and sets the approver.
2407 */
2408 approver?: VSSInterfaces.IdentityRef;
2409 /**
2410 * Indicates whether the approval automated.
2411 */
2412 isAutomated?: boolean;
2413 /**
2414 * Indicates whether the approval notification set.
2415 */
2416 isNotificationOn?: boolean;
2417 /**
2418 * Gets or sets the rank of approval step.
2419 */
2420 rank?: number;
2421}
2422export interface ReleaseDefinitionDeployStep extends ReleaseDefinitionEnvironmentStep {
2423 /**
2424 * The list of steps for this definition.
2425 */
2426 tasks?: WorkflowTask[];
2427}
2428export interface ReleaseDefinitionEnvironment {
2429 /**
2430 * Gets or sets the BadgeUrl. BadgeUrl will be used when Badge will be enabled in Release Definition Environment.
2431 */
2432 badgeUrl?: string;
2433 /**
2434 * Gets or sets the environment conditions.
2435 */
2436 conditions?: Condition[];
2437 /**
2438 * Gets or sets the current release reference.
2439 */
2440 currentRelease?: ReleaseShallowReference;
2441 /**
2442 * Gets or sets the demands.
2443 */
2444 demands?: Demand[];
2445 /**
2446 * Gets or sets the deploy phases of environment.
2447 */
2448 deployPhases?: DeployPhase[];
2449 /**
2450 * Gets or sets the deploystep.
2451 */
2452 deployStep?: ReleaseDefinitionDeployStep;
2453 /**
2454 * Gets or sets the environment options.
2455 */
2456 environmentOptions?: EnvironmentOptions;
2457 /**
2458 * Gets or sets the triggers on environment.
2459 */
2460 environmentTriggers?: EnvironmentTrigger[];
2461 /**
2462 * Gets or sets the environment execution policy.
2463 */
2464 executionPolicy?: EnvironmentExecutionPolicy;
2465 /**
2466 * Gets and sets the ID of the ReleaseDefinitionEnvironment.
2467 */
2468 id?: number;
2469 /**
2470 * Gets and sets the name of the ReleaseDefinitionEnvironment.
2471 */
2472 name?: string;
2473 /**
2474 * Gets and sets the Owner of the ReleaseDefinitionEnvironment.
2475 */
2476 owner?: VSSInterfaces.IdentityRef;
2477 /**
2478 * Gets or sets the post deployment approvals.
2479 */
2480 postDeployApprovals?: ReleaseDefinitionApprovals;
2481 /**
2482 * Gets or sets the post deployment gates.
2483 */
2484 postDeploymentGates?: ReleaseDefinitionGatesStep;
2485 /**
2486 * Gets or sets the pre deployment approvals.
2487 */
2488 preDeployApprovals?: ReleaseDefinitionApprovals;
2489 /**
2490 * Gets or sets the pre deployment gates.
2491 */
2492 preDeploymentGates?: ReleaseDefinitionGatesStep;
2493 /**
2494 * Gets or sets the environment process parameters.
2495 */
2496 processParameters?: DistributedTaskCommonInterfaces.ProcessParameters;
2497 /**
2498 * Gets or sets the properties on environment.
2499 */
2500 properties?: any;
2501 /**
2502 * Gets or sets the queue ID.
2503 */
2504 queueId?: number;
2505 /**
2506 * Gets and sets the rank of the ReleaseDefinitionEnvironment.
2507 */
2508 rank?: number;
2509 /**
2510 * Gets or sets the environment retention policy.
2511 */
2512 retentionPolicy?: EnvironmentRetentionPolicy;
2513 runOptions?: {
2514 [key: string]: string;
2515 };
2516 /**
2517 * Gets or sets the schedules
2518 */
2519 schedules?: ReleaseSchedule[];
2520 /**
2521 * Gets or sets the variable groups.
2522 */
2523 variableGroups?: number[];
2524 /**
2525 * Gets and sets the variables.
2526 */
2527 variables?: {
2528 [key: string]: ConfigurationVariableValue;
2529 };
2530}
2531export interface ReleaseDefinitionEnvironmentStep {
2532 /**
2533 * ID of the approval or deploy step.
2534 */
2535 id?: number;
2536}
2537export interface ReleaseDefinitionEnvironmentSummary {
2538 /**
2539 * ID of ReleaseDefinition environment summary.
2540 */
2541 id?: number;
2542 /**
2543 * List of release shallow reference deployed using this ReleaseDefinition.
2544 */
2545 lastReleases?: ReleaseShallowReference[];
2546 /**
2547 * Name of ReleaseDefinition environment summary.
2548 */
2549 name?: string;
2550}
2551export interface ReleaseDefinitionEnvironmentTemplate {
2552 /**
2553 * Indicates whether template can be deleted or not.
2554 */
2555 canDelete?: boolean;
2556 /**
2557 * Category of the ReleaseDefinition environment template.
2558 */
2559 category?: string;
2560 /**
2561 * Description of the ReleaseDefinition environment template.
2562 */
2563 description?: string;
2564 /**
2565 * ReleaseDefinition environment data which used to create this template.
2566 */
2567 environment?: ReleaseDefinitionEnvironment;
2568 /**
2569 * ID of the task which used to display icon used for this template.
2570 */
2571 iconTaskId?: string;
2572 /**
2573 * Icon uri of the template.
2574 */
2575 iconUri?: string;
2576 /**
2577 * ID of the ReleaseDefinition environment template.
2578 */
2579 id?: string;
2580 /**
2581 * Indicates whether template deleted or not.
2582 */
2583 isDeleted?: boolean;
2584 /**
2585 * Name of the ReleaseDefinition environment template.
2586 */
2587 name?: string;
2588}
2589export declare enum ReleaseDefinitionExpands {
2590 /**
2591 * Returns top level properties of object.
2592 */
2593 None = 0,
2594 /**
2595 * Include environments in return object.
2596 */
2597 Environments = 2,
2598 /**
2599 * Include artifacts in return object.
2600 */
2601 Artifacts = 4,
2602 /**
2603 * Include triggers in return object.
2604 */
2605 Triggers = 8,
2606 /**
2607 * Include variables in return object.
2608 */
2609 Variables = 16,
2610 /**
2611 * Include tags in return object.
2612 */
2613 Tags = 32,
2614 /**
2615 * Include last release in return object.
2616 */
2617 LastRelease = 64
2618}
2619export interface ReleaseDefinitionGate {
2620 /**
2621 * Gets or sets the flag that indicates if gate was generated.
2622 */
2623 isGenerated?: boolean;
2624 /**
2625 * Gets or sets the gates workflow.
2626 */
2627 tasks?: WorkflowTask[];
2628}
2629export interface ReleaseDefinitionGatesOptions {
2630 /**
2631 * Gets or sets as the gates enabled or not.
2632 */
2633 isEnabled?: boolean;
2634 /**
2635 * Gets or sets the minimum duration for steady results after a successful gates evaluation.
2636 */
2637 minimumSuccessDuration?: number;
2638 /**
2639 * Gets or sets the time between re-evaluation of gates.
2640 */
2641 samplingInterval?: number;
2642 /**
2643 * Gets or sets the delay before evaluation.
2644 */
2645 stabilizationTime?: number;
2646 /**
2647 * Gets or sets the timeout after which gates fail.
2648 */
2649 timeout?: number;
2650}
2651export interface ReleaseDefinitionGatesStep {
2652 /**
2653 * Gets or sets the gates.
2654 */
2655 gates?: ReleaseDefinitionGate[];
2656 /**
2657 * Gets or sets the gate options.
2658 */
2659 gatesOptions?: ReleaseDefinitionGatesOptions;
2660 /**
2661 * ID of the ReleaseDefinitionGateStep.
2662 */
2663 id?: number;
2664}
2665export declare enum ReleaseDefinitionQueryOrder {
2666 /**
2667 * Return results based on release definition Id ascending order.
2668 */
2669 IdAscending = 0,
2670 /**
2671 * Return results based on release definition Id descending order.
2672 */
2673 IdDescending = 1,
2674 /**
2675 * Return results based on release definition name ascending order.
2676 */
2677 NameAscending = 2,
2678 /**
2679 * Return results based on release definition name descending order.
2680 */
2681 NameDescending = 3
2682}
2683export interface ReleaseDefinitionRevision {
2684 /**
2685 * Gets api-version for revision object.
2686 */
2687 apiVersion?: string;
2688 /**
2689 * Gets the identity who did change.
2690 */
2691 changedBy?: VSSInterfaces.IdentityRef;
2692 /**
2693 * Gets date on which ReleaseDefinition changed.
2694 */
2695 changedDate?: Date;
2696 /**
2697 * Gets type of change.
2698 */
2699 changeType?: AuditAction;
2700 /**
2701 * Gets comments for revision.
2702 */
2703 comment?: string;
2704 /**
2705 * Get id of the definition.
2706 */
2707 definitionId?: number;
2708 /**
2709 * Gets definition URL.
2710 */
2711 definitionUrl?: string;
2712 /**
2713 * Get revision number of the definition.
2714 */
2715 revision?: number;
2716}
2717export interface ReleaseDefinitionShallowReference {
2718 /**
2719 * Gets the links to related resources, APIs, and views for the release definition.
2720 */
2721 _links?: any;
2722 /**
2723 * Gets the unique identifier of release definition.
2724 */
2725 id?: number;
2726 /**
2727 * Gets or sets the name of the release definition.
2728 */
2729 name?: string;
2730 /**
2731 * Gets or sets the path of the release definition.
2732 */
2733 path?: string;
2734 /**
2735 * Gets or sets project reference.
2736 */
2737 projectReference?: ProjectReference;
2738 /**
2739 * Gets the REST API url to access the release definition.
2740 */
2741 url?: string;
2742}
2743export declare enum ReleaseDefinitionSource {
2744 /**
2745 * Indicates ReleaseDefinition source not defined.
2746 */
2747 Undefined = 0,
2748 /**
2749 * Indicates ReleaseDefinition created using REST API.
2750 */
2751 RestApi = 1,
2752 /**
2753 * Indicates ReleaseDefinition created using UI.
2754 */
2755 UserInterface = 2,
2756 /**
2757 * Indicates ReleaseDefinition created from Ibiza.
2758 */
2759 Ibiza = 4,
2760 /**
2761 * Indicates ReleaseDefinition created from PortalExtension API.
2762 */
2763 PortalExtensionApi = 8
2764}
2765export interface ReleaseDefinitionSummary {
2766 /**
2767 * List of Release Definition environment summary.
2768 */
2769 environments?: ReleaseDefinitionEnvironmentSummary[];
2770 /**
2771 * Release Definition reference.
2772 */
2773 releaseDefinition?: ReleaseDefinitionShallowReference;
2774 /**
2775 * List of releases deployed using this Release Definition.
2776 */
2777 releases?: Release[];
2778}
2779export interface ReleaseDefinitionUndeleteParameter {
2780 /**
2781 * Gets or sets comment.
2782 */
2783 comment?: string;
2784}
2785export interface ReleaseDeployPhase {
2786 /**
2787 * Deployment jobs of the phase.
2788 */
2789 deploymentJobs?: DeploymentJob[];
2790 /**
2791 * Phase execution error logs.
2792 */
2793 errorLog?: string;
2794 /**
2795 * ID of the phase.
2796 */
2797 id?: number;
2798 /**
2799 * List of manual intervention tasks execution information in phase.
2800 */
2801 manualInterventions?: ManualIntervention[];
2802 /**
2803 * Name of the phase.
2804 */
2805 name?: string;
2806 /**
2807 * ID of the phase.
2808 */
2809 phaseId?: string;
2810 /**
2811 * Type of the phase.
2812 */
2813 phaseType?: DeployPhaseTypes;
2814 /**
2815 * Rank of the phase.
2816 */
2817 rank?: number;
2818 /**
2819 * Run Plan ID of the phase.
2820 */
2821 runPlanId?: string;
2822 /**
2823 * Phase start time.
2824 */
2825 startedOn?: Date;
2826 /**
2827 * Status of the phase.
2828 */
2829 status?: DeployPhaseStatus;
2830}
2831export interface ReleaseEnvironment {
2832 /**
2833 * Gets list of conditions.
2834 */
2835 conditions?: ReleaseCondition[];
2836 /**
2837 * Gets date on which it got created.
2838 */
2839 createdOn?: Date;
2840 /**
2841 * Gets definition environment id.
2842 */
2843 definitionEnvironmentId?: number;
2844 /**
2845 * Gets demands.
2846 */
2847 demands?: Demand[];
2848 /**
2849 * Gets list of deploy phases snapshot.
2850 */
2851 deployPhasesSnapshot?: DeployPhase[];
2852 /**
2853 * Gets deploy steps.
2854 */
2855 deploySteps?: DeploymentAttempt[];
2856 /**
2857 * Gets environment options.
2858 */
2859 environmentOptions?: EnvironmentOptions;
2860 /**
2861 * Gets the unique identifier of this field.
2862 */
2863 id?: number;
2864 /**
2865 * Gets date on which it got modified.
2866 */
2867 modifiedOn?: Date;
2868 /**
2869 * Gets name.
2870 */
2871 name?: string;
2872 /**
2873 * Gets next scheduled UTC time.
2874 */
2875 nextScheduledUtcTime?: Date;
2876 /**
2877 * Gets the identity who is owner for release environment.
2878 */
2879 owner?: VSSInterfaces.IdentityRef;
2880 /**
2881 * Gets list of post deploy approvals snapshot.
2882 */
2883 postApprovalsSnapshot?: ReleaseDefinitionApprovals;
2884 /**
2885 * Gets list of post deploy approvals.
2886 */
2887 postDeployApprovals?: ReleaseApproval[];
2888 /**
2889 * Post deployment gates snapshot data.
2890 */
2891 postDeploymentGatesSnapshot?: ReleaseDefinitionGatesStep;
2892 /**
2893 * Gets list of pre deploy approvals snapshot.
2894 */
2895 preApprovalsSnapshot?: ReleaseDefinitionApprovals;
2896 /**
2897 * Gets list of pre deploy approvals.
2898 */
2899 preDeployApprovals?: ReleaseApproval[];
2900 /**
2901 * Pre deployment gates snapshot data.
2902 */
2903 preDeploymentGatesSnapshot?: ReleaseDefinitionGatesStep;
2904 /**
2905 * Gets process parameters.
2906 */
2907 processParameters?: DistributedTaskCommonInterfaces.ProcessParameters;
2908 /**
2909 * Gets queue id.
2910 */
2911 queueId?: number;
2912 /**
2913 * Gets rank.
2914 */
2915 rank?: number;
2916 /**
2917 * Gets release reference which specifies the reference of the release to which this release environment is associated.
2918 */
2919 release?: ReleaseShallowReference;
2920 /**
2921 * Gets the identity who created release.
2922 */
2923 releaseCreatedBy?: VSSInterfaces.IdentityRef;
2924 /**
2925 * Gets releaseDefinitionReference which specifies the reference of the release definition to which this release environment is associated.
2926 */
2927 releaseDefinition?: ReleaseDefinitionShallowReference;
2928 /**
2929 * Gets release description.
2930 */
2931 releaseDescription?: string;
2932 /**
2933 * Gets release id.
2934 */
2935 releaseId?: number;
2936 /**
2937 * Gets schedule deployment time of release environment.
2938 */
2939 scheduledDeploymentTime?: Date;
2940 /**
2941 * Gets list of schedules.
2942 */
2943 schedules?: ReleaseSchedule[];
2944 /**
2945 * Gets environment status.
2946 */
2947 status?: EnvironmentStatus;
2948 /**
2949 * Gets time to deploy.
2950 */
2951 timeToDeploy?: number;
2952 /**
2953 * Gets trigger reason.
2954 */
2955 triggerReason?: string;
2956 /**
2957 * Gets the list of variable groups.
2958 */
2959 variableGroups?: VariableGroup[];
2960 /**
2961 * Gets the dictionary of variables.
2962 */
2963 variables?: {
2964 [key: string]: ConfigurationVariableValue;
2965 };
2966 /**
2967 * Gets list of workflow tasks.
2968 */
2969 workflowTasks?: WorkflowTask[];
2970}
2971export interface ReleaseEnvironmentCompletedEvent {
2972 createdByName?: string;
2973 definitionId?: number;
2974 definitionName?: string;
2975 environment?: ReleaseEnvironment;
2976 environmentId?: number;
2977 projectName?: string;
2978 reason?: DeploymentReason;
2979 releaseCreatedBy?: VSSInterfaces.IdentityRef;
2980 releaseLogsUri?: string;
2981 releaseName?: string;
2982 status?: string;
2983 title?: string;
2984 webAccessUri?: string;
2985}
2986export declare enum ReleaseEnvironmentExpands {
2987 /**
2988 * Return top level properties of object.
2989 */
2990 None = 0,
2991 /**
2992 * Expand environment with tasks.
2993 */
2994 Tasks = 1
2995}
2996export interface ReleaseEnvironmentShallowReference {
2997 /**
2998 * Gets the links to related resources, APIs, and views for the release environment.
2999 */
3000 _links?: any;
3001 /**
3002 * Gets the unique identifier of release environment.
3003 */
3004 id?: number;
3005 /**
3006 * Gets or sets the name of the release environment.
3007 */
3008 name?: string;
3009 /**
3010 * Gets the REST API url to access the release environment.
3011 */
3012 url?: string;
3013}
3014export interface ReleaseEnvironmentStatusUpdatedEvent extends RealtimeReleaseDefinitionEvent {
3015 environmentId?: number;
3016 environmentStatus?: EnvironmentStatus;
3017 latestDeploymentOperationStatus?: DeploymentOperationStatus;
3018 latestDeploymentStatus?: DeploymentStatus;
3019 releaseId?: number;
3020}
3021export interface ReleaseEnvironmentUpdateMetadata {
3022 /**
3023 * Gets or sets comment.
3024 */
3025 comment?: string;
3026 /**
3027 * Gets or sets scheduled deployment time.
3028 */
3029 scheduledDeploymentTime?: Date;
3030 /**
3031 * Gets or sets status of environment.
3032 */
3033 status?: EnvironmentStatus;
3034 /**
3035 * Sets list of environment variables to be overridden at deployment time.
3036 */
3037 variables?: {
3038 [key: string]: ConfigurationVariableValue;
3039 };
3040}
3041export interface ReleaseEvent {
3042 id?: number;
3043 url?: string;
3044}
3045export declare enum ReleaseExpands {
3046 None = 0,
3047 Environments = 2,
3048 Artifacts = 4,
3049 Approvals = 8,
3050 ManualInterventions = 16,
3051 Variables = 32,
3052 Tags = 64
3053}
3054export interface ReleaseGates {
3055 /**
3056 * Contains the gates job details of each evaluation.
3057 */
3058 deploymentJobs?: DeploymentJob[];
3059 /**
3060 * ID of release gates.
3061 */
3062 id?: number;
3063 /**
3064 * List of ignored gates.
3065 */
3066 ignoredGates?: IgnoredGate[];
3067 /**
3068 * Gates last modified time.
3069 */
3070 lastModifiedOn?: Date;
3071 /**
3072 * Run plan ID of the gates.
3073 */
3074 runPlanId?: string;
3075 /**
3076 * Gates stabilization completed date and time.
3077 */
3078 stabilizationCompletedOn?: Date;
3079 /**
3080 * Gates evaluation started time.
3081 */
3082 startedOn?: Date;
3083 /**
3084 * Status of release gates.
3085 */
3086 status?: GateStatus;
3087 /**
3088 * Date and time at which all gates executed successfully.
3089 */
3090 succeedingSince?: Date;
3091}
3092export interface ReleaseGatesPhase extends ReleaseDeployPhase {
3093 /**
3094 * List of ignored gates.
3095 */
3096 ignoredGates?: IgnoredGate[];
3097 /**
3098 * Date and time at which stabilization of gates completed.
3099 */
3100 stabilizationCompletedOn?: Date;
3101 /**
3102 * Date and time at which all gates executed successfully.
3103 */
3104 succeedingSince?: Date;
3105}
3106export interface ReleaseManagementInputValue {
3107 /**
3108 * The text to show for the display of this value.
3109 */
3110 displayValue?: string;
3111 /**
3112 * The value to store for this input.
3113 */
3114 value?: string;
3115}
3116export interface ReleaseNotCreatedEvent {
3117 definitionReference?: ReleaseDefinitionShallowReference;
3118 message?: string;
3119 releaseReason?: ReleaseReason;
3120 requestedBy?: VSSInterfaces.IdentityRef;
3121}
3122export declare enum ReleaseQueryOrder {
3123 /**
3124 * Return results in descending order.
3125 */
3126 Descending = 0,
3127 /**
3128 * Return results in ascending order.
3129 */
3130 Ascending = 1
3131}
3132export declare enum ReleaseReason {
3133 /**
3134 * Indicates the release triggered reason not set.
3135 */
3136 None = 0,
3137 /**
3138 * Indicates the release triggered manually.
3139 */
3140 Manual = 1,
3141 /**
3142 * Indicates the release triggered by continuous integration.
3143 */
3144 ContinuousIntegration = 2,
3145 /**
3146 * Indicates the release triggered by schedule.
3147 */
3148 Schedule = 3,
3149 /**
3150 * Indicates the release triggered by PullRequest.
3151 */
3152 PullRequest = 4
3153}
3154export interface ReleaseReference {
3155 /**
3156 * Gets links to access the release.
3157 */
3158 _links?: any;
3159 /**
3160 * Gets list of artifacts.
3161 */
3162 artifacts?: Artifact[];
3163 /**
3164 * Gets the identity who created release.
3165 */
3166 createdBy?: VSSInterfaces.IdentityRef;
3167 /**
3168 * Gets date on when this release created.
3169 */
3170 createdOn?: Date;
3171 /**
3172 * Gets description.
3173 */
3174 description?: string;
3175 /**
3176 * ID of the Release.
3177 */
3178 id?: number;
3179 /**
3180 * Gets the identity who modified release.
3181 */
3182 modifiedBy?: VSSInterfaces.IdentityRef;
3183 /**
3184 * Gets name of release.
3185 */
3186 name?: string;
3187 /**
3188 * Gets reason for release.
3189 */
3190 reason?: ReleaseReason;
3191 /**
3192 * Gets release definition shallow reference.
3193 */
3194 releaseDefinition?: ReleaseDefinitionShallowReference;
3195 url?: string;
3196 webAccessUri?: string;
3197}
3198export interface ReleaseRevision {
3199 /**
3200 * Gets or sets the identity who changed.
3201 */
3202 changedBy?: VSSInterfaces.IdentityRef;
3203 /**
3204 * Change date of the revision.
3205 */
3206 changedDate?: Date;
3207 /**
3208 * Change details of the revision.
3209 */
3210 changeDetails?: string;
3211 /**
3212 * Change details of the revision. Typically ChangeDetails values are Add and Update.
3213 */
3214 changeType?: string;
3215 /**
3216 * Comment of the revision.
3217 */
3218 comment?: string;
3219 /**
3220 * Release ID of which this revision belongs.
3221 */
3222 definitionSnapshotRevision?: number;
3223 /**
3224 * Gets or sets the release ID of which this revision belongs.
3225 */
3226 releaseId?: number;
3227}
3228export interface ReleaseSchedule {
3229 /**
3230 * Days of the week to release.
3231 */
3232 daysToRelease?: ScheduleDays;
3233 /**
3234 * Team Foundation Job Definition Job Id.
3235 */
3236 jobId?: string;
3237 /**
3238 * Flag to determine if this schedule should only release if the associated artifact has been changed or release definition changed.
3239 */
3240 scheduleOnlyWithChanges?: boolean;
3241 /**
3242 * Local time zone hour to start.
3243 */
3244 startHours?: number;
3245 /**
3246 * Local time zone minute to start.
3247 */
3248 startMinutes?: number;
3249 /**
3250 * Time zone Id of release schedule, such as 'UTC'.
3251 */
3252 timeZoneId?: string;
3253}
3254export interface ReleaseSettings {
3255 /**
3256 * Release Compliance settings.
3257 */
3258 complianceSettings?: ComplianceSettings;
3259 /**
3260 * Release retention settings.
3261 */
3262 retentionSettings?: RetentionSettings;
3263}
3264export interface ReleaseShallowReference {
3265 /**
3266 * Gets the links to related resources, APIs, and views for the release.
3267 */
3268 _links?: any;
3269 /**
3270 * Gets the unique identifier of release.
3271 */
3272 id?: number;
3273 /**
3274 * Gets or sets the name of the release.
3275 */
3276 name?: string;
3277 /**
3278 * Gets the REST API url to access the release.
3279 */
3280 url?: string;
3281}
3282export interface ReleaseStartEnvironmentMetadata {
3283 /**
3284 * Sets release definition environment id.
3285 */
3286 definitionEnvironmentId?: number;
3287 /**
3288 * Sets list of environments variables to be overridden at deployment time.
3289 */
3290 variables?: {
3291 [key: string]: ConfigurationVariableValue;
3292 };
3293}
3294export interface ReleaseStartMetadata {
3295 /**
3296 * Sets list of artifact to create a release.
3297 */
3298 artifacts?: ArtifactMetadata[];
3299 /**
3300 * Optionally provide a requestor identity
3301 */
3302 createdFor?: string;
3303 /**
3304 * Sets definition Id to create a release.
3305 */
3306 definitionId?: number;
3307 /**
3308 * Sets description to create a release.
3309 */
3310 description?: string;
3311 /**
3312 * Sets list of environments meta data.
3313 */
3314 environmentsMetadata?: ReleaseStartEnvironmentMetadata[];
3315 /**
3316 * Sets 'true' to create release in draft mode, 'false' otherwise.
3317 */
3318 isDraft?: boolean;
3319 /**
3320 * Sets list of environments to manual as condition.
3321 */
3322 manualEnvironments?: string[];
3323 properties?: any;
3324 /**
3325 * Sets reason to create a release.
3326 */
3327 reason?: ReleaseReason;
3328 /**
3329 * Sets list of release variables to be overridden at deployment time.
3330 */
3331 variables?: {
3332 [key: string]: ConfigurationVariableValue;
3333 };
3334}
3335export declare enum ReleaseStatus {
3336 /**
3337 * Release status not set.
3338 */
3339 Undefined = 0,
3340 /**
3341 * Release is in draft state.
3342 */
3343 Draft = 1,
3344 /**
3345 * Release status is in active.
3346 */
3347 Active = 2,
3348 /**
3349 * Release status is in abandoned.
3350 */
3351 Abandoned = 4
3352}
3353export interface ReleaseTask {
3354 /**
3355 * Agent name on which task executed.
3356 */
3357 agentName?: string;
3358 dateEnded?: Date;
3359 dateStarted?: Date;
3360 /**
3361 * Finish time of the release task.
3362 */
3363 finishTime?: Date;
3364 /**
3365 * ID of the release task.
3366 */
3367 id?: number;
3368 /**
3369 * List of issues occurred while execution of task.
3370 */
3371 issues?: Issue[];
3372 /**
3373 * Number of lines log release task has.
3374 */
3375 lineCount?: number;
3376 /**
3377 * Log URL of the task.
3378 */
3379 logUrl?: string;
3380 /**
3381 * Name of the task.
3382 */
3383 name?: string;
3384 /**
3385 * Task execution complete precent.
3386 */
3387 percentComplete?: number;
3388 /**
3389 * Rank of the release task.
3390 */
3391 rank?: number;
3392 /**
3393 * Result code of the task.
3394 */
3395 resultCode?: string;
3396 /**
3397 * ID of the release task.
3398 */
3399 startTime?: Date;
3400 /**
3401 * Status of release task.
3402 */
3403 status?: TaskStatus;
3404 /**
3405 * Workflow task reference.
3406 */
3407 task?: WorkflowTaskReference;
3408 /**
3409 * Timeline record ID of the release task.
3410 */
3411 timelineRecordId?: string;
3412}
3413export interface ReleaseTaskAttachment {
3414 /**
3415 * Reference links of task.
3416 */
3417 _links?: any;
3418 /**
3419 * Data and time when it created.
3420 */
3421 createdOn?: Date;
3422 /**
3423 * Identity who modified.
3424 */
3425 modifiedBy?: VSSInterfaces.IdentityRef;
3426 /**
3427 * Data and time when modified.
3428 */
3429 modifiedOn?: Date;
3430 /**
3431 * Name of the task attachment.
3432 */
3433 name?: string;
3434 /**
3435 * Record ID of the task.
3436 */
3437 recordId?: string;
3438 /**
3439 * Timeline ID of the task.
3440 */
3441 timelineId?: string;
3442 /**
3443 * Type of task attachment.
3444 */
3445 type?: string;
3446}
3447export interface ReleaseTaskLogUpdatedEvent extends RealtimeReleaseEvent {
3448 lines?: string[];
3449 stepRecordId?: string;
3450 timelineRecordId?: string;
3451}
3452export interface ReleaseTasksUpdatedEvent extends RealtimeReleaseEvent {
3453 job?: ReleaseTask;
3454 planId?: string;
3455 releaseDeployPhaseId?: number;
3456 releaseStepId?: number;
3457 tasks?: ReleaseTask[];
3458}
3459export interface ReleaseTriggerBase {
3460 /**
3461 * Type of release trigger.
3462 */
3463 triggerType?: ReleaseTriggerType;
3464}
3465export declare enum ReleaseTriggerType {
3466 /**
3467 * Release trigger type not set.
3468 */
3469 Undefined = 0,
3470 /**
3471 * Artifact based release trigger.
3472 */
3473 ArtifactSource = 1,
3474 /**
3475 * Schedule based release trigger.
3476 */
3477 Schedule = 2,
3478 /**
3479 * Source repository based release trigger.
3480 */
3481 SourceRepo = 3,
3482 /**
3483 * Container image based release trigger.
3484 */
3485 ContainerImage = 4,
3486 /**
3487 * Package based release trigger.
3488 */
3489 Package = 5,
3490 /**
3491 * Pull request based release trigger.
3492 */
3493 PullRequest = 6
3494}
3495export interface ReleaseUpdatedEvent extends RealtimeReleaseEvent {
3496 release?: Release;
3497}
3498export interface ReleaseUpdateMetadata {
3499 /**
3500 * Sets comment for release.
3501 */
3502 comment?: string;
3503 /**
3504 * Set 'true' to exclude the release from retention policies.
3505 */
3506 keepForever?: boolean;
3507 /**
3508 * Sets list of manual environments.
3509 */
3510 manualEnvironments?: string[];
3511 /**
3512 * Sets name of the release.
3513 */
3514 name?: string;
3515 /**
3516 * Sets status of the release.
3517 */
3518 status?: ReleaseStatus;
3519}
3520export interface ReleaseWorkItemRef {
3521 assignee?: string;
3522 /**
3523 * Gets or sets the ID.
3524 */
3525 id?: string;
3526 /**
3527 * Gets or sets the provider.
3528 */
3529 provider?: string;
3530 /**
3531 * Gets or sets the state.
3532 */
3533 state?: string;
3534 /**
3535 * Gets or sets the title.
3536 */
3537 title?: string;
3538 /**
3539 * Gets or sets the type.
3540 */
3541 type?: string;
3542 /**
3543 * Gets or sets the workitem url.
3544 */
3545 url?: string;
3546}
3547/**
3548 * Represents a reference to a resource.
3549 */
3550export interface ResourceReference {
3551 /**
3552 * An alias to be used when referencing the resource.
3553 */
3554 alias?: string;
3555}
3556export interface RetentionPolicy {
3557 /**
3558 * Indicates the number of days to keep deployment.
3559 */
3560 daysToKeep?: number;
3561}
3562export interface RetentionSettings {
3563 /**
3564 * Number of days to keep deleted releases.
3565 */
3566 daysToKeepDeletedReleases?: number;
3567 /**
3568 * Specifies the default environment retention policy.
3569 */
3570 defaultEnvironmentRetentionPolicy?: EnvironmentRetentionPolicy;
3571 /**
3572 * Specifies the maximum environment retention policy.
3573 */
3574 maximumEnvironmentRetentionPolicy?: EnvironmentRetentionPolicy;
3575}
3576export interface RunOnServerDeployPhase extends DeployPhase {
3577 /**
3578 * Gets and sets the agentless job input.
3579 */
3580 deploymentInput?: ServerDeploymentInput;
3581}
3582export declare enum ScheduleDays {
3583 /**
3584 * Scheduled day not set.
3585 */
3586 None = 0,
3587 /**
3588 * Scheduled on Monday.
3589 */
3590 Monday = 1,
3591 /**
3592 * Scheduled on Tuesday.
3593 */
3594 Tuesday = 2,
3595 /**
3596 * Scheduled on Wednesday.
3597 */
3598 Wednesday = 4,
3599 /**
3600 * Scheduled on Thursday.
3601 */
3602 Thursday = 8,
3603 /**
3604 * Scheduled on Friday.
3605 */
3606 Friday = 16,
3607 /**
3608 * Scheduled on Saturday.
3609 */
3610 Saturday = 32,
3611 /**
3612 * Scheduled on Sunday.
3613 */
3614 Sunday = 64,
3615 /**
3616 * Scheduled on all the days in week.
3617 */
3618 All = 127
3619}
3620export interface ScheduledReleaseTrigger extends ReleaseTriggerBase {
3621 /**
3622 * Release schedule for Scheduled Release trigger type.
3623 */
3624 schedule?: ReleaseSchedule;
3625}
3626export declare enum SenderType {
3627 ServiceAccount = 1,
3628 RequestingUser = 2
3629}
3630export interface ServerDeploymentInput extends BaseDeploymentInput {
3631 /**
3632 * Gets or sets the parallel execution input.
3633 */
3634 parallelExecution?: ExecutionInput;
3635}
3636/**
3637 * Represents a reference to a service endpoint.
3638 */
3639export interface ServiceEndpointReference extends ResourceReference {
3640 /**
3641 * The ID of the service endpoint.
3642 */
3643 id?: string;
3644}
3645export declare enum SingleReleaseExpands {
3646 /**
3647 * Return top level properties of object.
3648 */
3649 None = 0,
3650 /**
3651 * Expand release with tasks.
3652 */
3653 Tasks = 1
3654}
3655export interface SourceIdInput {
3656 /**
3657 * ID of source.
3658 */
3659 id?: string;
3660 /**
3661 * Name of the source.
3662 */
3663 name?: string;
3664}
3665export interface SourcePullRequestVersion {
3666 /**
3667 * Pull Request Iteration Id for which the release will publish status.
3668 */
3669 iterationId?: string;
3670 /**
3671 * Pull Request Id for which the release will publish status.
3672 */
3673 pullRequestId?: string;
3674 /**
3675 * Date and time of the pull request merge creation. It is required to keep timeline record of Releases created by pull request.
3676 */
3677 pullRequestMergedAt?: Date;
3678 /**
3679 * Source branch of the Pull Request.
3680 */
3681 sourceBranch?: string;
3682 /**
3683 * Source branch commit Id of the Pull Request for which the release will publish status.
3684 */
3685 sourceBranchCommitId?: string;
3686 /**
3687 * Target branch of the Pull Request.
3688 */
3689 targetBranch?: string;
3690}
3691export interface SourceRepoTrigger extends ReleaseTriggerBase {
3692 /**
3693 * Alias of the source repo trigger.
3694 */
3695 alias?: string;
3696 branchFilters?: string[];
3697}
3698export interface SummaryMailSection {
3699 /**
3700 * Html content of summary mail.
3701 */
3702 htmlContent?: string;
3703 /**
3704 * Rank of the summary mail.
3705 */
3706 rank?: number;
3707 /**
3708 * Summary mail section type. MailSectionType has section types.
3709 */
3710 sectionType?: MailSectionType;
3711 /**
3712 * Title of the summary mail.
3713 */
3714 title?: string;
3715}
3716export interface TagFilter {
3717 /**
3718 * Gets or sets the tag filter pattern.
3719 */
3720 pattern?: string;
3721}
3722export interface TaskOrchestrationPlanGroupReference {
3723 /**
3724 * Gets or sets the plan group.
3725 */
3726 planGroup?: string;
3727 /**
3728 * ID of the Project.
3729 */
3730 projectId?: string;
3731}
3732export interface TaskOrchestrationPlanGroupsStartedEvent {
3733 planGroups?: TaskOrchestrationPlanGroupReference[];
3734}
3735export declare enum TaskStatus {
3736 /**
3737 * The task does not have the status set.
3738 */
3739 Unknown = 0,
3740 /**
3741 * The task is in pending status.
3742 */
3743 Pending = 1,
3744 /**
3745 * The task is currently in progress.
3746 */
3747 InProgress = 2,
3748 /**
3749 * The task completed successfully.
3750 */
3751 Success = 3,
3752 /**
3753 * The task execution failed.
3754 */
3755 Failure = 4,
3756 /**
3757 * The task execution canceled.
3758 */
3759 Canceled = 5,
3760 /**
3761 * The task execution skipped.
3762 */
3763 Skipped = 6,
3764 /**
3765 * The task completed successfully.
3766 */
3767 Succeeded = 7,
3768 /**
3769 * The task execution failed.
3770 */
3771 Failed = 8,
3772 /**
3773 * The task execution partially succeeded.
3774 */
3775 PartiallySucceeded = 9
3776}
3777export interface TfvcArtifactDownloadInput extends ArtifactDownloadInputBase {
3778}
3779export interface TimeZone {
3780 /**
3781 * Display name of the time zone.
3782 */
3783 displayName?: string;
3784 /**
3785 * Id of the time zone.
3786 */
3787 id?: string;
3788}
3789export interface TimeZoneList {
3790 /**
3791 * UTC timezone.
3792 */
3793 utcTimeZone?: TimeZone;
3794 /**
3795 * List of valid timezones.
3796 */
3797 validTimeZones?: TimeZone[];
3798}
3799export interface VariableGroup {
3800 /**
3801 * Gets or sets the identity who created.
3802 */
3803 createdBy?: VSSInterfaces.IdentityRef;
3804 /**
3805 * Gets date on which it got created.
3806 */
3807 createdOn?: Date;
3808 /**
3809 * Gets or sets description.
3810 */
3811 description?: string;
3812 /**
3813 * Gets the unique identifier of this field.
3814 */
3815 id?: number;
3816 /**
3817 * Denotes if a variable group is shared with other project or not.
3818 */
3819 isShared?: boolean;
3820 /**
3821 * Gets or sets the identity who modified.
3822 */
3823 modifiedBy?: VSSInterfaces.IdentityRef;
3824 /**
3825 * Gets date on which it got modified.
3826 */
3827 modifiedOn?: Date;
3828 /**
3829 * Gets or sets name.
3830 */
3831 name?: string;
3832 /**
3833 * Gets or sets provider data.
3834 */
3835 providerData?: VariableGroupProviderData;
3836 /**
3837 * Gets or sets type.
3838 */
3839 type?: string;
3840 /**
3841 * all project references where the variable group is shared with other projects.
3842 */
3843 variableGroupProjectReferences?: VariableGroupProjectReference[];
3844 /**
3845 * Gets and sets the dictionary of variables.
3846 */
3847 variables?: {
3848 [key: string]: VariableValue;
3849 };
3850}
3851export declare enum VariableGroupActionFilter {
3852 None = 0,
3853 Manage = 2,
3854 Use = 16
3855}
3856/**
3857 * A variable group reference is a shallow reference to variable group.
3858 */
3859export interface VariableGroupProjectReference {
3860 /**
3861 * Gets or sets description of the variable group.
3862 */
3863 description?: string;
3864 /**
3865 * Gets or sets name of the variable group.
3866 */
3867 name?: string;
3868 /**
3869 * Gets or sets project reference of the variable group.
3870 */
3871 projectReference?: ProjectReference;
3872}
3873export interface VariableGroupProviderData {
3874}
3875export interface VariableValue {
3876 /**
3877 * Gets or sets if the variable is read only or not.
3878 */
3879 isReadOnly?: boolean;
3880 /**
3881 * Gets or sets as the variable is secret or not.
3882 */
3883 isSecret?: boolean;
3884 /**
3885 * Gets or sets the value.
3886 */
3887 value?: string;
3888}
3889export interface WorkflowTask {
3890 /**
3891 * Gets or sets as the task always run or not.
3892 */
3893 alwaysRun?: boolean;
3894 /**
3895 * Gets or sets the check configuration if check is injected as gate.
3896 */
3897 checkConfig?: CheckConfigurationReference;
3898 /**
3899 * Gets or sets the task condition.
3900 */
3901 condition?: string;
3902 /**
3903 * Gets or sets as the task continue run on error or not.
3904 */
3905 continueOnError?: boolean;
3906 /**
3907 * Gets or sets the task definition type. Example:- 'Agent', DeploymentGroup', 'Server' or 'ServerGate'.
3908 */
3909 definitionType?: string;
3910 /**
3911 * Gets or sets as the task enabled or not.
3912 */
3913 enabled?: boolean;
3914 /**
3915 * Gets or sets the task environment variables.
3916 */
3917 environment?: {
3918 [key: string]: string;
3919 };
3920 /**
3921 * Gets or sets the task inputs.
3922 */
3923 inputs?: {
3924 [key: string]: string;
3925 };
3926 /**
3927 * Gets or sets the name of the task.
3928 */
3929 name?: string;
3930 /**
3931 * Gets or sets the task override inputs.
3932 */
3933 overrideInputs?: {
3934 [key: string]: string;
3935 };
3936 /**
3937 * Gets or sets the reference name of the task.
3938 */
3939 refName?: string;
3940 /**
3941 * Gets or sets the task retryCount.
3942 */
3943 retryCountOnTaskFailure?: number;
3944 /**
3945 * Gets or sets the ID of the task.
3946 */
3947 taskId: string;
3948 /**
3949 * Gets or sets the task timeout.
3950 */
3951 timeoutInMinutes?: number;
3952 /**
3953 * Gets or sets the version of the task.
3954 */
3955 version: string;
3956}
3957export interface WorkflowTaskReference {
3958 /**
3959 * Task identifier.
3960 */
3961 id?: string;
3962 /**
3963 * Name of the task.
3964 */
3965 name?: string;
3966 /**
3967 * Version of the task.
3968 */
3969 version?: string;
3970}
3971export interface YamlFileSource {
3972 /**
3973 * Gets or sets definition reference. e.g. {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}
3974 */
3975 sourceReference?: {
3976 [key: string]: YamlSourceReference;
3977 };
3978 type?: YamlFileSourceTypes;
3979}
3980export declare enum YamlFileSourceTypes {
3981 None = 0,
3982 TFSGit = 1
3983}
3984export interface YamlPipelineProcess extends PipelineProcess {
3985 errors?: string[];
3986 filename?: string;
3987 fileSource?: YamlFileSource;
3988 resources?: YamlPipelineProcessResources;
3989}
3990export interface YamlPipelineProcessResources {
3991 endpoints?: ServiceEndpointReference[];
3992 queues?: AgentPoolQueueReference[];
3993}
3994export interface YamlSourceReference {
3995 id?: string;
3996 name?: string;
3997}
3998export declare var TypeInfo: {
3999 AgentArtifactDefinition: any;
4000 AgentArtifactType: {
4001 enumValues: {
4002 xamlBuild: number;
4003 build: number;
4004 jenkins: number;
4005 fileShare: number;
4006 nuget: number;
4007 tfsOnPrem: number;
4008 gitHub: number;
4009 tfGit: number;
4010 externalTfsBuild: number;
4011 custom: number;
4012 tfvc: number;
4013 };
4014 };
4015 AgentBasedDeployPhase: any;
4016 AgentDeploymentInput: any;
4017 ApprovalExecutionOrder: {
4018 enumValues: {
4019 beforeGates: number;
4020 afterSuccessfulGates: number;
4021 afterGatesAlways: number;
4022 };
4023 };
4024 ApprovalFilters: {
4025 enumValues: {
4026 none: number;
4027 manualApprovals: number;
4028 automatedApprovals: number;
4029 approvalSnapshots: number;
4030 all: number;
4031 };
4032 };
4033 ApprovalOptions: any;
4034 ApprovalStatus: {
4035 enumValues: {
4036 undefined: number;
4037 pending: number;
4038 approved: number;
4039 rejected: number;
4040 reassigned: number;
4041 canceled: number;
4042 skipped: number;
4043 };
4044 };
4045 ApprovalType: {
4046 enumValues: {
4047 undefined: number;
4048 preDeploy: number;
4049 postDeploy: number;
4050 all: number;
4051 };
4052 };
4053 ArtifactContributionDefinition: any;
4054 ArtifactMetadata: any;
4055 ArtifactSourceTrigger: any;
4056 ArtifactTypeDefinition: any;
4057 ArtifactVersion: any;
4058 ArtifactVersionQueryResult: any;
4059 AuditAction: {
4060 enumValues: {
4061 add: number;
4062 update: number;
4063 delete: number;
4064 undelete: number;
4065 };
4066 };
4067 AuthorizationHeaderFor: {
4068 enumValues: {
4069 revalidateApproverIdentity: number;
4070 onBehalfOf: number;
4071 };
4072 };
4073 AutoTriggerIssue: any;
4074 AzureKeyVaultVariableGroupProviderData: any;
4075 AzureKeyVaultVariableValue: any;
4076 BuildVersion: any;
4077 Change: any;
4078 CodeRepositoryReference: any;
4079 Condition: any;
4080 ConditionType: {
4081 enumValues: {
4082 undefined: number;
4083 event: number;
4084 environmentState: number;
4085 artifact: number;
4086 };
4087 };
4088 ContainerImageTrigger: any;
4089 ContinuousDeploymentTriggerIssue: any;
4090 Deployment: any;
4091 DeploymentApprovalCompletedEvent: any;
4092 DeploymentApprovalPendingEvent: any;
4093 DeploymentAttempt: any;
4094 DeploymentAuthorizationInfo: any;
4095 DeploymentAuthorizationOwner: {
4096 enumValues: {
4097 automatic: number;
4098 deploymentSubmitter: number;
4099 firstPreDeploymentApprover: number;
4100 };
4101 };
4102 DeploymentCompletedEvent: any;
4103 DeploymentExpands: {
4104 enumValues: {
4105 all: number;
4106 deploymentOnly: number;
4107 approvals: number;
4108 artifacts: number;
4109 };
4110 };
4111 DeploymentJob: any;
4112 DeploymentManualInterventionPendingEvent: any;
4113 DeploymentOperationStatus: {
4114 enumValues: {
4115 undefined: number;
4116 queued: number;
4117 scheduled: number;
4118 pending: number;
4119 approved: number;
4120 rejected: number;
4121 deferred: number;
4122 queuedForAgent: number;
4123 phaseInProgress: number;
4124 phaseSucceeded: number;
4125 phasePartiallySucceeded: number;
4126 phaseFailed: number;
4127 canceled: number;
4128 phaseCanceled: number;
4129 manualInterventionPending: number;
4130 queuedForPipeline: number;
4131 cancelling: number;
4132 evaluatingGates: number;
4133 gateFailed: number;
4134 all: number;
4135 };
4136 };
4137 DeploymentQueryParameters: any;
4138 DeploymentReason: {
4139 enumValues: {
4140 none: number;
4141 manual: number;
4142 automated: number;
4143 scheduled: number;
4144 redeployTrigger: number;
4145 };
4146 };
4147 DeploymentsQueryType: {
4148 enumValues: {
4149 regular: number;
4150 failingSince: number;
4151 };
4152 };
4153 DeploymentStartedEvent: any;
4154 DeploymentStatus: {
4155 enumValues: {
4156 undefined: number;
4157 notDeployed: number;
4158 inProgress: number;
4159 succeeded: number;
4160 partiallySucceeded: number;
4161 failed: number;
4162 all: number;
4163 };
4164 };
4165 DeployPhase: any;
4166 DeployPhaseStatus: {
4167 enumValues: {
4168 undefined: number;
4169 notStarted: number;
4170 inProgress: number;
4171 partiallySucceeded: number;
4172 succeeded: number;
4173 failed: number;
4174 canceled: number;
4175 skipped: number;
4176 cancelling: number;
4177 };
4178 };
4179 DeployPhaseTypes: {
4180 enumValues: {
4181 undefined: number;
4182 agentBasedDeployment: number;
4183 runOnServer: number;
4184 machineGroupBasedDeployment: number;
4185 deploymentGates: number;
4186 };
4187 };
4188 EnvironmentStatus: {
4189 enumValues: {
4190 undefined: number;
4191 notStarted: number;
4192 inProgress: number;
4193 succeeded: number;
4194 canceled: number;
4195 rejected: number;
4196 queued: number;
4197 scheduled: number;
4198 partiallySucceeded: number;
4199 };
4200 };
4201 EnvironmentTrigger: any;
4202 EnvironmentTriggerType: {
4203 enumValues: {
4204 undefined: number;
4205 deploymentGroupRedeploy: number;
4206 rollbackRedeploy: number;
4207 };
4208 };
4209 ExecutionInput: any;
4210 Folder: any;
4211 FolderPathQueryOrder: {
4212 enumValues: {
4213 none: number;
4214 ascending: number;
4215 descending: number;
4216 };
4217 };
4218 GatesDeployPhase: any;
4219 GateStatus: {
4220 enumValues: {
4221 none: number;
4222 pending: number;
4223 inProgress: number;
4224 succeeded: number;
4225 failed: number;
4226 canceled: number;
4227 };
4228 };
4229 IgnoredGate: any;
4230 IssueSource: {
4231 enumValues: {
4232 none: number;
4233 user: number;
4234 system: number;
4235 };
4236 };
4237 MachineGroupBasedDeployPhase: any;
4238 MailMessage: any;
4239 MailSectionType: {
4240 enumValues: {
4241 details: number;
4242 environments: number;
4243 issues: number;
4244 testResults: number;
4245 workItems: number;
4246 releaseInfo: number;
4247 };
4248 };
4249 ManualIntervention: any;
4250 ManualInterventionStatus: {
4251 enumValues: {
4252 unknown: number;
4253 pending: number;
4254 rejected: number;
4255 approved: number;
4256 canceled: number;
4257 };
4258 };
4259 ManualInterventionUpdateMetadata: any;
4260 MultiConfigInput: any;
4261 MultiMachineInput: any;
4262 PackageTrigger: any;
4263 ParallelExecutionInputBase: any;
4264 ParallelExecutionTypes: {
4265 enumValues: {
4266 none: number;
4267 multiConfiguration: number;
4268 multiMachine: number;
4269 };
4270 };
4271 PipelineProcess: any;
4272 PipelineProcessTypes: {
4273 enumValues: {
4274 designer: number;
4275 yaml: number;
4276 };
4277 };
4278 PropertySelector: any;
4279 PropertySelectorType: {
4280 enumValues: {
4281 inclusion: number;
4282 exclusion: number;
4283 };
4284 };
4285 PullRequestConfiguration: any;
4286 PullRequestSystemType: {
4287 enumValues: {
4288 none: number;
4289 tfsGit: number;
4290 gitHub: number;
4291 };
4292 };
4293 PullRequestTrigger: any;
4294 Release: any;
4295 ReleaseAbandonedEvent: any;
4296 ReleaseApproval: any;
4297 ReleaseApprovalHistory: any;
4298 ReleaseApprovalPendingEvent: any;
4299 ReleaseCondition: any;
4300 ReleaseCreatedEvent: any;
4301 ReleaseDefinition: any;
4302 ReleaseDefinitionApprovals: any;
4303 ReleaseDefinitionEnvironment: any;
4304 ReleaseDefinitionEnvironmentTemplate: any;
4305 ReleaseDefinitionExpands: {
4306 enumValues: {
4307 none: number;
4308 environments: number;
4309 artifacts: number;
4310 triggers: number;
4311 variables: number;
4312 tags: number;
4313 lastRelease: number;
4314 };
4315 };
4316 ReleaseDefinitionQueryOrder: {
4317 enumValues: {
4318 idAscending: number;
4319 idDescending: number;
4320 nameAscending: number;
4321 nameDescending: number;
4322 };
4323 };
4324 ReleaseDefinitionRevision: any;
4325 ReleaseDefinitionSource: {
4326 enumValues: {
4327 undefined: number;
4328 restApi: number;
4329 userInterface: number;
4330 ibiza: number;
4331 portalExtensionApi: number;
4332 };
4333 };
4334 ReleaseDefinitionSummary: any;
4335 ReleaseDeployPhase: any;
4336 ReleaseEnvironment: any;
4337 ReleaseEnvironmentCompletedEvent: any;
4338 ReleaseEnvironmentExpands: {
4339 enumValues: {
4340 none: number;
4341 tasks: number;
4342 };
4343 };
4344 ReleaseEnvironmentStatusUpdatedEvent: any;
4345 ReleaseEnvironmentUpdateMetadata: any;
4346 ReleaseExpands: {
4347 enumValues: {
4348 none: number;
4349 environments: number;
4350 artifacts: number;
4351 approvals: number;
4352 manualInterventions: number;
4353 variables: number;
4354 tags: number;
4355 };
4356 };
4357 ReleaseGates: any;
4358 ReleaseGatesPhase: any;
4359 ReleaseNotCreatedEvent: any;
4360 ReleaseQueryOrder: {
4361 enumValues: {
4362 descending: number;
4363 ascending: number;
4364 };
4365 };
4366 ReleaseReason: {
4367 enumValues: {
4368 none: number;
4369 manual: number;
4370 continuousIntegration: number;
4371 schedule: number;
4372 pullRequest: number;
4373 };
4374 };
4375 ReleaseReference: any;
4376 ReleaseRevision: any;
4377 ReleaseSchedule: any;
4378 ReleaseStartMetadata: any;
4379 ReleaseStatus: {
4380 enumValues: {
4381 undefined: number;
4382 draft: number;
4383 active: number;
4384 abandoned: number;
4385 };
4386 };
4387 ReleaseTask: any;
4388 ReleaseTaskAttachment: any;
4389 ReleaseTasksUpdatedEvent: any;
4390 ReleaseTriggerBase: any;
4391 ReleaseTriggerType: {
4392 enumValues: {
4393 undefined: number;
4394 artifactSource: number;
4395 schedule: number;
4396 sourceRepo: number;
4397 containerImage: number;
4398 package: number;
4399 pullRequest: number;
4400 };
4401 };
4402 ReleaseUpdatedEvent: any;
4403 ReleaseUpdateMetadata: any;
4404 RunOnServerDeployPhase: any;
4405 ScheduleDays: {
4406 enumValues: {
4407 none: number;
4408 monday: number;
4409 tuesday: number;
4410 wednesday: number;
4411 thursday: number;
4412 friday: number;
4413 saturday: number;
4414 sunday: number;
4415 all: number;
4416 };
4417 };
4418 ScheduledReleaseTrigger: any;
4419 SenderType: {
4420 enumValues: {
4421 serviceAccount: number;
4422 requestingUser: number;
4423 };
4424 };
4425 ServerDeploymentInput: any;
4426 SingleReleaseExpands: {
4427 enumValues: {
4428 none: number;
4429 tasks: number;
4430 };
4431 };
4432 SourcePullRequestVersion: any;
4433 SourceRepoTrigger: any;
4434 SummaryMailSection: any;
4435 TaskStatus: {
4436 enumValues: {
4437 unknown: number;
4438 pending: number;
4439 inProgress: number;
4440 success: number;
4441 failure: number;
4442 canceled: number;
4443 skipped: number;
4444 succeeded: number;
4445 failed: number;
4446 partiallySucceeded: number;
4447 };
4448 };
4449 VariableGroup: any;
4450 VariableGroupActionFilter: {
4451 enumValues: {
4452 none: number;
4453 manage: number;
4454 use: number;
4455 };
4456 };
4457 YamlFileSource: any;
4458 YamlFileSourceTypes: {
4459 enumValues: {
4460 none: number;
4461 tfsGit: number;
4462 };
4463 };
4464 YamlPipelineProcess: any;
4465};