AlertRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:erna

Extends

RestClientBase

Konstruktorer

AlertRestClient(IVssRestClientOptions)

Metoder

getAlert(string, number, string, string, ExpandOption)	Få en avisering.
getAlertInstances(string, number, string, string)	Hämta instanser av en avisering.
getAlerts(string, string, number, string, SearchCriteria, string)	Hämta aviseringar för en lagringsplats
getAlertSarif(string, number, string, string, ExpandOption)	Få en avisering.
getSarif(number)	Hämta status för Sarif-bearbetningsjobbet
getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)	Uppdatera status för en avisering
updateAlertsMetadata(AlertMetadata[], string, string)	Uppdatera metadataassociationer för aviseringar.
uploadSarif(string, string, string)	Ladda upp en Sarif som innehåller säkerhetsaviseringar

Konstruktorinformation

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metodinformation

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

Få en avisering.

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

Parametrar

project

string

Projekt-ID eller projektnamn

alertId

number

ID för avisering som ska hämtas

repository

string

Namn eller ID för en lagringsplats som aviseringen ingår i

ref

string

expand

ExpandOption

Expandera aviseringsattribut. Möjliga alternativ är {ValidationFingerprint, None}

Returer

Promise<Alert>

getAlertInstances(string, number, string, string)

Hämta instanser av en avisering.

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

Parametrar

project

string

Projekt-ID eller projektnamn

alertId

number

ID för avisering som ska hämtas

repository

string

Namn eller ID för en lagringsplats som aviseringen ingår i

ref

string

Returer

Promise<AlertAnalysisInstance[]>

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

Hämta aviseringar för en lagringsplats

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

Lagringsplatsens namn eller ID

top

number

Det maximala antalet aviseringar som ska returneras

orderBy

string

Måste vara "id" "firstSeen" "lastSeen" "fixedOn" eller "severity" Defaults to "id"

criteria

SearchCriteria

Alternativ för att begränsa de returnerade aviseringarna

continuationToken

string

Om det finns fler aviseringar än vad som kan returneras placeras en fortsättningstoken i rubriken "x-ms-continuationtoken". Använd denna token här för att hämta nästa sida med aviseringar

Returer

Promise<PagedList<Alert>>

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

Få en avisering.

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

Parametrar

project

string

Projekt-ID eller projektnamn

alertId

number

ID för avisering som ska hämtas

repository

string

Namn eller ID för en lagringsplats som aviseringen ingår i

ref

string

expand

ExpandOption

Expandera aviseringsattribut. Möjliga alternativ är {ValidationFingerprint, None}

Returer

Promise<string>

getSarif(number)

Hämta status för Sarif-bearbetningsjobbet

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

Parametrar

sarifId

number

Sarif-ID returnerades när Sarif laddades upp

Returer

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

alertType

AlertType

Returer

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

Uppdatera status för en avisering

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

Parametrar

stateUpdate

AlertStateUpdate

Den nya statusen för aviseringen

project

string

Projekt-ID eller projektnamn

alertId

number

ID för aviseringen

repository

string

Lagringsplatsens namn eller ID

Returer

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Uppdatera metadataassociationer för aviseringar.

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

Parametrar

alertsMetadata

AlertMetadata[]

En lista över metadata som ska associeras med aviseringar.

project

string

Projekt-ID eller projektnamn

repository

string

Namnet eller ID:t för lagringsplatsen.

Returer

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Ladda upp en Sarif som innehåller säkerhetsaviseringar

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

Parametrar

content

string

Innehåll som ska laddas upp

project

string

Projekt-ID eller projektnamn

repository

string

Namnet eller ID:t för en lagringsplats

Returer

Promise<number>