ReportingRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's

Uitbreiding

RestClientBase

Constructors

ReportingRestClient(IVssRestClientOptions)

Methoden

createAdvancedFilter(AdvancedFilterCreate)	Maakt een nieuw geavanceerd filter voor de organisatie.
deleteAdvancedFilter(string)	Verwijdert een geavanceerd filter.
getAdvancedFilter(string)	Krijgt een specifiek geavanceerd filter via zijn ID.
getAlertSummaryForOrg(FilterCriteria)	Waarschuwingsoverzicht ophalen op ernst voor de organisatie
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Ontvang gecombineerde meldingen voor de organisatie
getDependencyComponentNamesForOrg()	Haal alle verschillende afhankelijkheidscomponentnamen voor de organisatie op (gebruikt voor UX-filtering)
getEnablementSummaryForOrg(EnablementFilterCriteria)	Krijg een samenvatting van Enablement voor de organisatie
getProjectsAndReposForOrg()	Download alle projecten en repositories van de organisatie (gebruikt voor UX-filtering)
getRuleNamesForOrg(string)	Krijg alle verschillende codescanningsregelnamen voor de organisatie (gebruikt voor UX-filtering)
getSecretTypesForOrg()	Haal alle verschillende geheime types voor de organisatie (gebruikt voor UX-filtering)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Bevat alle geavanceerde filters voor de organisatie.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Werkt een geavanceerd filter bij. Alleen de naam kan worden bijgewerkt.

Constructordetails

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Methodedetails

createAdvancedFilter(AdvancedFilterCreate)

Maakt een nieuw geavanceerd filter voor de organisatie.

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

Parameters

filter

AdvancedFilterCreate

Het geavanceerde filter om te creëren.

Retouren

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Verwijdert een geavanceerd filter.

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

Parameters

filterId

string

De ID van het geavanceerde filter om te verwijderen.

Retouren

Promise<void>

getAdvancedFilter(string)

Krijgt een specifiek geavanceerd filter via zijn ID.

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

Parameters

filterId

string

De ID van het geavanceerde filter om op te halen.

Retouren

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Waarschuwingsoverzicht ophalen op ernst voor de organisatie

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

Parameters

criteria

FilterCriteria

Opties om het aantal teruggestuurde samenvattingen te beperken

Retouren

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Ontvang gecombineerde meldingen voor de organisatie

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

Parameters

criteria

CombinedAlertFilterCriteria

Opties om de gecombineerde meldingen te filteren

top

number

Het maximum aantal waarschuwingen dat moet worden geretourneerd

continuationToken

string

Als er meer waarschuwingen zijn dan kan worden geretourneerd, wordt een vervolgtoken in de header x-ms-continuationtoken geplaatst. Gebruik dit token hier om de volgende pagina met waarschuwingen op te halen

Retouren

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Haal alle verschillende afhankelijkheidscomponentnamen voor de organisatie op (gebruikt voor UX-filtering)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Retouren

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Krijg een samenvatting van Enablement voor de organisatie

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

Parameters

criteria

EnablementFilterCriteria

Opties om het aantal teruggestuurde samenvattingen te beperken

Retouren

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Download alle projecten en repositories van de organisatie (gebruikt voor UX-filtering)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Retouren

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Krijg alle verschillende codescanningsregelnamen voor de organisatie (gebruikt voor UX-filtering)

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

Parameters

toolName

string

Optionele toolnaam om regels op te filteren

Retouren

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Haal alle verschillende geheime types voor de organisatie (gebruikt voor UX-filtering)

function getSecretTypesForOrg(): Promise<string[]>

Retouren

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Retouren

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Bevat alle geavanceerde filters voor de organisatie.

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

Parameters

includeDeleted

boolean

Of er zacht verwijderde filters worden toegevoegd.

keywords

string

Optioneel filter om filters op naam te zoeken (hoofdlettergevoelig, gedeeltelijke overeenkomst).

Retouren

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Werkt een geavanceerd filter bij. Alleen de naam kan worden bijgewerkt.

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

Parameters

filter

AdvancedFilterUpdate

De updategegevens met de nieuwe naam.

filterId

string

De ID van het geavanceerde filter om te updaten.

Retouren

Promise<void>