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

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.
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.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Ottenere avvisi per un repository
getAlertSarif(string, number, string, string, ExpandOption)	Ottenere un avviso.
getBranches(string, string, AlertType, string, string, number, boolean)	Restituisce i rami per i quali sono stati inviati i risultati dell'analisi.
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
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
updateAlert(AlertStateUpdate, string, number, string)	Aggiornare lo stato di un avviso
updateAlertsMetadata(AlertMetadata[], string, string)	Aggiornare le associazioni dei metadati degli avvisi.
uploadOrgSarif(string)	Caricare un file Sarif a livello di organizzazione
uploadSarif(string, string, string, String)	Caricare un sarif contenente gli avvisi di sicurezza

Dettagli costruttore

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli metodo

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

Restituisce

Promise<LegalReview>

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.

Restituisce

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

Restituisce

Promise<AlertAnalysisInstance[]>

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

Restituisce

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.

Restituisce

Promise<string>

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.

Restituisce

Promise<Branch[]>

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

Restituisce

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

Restituisce

Promise<SarifUploadStatus>

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

Restituisce

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

Restituisce

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

Restituisce

Promise<AlertValidationRequestStatus>

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

Restituisce

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.

Restituisce

Promise<AlertMetadataChange[]>

uploadOrgSarif(string)

Caricare un file Sarif a livello di organizzazione

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

Parametri

content

string

Contenuto da caricare

Restituisce

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

Restituisce

Promise<number>