azure-devops-extension-api 5.275.0 → 5.279.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AdvancedSecurity.Reporting/Reporting.d.ts +81 -2
- package/AdvancedSecurity.Reporting/Reporting.js +4 -0
- package/AdvancedSecurity.Reporting/Reporting.min.js +1 -1
- package/Alert/Alert.d.ts +244 -9
- package/Alert/Alert.js +124 -1
- package/Alert/Alert.min.js +1 -1
- package/Alert/AlertClient.d.ts +76 -12
- package/Alert/AlertClient.js +205 -23
- package/Alert/AlertClient.min.js +1 -1
- package/Build/Build.d.ts +29 -0
- package/Build/Build.js +19 -1
- package/Build/Build.min.js +1 -1
- package/Gallery/Gallery.d.ts +46 -0
- package/Gallery/Gallery.js +11 -1
- package/Gallery/Gallery.min.js +1 -1
- package/Gallery/GalleryClient.d.ts +14 -0
- package/Gallery/GalleryClient.js +48 -0
- package/Gallery/GalleryClient.min.js +1 -1
- package/Git/Git.d.ts +2 -22
- package/Git/GitClient.d.ts +10 -3
- package/Git/GitClient.js +23 -3
- package/Git/GitClient.min.js +1 -1
- package/Management/Management.d.ts +38 -2
- package/Management/Management.js +4 -0
- package/Management/Management.min.js +1 -1
- package/ServiceHooks/ServiceHooks.d.ts +1 -1
- package/TaskAgent/TaskAgent.d.ts +2 -0
- package/Test/Test.d.ts +106 -56
- package/TestResults/TestResultsClient.d.ts +86 -20
- package/TestResults/TestResultsClient.js +226 -55
- package/TestResults/TestResultsClient.min.js +1 -1
- package/Tfvc/Tfvc.d.ts +54 -0
- package/Tfvc/Tfvc.js +57 -1
- package/Tfvc/Tfvc.min.js +1 -1
- package/Wiki/Wiki.d.ts +17 -0
- package/Wiki/WikiClient.d.ts +8 -0
- package/Wiki/WikiClient.js +23 -0
- package/Wiki/WikiClient.min.js +1 -1
- package/WorkItemTracking/WorkItemTracking.d.ts +48 -0
- package/WorkItemTracking/WorkItemTracking.js +11 -1
- package/WorkItemTracking/WorkItemTracking.min.js +1 -1
- package/esm/AdvancedSecurity.Reporting/Reporting.js +4 -0
- package/esm/AdvancedSecurity.Reporting/Reporting.min.js +1 -1
- package/esm/Alert/Alert.js +123 -0
- package/esm/Alert/Alert.min.js +1 -1
- package/esm/Alert/AlertClient.js +190 -22
- package/esm/Alert/AlertClient.min.js +1 -1
- package/esm/Build/Build.js +18 -0
- package/esm/Build/Build.min.js +1 -1
- package/esm/Gallery/Gallery.js +10 -0
- package/esm/Gallery/Gallery.min.js +1 -1
- package/esm/Gallery/GalleryClient.js +42 -0
- package/esm/Gallery/GalleryClient.min.js +1 -1
- package/esm/Git/GitClient.js +21 -3
- package/esm/Git/GitClient.min.js +1 -1
- package/esm/Management/Management.js +4 -0
- package/esm/Management/Management.min.js +1 -1
- package/esm/TestResults/TestResultsClient.js +208 -49
- package/esm/TestResults/TestResultsClient.min.js +1 -1
- package/esm/Tfvc/Tfvc.js +56 -0
- package/esm/Tfvc/Tfvc.min.js +1 -1
- package/esm/Wiki/WikiClient.js +21 -0
- package/esm/Wiki/WikiClient.min.js +1 -1
- package/esm/WorkItemTracking/WorkItemTracking.js +10 -0
- package/esm/WorkItemTracking/WorkItemTracking.min.js +1 -1
- package/package.json +1 -1
- package/_manifest/comparison-result.json +0 -40
- package/_manifest/spdx_2.2/ESRPClientLogs0716164721553.json +0 -1
- package/_manifest/spdx_2.2/bsi.cose +0 -0
- package/_manifest/spdx_2.2/bsi.json +0 -1
- package/_manifest/spdx_2.2/manifest.cat +0 -0
- package/_manifest/spdx_2.2/manifest.spdx.cose +0 -0
- package/_manifest/spdx_2.2/manifest.spdx.json +0 -1
- package/_manifest/spdx_2.2/manifest.spdx.json.sha256 +0 -1
- package/_manifest/spdx_3.0/manifest.spdx.json +0 -1
- package/_manifest/spdx_3.0/manifest.spdx.json.sha256 +0 -1
|
@@ -128,7 +128,11 @@ export declare enum AlertType {
|
|
|
128
128
|
/**
|
|
129
129
|
* The code contains a weakness determined by AI-powered analysis.
|
|
130
130
|
*/
|
|
131
|
-
AICode = 5
|
|
131
|
+
AICode = 5,
|
|
132
|
+
/**
|
|
133
|
+
* The code uses a dependency flagged as malware by the GitHub Advisory Database.
|
|
134
|
+
*/
|
|
135
|
+
Malware = 6
|
|
132
136
|
}
|
|
133
137
|
export declare enum AlertValidityStatus {
|
|
134
138
|
/**
|
|
@@ -306,6 +310,15 @@ export declare enum ComponentType {
|
|
|
306
310
|
*/
|
|
307
311
|
Vcpkg = 16
|
|
308
312
|
}
|
|
313
|
+
/**
|
|
314
|
+
* Repository count for a Security Overview Coverage metric.
|
|
315
|
+
*/
|
|
316
|
+
export interface CoverageSummaryMetric {
|
|
317
|
+
/**
|
|
318
|
+
* Number of repositories matching the metric.
|
|
319
|
+
*/
|
|
320
|
+
repositoryCount: number;
|
|
321
|
+
}
|
|
309
322
|
/**
|
|
310
323
|
* An alert entity used in the dashboard for combined alerts.
|
|
311
324
|
*/
|
|
@@ -343,7 +356,7 @@ export interface DashboardAlert {
|
|
|
343
356
|
*/
|
|
344
357
|
state: State;
|
|
345
358
|
/**
|
|
346
|
-
* Title will only be rendered as text and does not support markdown formatting. There is a maximum character limit of
|
|
359
|
+
* Title will only be rendered as text and does not support markdown formatting. There is a maximum character limit of 512.
|
|
347
360
|
*/
|
|
348
361
|
title: string;
|
|
349
362
|
/**
|
|
@@ -487,6 +500,39 @@ export interface OrgAlertSummary {
|
|
|
487
500
|
* A list of Project summary data.
|
|
488
501
|
*/
|
|
489
502
|
projects: ProjectAlertSummary[];
|
|
503
|
+
/**
|
|
504
|
+
* Summary metrics for the authorized repository scope.
|
|
505
|
+
*/
|
|
506
|
+
totals: OrgAlertSummaryTotals;
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* Aggregate Risk values for an organization Security Overview response.
|
|
510
|
+
*/
|
|
511
|
+
export interface OrgAlertSummaryTotals {
|
|
512
|
+
/**
|
|
513
|
+
* Alerts dismissed during the selected period.
|
|
514
|
+
*/
|
|
515
|
+
dismissedAlerts: number;
|
|
516
|
+
/**
|
|
517
|
+
* Alerts fixed during the selected period.
|
|
518
|
+
*/
|
|
519
|
+
fixedAlerts: number;
|
|
520
|
+
/**
|
|
521
|
+
* Distinct authorized repositories in the filtered response.
|
|
522
|
+
*/
|
|
523
|
+
matchingRepositoryCount: number;
|
|
524
|
+
/**
|
|
525
|
+
* Alerts introduced during the selected period that remain open.
|
|
526
|
+
*/
|
|
527
|
+
newAlerts: number;
|
|
528
|
+
/**
|
|
529
|
+
* Current open alerts.
|
|
530
|
+
*/
|
|
531
|
+
openAlerts: number;
|
|
532
|
+
/**
|
|
533
|
+
* Distinct authorized Advanced Security-enabled repositories.
|
|
534
|
+
*/
|
|
535
|
+
totalRepositoryCount: number;
|
|
490
536
|
}
|
|
491
537
|
/**
|
|
492
538
|
* Org Enablement Summary.
|
|
@@ -500,6 +546,39 @@ export interface OrgEnablementSummary {
|
|
|
500
546
|
* A list of Project Enablement data.
|
|
501
547
|
*/
|
|
502
548
|
projects: ProjectEnablementSummary[];
|
|
549
|
+
/**
|
|
550
|
+
* Summary metrics for the authorized repository scope.
|
|
551
|
+
*/
|
|
552
|
+
totals: OrgEnablementSummaryTotals;
|
|
553
|
+
}
|
|
554
|
+
/**
|
|
555
|
+
* Aggregate Coverage values for an organization Security Overview response.
|
|
556
|
+
*/
|
|
557
|
+
export interface OrgEnablementSummaryTotals {
|
|
558
|
+
/**
|
|
559
|
+
* Repositories with code alerts enabled.
|
|
560
|
+
*/
|
|
561
|
+
code: CoverageSummaryMetric;
|
|
562
|
+
/**
|
|
563
|
+
* Repositories with dependency alerts enabled.
|
|
564
|
+
*/
|
|
565
|
+
dependencies: CoverageSummaryMetric;
|
|
566
|
+
/**
|
|
567
|
+
* Distinct authorized repositories in the filtered response.
|
|
568
|
+
*/
|
|
569
|
+
matchingRepositoryCount: number;
|
|
570
|
+
/**
|
|
571
|
+
* Repositories with all Coverage settings disabled.
|
|
572
|
+
*/
|
|
573
|
+
noTooling: CoverageSummaryMetric;
|
|
574
|
+
/**
|
|
575
|
+
* Repositories with secret alerts enabled.
|
|
576
|
+
*/
|
|
577
|
+
secrets: CoverageSummaryMetric;
|
|
578
|
+
/**
|
|
579
|
+
* Distinct authorized Advanced Security-enabled repositories.
|
|
580
|
+
*/
|
|
581
|
+
totalRepositoryCount: number;
|
|
503
582
|
}
|
|
504
583
|
export interface Project {
|
|
505
584
|
id: string;
|
|
@@ -32,6 +32,10 @@ var AlertType;
|
|
|
32
32
|
* The code contains a weakness determined by AI-powered analysis.
|
|
33
33
|
*/
|
|
34
34
|
AlertType[AlertType["AICode"] = 5] = "AICode";
|
|
35
|
+
/**
|
|
36
|
+
* The code uses a dependency flagged as malware by the GitHub Advisory Database.
|
|
37
|
+
*/
|
|
38
|
+
AlertType[AlertType["Malware"] = 6] = "Malware";
|
|
35
39
|
})(AlertType || (exports.AlertType = AlertType = {}));
|
|
36
40
|
var AlertValidityStatus;
|
|
37
41
|
(function (AlertValidityStatus) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TimePeriod=exports.State=exports.Severity=exports.DismissalType=exports.DashboardAlertState=exports.ComponentType=exports.AlertValidityStatus=exports.AlertType=void 0;var AlertType;!function(e){e[e.Unknown=0]="Unknown",e[e.Dependency=1]="Dependency",e[e.Secret=2]="Secret",e[e.Code=3]="Code",e[e.License=4]="License",e[e.AICode=5]="AICode"}(AlertType||(exports.AlertType=AlertType={}));var AlertValidityStatus;!function(e){e[e.None=0]="None",e[e.Unknown=1]="Unknown",e[e.Active=2]="Active",e[e.Inactive=3]="Inactive"}(AlertValidityStatus||(exports.AlertValidityStatus=AlertValidityStatus={}));var ComponentType;!function(e){e[e.Unknown=0]="Unknown",e[e.NuGet=1]="NuGet",e[e.Npm=2]="Npm",e[e.Maven=3]="Maven",e[e.Git=4]="Git",e[e.Other=5]="Other",e[e.RubyGems=6]="RubyGems",e[e.Cargo=7]="Cargo",e[e.Pip=8]="Pip",e[e.File=9]="File",e[e.Go=10]="Go",e[e.DockerImage=11]="DockerImage",e[e.Pod=12]="Pod",e[e.Linux=13]="Linux",e[e.Conda=14]="Conda",e[e.DockerReference=15]="DockerReference",e[e.Vcpkg=16]="Vcpkg"}(ComponentType||(exports.ComponentType=ComponentType={}));var DashboardAlertState;!function(e){e[e.Open=0]="Open",e[e.Closed=1]="Closed"}(DashboardAlertState||(exports.DashboardAlertState=DashboardAlertState={}));var DismissalType;!function(e){e[e.Unknown=0]="Unknown",e[e.Fixed=1]="Fixed",e[e.AcceptedRisk=2]="AcceptedRisk",e[e.FalsePositive=3]="FalsePositive",e[e.AgreedToGuidance=4]="AgreedToGuidance",e[e.ToolUpgrade=5]="ToolUpgrade",e[e.NotDistributed=6]="NotDistributed"}(DismissalType||(exports.DismissalType=DismissalType={}));var Severity;!function(e){e[e.Low=0]="Low",e[e.Medium=1]="Medium",e[e.High=2]="High",e[e.Critical=3]="Critical",e[e.Note=4]="Note",e[e.Warning=5]="Warning",e[e.Error=6]="Error",e[e.Undefined=7]="Undefined"}(Severity||(exports.Severity=Severity={}));var State;!function(e){e[e.Unknown=0]="Unknown",e[e.Active=1]="Active",e[e.Dismissed=2]="Dismissed",e[e.Fixed=4]="Fixed",e[e.AutoDismissed=8]="AutoDismissed",e[e.Draft=16]="Draft"}(State||(exports.State=State={}));var TimePeriod;!function(e){e[e.Undefined=0]="Undefined",e[e.Last24Hours=5]="Last24Hours",e[e.Last7Days=6]="Last7Days",e[e.Last14Days=7]="Last14Days",e[e.Last30Days=8]="Last30Days",e[e.Last90Days=9]="Last90Days"}(TimePeriod||(exports.TimePeriod=TimePeriod={}));
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.TimePeriod=exports.State=exports.Severity=exports.DismissalType=exports.DashboardAlertState=exports.ComponentType=exports.AlertValidityStatus=exports.AlertType=void 0;var AlertType;!function(e){e[e.Unknown=0]="Unknown",e[e.Dependency=1]="Dependency",e[e.Secret=2]="Secret",e[e.Code=3]="Code",e[e.License=4]="License",e[e.AICode=5]="AICode",e[e.Malware=6]="Malware"}(AlertType||(exports.AlertType=AlertType={}));var AlertValidityStatus;!function(e){e[e.None=0]="None",e[e.Unknown=1]="Unknown",e[e.Active=2]="Active",e[e.Inactive=3]="Inactive"}(AlertValidityStatus||(exports.AlertValidityStatus=AlertValidityStatus={}));var ComponentType;!function(e){e[e.Unknown=0]="Unknown",e[e.NuGet=1]="NuGet",e[e.Npm=2]="Npm",e[e.Maven=3]="Maven",e[e.Git=4]="Git",e[e.Other=5]="Other",e[e.RubyGems=6]="RubyGems",e[e.Cargo=7]="Cargo",e[e.Pip=8]="Pip",e[e.File=9]="File",e[e.Go=10]="Go",e[e.DockerImage=11]="DockerImage",e[e.Pod=12]="Pod",e[e.Linux=13]="Linux",e[e.Conda=14]="Conda",e[e.DockerReference=15]="DockerReference",e[e.Vcpkg=16]="Vcpkg"}(ComponentType||(exports.ComponentType=ComponentType={}));var DashboardAlertState;!function(e){e[e.Open=0]="Open",e[e.Closed=1]="Closed"}(DashboardAlertState||(exports.DashboardAlertState=DashboardAlertState={}));var DismissalType;!function(e){e[e.Unknown=0]="Unknown",e[e.Fixed=1]="Fixed",e[e.AcceptedRisk=2]="AcceptedRisk",e[e.FalsePositive=3]="FalsePositive",e[e.AgreedToGuidance=4]="AgreedToGuidance",e[e.ToolUpgrade=5]="ToolUpgrade",e[e.NotDistributed=6]="NotDistributed"}(DismissalType||(exports.DismissalType=DismissalType={}));var Severity;!function(e){e[e.Low=0]="Low",e[e.Medium=1]="Medium",e[e.High=2]="High",e[e.Critical=3]="Critical",e[e.Note=4]="Note",e[e.Warning=5]="Warning",e[e.Error=6]="Error",e[e.Undefined=7]="Undefined"}(Severity||(exports.Severity=Severity={}));var State;!function(e){e[e.Unknown=0]="Unknown",e[e.Active=1]="Active",e[e.Dismissed=2]="Dismissed",e[e.Fixed=4]="Fixed",e[e.AutoDismissed=8]="AutoDismissed",e[e.Draft=16]="Draft"}(State||(exports.State=State={}));var TimePeriod;!function(e){e[e.Undefined=0]="Undefined",e[e.Last24Hours=5]="Last24Hours",e[e.Last7Days=6]="Last7Days",e[e.Last14Days=7]="Last14Days",e[e.Last30Days=8]="Last30Days",e[e.Last90Days=9]="Last90Days"}(TimePeriod||(exports.TimePeriod=TimePeriod={}));
|
package/Alert/Alert.d.ts
CHANGED
|
@@ -1,11 +1,28 @@
|
|
|
1
1
|
import * as WebApi from "../WebApi/WebApi";
|
|
2
|
+
/**
|
|
3
|
+
* Reference to the AI metadata blob associated with an AI code alert. Allows a consumer to download the full metadata blob. No querying over the blob contents is supported.
|
|
4
|
+
*/
|
|
5
|
+
export interface AIMetadataBlobReference {
|
|
6
|
+
/**
|
|
7
|
+
* URL to download the full AI metadata blob.
|
|
8
|
+
*/
|
|
9
|
+
downloadUrl: string;
|
|
10
|
+
}
|
|
2
11
|
export interface Alert {
|
|
12
|
+
/**
|
|
13
|
+
* Additional information message to display for this alert. For ASAN tools, contains crash details formatted in code blocks. For AI code scanning tools, contains markdown content from result.message.markdown.
|
|
14
|
+
*/
|
|
15
|
+
additionalInformationMessage: string;
|
|
3
16
|
/**
|
|
4
17
|
* Additional properties of this alert.
|
|
5
18
|
*/
|
|
6
19
|
additionalProperties: {
|
|
7
20
|
[key: string]: any;
|
|
8
21
|
};
|
|
22
|
+
/**
|
|
23
|
+
* Reference to the AI metadata blob associated with the alert (AI code alerts only). Only returned on demand when the Expand parameter is set to AIMetadataBlobReference.
|
|
24
|
+
*/
|
|
25
|
+
aiMetadataBlobReference: AIMetadataBlobReference;
|
|
9
26
|
/**
|
|
10
27
|
* Identifier for the alert. It is unique within Azure DevOps organization.
|
|
11
28
|
*/
|
|
@@ -43,9 +60,13 @@ export interface Alert {
|
|
|
43
60
|
*/
|
|
44
61
|
introducedDate: Date;
|
|
45
62
|
/**
|
|
46
|
-
* Value indicates whether
|
|
63
|
+
* Value indicates whether Copilot Autofix can currently be run on the alert. True when Copilot Autofix is available for the organization and enabled on the repository, the alert is a code scanning alert detected by CodeQL with a supported rule, and the alert's ref is eligible. Null when the value has not been computed for this code path.
|
|
47
64
|
*/
|
|
48
65
|
isAutoFixable: boolean;
|
|
66
|
+
/**
|
|
67
|
+
* Value indicates whether the alert was generated for a development dependency. True indicates development dependency, false indicates runtime dependency, and null indicates unknown or not applicable.
|
|
68
|
+
*/
|
|
69
|
+
isDevDependency: boolean;
|
|
49
70
|
/**
|
|
50
71
|
* This value is computed and returned by the service. This value represents the last time the service has seen this issue reported in an analysis instance.
|
|
51
72
|
*/
|
|
@@ -83,7 +104,7 @@ export interface Alert {
|
|
|
83
104
|
*/
|
|
84
105
|
state: State;
|
|
85
106
|
/**
|
|
86
|
-
* Title will only be rendered as text and does not support markdown formatting. There is a maximum character limit of
|
|
107
|
+
* Title will only be rendered as text and does not support markdown formatting. There is a maximum character limit of 512.
|
|
87
108
|
*/
|
|
88
109
|
title: string;
|
|
89
110
|
/**
|
|
@@ -158,6 +179,106 @@ export interface AlertBatchStateUpdateRequest {
|
|
|
158
179
|
*/
|
|
159
180
|
alertType: AlertType;
|
|
160
181
|
}
|
|
182
|
+
/**
|
|
183
|
+
* Describes the last accepted snapshot of an external job.
|
|
184
|
+
*/
|
|
185
|
+
export interface AlertJob {
|
|
186
|
+
/**
|
|
187
|
+
* Gets or sets the alerts associated with the job.
|
|
188
|
+
*/
|
|
189
|
+
alertIds: number[];
|
|
190
|
+
/**
|
|
191
|
+
* Gets or sets the artifacts produced by the job.
|
|
192
|
+
*/
|
|
193
|
+
artifacts: AlertJobArtifact[];
|
|
194
|
+
/**
|
|
195
|
+
* Gets or sets the requested branch reference.
|
|
196
|
+
*/
|
|
197
|
+
branchRef: string;
|
|
198
|
+
/**
|
|
199
|
+
* Gets or sets the identity that created the job.
|
|
200
|
+
*/
|
|
201
|
+
createdBy: string;
|
|
202
|
+
/**
|
|
203
|
+
* Gets or sets the date the job was created.
|
|
204
|
+
*/
|
|
205
|
+
createdDate: Date;
|
|
206
|
+
/**
|
|
207
|
+
* Gets or sets the provider-assigned job identifier.
|
|
208
|
+
*/
|
|
209
|
+
jobId: string;
|
|
210
|
+
/**
|
|
211
|
+
* Gets or sets the provider-defined job state.
|
|
212
|
+
*/
|
|
213
|
+
jobState: string;
|
|
214
|
+
/**
|
|
215
|
+
* Gets or sets the job type.
|
|
216
|
+
*/
|
|
217
|
+
jobType: AlertJobType;
|
|
218
|
+
/**
|
|
219
|
+
* Gets or sets the identity that last updated the job.
|
|
220
|
+
*/
|
|
221
|
+
lastUpdatedBy: string;
|
|
222
|
+
/**
|
|
223
|
+
* Gets or sets the date the job was last updated.
|
|
224
|
+
*/
|
|
225
|
+
lastUpdatedDate: Date;
|
|
226
|
+
/**
|
|
227
|
+
* Gets or sets provider-specific properties.
|
|
228
|
+
*/
|
|
229
|
+
properties: any;
|
|
230
|
+
/**
|
|
231
|
+
* Gets or sets the external job provider.
|
|
232
|
+
*/
|
|
233
|
+
provider: string;
|
|
234
|
+
/**
|
|
235
|
+
* Gets or sets the storage revision used for optimistic concurrency.
|
|
236
|
+
*/
|
|
237
|
+
revision: number;
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* Describes a canonical artifact produced by an external job.
|
|
241
|
+
*/
|
|
242
|
+
export interface AlertJobArtifact {
|
|
243
|
+
/**
|
|
244
|
+
* Gets or sets the artifact type.
|
|
245
|
+
*/
|
|
246
|
+
type: AlertJobArtifactType;
|
|
247
|
+
/**
|
|
248
|
+
* Gets or sets the externally addressable artifact URL.
|
|
249
|
+
*/
|
|
250
|
+
url: string;
|
|
251
|
+
}
|
|
252
|
+
/**
|
|
253
|
+
* Identifies the supported artifact types produced by an alert job.
|
|
254
|
+
*/
|
|
255
|
+
export declare enum AlertJobArtifactType {
|
|
256
|
+
/**
|
|
257
|
+
* An artifact type not recognized by this client version.
|
|
258
|
+
*/
|
|
259
|
+
Unknown = 0,
|
|
260
|
+
/**
|
|
261
|
+
* An Azure Repos pull request.
|
|
262
|
+
*/
|
|
263
|
+
PullRequest = 1
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Identifies the supported alert job workflows.
|
|
267
|
+
*/
|
|
268
|
+
export declare enum AlertJobType {
|
|
269
|
+
/**
|
|
270
|
+
* An alert job type not recognized by this client version.
|
|
271
|
+
*/
|
|
272
|
+
Unknown = 0,
|
|
273
|
+
/**
|
|
274
|
+
* A WIM workflow that creates a pull request.
|
|
275
|
+
*/
|
|
276
|
+
WIMAutoPR = 1,
|
|
277
|
+
/**
|
|
278
|
+
* An AI alert consolidation workflow.
|
|
279
|
+
*/
|
|
280
|
+
AIAlertConsolidation = 2
|
|
281
|
+
}
|
|
161
282
|
export declare enum AlertListExpandOption {
|
|
162
283
|
/**
|
|
163
284
|
* No Expands.
|
|
@@ -170,7 +291,11 @@ export declare enum AlertListExpandOption {
|
|
|
170
291
|
/**
|
|
171
292
|
* Return only the count of active alerts grouped by alert type.
|
|
172
293
|
*/
|
|
173
|
-
Count = 2
|
|
294
|
+
Count = 2,
|
|
295
|
+
/**
|
|
296
|
+
* Return the AI metadata blob reference in AI code alerts.
|
|
297
|
+
*/
|
|
298
|
+
AIMetadataBlobReference = 3
|
|
174
299
|
}
|
|
175
300
|
/**
|
|
176
301
|
* Alert metadata.
|
|
@@ -224,6 +349,17 @@ export declare enum AlertMetadataErrorPolicy {
|
|
|
224
349
|
*/
|
|
225
350
|
Omit = 2
|
|
226
351
|
}
|
|
352
|
+
/**
|
|
353
|
+
* Criteria for the POST alerts query endpoint. Only metadata type filtering is supported here; use GET alerts with SearchCriteria for other filters.
|
|
354
|
+
*/
|
|
355
|
+
export interface AlertMetadataQueryCriteria {
|
|
356
|
+
/**
|
|
357
|
+
* Filters alerts by linkage to specific metadata types (e.g. "pullRequest", "WorkItem"). A value of "true" requires the alert to be linked to that metadata type, "false" requires it not be linked. All entries must be satisfied for an alert to be returned.
|
|
358
|
+
*/
|
|
359
|
+
metadataTypeFilters: {
|
|
360
|
+
[key: string]: boolean;
|
|
361
|
+
};
|
|
362
|
+
}
|
|
227
363
|
export interface AlertStateUpdate {
|
|
228
364
|
dismissedComment: string;
|
|
229
365
|
dismissedReason: DismissalType;
|
|
@@ -246,7 +382,7 @@ export interface AlertStateUpdateForAlert {
|
|
|
246
382
|
*/
|
|
247
383
|
dismissedReason: DismissalType;
|
|
248
384
|
/**
|
|
249
|
-
* The state to transition the alert to
|
|
385
|
+
* The state to transition the alert to. Only Active and Dismissed are supported.
|
|
250
386
|
*/
|
|
251
387
|
state: State;
|
|
252
388
|
}
|
|
@@ -274,7 +410,11 @@ export declare enum AlertType {
|
|
|
274
410
|
/**
|
|
275
411
|
* The code contains a weakness determined by AI-powered analysis.
|
|
276
412
|
*/
|
|
277
|
-
AICode = 5
|
|
413
|
+
AICode = 5,
|
|
414
|
+
/**
|
|
415
|
+
* The code uses a dependency flagged as malware by the GitHub Advisory Database.
|
|
416
|
+
*/
|
|
417
|
+
Malware = 6
|
|
278
418
|
}
|
|
279
419
|
export declare enum AlertValidationRequestStatus {
|
|
280
420
|
/**
|
|
@@ -464,17 +604,84 @@ export declare enum AutofixCallbackStatus {
|
|
|
464
604
|
/**
|
|
465
605
|
* The pipeline or post-processing failed.
|
|
466
606
|
*/
|
|
467
|
-
Failed = 1
|
|
607
|
+
Failed = 1,
|
|
608
|
+
/**
|
|
609
|
+
* The pipeline completed successfully but the autofix binary produced no changes, so no pull request was created.
|
|
610
|
+
*/
|
|
611
|
+
NoChangesProduced = 2,
|
|
612
|
+
/**
|
|
613
|
+
* The pipeline completed successfully and determined that the alert is a false positive, so no pull request was created.
|
|
614
|
+
*/
|
|
615
|
+
FalsePositive = 3,
|
|
616
|
+
/**
|
|
617
|
+
* The target file referenced by the analysis could not be found.
|
|
618
|
+
*/
|
|
619
|
+
TargetFileNotFound = 4,
|
|
620
|
+
/**
|
|
621
|
+
* The push was rejected by the commit author email validation policy.
|
|
622
|
+
*/
|
|
623
|
+
CommitAuthorEmailValidationFailed = 5
|
|
468
624
|
}
|
|
469
625
|
/**
|
|
470
626
|
* Represents an autofix request resource.
|
|
471
627
|
*/
|
|
472
628
|
export interface AutofixRequest {
|
|
473
629
|
createdDate: Date;
|
|
630
|
+
failedReason: AutofixRequestFailedReason;
|
|
474
631
|
pipelinePlanId: string;
|
|
632
|
+
pullRequestId: number;
|
|
475
633
|
requestId: number;
|
|
476
634
|
status: AutofixRequestStatus;
|
|
477
635
|
}
|
|
636
|
+
/**
|
|
637
|
+
* Indicates the reason an autofix request failed. Maps to TINYINT (nullable) in the database.
|
|
638
|
+
*/
|
|
639
|
+
export declare enum AutofixRequestFailedReason {
|
|
640
|
+
/**
|
|
641
|
+
* Default sentinel value; not a valid failure reason.
|
|
642
|
+
*/
|
|
643
|
+
None = 0,
|
|
644
|
+
/**
|
|
645
|
+
* The autofix pipeline run completed with a failure status.
|
|
646
|
+
*/
|
|
647
|
+
PipelineFailed = 1,
|
|
648
|
+
/**
|
|
649
|
+
* The autofix pipeline did not complete within the allowed time window.
|
|
650
|
+
*/
|
|
651
|
+
PipelineTimedOut = 2,
|
|
652
|
+
/**
|
|
653
|
+
* The expected callback from the pipeline was never received.
|
|
654
|
+
*/
|
|
655
|
+
CallbackNotReceived = 3,
|
|
656
|
+
/**
|
|
657
|
+
* The processor job encountered an error.
|
|
658
|
+
*/
|
|
659
|
+
ProcessorJobFailed = 4,
|
|
660
|
+
/**
|
|
661
|
+
* The pipeline completed successfully but produced no changes, so no pull request was created. A valid terminal outcome surfaced as a failure with this distinct reason.
|
|
662
|
+
*/
|
|
663
|
+
NoChanges = 5,
|
|
664
|
+
/**
|
|
665
|
+
* The target project's agent pool could not be found or has not been authorized for use, so the validation pipeline could not be queued. This is a user/configuration error.
|
|
666
|
+
*/
|
|
667
|
+
AgentPoolUnavailable = 6,
|
|
668
|
+
/**
|
|
669
|
+
* The alert ref cannot be resolved to an existing branch because the pull request or merge ref, source branch, or normal branch no longer exists.
|
|
670
|
+
*/
|
|
671
|
+
BranchNotResolvable = 7,
|
|
672
|
+
/**
|
|
673
|
+
* The pipeline completed successfully and determined that the alert is a false positive, so no pull request was created. This is a terminal non-PR result, not an operational pipeline failure.
|
|
674
|
+
*/
|
|
675
|
+
FalsePositive = 8,
|
|
676
|
+
/**
|
|
677
|
+
* The target file referenced by the analysis could not be found.
|
|
678
|
+
*/
|
|
679
|
+
TargetFileNotFound = 9,
|
|
680
|
+
/**
|
|
681
|
+
* The push was rejected by the commit author email validation policy.
|
|
682
|
+
*/
|
|
683
|
+
CommitAuthorEmailValidationFailed = 10
|
|
684
|
+
}
|
|
478
685
|
/**
|
|
479
686
|
* Indicates the lifecycle status of an autofix request. Maps to TINYINT in the database.
|
|
480
687
|
*/
|
|
@@ -647,6 +854,10 @@ export interface DependencyResult {
|
|
|
647
854
|
*/
|
|
648
855
|
versionControlFilePath: VersionControlFilePath;
|
|
649
856
|
}
|
|
857
|
+
export declare enum DependencyScope {
|
|
858
|
+
Runtime = 0,
|
|
859
|
+
Development = 1
|
|
860
|
+
}
|
|
650
861
|
/**
|
|
651
862
|
* Information about an alert dismissal
|
|
652
863
|
*/
|
|
@@ -711,7 +922,11 @@ export declare enum ExpandOption {
|
|
|
711
922
|
/**
|
|
712
923
|
* Return validationFingerprints in Alert.
|
|
713
924
|
*/
|
|
714
|
-
ValidationFingerprint = 1
|
|
925
|
+
ValidationFingerprint = 1,
|
|
926
|
+
/**
|
|
927
|
+
* Return the AI metadata blob reference in Alert.
|
|
928
|
+
*/
|
|
929
|
+
AIMetadataBlobReference = 2
|
|
715
930
|
}
|
|
716
931
|
/**
|
|
717
932
|
* Details for a legal review for a given component
|
|
@@ -1062,7 +1277,15 @@ export declare enum SarifJobStatus {
|
|
|
1062
1277
|
/**
|
|
1063
1278
|
* The job is currently being processed in the concurrent processing workflow exclusive for no autofix flows
|
|
1064
1279
|
*/
|
|
1065
|
-
ConcurrentProcessing = 5
|
|
1280
|
+
ConcurrentProcessing = 5,
|
|
1281
|
+
/**
|
|
1282
|
+
* The original AI SARIF has been superseded by a consolidated SARIF (AI alert consolidation experiment). Terminal status: the original is never processed for alerts and is never re-consolidated.
|
|
1283
|
+
*/
|
|
1284
|
+
Consolidated = 6,
|
|
1285
|
+
/**
|
|
1286
|
+
* An original AI SARIF awaiting consolidation (AI alert consolidation experiment). Excluded from normal alert processing; selected by the consolidation job, which moves it to Consolidated once it has launched the consolidation pipeline.
|
|
1287
|
+
*/
|
|
1288
|
+
WaitingConsolidation = 7
|
|
1066
1289
|
}
|
|
1067
1290
|
export interface SarifUploadStatus {
|
|
1068
1291
|
errors: SarifValidationError[];
|
|
@@ -1090,12 +1313,16 @@ export interface SearchCriteria {
|
|
|
1090
1313
|
* If provided, only alerts for this dependency are returned. \<br /\>Otherwise, return alerts for all dependencies. \<br /\>In a sarif submission, a dependency (or a component) is specified in result.RelatedLocations[].logicalLocation. \<br /\>Not applicable for secret alerts.
|
|
1091
1314
|
*/
|
|
1092
1315
|
dependencyName: string;
|
|
1316
|
+
/**
|
|
1317
|
+
* If provided, only alerts for dependencies in this scope are returned. \<br /\>Otherwise, return alerts regardless of scope. \<br /\>Only applicable for dependency alerts.
|
|
1318
|
+
*/
|
|
1319
|
+
dependencyScope: DependencyScope;
|
|
1093
1320
|
/**
|
|
1094
1321
|
* If provided, only return alerts last seen after this date. \<br /\>Otherwise return all alerts.
|
|
1095
1322
|
*/
|
|
1096
1323
|
fromDate: Date;
|
|
1097
1324
|
/**
|
|
1098
|
-
* If provided, filters alerts based on whether they have linked work items. \<br /\>Set to "true" to return only alerts with linked work items. \<br /\>Set to "false" to return only alerts without linked work items. \<br /\>If not provided, returns all alerts regardless of linked work items. \<br /\>Not applicable for secret and dependency scanning alerts.
|
|
1325
|
+
* If provided, filters alerts based on whether they have linked work items. \<br /\>Set to "true" to return only alerts with linked work items. \<br /\>Set to "false" to return only alerts without linked work items. \<br /\>If not provided, returns all alerts regardless of linked work items. \<br /\>Not applicable for secret and dependency scanning alerts. \<br /\>This property will be deprecated in the future; prefer filtering by metadata type instead.
|
|
1099
1326
|
*/
|
|
1100
1327
|
hasLinkedWorkItems: boolean;
|
|
1101
1328
|
/**
|
|
@@ -1162,6 +1389,10 @@ export interface SearchCriteria {
|
|
|
1162
1389
|
* If provided with toolName, only return alerts detected by this tool. \<br /\>Otherwise, return alerts detected by all tools.
|
|
1163
1390
|
*/
|
|
1164
1391
|
toolName: string;
|
|
1392
|
+
/**
|
|
1393
|
+
* If provided, only return alerts detected by these tools. \<br /\>Takes precedence over ToolName when populated. \<br /\>Requires the EnableMultiToolSelection feature flag.
|
|
1394
|
+
*/
|
|
1395
|
+
toolNames: string[];
|
|
1165
1396
|
/**
|
|
1166
1397
|
* If provided, only return alerts with the validity specified here. If the validity status is Unknown, fetch alerts of all validity results. \<br /\>Only applicable for secret alerts. \<br /\>Filtering by validity status may cause less alerts to be returned than requested with TOP parameter. \<br /\>Due to this behavior, the ContinuationToken(\<![CDATA[\<header name\>]]\>) in the response header should be relied on to decide if another batch needs to be fetched.
|
|
1167
1398
|
*/
|
|
@@ -1207,6 +1438,10 @@ export declare enum State {
|
|
|
1207
1438
|
* An Analysis tool that can generate security alerts
|
|
1208
1439
|
*/
|
|
1209
1440
|
export interface Tool {
|
|
1441
|
+
/**
|
|
1442
|
+
* Whether the tool produces deterministic results. Used to group tools in the alerts filter UI.
|
|
1443
|
+
*/
|
|
1444
|
+
isDeterministic: boolean;
|
|
1210
1445
|
/**
|
|
1211
1446
|
* Name of the tool
|
|
1212
1447
|
*/
|