ReportingRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Sträcker sig

RestClientBase

Konstruktörer

ReportingRestClient(IVssRestClientOptions)

Metoder

createAdvancedFilter(AdvancedFilterCreate)	Skapar ett nytt avancerat filter för organisationen.
deleteAdvancedFilter(string)	Tar bort ett avancerat filter.
getAdvancedFilter(string)	Får ett specifikt avancerat filter via sitt ID.
getAlertSummaryForOrg(FilterCriteria)	Hämta aviseringssammanfattning efter allvarlighetsgrad för organisationen
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Få kombinerade varningar för organisationen
getDependencyComponentNamesForOrg()	Få tag på alla olika beroendekomponenter för organisationen (används för UX-filtrering)
getEnablementSummaryForOrg(EnablementFilterCriteria)	Få sammanfattning av aktivering för organisationen
getProjectsAndReposForOrg()	Hämta alla projekt och repositories för organisationen (används för UX-filtrering)
getRuleNamesForOrg(string)	Få alla olika kodskanningsregelnamn för organisationen (används för UX-filtrering)
getSecretTypesForOrg()	Få alla olika hemliga typer för organisationen (används för UX-filtrering)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Innehåller alla avancerade filter för organisationen.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Uppdaterar ett avancerat filter. Endast namnet kan uppdateras.

Konstruktördetaljer

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metoddetaljer

createAdvancedFilter(AdvancedFilterCreate)

Skapar ett nytt avancerat filter för organisationen.

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

Parametrar

filter

AdvancedFilterCreate

Det avancerade filtret för att skapa.

Returnerar

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Tar bort ett avancerat filter.

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

Parametrar

filterId

string

ID:t för det avancerade filtret för att ta bort.

Returnerar

Promise<void>

getAdvancedFilter(string)

Får ett specifikt avancerat filter via sitt ID.

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

Parametrar

filterId

string

ID:t för det avancerade filtret att hämta.

Returnerar

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Hämta aviseringssammanfattning efter allvarlighetsgrad för organisationen

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

Parametrar

criteria

FilterCriteria

Alternativ för att begränsa de återkommande sammanfattningarna

Returnerar

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Få kombinerade varningar för organisationen

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

Parametrar

criteria

CombinedAlertFilterCriteria

Alternativ för att filtrera de kombinerade varningarna returnerades

top

number

Det maximala antalet aviseringar som ska returneras

continuationToken

string

Om det finns fler aviseringar än vad som kan returneras placeras en fortsättningstoken i rubriken "x-ms-continuationtoken". Använd den token här för att hämta nästa sida med aviseringar

Returnerar

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Få tag på alla olika beroendekomponenter för organisationen (används för UX-filtrering)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Returnerar

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Få sammanfattning av aktivering för organisationen

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

Parametrar

criteria

EnablementFilterCriteria

Alternativ för att begränsa de återkommande sammanfattningarna

Returnerar

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Hämta alla projekt och repositories för organisationen (används för UX-filtrering)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Returnerar

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Få alla olika kodskanningsregelnamn för organisationen (används för UX-filtrering)

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

Parametrar

toolName

string

Valfritt verktygsnamn för att filtrera regler efter

Returnerar

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Få alla olika hemliga typer för organisationen (används för UX-filtrering)

function getSecretTypesForOrg(): Promise<string[]>

Returnerar

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Returnerar

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Innehåller alla avancerade filter för organisationen.

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

Parametrar

includeDeleted

boolean

Om man ska inkludera mjukt raderade filter.

keywords

string

Valfritt filter för att söka filter efter namn (kasuskänslig, delvis matchning).

Returnerar

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Uppdaterar ett avancerat filter. Endast namnet kan uppdateras.

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

Parametrar

filter

AdvancedFilterUpdate

Uppdateringsdata som innehåller det nya namnet.

filterId

string

ID:t för det avancerade filtret för att uppdateras.

Returnerar

Promise<void>