AlertRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

RestClientBase

Constructors

AlertRestClient(IVssRestClientOptions)

Methoden

getAlert(string, number, string, string, ExpandOption)	Ontvang een waarschuwing.
getAlertInstances(string, number, string, string)	Exemplaren van een waarschuwing ophalen.
getAlerts(string, string, number, string, SearchCriteria, string)	Waarschuwingen voor een opslagplaats ophalen
getAlertSarif(string, number, string, string, ExpandOption)	Ontvang een waarschuwing.
getSarif(number)	De status van de Sarif-verwerkingstaak ophalen
getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)	De status van een waarschuwing bijwerken
updateAlertsMetadata(AlertMetadata[], string, string)	Metagegevenskoppelingen voor waarschuwingen bijwerken.
uploadSarif(string, string, string)	Een Sarif met beveiligingswaarschuwingen uploaden

Constructordetails

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Methodedetails

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

Ontvang een waarschuwing.

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

Parameters

project

string

Project-id of projectnaam

alertId

number

Id van de waarschuwing die moet worden opgehaald

repository

string

Naam of id van een opslagplaats waarvan de waarschuwing deel uitmaakt

ref

string

expand

ExpandOption

Vouw waarschuwingskenmerken uit. Mogelijke opties zijn {ValidationFingerprint, None}

Retouren

Promise<Alert>

getAlertInstances(string, number, string, string)

Exemplaren van een waarschuwing ophalen.

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

Parameters

project

string

Project-id of projectnaam

alertId

number

Id van de waarschuwing die moet worden opgehaald

repository

string

Naam of id van een opslagplaats waarvan de waarschuwing deel uitmaakt

ref

string

Retouren

Promise<AlertAnalysisInstance[]>

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

Waarschuwingen voor een opslagplaats ophalen

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

Parameters

project

string

Project-id of projectnaam

repository

string

De naam of id van de opslagplaats

top

number

Het maximum aantal waarschuwingen dat moet worden geretourneerd

orderBy

string

Moet 'id' 'firstSeen' 'lastSeen' 'fixedOn' of 'ernst' de standaardinstelling zijn voor 'id'

criteria

SearchCriteria

Opties voor het beperken van de geretourneerde waarschuwingen

continuationToken

string

Als er meer waarschuwingen zijn dan kan worden geretourneerd, wordt een vervolgtoken in de header 'x-ms-continuationtoken' geplaatst. Gebruik dit token hier om de volgende pagina met waarschuwingen op te halen

Retouren

Promise<PagedList<Alert>>

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

Ontvang een waarschuwing.

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

Parameters

project

string

Project-id of projectnaam

alertId

number

Id van de waarschuwing die moet worden opgehaald

repository

string

Naam of id van een opslagplaats waarvan de waarschuwing deel uitmaakt

ref

string

expand

ExpandOption

Vouw waarschuwingskenmerken uit. Mogelijke opties zijn {ValidationFingerprint, None}

Retouren

Promise<string>

getSarif(number)

De status van de Sarif-verwerkingstaak ophalen

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

Parameters

sarifId

number

Sarif-id geretourneerd toen de Sarif werd geüpload

Retouren

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parameters

project

string

Project-id of projectnaam

repository

string

alertType

AlertType

Retouren

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

De status van een waarschuwing bijwerken

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

Parameters

stateUpdate

AlertStateUpdate

De nieuwe status van de waarschuwing

project

string

Project-id of projectnaam

alertId

number

De id van de waarschuwing

repository

string

De naam of id van de opslagplaats

Retouren

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Metagegevenskoppelingen voor waarschuwingen bijwerken.

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

Parameters

alertsMetadata

AlertMetadata[]

Een lijst met metagegevens die moeten worden gekoppeld aan waarschuwingen.

project

string

Project-id of projectnaam

repository

string

De naam of id van de opslagplaats.

Retouren

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Een Sarif met beveiligingswaarschuwingen uploaden

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

Parameters

content

string

Inhoud die moet worden geüpload

project

string

Project-id of projectnaam

repository

string

De naam of id van een opslagplaats

Retouren

Promise<number>