ReportingRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

ReportingRestClient(IVssRestClientOptions)

Metode

createAdvancedFilter(AdvancedFilterCreate)	Membuat filter lanjutan baru untuk organisasi.
deleteAdvancedFilter(string)	Menghapus filter lanjutan.
getAdvancedFilter(string)	Mendapatkan filter lanjutan tertentu berdasarkan ID-nya.
getAlertSummaryForOrg(FilterCriteria)	Mendapatkan ringkasan Pemberitahuan berdasarkan tingkat keparahan untuk org
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Mendapatkan Pemberitahuan Gabungan untuk org
getDependencyComponentNamesForOrg()	Dapatkan semua nama komponen dependensi yang berbeda untuk organisasi (digunakan untuk pemfilteran UX)
getEnablementSummaryForOrg(EnablementFilterCriteria)	Mendapatkan ringkasan Pengaktifan untuk org
getProjectsAndReposForOrg()	Dapatkan semua proyek dan repositori untuk organisasi (digunakan untuk pemfilteran UX)
getRuleNamesForOrg(string)	Dapatkan semua nama aturan pemindaian kode yang berbeda untuk organisasi (digunakan untuk pemfilteran UX)
getSecretTypesForOrg()	Dapatkan semua jenis rahasia yang berbeda untuk organisasi (digunakan untuk pemfilteran UX)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Mendapatkan semua filter lanjutan untuk organisasi.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Memperbarui filter lanjutan. Hanya nama yang dapat diperbarui.

Detail Konstruktor

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Metode

createAdvancedFilter(AdvancedFilterCreate)

Membuat filter lanjutan baru untuk organisasi.

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

Parameter

filter

AdvancedFilterCreate

Filter lanjutan untuk membuat.

Mengembalikan

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Menghapus filter lanjutan.

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

Parameter

filterId

string

ID filter lanjutan yang akan dihapus.

Mengembalikan

Promise<void>

getAdvancedFilter(string)

Mendapatkan filter lanjutan tertentu berdasarkan ID-nya.

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

Parameter

filterId

string

ID filter lanjutan yang akan diambil.

Mengembalikan

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

Mendapatkan ringkasan Pemberitahuan berdasarkan tingkat keparahan untuk org

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

Parameter

criteria

FilterCriteria

Opsi untuk membatasi ringkasan yang ditampilkan

Mengembalikan

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Mendapatkan Pemberitahuan Gabungan untuk org

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

Parameter

criteria

CombinedAlertFilterCriteria

Opsi untuk memfilter pemberitahuan gabungan yang ditampilkan

top

number

Jumlah maksimum pemberitahuan yang akan dikembalikan

continuationToken

string

Jika ada lebih banyak pemberitahuan daripada yang dapat dikembalikan, token kelanjutan ditempatkan di header "x-ms-continuationtoken". Gunakan token tersebut di sini untuk mendapatkan halaman pemberitahuan berikutnya

Mengembalikan

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Dapatkan semua nama komponen dependensi yang berbeda untuk organisasi (digunakan untuk pemfilteran UX)

function getDependencyComponentNamesForOrg(): Promise<string[]>

Mengembalikan

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Mendapatkan ringkasan Pengaktifan untuk org

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

Parameter

criteria

EnablementFilterCriteria

Opsi untuk membatasi ringkasan yang ditampilkan

Mengembalikan

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Dapatkan semua proyek dan repositori untuk organisasi (digunakan untuk pemfilteran UX)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

Mengembalikan

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Dapatkan semua nama aturan pemindaian kode yang berbeda untuk organisasi (digunakan untuk pemfilteran UX)

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

Parameter

toolName

string

Nama alat opsional untuk memfilter aturan berdasarkan

Mengembalikan

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Dapatkan semua jenis rahasia yang berbeda untuk organisasi (digunakan untuk pemfilteran UX)

function getSecretTypesForOrg(): Promise<string[]>

Mengembalikan

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

Mengembalikan

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

Mendapatkan semua filter lanjutan untuk organisasi.

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

Parameter

includeDeleted

boolean

Apakah akan menyertakan filter yang dihapus sementara.

keywords

string

Filter opsional untuk mencari filter berdasarkan nama (tidak peka huruf besar/kecil, pencocokan parsial).

Mengembalikan

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Memperbarui filter lanjutan. Hanya nama yang dapat diperbarui.

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

Parameter

filter

AdvancedFilterUpdate

Data pembaruan yang berisi nama baru.

filterId

string

ID filter lanjutan yang akan diperbarui.

Mengembalikan

Promise<void>