AlertRestClient class
Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST vss
- Extends
Costruttori
| Alert |
Metodi
| get |
Ottenere un avviso. |
| get |
Ottenere istanze di un avviso. |
| get |
Ottenere avvisi per un repository |
| get |
Ottenere un avviso. |
| get |
Ottenere lo stato del processo di elaborazione Sarif |
| get |
|
| update |
Aggiornare lo stato di un avviso |
| update |
Aggiornare le associazioni dei metadati degli avvisi. |
| upload |
Caricare un sarif contenente gli avvisi di sicurezza |
Dettagli costruttore
AlertRestClient(IVssRestClientOptions)
Dettagli metodo
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 del 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 degli avvisi. Le opzioni possibili sono {ValidationFingerprint, None}
Restituisce
Promise<Alert>
getAlertInstances(string, number, string, string)
Ottenere istanze di un avviso.
function getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<AlertAnalysisInstance[]>Parametri
- project
-
string
ID progetto o nome del 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, string)
Ottenere avvisi per un repository
function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, continuationToken?: string): Promise<PagedList<Alert>>Parametri
- project
-
string
ID progetto o nome del 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
- continuationToken
-
string
Se sono presenti più avvisi che possono essere restituiti, un token di continuazione viene inserito nell'intestazione "x-ms-continuationtoken". Usare il token qui per ottenere la pagina successiva degli avvisi
Restituisce
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 del 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 degli avvisi. Le opzioni possibili sono {ValidationFingerprint, None}
Restituisce
Promise<string>
getSarif(number)
Ottenere lo stato del processo di elaborazione Sarif
function getSarif(sarifId: number): Promise<SarifUploadStatus>Parametri
- sarifId
-
number
ID Sarif restituito quando il Sarif è stato caricato
Restituisce
Promise<SarifUploadStatus>
getUxFilters(string, string, AlertType)
function getUxFilters(project: string, repository: string, alertType: AlertType): Promise<UxFilters>Parametri
- project
-
string
ID progetto o nome del progetto
- repository
-
string
- alertType
- AlertType
Restituisce
Promise<UxFilters>
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 del 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
Elenco di metadati da associare agli avvisi.
- project
-
string
ID progetto o nome del progetto
- repository
-
string
Nome o ID del repository.
Restituisce
Promise<AlertMetadataChange[]>
uploadSarif(string, string, string)
Caricare un sarif contenente gli avvisi di sicurezza
function uploadSarif(content: string, project: string, repository: string): Promise<number>Parametri
- content
-
string
Contenuto da caricare
- project
-
string
ID progetto o nome del progetto
- repository
-
string
Nome o ID di un repository
Restituisce
Promise<number>
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per