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

createLegalReview(string, string, number, string)	Créez un examen juridique. Cela crée l’examen juridique associé à l’alerte. Il s’agit de l’URL de l’élément de travail de révision.
getAlert(string, number, string, string, ExpandOption)	Obtenez une alerte.
getAlertInstances(string, number, string, string)	Obtenir des instances d’une alerte sur une branche spécifiée avec @ref. Si @ref n’est pas fourni, retournez des instances d’une alerte sur la branche par défaut (si l’alerte existe dans la branche par défaut) ou la branche affectée la plus récente.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Obtenir des alertes pour un référentiel
getAlertSarif(string, number, string, string, ExpandOption)	Obtenez une alerte.
getBranches(string, string, AlertType, string, string, number, boolean)	Retourne les branches pour lesquelles les résultats d’analyse ont été envoyés.
getSarif(number)	Obtenir l’état du travail de traitement Sarif
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Obtenez les détails de validité d’une alerte.
initiateValidation(string, string, number)	Lancer le processus de validation d’une alerte donnée
updateAlert(AlertStateUpdate, string, number, string)	Mettre à jour l’état d’une alerte
updateAlertsMetadata(AlertMetadata[], string, string)	Mettez à jour les associations de métadonnées d’alerte.
uploadSarif(string, 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

createLegalReview(string, string, number, string)

Créez un examen juridique. Cela crée l’examen juridique associé à l’alerte. Il s’agit de l’URL de l’élément de travail de révision.

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

Paramètres

project

string

ID de projet ou nom du projet

repository

string

Nom ou identifiant d’un référentiel pour l’alerte juridique

alertId

number

Alerte de sécurité préalable identifiant de l’alerte juridique pour obtenir l’examen juridique

ref

string

Retours

Promise<LegalReview>

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 d’alerte à récupérer

repository

string

Nom ou ID d’un référentiel 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 des instances d’une alerte sur une branche spécifiée avec @ref. Si @ref n’est pas fourni, retournez des instances d’une alerte sur la branche par défaut (si l’alerte existe dans la branche par défaut) ou la branche affectée la plus récente.

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 d’alerte à récupérer

repository

string

Nom ou ID d’un référentiel dont l’alerte fait partie

ref

string

Retours

Promise<AlertAnalysisInstance[]>

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

Obtenir des alertes pour un référentiel

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

Paramètres

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID du référentiel

top

number

Nombre maximal d’alertes à retourner

orderBy

string

Doit être « id » « firstSeen » « lastSeen » « fixedOn » ou « gravité » Par défaut sur « id »

criteria

SearchCriteria

Options permettant de limiter les alertes retournées

expand

AlertListExpandOption

continuationToken

string

S’il existe plus d’alertes que possible, un jeton de continuation est placé dans l’en-tête « x-ms-continuationtoken ». Utilisez ce jeton ici pour obtenir la page suivante des 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 d’alerte à récupérer

repository

string

Nom ou ID d’un référentiel dont l’alerte fait partie

ref

string

expand

ExpandOption

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

Retours

Promise<string>

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

Retourne les branches pour lesquelles les résultats d’analyse ont été envoyés.

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

Paramètres

project

string

ID de projet ou nom du projet

repository

string

alertType

AlertType

Type d’alerte : Analyse des dépendances (1), Secret (2), Code QL (3), etc.

continuationToken

string

Variable de chaîne qui représente le nom de la branche et est utilisée pour extraire des branches qui le suivent dans l’ordre alphabétique.

branchNameContains

string

Variable de chaîne utilisée pour extraire des branches qui contiennent cette chaîne n’importe où dans le nom de la branche, ne respectant pas la casse.

top

number

Variable int utilisée pour retourner les branches k supérieures qui répondent aux critères de recherche.

includePullRequestBranches

boolean

Variable bool indiquant s’il faut inclure ou non des branches de demande de tirage.

Retours

Promise<Branch[]>

getSarif(number)

Obtenir l’état 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>

getValidityData(string, string, number)

Obtenez les détails de validité d’une alerte.

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

Paramètres

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID d’un référentiel

alertId

number

ID de l’alerte

Retours

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Lancer le processus de validation d’une alerte donnée

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

Paramètres

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID d’un référentiel

alertId

number

ID de l’alerte

Retours

Promise<AlertValidationRequestStatus>

updateAlert(AlertStateUpdate, string, number, string)

Mettre à jour l’état d’une alerte

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

Paramètres

stateUpdate

AlertStateUpdate

Nouvel état de l’alerte

project

string

ID de projet ou nom du projet

alertId

number

ID de l’alerte

repository

string

Nom ou ID du référentiel

Retours

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

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

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

Paramètres

alertsMetadata

AlertMetadata[]

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

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID du référentiel.

Retours

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string, String)

Charger un Sarif contenant des alertes de sécurité

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

notificationFlag

String

En-tête pour signaler qu’il s’agit d’une notification de progression

Retours

Promise<number>