AlertRestClient class

Csomag:

azure-devops-extension-api

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

Kiterjeszti

RestClientBase

Konstruktorok

AlertRestClient(IVssRestClientOptions)

Módszerek

createLegalReview(string, string, number, string)	Hozzon létre jogi felülvizsgálatot. Ez létrehozza a riasztáshoz társított jogi felülvizsgálatot. Tartalmazza a munkaelem URL-címét.
getAlert(string, number, string, string, ExpandOption)	Riasztás kérése.
getAlertInstances(string, number, string, string)	Riasztás példányainak lekérése a megadott ágon @ref. Ha @ref nincs megadva, a riasztások példányait adja vissza az alapértelmezett ágon (ha a riasztás az alapértelmezett ágban található) vagy a legújabb érintett ágat.
getAlertMetadata(string, number, string)	Szerezz egy figyelmeztető metaadatot.
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)	Szerezz értesítéseket, metaadatokat.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Riasztások lekérése adattárakhoz
getAlertSarif(string, number, string, string, ExpandOption)	Riasztás kérése.
getAlertsByIds(AlertBatchRequest, string, string)	Értesítéseket kapjon riasztásazonosítók alapján. Jelenleg csak a titkos riasztások lekérését támogatja.
getBranches(string, string, AlertType, string, string, number, boolean)	Azokat az ágakat adja vissza, amelyekhez elemzési eredményeket küldtek.
getOrgLevelAlertsByIds(number[])	Riasztásokat kaphat az azonosítójuk alapján szervezeti szinten. Csak azokat a riasztásokat futtatja újra, amelyek megtekintésére a felhasználónak van engedélye. Csak az engedélyezett termékváltozati csomagok riasztásait adja vissza.
getSarif(number)	A Sarif feldolgozási feladat állapotának lekérése
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Kérje le a riasztás érvényességi adatait.
initiateValidation(string, string, number)	Egy adott riasztás érvényesítési folyamatának kezdeményezése
updateAlert(AlertStateUpdate, string, number, string)	Riasztás állapotának frissítése
updateAlertsMetadata(AlertMetadata[], string, string)	A riasztás metaadat-társításainak frissítése.
uploadOrgSarif(string)	Sarif fájl feltöltése szervezeti szinten
uploadSarif(string, string, string, String)	Biztonsági riasztásokat tartalmazó Sarif feltöltése

Építő részletek

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Módszer részletei

createLegalReview(string, string, number, string)

Hozzon létre jogi felülvizsgálatot. Ez létrehozza a riasztáshoz társított jogi felülvizsgálatot. Tartalmazza a munkaelem URL-címét.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

repository

string

A jogi riasztás adattárának neve vagy azonosítója

alertId

number

A jogi riasztás előzetes biztonsági riasztásazonosítója a jogi felülvizsgálat megszerzéséhez

ref

string

Visszatér

Promise<LegalReview>

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 egy titkos riasztás attribútumait. A lehetséges értékek a és None .ValidationFingerprint Alapértelmezett érték: None. Vegye figyelembe, hogy ha expand a ValidationFingerprintbeállítás , a válasz titkosítatlan formában is tartalmazhatja a titkos kulcsot. Kérjük, legyen körültekintő, amikor ezeket az adatokat használja.

Visszatér

Promise<Alert>

getAlertInstances(string, number, string, string)

Riasztás példányainak lekérése a megadott ágon @ref. Ha @ref nincs megadva, a riasztások példányait adja vissza az alapértelmezett ágon (ha a riasztás az alapértelmezett ágban található) vagy a legújabb érintett ágat.

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

Visszatér

Promise<AlertAnalysisInstance[]>

getAlertMetadata(string, number, string)

Szerezz egy figyelmeztető metaadatot.

function getAlertMetadata(project: string, alertId: number, repository: string): Promise<AlertMetadata>

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

Visszatér

Promise<AlertMetadata>

getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)

Szerezz értesítéseket, metaadatokat.

function getAlertMetadataBatch(alertMetadataBatchRequest: AlertMetadataBatchRequest, project: string, repository: string): Promise<AlertMetadata[]>

Paraméterek

alertMetadataBatchRequest

AlertMetadataBatchRequest

project

string

Projektazonosító vagy projektnév

repository

string

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

Visszatér

Promise<AlertMetadata[]>

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

Riasztások lekérése adattárakhoz

function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, expand?: AlertListExpandOption, 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 visszaadni kívánt riasztások maximális száma

orderBy

string

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

criteria

SearchCriteria

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

expand

AlertListExpandOption

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 a riasztások következő oldalának lekéréséhez

Visszatér

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 egy titkos riasztás attribútumait. A lehetséges értékek a és None .ValidationFingerprint Alapértelmezett érték: None. Vegye figyelembe, hogy ha expand a ValidationFingerprintbeállítás , a válasz titkosítatlan formában is tartalmazhatja a titkos kulcsot. Kérjük, legyen körültekintő, amikor ezeket az adatokat használja.

Visszatér

Promise<string>

getAlertsByIds(AlertBatchRequest, string, string)

Értesítéseket kapjon riasztásazonosítók alapján. Jelenleg csak a titkos riasztások lekérését támogatja.

function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string): Promise<Alert[]>

Paraméterek

request

AlertBatchRequest

Kérés, amely tartalmaz riasztásazonosítókat és opcionális riasztástípus-szűrőt

project

string

Projektazonosító vagy projektnév

repository

string

Az adattár neve vagy azonosítója

Visszatér

Promise<Alert[]>

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

Azokat az ágakat adja vissza, amelyekhez elemzési eredményeket küldtek.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

repository

string

alertType

AlertType

A riasztás típusa: Függőségek vizsgálata (1), Titkos kód (2), Kód QL (3) stb.

continuationToken

string

Egy sztringváltozó, amely az ág nevét jelöli, és az azt követő ágak betűrendben történő lekérésére szolgál.

branchNameContains

string

Sztringváltozó, amely a sztringet tartalmazó ágak lekérésére szolgál bárhol az ágnévben, a kis- és nagybetűk nem érzékenyek.

top

number

A keresési feltételeknek megfelelő legfelső k ágak visszaadására használt int változó.

includePullRequestBranches

boolean

Egy bool változó, amely azt jelzi, hogy a lekéréses kérelmek ágait is tartalmaznia kell-e.

Visszatér

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

Riasztásokat kaphat az azonosítójuk alapján szervezeti szinten. Csak azokat a riasztásokat futtatja újra, amelyek megtekintésére a felhasználónak van engedélye. Csak az engedélyezett termékváltozati csomagok riasztásait adja vissza.

function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>

Paraméterek

alertIds

number[]

A lekért riasztásazonosítók listája

Visszatér

Promise<Alert[]>

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

Visszatér

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

Visszatér

Promise<UxFilters>

getValidityData(string, string, number)

Kérje le a riasztás érvényességi adatait.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

repository

string

Egy adattár neve vagy azonosítója

alertId

number

A riasztás azonosítója

Visszatér

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Egy adott riasztás érvényesítési folyamatának kezdeményezése

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

Paraméterek

project

string

Projektazonosító vagy projektnév

repository

string

Egy adattár neve vagy azonosítója

alertId

number

A riasztás azonosítója

Visszatér

Promise<AlertValidationRequestStatus>

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

Visszatér

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

A riasztás metaadat-társításainak 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.

Visszatér

Promise<AlertMetadataChange[]>

uploadOrgSarif(string)

Sarif fájl feltöltése szervezeti szinten

function uploadOrgSarif(content: string): Promise<number>

Paraméterek

content

string

Feltöltendő tartalom

Visszatér

Promise<number>

uploadSarif(string, string, string, String)

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

function uploadSarif(content: string, project: string, repository: string, notificationFlag?: 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

notificationFlag

String

Fejléc, amely jelzi, hogy ez egy állapotértesítés

Visszatér

Promise<number>