ReportingRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerza

RestClientBase

Konstruktorów

ReportingRestClient(IVssRestClientOptions)

Metody

createAdvancedFilter(AdvancedFilterCreate)	Tworzy nowy, zaawansowany filtr dla organizacji.
deleteAdvancedFilter(string)	Usuwa zaawansowany filtr.
getAdvancedFilter(string)	Otrzymuje specyficzny zaawansowany filtr na podstawie swojego ID.
getAlertSummaryForOrg(FilterCriteria)	Pobieranie podsumowania alertu według ważności dla organizacji
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Uzyskiwanie połączonych alertów dla organizacji
getDependencyComponentNamesForOrg()	Pobierz wszystkie różne nazwy komponentów zależności dla organizacji (używane do filtrowania UX)
getEnablementSummaryForOrg(EnablementFilterCriteria)	Pobieranie podsumowania włączenia dla organizacji
getProjectsAndReposForOrg()	Pobierz wszystkie projekty i repozytoria dla organizacji (używane do filtrowania UX)
getRuleNamesForOrg(string)	Uzyskaj wszystkie różne nazwy reguł skanowania kodu dla organizacji (używane do filtrowania UX)
getSecretTypesForOrg()	Zdobądź wszystkie różne typy sekretów dla organizacji (używane do filtrowania UX)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Otrzymuje wszystkie zaawansowane filtry dla organizacji.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Aktualizuje zaawansowany filtr. Można aktualizować tylko nazwę.

Szczegóły konstruktora

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły metody

createAdvancedFilter(AdvancedFilterCreate)

Tworzy nowy, zaawansowany filtr dla organizacji.

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

Parametry

filter

AdvancedFilterCreate

Zaawansowany filtr do tworzenia.

Zwraca

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Usuwa zaawansowany filtr.

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

Parametry

filterId

string

ID zaawansowanego filtra do usunięcia.

Zwraca

Promise<void>

getAdvancedFilter(string)

Otrzymuje specyficzny zaawansowany filtr na podstawie swojego ID.

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

Parametry

filterId

string

ID zaawansowanego filtra do pobrania.

Zwraca

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Pobieranie podsumowania alertu według ważności dla organizacji

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

Parametry

criteria

FilterCriteria

Opcje ograniczające liczbę zwróconych streszczeń

Zwraca

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Uzyskiwanie połączonych alertów dla organizacji

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

Parametry

criteria

CombinedAlertFilterCriteria

Opcje filtrowania połączonych zwróconych alertów

top

number

Maksymalna liczba alertów do zwrócenia

continuationToken

string

Jeśli istnieje więcej alertów niż można zwrócić, token kontynuacji zostanie umieszczony w nagłówku "x-ms-continuationtoken". Użyj tego tokenu tutaj, aby uzyskać następną stronę alertów

Zwraca

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Pobierz wszystkie różne nazwy komponentów zależności dla organizacji (używane do filtrowania UX)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Zwraca

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Pobieranie podsumowania włączenia dla organizacji

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

Parametry

criteria

EnablementFilterCriteria

Opcje ograniczające liczbę zwróconych streszczeń

Zwraca

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Pobierz wszystkie projekty i repozytoria dla organizacji (używane do filtrowania UX)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Zwraca

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Uzyskaj wszystkie różne nazwy reguł skanowania kodu dla organizacji (używane do filtrowania UX)

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

Parametry

toolName

string

Opcjonalna nazwa narzędzia do filtrowania reguł według

Zwraca

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Zdobądź wszystkie różne typy sekretów dla organizacji (używane do filtrowania UX)

function getSecretTypesForOrg(): Promise<string[]>

Zwraca

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Zwraca

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Otrzymuje wszystkie zaawansowane filtry dla organizacji.

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

Parametry

includeDeleted

boolean

Czy uwzględnić filtry miękko usunięte.

keywords

string

Opcjonalny filtr do wyszukiwania filtrów według nazwy (nierozróżniające wielka litera, częściowe dopasowanie).

Zwraca

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Aktualizuje zaawansowany filtr. Można aktualizować tylko nazwę.

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

Parametry

filter

AdvancedFilterUpdate

Dane aktualizacji zawierające nową nazwę.

filterId

string

ID zaawansowanego filtra do aktualizacji.

Zwraca

Promise<void>