ReportingRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

ReportingRestClient(IVssRestClientOptions)

Metody

createAdvancedFilter(AdvancedFilterCreate)	Vytváří nový pokročilý filtr pro organizaci.
deleteAdvancedFilter(string)	Smaže pokročilý filtr.
getAdvancedFilter(string)	Získává specifický pokročilý filtr podle svého ID.
getAlertSummaryForOrg(FilterCriteria)	Získání souhrnu výstrah podle závažnosti pro organizaci
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Získání kombinovaných upozornění pro organizaci
getDependencyComponentNamesForOrg()	Získejte všechny různé názvy komponent závislostí pro organizaci (používané pro UX filtrování)
getEnablementSummaryForOrg(EnablementFilterCriteria)	Získání souhrnu povolení pro organizaci
getProjectsAndReposForOrg()	Získejte všechny projekty a repozitáře pro organizaci (používané pro UX filtrování)
getRuleNamesForOrg(string)	Získejte všechny různé názvy pravidel pro skenování kódu pro organizaci (používané pro UX filtrování)
getSecretTypesForOrg()	Získejte všechny různé typy tajemství pro organizaci (používané pro UX filtrování)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Získává všechny pokročilé filtry pro organizaci.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Aktualizuje pokročilý filtr. Pouze název lze aktualizovat.

Podrobnosti konstruktoru

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

createAdvancedFilter(AdvancedFilterCreate)

Vytváří nový pokročilý filtr pro organizaci.

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

Parametry

filter

AdvancedFilterCreate

Pokročilý filtr pro tvoření.

Návraty

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Smaže pokročilý filtr.

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

Parametry

filterId

string

ID pokročilého filtru pro mazání.

Návraty

Promise<void>

getAdvancedFilter(string)

Získává specifický pokročilý filtr podle svého ID.

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

Parametry

filterId

string

ID pokročilého filtru pro načtení.

Návraty

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Získání souhrnu výstrah podle závažnosti pro organizaci

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

Parametry

criteria

FilterCriteria

Možnosti omezení počtu vrácených souhrnů

Návraty

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Získání kombinovaných upozornění pro organizaci

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

Parametry

criteria

CombinedAlertFilterCriteria

Možnosti filtrování kombinovaných vrácených upozornění

top

number

Maximální počet výstrah, které se mají vrátit

continuationToken

string

Pokud existuje více výstrah, než je možné vrátit, token pro pokračování se umístí do hlavičky x-ms-continuationtoken. Pomocí tohoto tokenu zde získáte další stránku upozornění.

Návraty

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Získejte všechny různé názvy komponent závislostí pro organizaci (používané pro UX filtrování)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Návraty

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Získání souhrnu povolení pro organizaci

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

Parametry

criteria

EnablementFilterCriteria

Možnosti omezení počtu vrácených souhrnů

Návraty

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Získejte všechny projekty a repozitáře pro organizaci (používané pro UX filtrování)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Návraty

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Získejte všechny různé názvy pravidel pro skenování kódu pro organizaci (používané pro UX filtrování)

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

Parametry

toolName

string

Volitelný název nástroje pro filtrování pravidel podle

Návraty

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Získejte všechny různé typy tajemství pro organizaci (používané pro UX filtrování)

function getSecretTypesForOrg(): Promise<string[]>

Návraty

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Návraty

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Získává všechny pokročilé filtry pro organizaci.

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

Parametry

includeDeleted

boolean

Zda zahrnout soft-deleted filtry.

keywords

string

Volitelný filtr pro vyhledávání filtrů podle názvu (necitlivé na velká písmena, částečná shoda).

Návraty

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Aktualizuje pokročilý filtr. Pouze název lze aktualizovat.

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

Parametry

filter

AdvancedFilterUpdate

Aktualizace obsahující nové jméno.

filterId

string

ID pokročilého filtru pro aktualizaci.

Návraty

Promise<void>