AlertRestClient class

new AlertRestClient(options: IVssRestClientOptions)

Paramètres

Reçoit un rappel du pipeline autofix avec le résultat de la course. Idempotent : appels répétés pour une requête déjà en état terminal retournent 200 sans modifications.

function autofixCallback(callbackRequest: AutofixCallbackRequest, project: string, repository: string, alertId: number): Promise<void>

Paramètres

Retours

Créez une demande d’autofixation pour l’alerte spécifiée.

function createAutofixRequest(project: string, alertId: number, repository: string): Promise<AutofixRequest>

Paramètres

Retours

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

Retours

Supprime de manière réversible les données d’analyse pour tous les pipelines d’un référentiel, en supprimant les alertes Advanced Security associées.

function deleteAllPipelineAnalyses(project: string, repository: string): Promise<void>

Paramètres

Retours

Supprime de manière réversible les données d’analyse d’un pipeline spécifique, en supprimant les alertes Advanced Security associées.

function deletePipelineAnalysis(project: string, repository: string, adoPipelineId: number): Promise<void>

Paramètres

Retours

Exporter les alertes sous forme d’un seul fichier SARIF

function exportSarif(project: string, repository: string, alertIds: number[], branchName?: string): Promise<any>

Paramètres

Retours

Obtenez une alerte.

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

Paramètres

Retours

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

Retours

Obtenez une alerte de métadonnées.

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

Paramètres

Retours

Recevez des alertes, des métadonnées.

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

Paramètres

Retours

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

Retours

Obtenez une alerte.

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

Paramètres

Retours

Obtenir des alertes par ID d’alerte Prend actuellement en charge l’extraction d’alertes secrètes uniquement.

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

Paramètres

Retours

Obtenez toutes les demandes d’autofix pour l’alerte spécifiée.

function getAutofixRequestsByAlertId(project: string, alertId: number, repository: string): Promise<AutofixRequest[]>

Paramètres

Retours

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

Retours

Recevez des alertes par leur ID au niveau de l’organisation. Ne reprend que les alertes que l’utilisateur est autorisé à afficher. Renvoie uniquement les alertes des plans de référence SKU activés.

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

Paramètres

Retours

Obtenir l’état du travail de traitement Sarif

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

Paramètres

Retours

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

Paramètres

Retours

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

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

Paramètres

Retours

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

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

Paramètres

Retours

Mettre à jour l’état d’une alerte

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

Paramètres

Retours

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

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

Paramètres

Retours

Télécharger un fichier Sarif au niveau de l’organisation

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

Paramètres

Retours

Charger un Sarif contenant des alertes de sécurité

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

Paramètres

Retours

Téléverser un SARIF sur GitHub en scannant le code via une application GitOps.

function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>

Paramètres

Retours