Condividi tramite

ReportingRestClient class

Pacchetto:
azure-devops-extension-api

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

Extends
RestClientBase

Costruttori

ReportingRestClient(IVssRestClientOptions)

Metodi

createAdvancedFilter(AdvancedFilterCreate)

Crea un nuovo filtro avanzato per l'organizzazione.
deleteAdvancedFilter(string)

Elimina un filtro avanzato.
getAdvancedFilter(string)

Riceve un filtro avanzato specifico tramite il suo ID.
getAlertSummaryForOrg(FilterCriteria)

Ottenere il riepilogo degli avvisi in base alla gravità per l'organizzazione
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Ottenere avvisi combinati per l'organizzazione
getDependencyComponentNamesForOrg()

Ottieni tutti i nomi distinti dei componenti di dipendenza per l'organizzazione (usati per il filtraggio UX)
getEnablementSummaryForOrg(EnablementFilterCriteria)

Ottenere il riepilogo dell'abilitazione per l'organizzazione
getProjectsAndReposForOrg()

Raccogli tutti i progetti e i repository dell'organizzazione (usati per il filtraggio UX)
getRuleNamesForOrg(string)

Ottieni tutti i nomi distinti delle regole di scansione del codice per l'organizzazione (usate per il filtraggio UX)
getSecretTypesForOrg()

Ottieni tutti i tipi di segreti distinti per l'organizzazione (usati per il filtraggio UX)
getUXComputedFilters()
listAdvancedFilters(boolean, string)

Riceve tutti i filtri avanzati per l'organizzazione.
updateAdvancedFilter(AdvancedFilterUpdate, string)

Aggiorna un filtro avanzato. Solo il nome può essere aggiornato.

Dettagli costruttore

ReportingRestClient(IVssRestClientOptions) 

new ReportingRestClient(options: IVssRestClientOptions)

Parametri

options
IVssRestClientOptions

Dettagli metodo

createAdvancedFilter(AdvancedFilterCreate)

Crea un nuovo filtro avanzato per l'organizzazione.

function createAdvancedFilter(filter: AdvancedFilterCreate): Promise<AdvancedFilter>

Parametri

filter
AdvancedFilterCreate

Il filtro avanzato per creare.

Restituisce

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Elimina un filtro avanzato.

function deleteAdvancedFilter(filterId: string): Promise<void>

Parametri

filterId

string

L'ID del filtro avanzato da eliminare.

Restituisce

Promise<void>

getAdvancedFilter(string)

Riceve un filtro avanzato specifico tramite il suo ID.

function getAdvancedFilter(filterId: string): Promise<AdvancedFilter>

Parametri

filterId

string

L'ID del filtro avanzato da recuperare.

Restituisce

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Ottenere il riepilogo degli avvisi in base alla gravità per l'organizzazione

function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>

Parametri

criteria
FilterCriteria

Opzioni per limitare i riassunti restituiti

Restituisce

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Ottenere avvisi combinati per l'organizzazione

function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>

Parametri

criteria
CombinedAlertFilterCriteria

Sono tornate le opzioni per filtrare gli avvisi combinati

top

number

Numero massimo di avvisi da restituire

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<DashboardAlert>>

getDependencyComponentNamesForOrg()

Ottieni tutti i nomi distinti dei componenti di dipendenza per l'organizzazione (usati per il filtraggio UX)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Restituisce

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Ottenere il riepilogo dell'abilitazione per l'organizzazione

function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>

Parametri

criteria
EnablementFilterCriteria

Opzioni per limitare i riassunti restituiti

Restituisce

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Raccogli tutti i progetti e i repository dell'organizzazione (usati per il filtraggio UX)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Restituisce

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Ottieni tutti i nomi distinti delle regole di scansione del codice per l'organizzazione (usate per il filtraggio UX)

function getRuleNamesForOrg(toolName?: string): Promise<CodeScanningRuleInfo[]>

Parametri

toolName

string

Nome facoltativo dello strumento per filtrare le regole

Restituisce

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Ottieni tutti i tipi di segreti distinti per l'organizzazione (usati per il filtraggio UX)

function getSecretTypesForOrg(): Promise<string[]>

Restituisce

Promise<string[]>

getUXComputedFilters() 

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Restituisce

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Riceve tutti i filtri avanzati per l'organizzazione.

function listAdvancedFilters(includeDeleted?: boolean, keywords?: string): Promise<AdvancedFilter[]>

Parametri

includeDeleted

boolean

Se includere filtri a eliminazione soft.

keywords

string

Filtro opzionale per cercare filtri per nome (indistinto a maiuscole e minusco, corrispondenza parziale).

Restituisce

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Aggiorna un filtro avanzato. Solo il nome può essere aggiornato.

function updateAdvancedFilter(filter: AdvancedFilterUpdate, filterId: string): Promise<void>

Parametri

filter
AdvancedFilterUpdate

I dati di aggiornamento contenenti il nuovo nome.

filterId

string

L'ID del filtro avanzato da aggiornare.

Restituisce

Promise<void>