AlertRestClient class

Paket:

azure-devops-extension-api

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

Memperluas

RestClientBase

Konstruktor

AlertRestClient(IVssRestClientOptions)

Metode

createLegalReview(string, string, number, string)	Buat tinjauan hukum. Ini membuat tinjauan hukum yang terkait dengan pemberitahuan. Ini termasuk url item kerja tinjauan.
getAlert(string, number, string, string, ExpandOption)	Dapatkan pemberitahuan.
getAlertInstances(string, number, string, string)	Dapatkan instans pemberitahuan pada cabang yang ditentukan dengan @ref. Jika @ref tidak disediakan, kembalikan instans pemberitahuan pada cabang default (jika pemberitahuan ada di cabang default) atau cabang terbaru yang terpengaruh.
getAlertMetadata(string, number, string)	Dapatkan metadata pemberitahuan.
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)	Dapatkan metadata pemberitahuan.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Mendapatkan pemberitahuan untuk repositori
getAlertSarif(string, number, string, string, ExpandOption)	Dapatkan pemberitahuan.
getBranches(string, string, AlertType, string, string, number, boolean)	Mengembalikan cabang yang hasil analisisnya dikirimkan.
getOrgLevelAlertsByIds(number[])	Dapatkan pemberitahuan berdasarkan ID mereka di tingkat organisasi. Hanya mengulangi pemberitahuan yang pengguna memiliki izin untuk melihatnya. Hanya mengembalikan pemberitahuan paket SKU yang diaktifkan.
getSarif(number)	Mendapatkan status pekerjaan pemrosesan Sarif
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Dapatkan detail validitas untuk pemberitahuan.
initiateValidation(string, string, number)	Memulai proses validasi untuk pemberitahuan tertentu
updateAlert(AlertStateUpdate, string, number, string)	Memperbarui status pemberitahuan
updateAlertsMetadata(AlertMetadata[], string, string)	Memperbarui asosiasi metadata pemberitahuan.
uploadOrgSarif(string)	Mengunggah file Sarif di tingkat organisasi
uploadSarif(string, string, string, String)	Mengunggah Sarif yang berisi pemberitahuan keamanan

Detail Konstruktor

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Metode

createLegalReview(string, string, number, string)

Buat tinjauan hukum. Ini membuat tinjauan hukum yang terkait dengan pemberitahuan. Ini termasuk url item kerja tinjauan.

function createLegalReview(project: string, repository: string, alertId: number, ref?: string): Promise<LegalReview>

Parameter

project

string

ID proyek atau nama proyek

repository

string

Nama atau id repositori untuk pemberitahuan hukum

alertId

number

ID peringatan Keamanan Lanjutan dari pemberitahuan hukum untuk mendapatkan peninjauan hukum

ref

string

Mengembalikan

Promise<LegalReview>

getAlert(string, number, string, string, ExpandOption)

Dapatkan pemberitahuan.

function getAlert(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<Alert>

Parameter

project

string

ID proyek atau nama proyek

alertId

number

ID pemberitahuan yang akan diambil

repository

string

Nama atau id repositori yang pemberitahuannya merupakan bagian dari

ref

string

expand

ExpandOption

Perluas atribut pemberitahuan rahasia. Nilai yang mungkin adalah None dan ValidationFingerprint. Secara default menjadi None. Ketahuilah bahwa jika expand diatur ke ValidationFingerprint, respons mungkin berisi rahasia dalam bentuknya yang tidak terenkripsi. Berhati-hatilah saat menggunakan data ini.

Mengembalikan

Promise<Alert>

getAlertInstances(string, number, string, string)

Dapatkan instans pemberitahuan pada cabang yang ditentukan dengan @ref. Jika @ref tidak disediakan, kembalikan instans pemberitahuan pada cabang default (jika pemberitahuan ada di cabang default) atau cabang terbaru yang terpengaruh.

function getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<AlertAnalysisInstance[]>

Parameter

project

string

ID proyek atau nama proyek

alertId

number

ID pemberitahuan yang akan diambil

repository

string

Nama atau id repositori yang pemberitahuannya merupakan bagian dari

ref

string

Mengembalikan

Promise<AlertAnalysisInstance[]>

getAlertMetadata(string, number, string)

Dapatkan metadata pemberitahuan.

function getAlertMetadata(project: string, alertId: number, repository: string): Promise<AlertMetadata>

Parameter

project

string

ID proyek atau nama proyek

alertId

number

ID pemberitahuan yang akan diambil

repository

string

Nama atau id repositori yang pemberitahuannya merupakan bagian dari

Mengembalikan

Promise<AlertMetadata>

getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)

Dapatkan metadata pemberitahuan.

function getAlertMetadataBatch(alertMetadataBatchRequest: AlertMetadataBatchRequest, project: string, repository: string): Promise<AlertMetadata[]>

Parameter

alertMetadataBatchRequest

AlertMetadataBatchRequest

project

string

ID proyek atau nama proyek

repository

string

Nama atau id repositori yang pemberitahuannya merupakan bagian dari

Mengembalikan

Promise<AlertMetadata[]>

getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)

Mendapatkan pemberitahuan untuk repositori

function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, expand?: AlertListExpandOption, continuationToken?: string): Promise<PagedList<Alert>>

Parameter

project

string

ID proyek atau nama proyek

repository

string

Nama atau ID repositori

top

number

Jumlah maksimum pemberitahuan yang akan dikembalikan

orderBy

string

Harus "id" "firstSeen" "lastSeen" "fixedOn" atau "severity" Default ke "id"

criteria

SearchCriteria

Opsi untuk membatasi pemberitahuan yang dikembalikan

expand

AlertListExpandOption

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<Alert>>

getAlertSarif(string, number, string, string, ExpandOption)

Dapatkan pemberitahuan.

function getAlertSarif(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<string>

Parameter

project

string

ID proyek atau nama proyek

alertId

number

ID pemberitahuan yang akan diambil

repository

string

Nama atau id repositori yang pemberitahuannya merupakan bagian dari

ref

string

expand

ExpandOption

Perluas atribut pemberitahuan rahasia. Nilai yang mungkin adalah None dan ValidationFingerprint. Secara default menjadi None. Ketahuilah bahwa jika expand diatur ke ValidationFingerprint, respons mungkin berisi rahasia dalam bentuknya yang tidak terenkripsi. Berhati-hatilah saat menggunakan data ini.

Mengembalikan

Promise<string>

getBranches(string, string, AlertType, string, string, number, boolean)

Mengembalikan cabang yang hasil analisisnya dikirimkan.

function getBranches(project: string, repository: string, alertType: AlertType, continuationToken?: string, branchNameContains?: string, top?: number, includePullRequestBranches?: boolean): Promise<Branch[]>

Parameter

project

string

ID proyek atau nama proyek

repository

string

alertType

AlertType

Jenis pemberitahuan: Pemindaian Dependensi (1), Rahasia (2), Kode QL (3), dll.

continuationToken

string

Variabel string yang mewakili nama cabang dan digunakan untuk mengambil cabang yang mengikutinya dalam urutan alfabet.

branchNameContains

string

Variabel string yang digunakan untuk mengambil cabang yang berisi string ini di mana saja dalam nama cabang, tidak peka huruf besar/kecil.

top

number

Variabel int yang digunakan untuk mengembalikan cabang k teratas yang memenuhi kriteria pencarian.

includePullRequestBranches

boolean

Variabel bool yang menunjukkan apakah akan menyertakan cabang permintaan pull atau tidak.

Mengembalikan

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

Dapatkan pemberitahuan berdasarkan ID mereka di tingkat organisasi. Hanya mengulangi pemberitahuan yang pengguna memiliki izin untuk melihatnya. Hanya mengembalikan pemberitahuan paket SKU yang diaktifkan.

function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>

Parameter

alertIds

number[]

Daftar ID pemberitahuan yang akan diambil

Mengembalikan

Promise<Alert[]>

getSarif(number)

Mendapatkan status pekerjaan pemrosesan Sarif

function getSarif(sarifId: number): Promise<SarifUploadStatus>

Parameter

sarifId

number

ID Sarif dikembalikan saat Sarif diunggah

Mengembalikan

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

function getUxFilters(project: string, repository: string, alertType: AlertType): Promise<UxFilters>

Parameter

project

string

ID proyek atau nama proyek

repository

string

alertType

AlertType

Mengembalikan

Promise<UxFilters>

getValidityData(string, string, number)

Dapatkan detail validitas untuk pemberitahuan.

function getValidityData(project: string, repository: string, alertId: number): Promise<ValidationRequestInfo>

Parameter

project

string

ID proyek atau nama proyek

repository

string

Nama atau ID repositori

alertId

number

ID pemberitahuan

Mengembalikan

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Memulai proses validasi untuk pemberitahuan tertentu

function initiateValidation(project: string, repository: string, alertId: number): Promise<AlertValidationRequestStatus>

Parameter

project

string

ID proyek atau nama proyek

repository

string

Nama atau ID repositori

alertId

number

ID pemberitahuan

Mengembalikan

Promise<AlertValidationRequestStatus>

updateAlert(AlertStateUpdate, string, number, string)

Memperbarui status pemberitahuan

function updateAlert(stateUpdate: AlertStateUpdate, project: string, alertId: number, repository: string): Promise<Alert>

Parameter

stateUpdate

AlertStateUpdate

Status baru pemberitahuan

project

string

ID proyek atau nama proyek

alertId

number

ID pemberitahuan

repository

string

Nama atau ID repositori

Mengembalikan

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Memperbarui asosiasi metadata pemberitahuan.

function updateAlertsMetadata(alertsMetadata: AlertMetadata[], project: string, repository: string): Promise<AlertMetadataChange[]>

Parameter

alertsMetadata

AlertMetadata[]

Daftar metadata yang akan dikaitkan dengan pemberitahuan.

project

string

ID proyek atau nama proyek

repository

string

Nama atau ID repositori.

Mengembalikan

Promise<AlertMetadataChange[]>

uploadOrgSarif(string)

Mengunggah file Sarif di tingkat organisasi

function uploadOrgSarif(content: string): Promise<number>

Parameter

content

string

Konten yang akan diunggah

Mengembalikan

Promise<number>

uploadSarif(string, string, string, String)

Mengunggah Sarif yang berisi pemberitahuan keamanan

function uploadSarif(content: string, project: string, repository: string, notificationFlag?: String): Promise<number>

Parameter

content

string

Konten yang akan diunggah

project

string

ID proyek atau nama proyek

repository

string

Nama atau ID repositori

notificationFlag

String

Header untuk memberi sinyal bahwa ini adalah pemberitahuan kemajuan

Mengembalikan

Promise<number>