AlertRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).

Extends

RestClientBase

Konstruktoren

AlertRestClient(IVssRestClientOptions)

Methoden

getAlert(string, number, string, string, ExpandOption)	Rufen Sie eine Warnung ab.
getAlertInstances(string, number, string, string)	Rufen Sie Instanzen einer Warnung ab.
getAlerts(string, string, number, string, SearchCriteria, string)	Abrufen von Warnungen für ein Repository
getAlertSarif(string, number, string, string, ExpandOption)	Rufen Sie eine Warnung ab.
getSarif(number)	Abrufen der status des Sarif-Verarbeitungsauftrags
getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)	Aktualisieren der status einer Warnung
updateAlertsMetadata(AlertMetadata[], string, string)	Aktualisieren Sie Warnungsmetadatenzuordnungen.
uploadSarif(string, string, string)	Hochladen eines Sarifs mit Sicherheitswarnungen

Details zum Konstruktor

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Methode

getAlert(string, number, string, string, ExpandOption)

Rufen Sie eine Warnung ab.

function getAlert(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<Alert>

Parameter

project

string

Projekt-ID oder Projektname

alertId

number

ID der abzurufenden Warnung

repository

string

Name oder ID eines Repositorys, zu dem die Warnung gehört

ref

string

expand

ExpandOption

Erweitern Sie Warnungsattribute. Mögliche Optionen sind {ValidationFingerprint, None}

Gibt zurück

Promise<Alert>

getAlertInstances(string, number, string, string)

Rufen Sie Instanzen einer Warnung ab.

function getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<AlertAnalysisInstance[]>

Parameter

project

string

Projekt-ID oder Projektname

alertId

number

ID der abzurufenden Warnung

repository

string

Name oder ID eines Repositorys, zu dem die Warnung gehört

ref

string

Gibt zurück

Promise<AlertAnalysisInstance[]>

getAlerts(string, string, number, string, SearchCriteria, string)

Abrufen von Warnungen für ein Repository

function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, continuationToken?: string): Promise<PagedList<Alert>>

Parameter

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID des Repositorys

top

number

Die maximale Anzahl von Warnungen, die zurückgegeben werden sollen

orderBy

string

Muss "id" "firstSeen" "lastSeen" "fixedOn" oder "schweregrad" sein Standardwerte auf "id"

criteria

SearchCriteria

Optionen zum Einschränken der zurückgegebenen Warnungen

continuationToken

string

Wenn mehr Warnungen als zurückgegeben werden können, wird ein Fortsetzungstoken im Header "x-ms-continuationtoken" platziert. Verwenden Sie dieses Token hier, um die nächste Seite mit Warnungen abzurufen.

Gibt zurück

Promise<PagedList<Alert>>

getAlertSarif(string, number, string, string, ExpandOption)

Rufen Sie eine Warnung ab.

function getAlertSarif(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<string>

Parameter

project

string

Projekt-ID oder Projektname

alertId

number

ID der abzurufenden Warnung

repository

string

Name oder ID eines Repositorys, zu dem die Warnung gehört

ref

string

expand

ExpandOption

Erweitern Sie Warnungsattribute. Mögliche Optionen sind {ValidationFingerprint, None}

Gibt zurück

Promise<string>

getSarif(number)

Abrufen der status des Sarif-Verarbeitungsauftrags

function getSarif(sarifId: number): Promise<SarifUploadStatus>

Parameter

sarifId

number

Sarif-ID wurde zurückgegeben, als der Sarif hochgeladen wurde

Gibt zurück

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

function getUxFilters(project: string, repository: string, alertType: AlertType): Promise<UxFilters>

Parameter

project

string

Projekt-ID oder Projektname

repository

string

alertType

AlertType

Gibt zurück

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

Aktualisieren der status einer Warnung

function updateAlert(stateUpdate: AlertStateUpdate, project: string, alertId: number, repository: string): Promise<Alert>

Parameter

stateUpdate

AlertStateUpdate

Die neue status der Warnung

project

string

Projekt-ID oder Projektname

alertId

number

Die ID der Warnung

repository

string

Der Name oder die ID des Repositorys

Gibt zurück

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Aktualisieren Sie Warnungsmetadatenzuordnungen.

function updateAlertsMetadata(alertsMetadata: AlertMetadata[], project: string, repository: string): Promise<AlertMetadataChange[]>

Parameter

alertsMetadata

AlertMetadata[]

Eine Liste von Metadaten, die Warnungen zugeordnet werden sollen.

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID des Repositorys.

Gibt zurück

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Hochladen eines Sarifs mit Sicherheitswarnungen

function uploadSarif(content: string, project: string, repository: string): Promise<number>

Parameter

content

string

Hochzuladende Inhalte

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID eines Repositorys

Gibt zurück

Promise<number>