AlertRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

AlertRestClient(IVssRestClientOptions)

Metody

getAlert(string, number, string, string, ExpandOption)	Pobierz alert.
getAlertInstances(string, number, string, string)	Pobieranie wystąpień alertu.
getAlerts(string, string, number, string, SearchCriteria, string)	Pobieranie alertów dla repozytorium
getAlertSarif(string, number, string, string, ExpandOption)	Pobierz alert.
getSarif(number)	Pobieranie stanu zadania przetwarzania Sarif
getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)	Aktualizowanie stanu alertu
updateAlertsMetadata(AlertMetadata[], string, string)	Aktualizowanie skojarzeń metadanych alertu.
uploadSarif(string, string, string)	Przekazywanie sarifu zawierającego alerty zabezpieczeń

Szczegóły konstruktora

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły metody

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

Pobierz alert.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

alertId

number

Identyfikator alertu do pobrania

repository

string

Nazwa lub identyfikator repozytorium, którego częścią jest alert

ref

string

expand

ExpandOption

Rozwiń atrybuty alertu. Możliwe opcje to {ValidationFingerprint, None}

Zwraca

Promise<Alert>

getAlertInstances(string, number, string, string)

Pobieranie wystąpień alertu.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

alertId

number

Identyfikator alertu do pobrania

repository

string

Nazwa lub identyfikator repozytorium, którego częścią jest alert

ref

string

Zwraca

Promise<AlertAnalysisInstance[]>

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

Pobieranie alertów dla repozytorium

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

top

number

Maksymalna liczba alertów do zwrócenia

orderBy

string

Musi mieć wartość "id" "firstSeen" "lastSeen" "fixedOn" lub "severity" Wartość domyślna na "id"

criteria

SearchCriteria

Opcje ograniczania zwracanych alertów

continuationToken

string

Jeśli jest więcej alertów niż można zwrócić, token kontynuacji zostanie umieszczony w nagłówku "x-ms-continuationtoken". Użyj tego tokenu tutaj, aby uzyskać następną stronę alertów

Zwraca

Promise<PagedList<Alert>>

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

Pobierz alert.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

alertId

number

Identyfikator alertu do pobrania

repository

string

Nazwa lub identyfikator repozytorium, którego częścią jest alert

ref

string

expand

ExpandOption

Rozwiń atrybuty alertu. Możliwe opcje to {ValidationFingerprint, None}

Zwraca

Promise<string>

getSarif(number)

Pobieranie stanu zadania przetwarzania Sarif

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

Parametry

sarifId

number

Identyfikator Sarif zwrócony podczas przekazywania sarifu

Zwraca

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

alertType

AlertType

Zwraca

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

Aktualizowanie stanu alertu

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

Parametry

stateUpdate

AlertStateUpdate

Nowy stan alertu

project

string

Identyfikator projektu lub nazwa projektu

alertId

number

Identyfikator alertu

repository

string

Nazwa lub identyfikator repozytorium

Zwraca

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Aktualizowanie skojarzeń metadanych alertu.

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

Parametry

alertsMetadata

AlertMetadata[]

Lista metadanych do skojarzenia z alertami.

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium.

Zwraca

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Przekazywanie sarifu zawierającego alerty zabezpieczeń

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

Parametry

content

string

Zawartość do przekazania

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

Zwraca

Promise<number>