AlertRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

Extends

RestClientBase

Konstruktory

AlertRestClient(IVssRestClientOptions)

Metody

getAlert(string, number, string, string, ExpandOption)	Získejte upozornění.
getAlertInstances(string, number, string, string)	Získání instancí výstrahy
getAlerts(string, string, number, string, SearchCriteria, string)	Získání upozornění pro úložiště
getAlertSarif(string, number, string, string, ExpandOption)	Získejte upozornění.
getSarif(number)	Získání stavu úlohy zpracování Sarif
getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)	Aktualizace stavu výstrahy
updateAlertsMetadata(AlertMetadata[], string, string)	Aktualizujte přidružení metadat upozornění.
uploadSarif(string, string, string)	Nahrání sarifu obsahujícího výstrahy zabezpečení

Podrobnosti konstruktoru

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

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

Získejte upozornění.

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

Parametry

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy, která se má načíst

repository

string

Název nebo ID úložiště, které je součástí upozornění

ref

string

expand

ExpandOption

Rozbalte atributy upozornění. Možné možnosti jsou {ValidationFingerprint, None}

Návraty

Promise<Alert>

getAlertInstances(string, number, string, string)

Získání instancí výstrahy

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

Parametry

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy, která se má načíst

repository

string

Název nebo ID úložiště, které je součástí upozornění

ref

string

Návraty

Promise<AlertAnalysisInstance[]>

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

Získání upozornění pro úložiště

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

top

number

Maximální počet výstrah, které se mají vrátit

orderBy

string

Musí být "id" "firstSeen", "lastSeen", "fixedOn" nebo "severity" Výchozí hodnota je "id".

criteria

SearchCriteria

Možnosti omezení vrácených výstrah

continuationToken

string

Pokud existuje více výstrah, než je možné vrátit, umístí se do hlavičky x-ms-continuationtoken token pokračování. Pomocí tohoto tokenu získejte další stránku upozornění.

Návraty

Promise<PagedList<Alert>>

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

Získejte upozornění.

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

Parametry

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy, která se má načíst

repository

string

Název nebo ID úložiště, které je součástí upozornění

ref

string

expand

ExpandOption

Rozbalte atributy upozornění. Možné možnosti jsou {ValidationFingerprint, None}

Návraty

Promise<string>

getSarif(number)

Získání stavu úlohy zpracování Sarif

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

Parametry

sarifId

number

Id Sarif vráceno při nahrání Sarifu

Návraty

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

alertType

AlertType

Návraty

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

Aktualizace stavu výstrahy

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

Parametry

stateUpdate

AlertStateUpdate

Nový stav výstrahy

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy

repository

string

Název nebo ID úložiště

Návraty

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Aktualizujte přidružení metadat upozornění.

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

Parametry

alertsMetadata

AlertMetadata[]

Seznam metadat, která se mají přidružit k upozorněním.

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště.

Návraty

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Nahrání sarifu obsahujícího výstrahy zabezpečení

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

Parametry

content

string

Obsah k nahrání

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

Návraty

Promise<number>