ReportingRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Kiterjeszti

RestClientBase

Konstruktorok

ReportingRestClient(IVssRestClientOptions)

Módszerek

createAdvancedFilter(AdvancedFilterCreate)	Új fejlett szűrőt hoz létre a szervezet számára.
deleteAdvancedFilter(string)	Törli a fejlett szűrőt.
getAdvancedFilter(string)	Az azonosítója alapján egy specifikus, fejlett szűrőt kap.
getAlertSummaryForOrg(FilterCriteria)	Riasztások összegzésének lekérése súlyosság szerint a szervezet számára
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Szerezz összesített értesítéseket a szervezet számára
getDependencyComponentNamesForOrg()	Szerezd meg az összes különálló függőségi komponensnevet az szervezethez (UX szűréshez használják)
getEnablementSummaryForOrg(EnablementFilterCriteria)	Szerezd meg az Enablement összefoglalót az szervezethez
getProjectsAndReposForOrg()	Szerezd meg az összes projektet és tárolót az orgorgához (UX szűréshez használják)
getRuleNamesForOrg(string)	Szerezz meg minden különálló kódszkennelési szabálynevet a szervezethez (UX szűréshez használják)
getSecretTypesForOrg()	Szerezz meg minden különálló titkos típust az szervezethez (UX szűréshez használják)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Minden haladó szűrőt kap a szervezethez.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Frissít egy fejlett szűrőt. Csak a név frissíthető.

Építő részletek

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Módszer részletei

createAdvancedFilter(AdvancedFilterCreate)

Új fejlett szűrőt hoz létre a szervezet számára.

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

Paraméterek

filter

AdvancedFilterCreate

A fejlett szűrő, amit létrehozni lehet.

Visszatér

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Törli a fejlett szűrőt.

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

Paraméterek

filterId

string

A fejlett szűrő azonosítója, amit törölni.

Visszatér

Promise<void>

getAdvancedFilter(string)

Az azonosítója alapján egy specifikus, fejlett szűrőt kap.

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

Paraméterek

filterId

string

A fejlett szűrő azonosítója, amit a lekéréshez lehet.

Visszatér

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Riasztások összegzésének lekérése súlyosság szerint a szervezet számára

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

Paraméterek

criteria

FilterCriteria

Lehetőségek a visszaadott összefoglalók korlátozására

Visszatér

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Szerezz összesített értesítéseket a szervezet számára

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

Paraméterek

criteria

CombinedAlertFilterCriteria

A visszaküldött kombinált riasztások szűrési lehetőségei

top

number

A visszaadni kívánt riasztások maximális száma

continuationToken

string

Ha a visszaadhatónál több riasztás van, a rendszer egy folytatási jogkivonatot helyez el az "x-ms-continuationtoken" fejlécben. Használja ezt a jogkivonatot a riasztások következő oldalának lekéréséhez

Visszatér

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Szerezd meg az összes különálló függőségi komponensnevet az szervezethez (UX szűréshez használják)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Visszatér

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Szerezd meg az Enablement összefoglalót az szervezethez

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

Paraméterek

criteria

EnablementFilterCriteria

Lehetőségek a visszaadott összefoglalók korlátozására

Visszatér

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Szerezd meg az összes projektet és tárolót az orgorgához (UX szűréshez használják)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Visszatér

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Szerezz meg minden különálló kódszkennelési szabálynevet a szervezethez (UX szűréshez használják)

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

Paraméterek

toolName

string

Opcionális eszköznév a szabályok szűréséhez

Visszatér

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Szerezz meg minden különálló titkos típust az szervezethez (UX szűréshez használják)

function getSecretTypesForOrg(): Promise<string[]>

Visszatér

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Visszatér

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Minden haladó szűrőt kap a szervezethez.

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

Paraméterek

includeDeleted

boolean

Hogy beépítsék-e a szoftveres szűrőket.

keywords

string

Opcionális szűrő a szűrők kereséséhez név szerint (kis- és nagybetűs szenzitás, részleges egyezés).

Visszatér

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Frissít egy fejlett szűrőt. Csak a név frissíthető.

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

Paraméterek

filter

AdvancedFilterUpdate

Az új nevet tartalmazó frissítési adatok.

filterId

string

A fejlett szűrő azonosítója a frissítéshez.

Visszatér

Promise<void>