1
- // Type definitions for Microsoft Visual Studio Services v104.20160831.1112
1
+ // Type definitions for Microsoft Visual Studio Services v105.20160914.0830
2
2
// Project: https://www.visualstudio.com/integrate/extensions/overview
3
3
// Definitions by: Microsoft <[email protected] >
4
4
@@ -65,6 +65,8 @@ export module WellKnownReleaseVariables {
65
65
var ReleaseDescription : string ;
66
66
var ReleaseDefinitionName : string ;
67
67
var ReleaseDefinitionId : string ;
68
+ var ReleaseDefinitionEnvironmentId : string ;
69
+ var DeploymentId : string ;
68
70
var ReleaseUri : string ;
69
71
var ReleaseWebUrl : string ;
70
72
var ReleaseEnvironmentUri : string ;
@@ -300,7 +302,29 @@ export interface DataSourceBinding {
300
302
resultSelector : string ;
301
303
resultTemplate : string ;
302
304
target : string ;
303
- transformationTemplate : string ;
305
+ }
306
+ export interface DefinitionEnvironmentReference {
307
+ definitionEnvironmentId : number ;
308
+ releaseDefinitionId : number ;
309
+ }
310
+ export interface Deployment {
311
+ attempt : number ;
312
+ conditions : Condition [ ] ;
313
+ definitionEnvironmentId : number ;
314
+ deploymentStatus : DeploymentStatus ;
315
+ id : number ;
316
+ lastModifiedBy : VSS_Common_Contracts . IdentityRef ;
317
+ lastModifiedOn : Date ;
318
+ operationStatus : DeploymentOperationStatus ;
319
+ postDeployApprovals : ReleaseApproval [ ] ;
320
+ preDeployApprovals : ReleaseApproval [ ] ;
321
+ reason : DeploymentReason ;
322
+ release : ReleaseReference ;
323
+ releaseDefinition : ShallowReference ;
324
+ releaseEnvironment : ShallowReference ;
325
+ requestedBy : VSS_Common_Contracts . IdentityRef ;
326
+ scheduledDeploymentTime : Date ;
327
+ startedOn : Date ;
304
328
}
305
329
export interface DeploymentApprovalCompletedEvent {
306
330
approval : ReleaseApproval ;
@@ -359,6 +383,19 @@ export enum DeploymentOperationStatus {
359
383
PhaseFailed = 1024 ,
360
384
Canceled = 2048 ,
361
385
PhaseCanceled = 4096 ,
386
+ ManualInterventionPending = 8192 ,
387
+ }
388
+ export interface DeploymentQueryParameters {
389
+ artifactSourceId : string ;
390
+ artifactTypeId : string ;
391
+ artifactVersions : string [ ] ;
392
+ deploymentStatus : DeploymentStatus ;
393
+ environments : DefinitionEnvironmentReference [ ] ;
394
+ isDeleted : boolean ;
395
+ latestDeploymentsOnly : boolean ;
396
+ maxDeploymentsPerEnvironment : number ;
397
+ operationStatus : DeploymentOperationStatus ;
398
+ queryOrder : ReleaseQueryOrder ;
362
399
}
363
400
export enum DeploymentReason {
364
401
None = 0 ,
@@ -379,7 +416,6 @@ export enum DeploymentStatus {
379
416
Failed = 16 ,
380
417
}
381
418
export interface DeployPhase {
382
- controlOptions : ControlOptions ;
383
419
name : string ;
384
420
phaseType : DeployPhaseTypes ;
385
421
rank : number ;
@@ -730,9 +766,6 @@ export interface ReleaseEnvironment {
730
766
releaseDefinition : ShallowReference ;
731
767
releaseDescription : string ;
732
768
releaseId : number ;
733
- runOptions : {
734
- [ key : string ] : string ;
735
- } ;
736
769
scheduledDeploymentTime : Date ;
737
770
schedules : ReleaseSchedule [ ] ;
738
771
status : EnvironmentStatus ;
@@ -781,6 +814,12 @@ export enum ReleaseReason {
781
814
ContinuousIntegration = 2 ,
782
815
Schedule = 3 ,
783
816
}
817
+ export interface ReleaseReference {
818
+ artifacts : Artifact [ ] ;
819
+ id : number ;
820
+ name : string ;
821
+ url : string ;
822
+ }
784
823
export interface ReleaseRevision {
785
824
changedBy : VSS_Common_Contracts . IdentityRef ;
786
825
changedDate : Date ;
@@ -812,6 +851,9 @@ export interface ReleaseSchedule {
812
851
*/
813
852
timeZoneId : string ;
814
853
}
854
+ export interface ReleaseSettings {
855
+ retentionSettings : RetentionSettings ;
856
+ }
815
857
export interface ReleaseStartMetadata {
816
858
artifacts : ArtifactMetadata [ ] ;
817
859
definitionId : number ;
@@ -877,6 +919,11 @@ export interface ReleaseWorkItemRef {
877
919
export interface RetentionPolicy {
878
920
daysToKeep : number ;
879
921
}
922
+ export interface RetentionSettings {
923
+ daysToKeepDeletedReleases : number ;
924
+ defaultEnvironmentRetentionPolicy : EnvironmentRetentionPolicy ;
925
+ maximumEnvironmentRetentionPolicy : EnvironmentRetentionPolicy ;
926
+ }
880
927
export interface RunOnServerDeployPhase extends DeployPhase {
881
928
}
882
929
export enum ScheduleDays {
@@ -1004,6 +1051,7 @@ export var TypeInfo: {
1004
1051
"environmentState" : number ;
1005
1052
} ;
1006
1053
} ;
1054
+ Deployment : any ;
1007
1055
DeploymentApprovalCompletedEvent : any ;
1008
1056
DeploymentApprovalPendingEvent : any ;
1009
1057
DeploymentAttempt : any ;
@@ -1025,8 +1073,10 @@ export var TypeInfo: {
1025
1073
"phaseFailed" : number ;
1026
1074
"canceled" : number ;
1027
1075
"phaseCanceled" : number ;
1076
+ "manualInterventionPending" : number ;
1028
1077
} ;
1029
1078
} ;
1079
+ DeploymentQueryParameters : any ;
1030
1080
DeploymentReason : {
1031
1081
enumValues : {
1032
1082
"none" : number ;
@@ -1481,9 +1531,10 @@ export class CommonMethods2_2To3 extends CommonMethods2To3 {
1481
1531
* @param {number } definitionId
1482
1532
* @param {number } releaseCount
1483
1533
* @param {boolean } includeArtifact
1534
+ * @param {number[] } definitionEnvironmentIdsFilter
1484
1535
* @return IPromise<Contracts.ReleaseDefinitionSummary>
1485
1536
*/
1486
- getReleaseDefinitionSummary ( project : string , definitionId : number , releaseCount : number , includeArtifact ?: boolean ) : IPromise < Contracts . ReleaseDefinitionSummary > ;
1537
+ getReleaseDefinitionSummary ( project : string , definitionId : number , releaseCount : number , includeArtifact ?: boolean , definitionEnvironmentIdsFilter ?: number [ ] ) : IPromise < Contracts . ReleaseDefinitionSummary > ;
1487
1538
/**
1488
1539
* [Preview API]
1489
1540
*
@@ -1712,6 +1763,30 @@ export class CommonMethods2_2To3 extends CommonMethods2To3 {
1712
1763
*/
1713
1764
export class ReleaseHttpClient3 extends CommonMethods2_2To3 {
1714
1765
constructor ( rootRequestPath : string , options ?: VSS_WebApi . IVssHttpClientOptions ) ;
1766
+ /**
1767
+ * [Preview API]
1768
+ *
1769
+ * @param {string } project - Project ID or project name
1770
+ * @param {number } definitionId
1771
+ * @param {number } definitionEnvironmentId
1772
+ * @param {string } createdBy
1773
+ * @param {Contracts.DeploymentStatus } deploymentStatus
1774
+ * @param {Contracts.DeploymentOperationStatus } operationStatus
1775
+ * @param {boolean } latestAttemptsOnly
1776
+ * @param {Contracts.ReleaseQueryOrder } queryOrder
1777
+ * @param {number } top
1778
+ * @param {number } continuationToken
1779
+ * @return IPromise<Contracts.Deployment[]>
1780
+ */
1781
+ getDeployments ( project : string , definitionId ?: number , definitionEnvironmentId ?: number , createdBy ?: string , deploymentStatus ?: Contracts . DeploymentStatus , operationStatus ?: Contracts . DeploymentOperationStatus , latestAttemptsOnly ?: boolean , queryOrder ?: Contracts . ReleaseQueryOrder , top ?: number , continuationToken ?: number ) : IPromise < Contracts . Deployment [ ] > ;
1782
+ /**
1783
+ * [Preview API]
1784
+ *
1785
+ * @param {Contracts.DeploymentQueryParameters } queryParameters
1786
+ * @param {string } project - Project ID or project name
1787
+ * @return IPromise<Contracts.Deployment[]>
1788
+ */
1789
+ getDeploymentsForMultipleEnvironments ( queryParameters : Contracts . DeploymentQueryParameters , project : string ) : IPromise < Contracts . Deployment [ ] > ;
1715
1790
/**
1716
1791
* [Preview API]
1717
1792
*
@@ -1759,6 +1834,21 @@ export class ReleaseHttpClient3 extends CommonMethods2_2To3 {
1759
1834
* @return IPromise<void>
1760
1835
*/
1761
1836
undeleteRelease ( project : string , releaseId : number , comment : string ) : IPromise < void > ;
1837
+ /**
1838
+ * [Preview API]
1839
+ *
1840
+ * @param {string } project - Project ID or project name
1841
+ * @return IPromise<Contracts.ReleaseSettings>
1842
+ */
1843
+ getReleaseSettings ( project : string ) : IPromise < Contracts . ReleaseSettings > ;
1844
+ /**
1845
+ * [Preview API] Updates the release settings
1846
+ *
1847
+ * @param {Contracts.ReleaseSettings } releaseSettings
1848
+ * @param {string } project - Project ID or project name
1849
+ * @return IPromise<Contracts.ReleaseSettings>
1850
+ */
1851
+ updateReleaseSettings ( releaseSettings : Contracts . ReleaseSettings , project : string ) : IPromise < Contracts . ReleaseSettings > ;
1762
1852
/**
1763
1853
* [Preview API]
1764
1854
*
@@ -1778,21 +1868,39 @@ export class ReleaseHttpClient3 extends CommonMethods2_2To3 {
1778
1868
*/
1779
1869
getTasksForTaskGroup ( project : string , releaseId : number , environmentId : number , releaseDeployPhaseId : number ) : IPromise < Contracts . ReleaseTask [ ] > ;
1780
1870
}
1871
+ /**
1872
+ * @exemptedapi
1873
+ */
1874
+ export class ReleaseHttpClient2_3 extends CommonMethods2_2To3 {
1875
+ constructor ( rootRequestPath : string , options ?: VSS_WebApi . IVssHttpClientOptions ) ;
1876
+ }
1781
1877
/**
1782
1878
* @exemptedapi
1783
1879
*/
1784
1880
export class ReleaseHttpClient2_2 extends CommonMethods2_2To3 {
1785
1881
constructor ( rootRequestPath : string , options ?: VSS_WebApi . IVssHttpClientOptions ) ;
1786
1882
}
1883
+ /**
1884
+ * @exemptedapi
1885
+ */
1886
+ export class ReleaseHttpClient2_1 extends CommonMethods2To3 {
1887
+ constructor ( rootRequestPath : string , options ?: VSS_WebApi . IVssHttpClientOptions ) ;
1888
+ }
1889
+ /**
1890
+ * @exemptedapi
1891
+ */
1892
+ export class ReleaseHttpClient2 extends CommonMethods2To3 {
1893
+ constructor ( rootRequestPath : string , options ?: VSS_WebApi . IVssHttpClientOptions ) ;
1894
+ }
1787
1895
export class ReleaseHttpClient extends ReleaseHttpClient3 {
1788
1896
constructor ( rootRequestPath : string , options ?: VSS_WebApi . IVssHttpClientOptions ) ;
1789
1897
}
1790
1898
/**
1791
1899
* Gets an http client targeting the latest released version of the APIs.
1792
1900
*
1793
- * @return ReleaseHttpClient2_2
1901
+ * @return ReleaseHttpClient2_3
1794
1902
*/
1795
- export function getClient ( options ?: VSS_WebApi . IVssHttpClientOptions ) : ReleaseHttpClient2_2 ;
1903
+ export function getClient ( options ?: VSS_WebApi . IVssHttpClientOptions ) : ReleaseHttpClient2_3 ;
1796
1904
}
1797
1905
declare module "ReleaseManagement/Core/Utils" {
1798
1906
import RMContracts = require( "ReleaseManagement/Core/Contracts" ) ;
0 commit comments