AlertRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base da usare (derivata da) per effettuare richieste alle API REST vss

Extends

RestClientBase

Costruttori

AlertRestClient(IVssRestClientOptions)

Metodi

autofixCallback(AutofixCallbackRequest, string, string)	Riceve un callback dalla pipeline autofix con l'esito dell'esecuzione. Idempotente: chiamate ripetute per una richiesta già in stato terminale restituiscono 200 senza modifiche.
createAutofixRequest(string, number, string, string)	Crea una richiesta di autofix per l'avviso specificato.
createJob(any, string, string)	Crea un lavoro di allerta.
createLegalReview(string, string, number, string)	Crea una revisione legale. In questo modo viene creata la revisione legale associata all'avviso. Include l'URL dell'elemento di lavoro di revisione.
deleteAllPipelineAnalyses(string, string)	Elimina temporaneo i dati di analisi per tutte le pipeline in un repository, pulendo gli avvisi di sicurezza avanzati associati.
deletePipelineAnalysis(string, string, number)	Elimina soft-delete i dati di analisi per una pipeline specifica, eliminando gli avvisi di sicurezza avanzata associati.
exportSarif(string, string, number[], string)	Esporta gli avvisi come un singolo file SARIF
getAiMetadataContent(string, number, string)	Scarica l'intero blob di metadati AI per un avviso di codice AI.
getAlert(string, number, string, string, ExpandOption)	Ottenere un avviso.
getAlertInstances(string, number, string, string)	Ottenere istanze di un avviso in un ramo specificato con @ref. Se @ref non viene specificato, restituire istanze di un avviso nel ramo predefinito (se l'avviso esiste nel ramo predefinito) o nel ramo interessato più recente.
getAlertMetadata(string, number, string)	Ricevi un avviso sui metadati.
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)	Ricevi i metadati degli avvisi.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Ottenere avvisi per un repository
getAlertSarif(string, number, string, string, ExpandOption)	Ottenere un avviso.
getAlertsByIds(AlertBatchRequest, string, string, boolean)	Ottenere avvisi in base agli ID avviso Attualmente supporta solo il recupero degli avvisi segreti.
getAutofixRequestsByAlertId(string, number, string, string)	Ricevi tutte le richieste di autofix per l'avviso specificato.
getBranches(string, string, AlertType, string, string, number, boolean)	Restituisce i rami per i quali sono stati inviati i risultati dell'analisi.
getDraftAlerts(string, string, number, string, string)	Ricevi avvisi di bozza per un repository.
getJob(string, string, string)	Ricevi un lavoro all'avviso tramite ID.
getJobsForAlert(string, string, number, number, string)	Ricevi le segnalazioni di lavoro associate a un avviso.
getOrgLevelAlertsByIds(number[])	Ricevi avvisi in base ai loro ID a livello di organizzazione. Esegue solo gli avvisi che l'utente è autorizzato a visualizzare. Restituisce solo gli avvisi dei piani SKU abilitati.
getSarif(number)	Ottenere lo stato del processo di elaborazione Sarif
getSarifContent(number)
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Ottenere i dettagli di validità di un avviso.
initiateValidation(string, string, number)	Avviare il processo di convalida per un determinato avviso
queryAlerts(AlertMetadataQueryCriteria, string, string, number, string, AlertListExpandOption, string)	Eseguire query sugli avvisi per un repository in base al collegamento al tipo di metadati.
updateAlert(AlertStateUpdate, string, number, string)	Aggiornare lo stato di un avviso
updateAlertsBatch(AlertBatchStateUpdateRequest, string, string)	Avviso di aggiornamento batch. Solo uso interno — utilizzato dagli scanner di prova per trasferire gli avvisi di bozza generati dall'IA ad Attivi o Rifiutati. Gli avvisi contrassegnati come Draft (indeterminati) rimangono invariati.
updateAlertsMetadata(AlertMetadata[], string, string)	Aggiornare le associazioni dei metadati degli avvisi.
updateJob(any, string, string, string)	Aggiorna un lavoro di allerta.
uploadOrgSarif(string)	Caricare un file Sarif a livello di organizzazione
uploadSarif(string, string, string, String)	Caricare un sarif contenente gli avvisi di sicurezza
uploadSarifToGitHub(string, string, string, string, string)	Carica un SARIF su GitHub Code Scanning tramite un'app GitOps.

Dettagli costruttore

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli metodo

autofixCallback(AutofixCallbackRequest, string, string)

Riceve un callback dalla pipeline autofix con l'esito dell'esecuzione. Idempotente: chiamate ripetute per una richiesta già in stato terminale restituiscono 200 senza modifiche.

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

Parametri

callbackRequest

AutofixCallbackRequest

Il payload di callback contenente requestId, status e opzionale pullRequestId.

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository.

Valori restituiti

Promise<void>

createAutofixRequest(string, number, string, string)

Crea una richiesta di autofix per l'avviso specificato.

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

Parametri

project

string

ID progetto o nome progetto

alertId

number

L'ID dell'avviso per creare un autofix per.

repository

string

Nome o ID del repository.

ref

string

Il ref Git (ad esempio refs/heads/feature/x) dovrebbe essere mirato all'autofix.

Valori restituiti

Promise<AutofixRequest>

createJob(any, string, string)

Crea un lavoro di allerta.

function createJob(body: any, project: string, repository: string): Promise<AlertJob>

Parametri

body

any

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

Valori restituiti

Promise<AlertJob>

createLegalReview(string, string, number, string)

Crea una revisione legale. In questo modo viene creata la revisione legale associata all'avviso. Include l'URL dell'elemento di lavoro di revisione.

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID di un archivio per la segnalazione legale

alertId

number

ID avviso di sicurezza avanzato dell'avviso legale per ottenere la revisione legale

ref

string

Valori restituiti

Promise<LegalReview>

deleteAllPipelineAnalyses(string, string)

Elimina temporaneo i dati di analisi per tutte le pipeline in un repository, pulendo gli avvisi di sicurezza avanzati associati.

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository.

Valori restituiti

Promise<void>

deletePipelineAnalysis(string, string, number)

Elimina soft-delete i dati di analisi per una pipeline specifica, eliminando gli avvisi di sicurezza avanzata associati.

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository.

adoPipelineId

number

ID della pipeline ADO i cui dati di analisi devono essere puliti.

Valori restituiti

Promise<void>

exportSarif(string, string, number[], string)

Esporta gli avvisi come un singolo file SARIF

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID di un repository

alertIds

number[]

Elenco degli ID di avviso da esportare

branchName

string

Il nome della filiale dell'obiettivo allerta. Se non specificato, verrà utilizzato il ramo predefinito.

Valori restituiti

Promise<any>

getAiMetadataContent(string, number, string)

Scarica l'intero blob di metadati AI per un avviso di codice AI.

function getAiMetadataContent(project: string, alertId: number, repository: string): Promise<any>

Parametri

project

string

ID progetto o nome progetto

alertId

number

ID dell'avviso il cui blob di metadati AI dovrebbe essere scaricato.

repository

string

Nome o ID del repository a cui fa parte l'avviso.

Valori restituiti

Promise<any>

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

Ottenere un avviso.

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

Parametri

project

string

ID progetto o nome progetto

alertId

number

ID dell'avviso da recuperare

repository

string

Nome o ID di un repository di cui fa parte l'avviso

ref

string

expand

ExpandOption

Espandere gli attributi di un avviso segreto. I valori possibili sono None e ValidationFingerprint. Il valore predefinito è None. Tenere presente che se expand è impostato su ValidationFingerprint, la risposta può contenere il segreto nel formato non crittografato. Prestare attenzione quando si usano questi dati.

Valori restituiti

Promise<Alert>

getAlertInstances(string, number, string, string)

Ottenere istanze di un avviso in un ramo specificato con @ref. Se @ref non viene specificato, restituire istanze di un avviso nel ramo predefinito (se l'avviso esiste nel ramo predefinito) o nel ramo interessato più recente.

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

Parametri

project

string

ID progetto o nome progetto

alertId

number

ID dell'avviso da recuperare

repository

string

Nome o ID di un repository di cui fa parte l'avviso

ref

string

Valori restituiti

Promise<AlertAnalysisInstance[]>

getAlertMetadata(string, number, string)

Ricevi un avviso sui metadati.

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

Parametri

project

string

ID progetto o nome progetto

alertId

number

ID dell'avviso da recuperare

repository

string

Nome o ID di un repository di cui fa parte l'avviso

Valori restituiti

Promise<AlertMetadata>

getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)

Ricevi i metadati degli avvisi.

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

Parametri

alertMetadataBatchRequest

AlertMetadataBatchRequest

project

string

ID progetto o nome progetto

repository

string

Nome o ID di un repository di cui fa parte l'avviso

Valori restituiti

Promise<AlertMetadata[]>

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

Ottenere avvisi per un repository

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

top

number

Numero massimo di avvisi da restituire

orderBy

string

Deve essere "id" "firstSeen" "lastSeen" "fixedOn" o "severity" Il valore predefinito è "id"

criteria

SearchCriteria

Opzioni per limitare gli avvisi restituiti

expand

AlertListExpandOption

continuationToken

string

Se sono presenti più avvisi che possono essere restituiti, un token di continuazione viene inserito nell'intestazione "x-ms-continuationtoken". Usare questo token qui per ottenere la pagina successiva degli avvisi

Valori restituiti

Promise<PagedList<Alert>>

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

Ottenere un avviso.

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

Parametri

project

string

ID progetto o nome progetto

alertId

number

ID dell'avviso da recuperare

repository

string

Nome o ID di un repository di cui fa parte l'avviso

ref

string

expand

ExpandOption

Espandere gli attributi di un avviso segreto. I valori possibili sono None e ValidationFingerprint. Il valore predefinito è None. Tenere presente che se expand è impostato su ValidationFingerprint, la risposta può contenere il segreto nel formato non crittografato. Prestare attenzione quando si usano questi dati.

Valori restituiti

Promise<string>

getAlertsByIds(AlertBatchRequest, string, string, boolean)

Ottenere avvisi in base agli ID avviso Attualmente supporta solo il recupero degli avvisi segreti.

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

Parametri

request

AlertBatchRequest

Richiesta contenente ID di allarme e filtro opzionale per il tipo di allarme

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

includeSensitiveInformation

boolean

Si applica solo agli avvisi segreti. Quando false (impostazione predefinita), la 'ValidationFingerprintJson' delle impronte di validazione di ogni avviso segreto viene omessa dalla risposta. Impostato su vero per includerlo; Tieni presente che il JSON dell'impronta digitale di validazione può contenere il segreto non criptato e altri dati sensibili, quindi fai attenzione quando lo richiedi.

Valori restituiti

Promise<Alert[]>

getAutofixRequestsByAlertId(string, number, string, string)

Ricevi tutte le richieste di autofix per l'avviso specificato.

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

Parametri

project

string

ID progetto o nome progetto

alertId

number

ID dell'avviso.

repository

string

Nome o ID del repository.

ref

string

Il ref Git (ad esempio refs/heads/feature/x) dovrebbe essere mirato all'autofix.

Valori restituiti

Promise<AutofixRequest[]>

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

Restituisce i rami per i quali sono stati inviati i risultati dell'analisi.

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

Parametri

project

string

ID progetto o nome progetto

repository

string

alertType

AlertType

Tipo di avviso: Analisi delle dipendenze (1), Segreto (2), QL del codice (3) e così via.

continuationToken

string

Variabile stringa che rappresenta il nome del ramo e viene utilizzata per recuperare i rami che lo seguono in ordine alfabetico.

branchNameContains

string

Variabile stringa usata per recuperare i rami che contengono questa stringa in qualsiasi punto del nome del ramo, senza distinzione tra maiuscole e minuscole.

top

number

Variabile int usata per restituire i primi k rami che soddisfano i criteri di ricerca.

includePullRequestBranches

boolean

Variabile bool che indica se includere o meno rami di richiesta pull.

Valori restituiti

Promise<Branch[]>

getDraftAlerts(string, string, number, string, string)

Ricevi avvisi di bozza per un repository.

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

top

number

Numero massimo di avvisi da restituire

orderBy

string

Deve essere "id", "firstSeen", "lastSeen", "fixedOn" o "severity". Impostazione predefinita su "id"

continuationToken

string

Se sono presenti più avvisi che possono essere restituiti, un token di continuazione viene inserito nell'intestazione "x-ms-continuationtoken". Usare questo token qui per ottenere la pagina successiva degli avvisi

Valori restituiti

Promise<PagedList<Alert>>

getJob(string, string, string)

Ricevi un lavoro all'avviso tramite ID.

function getJob(project: string, repository: string, jobId: string): Promise<AlertJob>

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

jobId

string

L'identificatore del lavoro assegnato dal fornitore

Valori restituiti

Promise<AlertJob>

getJobsForAlert(string, string, number, number, string)

Ricevi le segnalazioni di lavoro associate a un avviso.

function getJobsForAlert(project: string, repository: string, alertId: number, top?: number, continuationToken?: string): Promise<PagedList<AlertJob>>

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

alertId

number

ID dell'avviso

top

number

Il numero massimo di posti da riprendere

continuationToken

string

Se ci sono più lavori di quanti ne possano essere restituiti, un token di continuazione viene inserito nell'intestazione "x-ms-continuationtoken". Usa quel token qui per ottenere la pagina successiva dei lavori

Valori restituiti

Promise<PagedList<AlertJob>>

getOrgLevelAlertsByIds(number[])

Ricevi avvisi in base ai loro ID a livello di organizzazione. Esegue solo gli avvisi che l'utente è autorizzato a visualizzare. Restituisce solo gli avvisi dei piani SKU abilitati.

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

Parametri

alertIds

number[]

Elenco degli ID di avviso da recuperare

Valori restituiti

Promise<Alert[]>

getSarif(number)

Ottenere lo stato del processo di elaborazione Sarif

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

Parametri

sarifId

number

ID Sarif restituito al caricamento del Sarif

Valori restituiti

Promise<SarifUploadStatus>

getSarifContent(number)

function getSarifContent(submissionId: number): Promise<any>

Parametri

submissionId

number

Valori restituiti

Promise<any>

getUxFilters(string, string, AlertType)

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

Parametri

project

string

ID progetto o nome progetto

repository

string

alertType

AlertType

Valori restituiti

Promise<UxFilters>

getValidityData(string, string, number)

Ottenere i dettagli di validità di un avviso.

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID di un repository

alertId

number

ID dell'avviso

Valori restituiti

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Avviare il processo di convalida per un determinato avviso

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID di un repository

alertId

number

ID dell'avviso

Valori restituiti

Promise<AlertValidationRequestStatus>

queryAlerts(AlertMetadataQueryCriteria, string, string, number, string, AlertListExpandOption, string)

Eseguire query sugli avvisi per un repository in base al collegamento al tipo di metadati.

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

Parametri

criteria

AlertMetadataQueryCriteria

Filtri di tipo di metadati per limitare gli avvisi restituiti

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

top

number

Numero massimo di avvisi da restituire

orderBy

string

Deve essere "id" "firstSeen" "lastSeen" "fixedOn" o "severity" Il valore predefinito è "id"

expand

AlertListExpandOption

Opzioni per espandere la risposta, ad esempio la restituzione dei conteggi degli avvisi anziché gli avvisi

continuationToken

string

Se sono presenti più avvisi che possono essere restituiti, un token di continuazione viene inserito nell'intestazione "x-ms-continuationtoken". Usare questo token qui per ottenere la pagina successiva degli avvisi

Valori restituiti

Promise<PagedList<Alert>>

updateAlert(AlertStateUpdate, string, number, string)

Aggiornare lo stato di un avviso

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

Parametri

stateUpdate

AlertStateUpdate

Nuovo stato dell'avviso

project

string

ID progetto o nome progetto

alertId

number

ID dell'avviso

repository

string

Nome o ID del repository

Valori restituiti

Promise<Alert>

updateAlertsBatch(AlertBatchStateUpdateRequest, string, string)

Avviso di aggiornamento batch. Solo uso interno — utilizzato dagli scanner di prova per trasferire gli avvisi di bozza generati dall'IA ad Attivi o Rifiutati. Gli avvisi contrassegnati come Draft (indeterminati) rimangono invariati.

function updateAlertsBatch(request: AlertBatchStateUpdateRequest, project: string, repository: string): Promise<Alert[]>

Parametri

request

AlertBatchStateUpdateRequest

Richiesta contenente aggiornamenti sullo stato degli allerti

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

Valori restituiti

Promise<Alert[]>

updateAlertsMetadata(AlertMetadata[], string, string)

Aggiornare le associazioni dei metadati degli avvisi.

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

Parametri

alertsMetadata

AlertMetadata[]

Elenco di metadati da associare agli avvisi.

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository.

Valori restituiti

Promise<AlertMetadataChange[]>

updateJob(any, string, string, string)

Aggiorna un lavoro di allerta.

function updateJob(patch: any, project: string, repository: string, jobId: string): Promise<AlertJob>

Parametri

patch

any

La patch che descrive i campi da aggiornare

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

jobId

string

L'identificatore del lavoro assegnato dal fornitore

Valori restituiti

Promise<AlertJob>

uploadOrgSarif(string)

Caricare un file Sarif a livello di organizzazione

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

Parametri

content

string

Contenuto da caricare

Valori restituiti

Promise<number>

uploadSarif(string, string, string, String)

Caricare un sarif contenente gli avvisi di sicurezza

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

Parametri

content

string

Contenuto da caricare

project

string

ID progetto o nome progetto

repository

string

Nome o ID di un repository

notificationFlag

String

Intestazione per segnalare che si tratta di una notifica di stato

Valori restituiti

Promise<number>

uploadSarifToGitHub(string, string, string, string, string)

Carica un SARIF su GitHub Code Scanning tramite un'app GitOps.

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

Parametri

content

string

Contenuto da caricare

project

string

ID progetto o nome progetto

hostname

string

Il nome host GitHub (ad esempio, github.com o microsoft.ghe.com)

owner

string

Il proprietario del repository GitHub (organizzazione o utente)

repo

string

Il nome del repository GitHub

Valori restituiti

Promise<string>