AlertRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatása) kell használni

Extends

RestClientBase

Konstruktorok

AlertRestClient(IVssRestClientOptions)

Metódusok

getAlert(string, number, string, string, ExpandOption)	Riasztás kérése.
getAlertInstances(string, number, string, string)	Riasztás példányainak lekérése.
getAlerts(string, string, number, string, SearchCriteria, string)	Adattárra vonatkozó riasztások lekérése
getAlertSarif(string, number, string, string, ExpandOption)	Riasztás kérése.
getSarif(number)	A Sarif feldolgozási feladat állapotának lekérése
getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)	Riasztás állapotának frissítése
updateAlertsMetadata(AlertMetadata[], string, string)	Riasztási metaadat-társítások frissítése.
uploadSarif(string, string, string)	Biztonsági riasztásokat tartalmazó Sarif feltöltése

Konstruktor adatai

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Metódus adatai

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

Riasztás kérése.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

alertId

number

A lekérendő riasztás azonosítója

repository

string

Egy olyan adattár neve vagy azonosítója, amely a riasztás részét képezi

ref

string

expand

ExpandOption

Bontsa ki a riasztási attribútumokat. Lehetséges lehetőségek: {ValidationFingerprint, None}

Válaszok

Promise<Alert>

getAlertInstances(string, number, string, string)

Riasztás példányainak lekérése.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

alertId

number

A lekérendő riasztás azonosítója

repository

string

Egy olyan adattár neve vagy azonosítója, amely a riasztás részét képezi

ref

string

Válaszok

Promise<AlertAnalysisInstance[]>

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

Adattárra vonatkozó riasztások lekérése

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

Paraméterek

project

string

Projektazonosító vagy projektnév

repository

string

Az adattár neve vagy azonosítója

top

number

A visszaadandó riasztások maximális száma

orderBy

string

Az "id" "firstSeen" "lastSeen" "fixedOn" vagy "súlyosság" alapértelmezett értéke "id"

criteria

SearchCriteria

A visszaadott riasztások korlátozásának lehetőségei

continuationToken

string

Ha a visszaadhatónál több riasztás van, a rendszer egy folytatási jogkivonatot helyez el az "x-ms-continuationtoken" fejlécben. Használja ezt a jogkivonatot itt a riasztások következő oldalának lekéréséhez

Válaszok

Promise<PagedList<Alert>>

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

Riasztás kérése.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

alertId

number

A lekérendő riasztás azonosítója

repository

string

Egy olyan adattár neve vagy azonosítója, amely a riasztás részét képezi

ref

string

expand

ExpandOption

Bontsa ki a riasztási attribútumokat. Lehetséges lehetőségek: {ValidationFingerprint, None}

Válaszok

Promise<string>

getSarif(number)

A Sarif feldolgozási feladat állapotának lekérése

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

Paraméterek

sarifId

number

A Sarif-azonosító a Sarif feltöltésekor lett visszaadva

Válaszok

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Paraméterek

project

string

Projektazonosító vagy projektnév

repository

string

alertType

AlertType

Válaszok

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

Riasztás állapotának frissítése

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

Paraméterek

stateUpdate

AlertStateUpdate

A riasztás új állapota

project

string

Projektazonosító vagy projektnév

alertId

number

A riasztás azonosítója

repository

string

Az adattár neve vagy azonosítója

Válaszok

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Riasztási metaadat-társítások frissítése.

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

Paraméterek

alertsMetadata

AlertMetadata[]

A riasztásokhoz társítandó metaadatok listája.

project

string

Projektazonosító vagy projektnév

repository

string

Az adattár neve vagy azonosítója.

Válaszok

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Biztonsági riasztásokat tartalmazó Sarif feltöltése

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

Paraméterek

content

string

Feltöltendő tartalom

project

string

Projektazonosító vagy projektnév

repository

string

Egy adattár neve vagy azonosítója

Válaszok

Promise<number>