ReportingRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends

RestClientBase

Constructeurs

ReportingRestClient(IVssRestClientOptions)

Méthodes

createAdvancedFilter(AdvancedFilterCreate)	Crée un nouveau filtre avancé pour l’organisation.
deleteAdvancedFilter(string)	Supprime un filtre avancé.
getAdvancedFilter(string)	Il obtient un filtre avancé spécifique par son ID.
getAlertSummaryForOrg(FilterCriteria)	Obtenir un résumé des alertes par gravité pour l’organisation
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Obtenir des alertes combinées pour l’organisation
getDependencyComponentNamesForOrg()	Obtenez tous les noms distincts des composants de dépendance pour l’organisation (utilisés pour le filtrage UX)
getEnablementSummaryForOrg(EnablementFilterCriteria)	Obtenir le résumé de l’activation pour l’organisation
getProjectsAndReposForOrg()	Obtenez tous les projets et dépôts de l’organisation (utilisés pour le filtrage UX)
getRuleNamesForOrg(string)	Obtenez tous les noms distincts de règles de balayage de code pour l’organisation (utilisées pour le filtrage UX)
getSecretTypesForOrg()	Obtenez tous les types de secrets distincts pour l’organisation (utilisés pour le filtrage UX)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Obtient tous les filtres avancés pour l’organisation.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Mise à jour un filtre avancé. Seul le nom peut être mis à jour.

Détails du constructeur

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la méthode

createAdvancedFilter(AdvancedFilterCreate)

Crée un nouveau filtre avancé pour l’organisation.

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

Paramètres

filter

AdvancedFilterCreate

Le filtre avancé à créer.

Retours

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Supprime un filtre avancé.

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

Paramètres

filterId

string

L’identifiant du filtre avancé à supprimer.

Retours

Promise<void>

getAdvancedFilter(string)

Il obtient un filtre avancé spécifique par son ID.

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

Paramètres

filterId

string

L’identifiant du filtre avancé à récupérer.

Retours

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Obtenir un résumé des alertes par gravité pour l’organisation

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

Paramètres

criteria

FilterCriteria

Options pour limiter les résumés retournés

Retours

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Obtenir des alertes combinées pour l’organisation

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

Paramètres

criteria

CombinedAlertFilterCriteria

Options pour filtrer les alertes combinées renvoyées

top

number

Nombre maximal d’alertes à retourner

continuationToken

string

S’il existe plus d’alertes que possible, un jeton de continuation est placé dans l’en-tête « x-ms-continuationtoken ». Utilisez ce jeton ici pour obtenir la page suivante des alertes

Retours

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Obtenez tous les noms distincts des composants de dépendance pour l’organisation (utilisés pour le filtrage UX)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Retours

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Obtenir le résumé de l’activation pour l’organisation

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

Paramètres

criteria

EnablementFilterCriteria

Options pour limiter les résumés retournés

Retours

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Obtenez tous les projets et dépôts de l’organisation (utilisés pour le filtrage UX)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Retours

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Obtenez tous les noms distincts de règles de balayage de code pour l’organisation (utilisées pour le filtrage UX)

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

Paramètres

toolName

string

Nom optionnel de l’outil pour filtrer les règles par

Retours

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Obtenez tous les types de secrets distincts pour l’organisation (utilisés pour le filtrage UX)

function getSecretTypesForOrg(): Promise<string[]>

Retours

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Retours

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Obtient tous les filtres avancés pour l’organisation.

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

Paramètres

includeDeleted

boolean

S’il faut inclure des filtres supprimés à la douce.

keywords

string

Filtre optionnel pour rechercher les filtres par nom (insensible à la casse, correspondance partielle).

Retours

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Mise à jour un filtre avancé. Seul le nom peut être mis à jour.

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

Paramètres

filter

AdvancedFilterUpdate

Les données de mise à jour contenant le nouveau nom.

filterId

string

L’ID du filtre avancé pour se mettre à jour.

Retours

Promise<void>