AlertRestClient 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

AlertRestClient(IVssRestClientOptions)

Yöntemler

getAlert(string, number, string, string, ExpandOption)	Uyarı alın.
getAlertInstances(string, number, string, string)	Uyarı örneklerini alma.
getAlerts(string, string, number, string, SearchCriteria, string)	Depo için uyarı alma
getAlertSarif(string, number, string, string, ExpandOption)	Uyarı alın.
getSarif(number)	Sarif işleme işinin durumunu alma
getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)	Uyarının durumunu güncelleştirme
updateAlertsMetadata(AlertMetadata[], string, string)	Uyarı meta veri ilişkilendirmelerini güncelleştirin.
uploadSarif(string, string, string)	Güvenlik uyarıları içeren bir Sarif'i karşıya yükleme

Oluşturucu Ayrıntıları

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Yöntem Ayrıntıları

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

Uyarı alın.

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

Parametreler

project

string

Proje Kimliği veya proje adı

alertId

number

Alınacak uyarının kimliği

repository

string

Uyarının parçası olduğu bir deponun adı veya kimliği

ref

string

expand

ExpandOption

Uyarı özniteliklerini genişletin. Olası seçenekler şunlardır: {ValidationFingerprint, None}

Döndürülenler

Promise<Alert>

getAlertInstances(string, number, string, string)

Uyarı örneklerini alma.

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

Parametreler

project

string

Proje Kimliği veya proje adı

alertId

number

Alınacak uyarının kimliği

repository

string

Uyarının parçası olduğu bir deponun adı veya kimliği

ref

string

Döndürülenler

Promise<AlertAnalysisInstance[]>

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

Depo için uyarı alma

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

Parametreler

project

string

Proje Kimliği veya proje adı

repository

string

Deponun adı veya kimliği

top

number

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

orderBy

string

"id" "firstSeen" "lastSeen" "fixedOn" veya "önem derecesi" Varsayılanları "id" olmalıdır

criteria

SearchCriteria

Döndürülen uyarıları sınırlama seçenekleri

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

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

Uyarı alın.

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

Parametreler

project

string

Proje Kimliği veya proje adı

alertId

number

Alınacak uyarının kimliği

repository

string

Uyarının parçası olduğu bir deponun adı veya kimliği

ref

string

expand

ExpandOption

Uyarı özniteliklerini genişletin. Olası seçenekler şunlardır: {ValidationFingerprint, None}

Döndürülenler

Promise<string>

getSarif(number)

Sarif işleme işinin durumunu alma

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

Parametreler

sarifId

number

Sarif karşıya yüklendiğinde döndürülen Sarif kimliği

Döndürülenler

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parametreler

project

string

Proje Kimliği veya proje adı

repository

string

alertType

AlertType

Döndürülenler

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

Uyarının durumunu güncelleştirme

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

Parametreler

stateUpdate

AlertStateUpdate

Uyarının yeni durumu

project

string

Proje Kimliği veya proje adı

alertId

number

Uyarının kimliği

repository

string

Deponun adı veya kimliği

Döndürülenler

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Uyarı meta veri ilişkilendirmelerini güncelleştirin.

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

Parametreler

alertsMetadata

AlertMetadata[]

Uyarılarla ilişkilendirilecek meta verilerin listesi.

project

string

Proje Kimliği veya proje adı

repository

string

Deponun adı veya kimliği.

Döndürülenler

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Güvenlik uyarıları içeren bir Sarif'i karşıya yükleme

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

Parametreler

content

string

Karşıya yüklenecek içerik

project

string

Proje Kimliği veya proje adı

repository

string

Bir deponun adı veya kimliği

Döndürülenler

Promise<number>