ReportingRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

ReportingRestClient(IVssRestClientOptions)

Yöntemler

createAdvancedFilter(AdvancedFilterCreate)	Organizasyon için yeni gelişmiş bir filtre oluşturur.
deleteAdvancedFilter(string)	Gelişmiş bir filtreyi siler.
getAdvancedFilter(string)	ID'sine göre belirli bir gelişmiş filtre alır.
getAlertSummaryForOrg(FilterCriteria)	Kuruluş için önem derecesine göre Uyarı özeti alma
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Kuruluş için Birleşik Uyarılar alma
getDependencyComponentNamesForOrg()	Organizasyon için tüm farklı bağımlılık bileşen isimlerini alın (UX filtreleme için kullanılır)
getEnablementSummaryForOrg(EnablementFilterCriteria)	Kuruluş için Etkinleştirme özeti alma
getProjectsAndReposForOrg()	Organizasyon için tüm projeleri ve depoları (UX filtreleme için kullanılan) alın
getRuleNamesForOrg(string)	Kuruluş için (UX filtreleme için kullanılan) tüm farklı kod tarama kuralı isimlerini alın
getSecretTypesForOrg()	Organizasyon için tüm farklı gizli tipleri alın (UX filtreleme için kullanılır)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Organizasyon için tüm gelişmiş filtreleri alıyor.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Gelişmiş bir filtreyi güncelliyor. Sadece isim güncellenebilir.

Oluşturucu Ayrıntıları

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Yöntem Ayrıntıları

createAdvancedFilter(AdvancedFilterCreate)

Organizasyon için yeni gelişmiş bir filtre oluşturur.

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

Parametreler

filter

AdvancedFilterCreate

Oluşturulacak gelişmiş filtre.

Döndürülenler

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Gelişmiş bir filtreyi siler.

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

Parametreler

filterId

string

Silinecek gelişmiş filtrenin kimliği.

Döndürülenler

Promise<void>

getAdvancedFilter(string)

ID'sine göre belirli bir gelişmiş filtre alır.

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

Parametreler

filterId

string

Geri alınacak gelişmiş filtrenin kimliği.

Döndürülenler

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Kuruluş için önem derecesine göre Uyarı özeti alma

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

Parametreler

criteria

FilterCriteria

Geri dönen özetleri sınırlama seçenekleri

Döndürülenler

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Kuruluş için Birleşik Uyarılar alma

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

Parametreler

criteria

CombinedAlertFilterCriteria

Geri dönen birleşik uyarıları filtreleme seçenekleri

top

number

Döndürülecek en fazla uyarı sayısı

continuationToken

string

Döndürülebilenden daha fazla uyarı varsa, "x-ms-continuationtoken" üst bilgisine bir devamlılık belirteci yerleştirilir. Sonraki uyarı sayfasını almak için bu belirteci burada kullanın

Döndürülenler

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Organizasyon için tüm farklı bağımlılık bileşen isimlerini alın (UX filtreleme için kullanılır)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Döndürülenler

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Kuruluş için Etkinleştirme özeti alma

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

Parametreler

criteria

EnablementFilterCriteria

Geri dönen özetleri sınırlama seçenekleri

Döndürülenler

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Organizasyon için tüm projeleri ve depoları (UX filtreleme için kullanılan) alın

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Döndürülenler

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Kuruluş için (UX filtreleme için kullanılan) tüm farklı kod tarama kuralı isimlerini alın

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

Parametreler

toolName

string

Kuralları filtrelemek için isteğe bağlı araç adı

Döndürülenler

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Organizasyon için tüm farklı gizli tipleri alın (UX filtreleme için kullanılır)

function getSecretTypesForOrg(): Promise<string[]>

Döndürülenler

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Döndürülenler

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Organizasyon için tüm gelişmiş filtreleri alıyor.

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

Parametreler

includeDeleted

boolean

Yumuşak silinmiş filtreleri ekleyip eklemememe.

keywords

string

İsme göre filtre arama için isteğe bağlı filtre (harfi duyarsız, kısmi eşleşme).

Döndürülenler

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Gelişmiş bir filtreyi güncelliyor. Sadece isim güncellenebilir.

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

Parametreler

filter

AdvancedFilterUpdate

Yeni ismi içeren güncelleme verileri.

filterId

string

Güncellenecek gelişmiş filtrenin kimliği.

Döndürülenler

Promise<void>