AlertRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS

Extends

RestClientBase

Constructeurs

AlertRestClient(IVssRestClientOptions)

Méthodes

getAlert(string, number, string, string, ExpandOption)	Obtenez une alerte.
getAlertInstances(string, number, string, string)	Obtenir les instances d’une alerte.
getAlerts(string, string, number, string, SearchCriteria, string)	Obtenir des alertes pour un dépôt
getAlertSarif(string, number, string, string, ExpandOption)	Obtenez une alerte.
getSarif(number)	Obtenir le status du travail de traitement Sarif
getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)	Mettre à jour le status d’une alerte
updateAlertsMetadata(AlertMetadata[], string, string)	Mettre à jour les associations de métadonnées d’alerte.
uploadSarif(string, string, string)	Charger un Sarif contenant des alertes de sécurité

Détails du constructeur

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la méthode

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

Obtenez une alerte.

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

Paramètres

project

string

ID de projet ou nom du projet

alertId

number

ID de l’alerte à récupérer

repository

string

Nom ou ID d’un dépôt dont l’alerte fait partie

ref

string

expand

ExpandOption

Développez les attributs d’alerte. Les options possibles sont {ValidationFingerprint, None}

Retours

Promise<Alert>

getAlertInstances(string, number, string, string)

Obtenir les instances d’une alerte.

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

Paramètres

project

string

ID de projet ou nom du projet

alertId

number

ID de l’alerte à récupérer

repository

string

Nom ou ID d’un dépôt dont l’alerte fait partie

ref

string

Retours

Promise<AlertAnalysisInstance[]>

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

Obtenir des alertes pour un dépôt

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

Paramètres

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID du dépôt

top

number

Nombre maximal d’alertes à retourner

orderBy

string

Doit être « id » « firstSeen », « lastSeen » « fixedOn » ou « severity » Par défaut, « id »

criteria

SearchCriteria

Options permettant de limiter les alertes retournées

continuationToken

string

S’il y a plus d’alertes que ce qui peut être retourné, un jeton de continuation est placé dans l’en-tête « x-ms-continuationtoken ». Utilisez ce jeton ici pour obtenir la page suivante d’alertes

Retours

Promise<PagedList<Alert>>

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

Obtenez une alerte.

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

Paramètres

project

string

ID de projet ou nom du projet

alertId

number

ID de l’alerte à récupérer

repository

string

Nom ou ID d’un dépôt dont l’alerte fait partie

ref

string

expand

ExpandOption

Développez les attributs d’alerte. Les options possibles sont {ValidationFingerprint, None}

Retours

Promise<string>

getSarif(number)

Obtenir le status du travail de traitement Sarif

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

Paramètres

sarifId

number

ID Sarif retourné lorsque le Sarif a été chargé

Retours

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Paramètres

project

string

ID de projet ou nom du projet

repository

string

alertType

AlertType

Retours

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

Mettre à jour le status d’une alerte

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

Paramètres

stateUpdate

AlertStateUpdate

Nouvelle status de l’alerte

project

string

ID de projet ou nom du projet

alertId

number

ID de l’alerte

repository

string

Nom ou ID du dépôt

Retours

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Mettre à jour les associations de métadonnées d’alerte.

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

Paramètres

alertsMetadata

AlertMetadata[]

Liste de métadonnées à associer aux alertes.

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID du dépôt.

Retours

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Charger un Sarif contenant des alertes de sécurité

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

Paramètres

content

string

Contenu à charger

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID d’un dépôt

Retours

Promise<number>