AlertRestClient class

Pakket:

azure-devops-extension-api

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

Uitbreiding

RestClientBase

Constructors

AlertRestClient(IVssRestClientOptions)

Methoden

createLegalReview(string, string, number, string)	Creëer een juridische beoordeling. Hiermee wordt de juridische beoordeling gemaakt die aan de melding is gekoppeld. Het bevat de url van het beoordelingswerkitem.
getAlert(string, number, string, string, ExpandOption)	Ontvang een waarschuwing.
getAlertInstances(string, number, string, string)	Exemplaren van een waarschuwing ophalen voor een vertakking die is opgegeven met @ref. Als @ref dit niet het geval is, retourneert u exemplaren van een waarschuwing in een standaardbranch (als de waarschuwing in de standaardbranch bestaat) of de meest recente beïnvloede vertakking.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Waarschuwingen voor een opslagplaats ophalen
getAlertSarif(string, number, string, string, ExpandOption)	Ontvang een waarschuwing.
getBranches(string, string, AlertType, string, string, number, boolean)	Retourneert de vertakkingen waarvoor analyseresultaten zijn verzonden.
getSarif(number)	De status van de Sarif-verwerkingstaak ophalen
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Bekijk de geldigheidsgegevens voor een waarschuwing.
initiateValidation(string, string, number)	Het validatieproces voor een bepaalde waarschuwing initiëren
updateAlert(AlertStateUpdate, string, number, string)	De status van een waarschuwing bijwerken
updateAlertsMetadata(AlertMetadata[], string, string)	Metagegevenskoppelingen voor waarschuwingen bijwerken.
uploadSarif(string, string, string, String)	Een Sarif met beveiligingswaarschuwingen uploaden

Constructordetails

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Methodedetails

createLegalReview(string, string, number, string)

Creëer een juridische beoordeling. Hiermee wordt de juridische beoordeling gemaakt die aan de melding is gekoppeld. Het bevat de url van het beoordelingswerkitem.

function createLegalReview(project: string, repository: string, alertId: number, ref?: string): Promise<LegalReview>

Parameters

project

string

Project-id of projectnaam

repository

string

Naam of id van een repository voor de juridische signalering

alertId

number

Voorafgaande beveiligingswaarschuwings-ID van de juridische waarschuwing om de juridische beoordeling te krijgen

ref

string

Retouren

Promise<LegalReview>

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 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 voor een vertakking die is opgegeven met @ref. Als @ref dit niet het geval is, retourneert u exemplaren van een waarschuwing in een standaardbranch (als de waarschuwing in de standaardbranch bestaat) of de meest recente beïnvloede vertakking.

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

Parameters

project

string

Project-id of projectnaam

alertId

number

Id van 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, AlertListExpandOption, string)

Waarschuwingen voor een opslagplaats ophalen

function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, expand?: AlertListExpandOption, 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' zijn, wordt standaard ingesteld op 'id'

criteria

SearchCriteria

Opties om de geretourneerde waarschuwingen te beperken

expand

AlertListExpandOption

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 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>

getBranches(string, string, AlertType, string, string, number, boolean)

Retourneert de vertakkingen waarvoor analyseresultaten zijn verzonden.

function getBranches(project: string, repository: string, alertType: AlertType, continuationToken?: string, branchNameContains?: string, top?: number, includePullRequestBranches?: boolean): Promise<Branch[]>

Parameters

project

string

Project-id of projectnaam

repository

string

alertType

AlertType

Het type waarschuwing: Afhankelijkheid scannen (1), Geheim (2), Code QL (3), enzovoort.

continuationToken

string

Een tekenreeksvariabele die de naam van de vertakking vertegenwoordigt en wordt gebruikt om vertakkingen op te halen die deze in alfabetische volgorde volgen.

branchNameContains

string

Een tekenreeksvariabele die wordt gebruikt om vertakkingen op te halen die deze tekenreeks ergens in de naam van de vertakking bevatten, hoofdlettergevoelig.

top

number

Een int-variabele die wordt gebruikt om de bovenste k-vertakkingen te retourneren die voldoen aan de zoekcriteria.

includePullRequestBranches

boolean

Een boolvariabele die aangeeft of pull-aanvraagvertakkingen al dan niet moeten worden opgenomen.

Retouren

Promise<Branch[]>

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>

getValidityData(string, string, number)

Bekijk de geldigheidsgegevens voor een waarschuwing.

function getValidityData(project: string, repository: string, alertId: number): Promise<ValidationRequestInfo>

Parameters

project

string

Project-id of projectnaam

repository

string

De naam of id van een opslagplaats

alertId

number

De id van de waarschuwing

Retouren

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Het validatieproces voor een bepaalde waarschuwing initiëren

function initiateValidation(project: string, repository: string, alertId: number): Promise<AlertValidationRequestStatus>

Parameters

project

string

Project-id of projectnaam

repository

string

De naam of id van een opslagplaats

alertId

number

De id van de waarschuwing

Retouren

Promise<AlertValidationRequestStatus>

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 aan waarschuwingen moeten worden gekoppeld.

project

string

Project-id of projectnaam

repository

string

De naam of id van de opslagplaats.

Retouren

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string, String)

Een Sarif met beveiligingswaarschuwingen uploaden

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

Parameters

content

string

Te uploaden inhoud

project

string

Project-id of projectnaam

repository

string

De naam of id van een opslagplaats

notificationFlag

String

Header om aan te geven dat dit een voortgangsmelding is

Retouren

Promise<number>