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

createLegalReview(string, string, number, string)	Yasal inceleme oluşturun. Bu, uyarıyla ilişkili yasal incelemeyi oluşturur. Gözden geçirme iş öğesi URL'sini içerir.
getAlert(string, number, string, string, ExpandOption)	Uyarı alın.
getAlertInstances(string, number, string, string)	@refile belirtilen bir dalda uyarının örneklerini alın. @ref sağlanmazsa, bir uyarının örneklerini varsayılan dalda (uyarı varsayılan dalda varsa) veya en son etkilenen dalda döndürür.
getAlertMetadata(string, number, string)	Bir uyarı meta veri alın.
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)	Uyarılar meta verileri alın.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Depo için uyarı alma
getAlertSarif(string, number, string, string, ExpandOption)	Uyarı alın.
getBranches(string, string, AlertType, string, string, number, boolean)	Analiz sonuçlarının gönderildiği dalları döndürür.
getOrgLevelAlertsByIds(number[])	Kuruluş düzeyinde kimliklerine göre uyarılar alın. Yalnızca kullanıcının görüntüleme iznine sahip olduğu uyarıları yeniden çalıştırır. Yalnızca etkinleştirilmiş sku planlarının uyarılarını döndürür.
getSarif(number)	Sarif işleme işinin durumunu alma
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Bir uyarının geçerlilik ayrıntılarını alın.
initiateValidation(string, string, number)	Belirli bir uyarı için doğrulama işlemini başlatma
updateAlert(AlertStateUpdate, string, number, string)	Uyarının durumunu güncelleştirme
updateAlertsMetadata(AlertMetadata[], string, string)	Uyarı meta veri ilişkilendirmelerini güncelleştirin.
uploadOrgSarif(string)	Kuruluş düzeyinde bir Sarif dosyası yükleyin
uploadSarif(string, 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ı

createLegalReview(string, string, number, string)

Yasal inceleme oluşturun. Bu, uyarıyla ilişkili yasal incelemeyi oluşturur. Gözden geçirme iş öğesi URL'sini içerir.

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

Parametreler

project

string

Proje kimliği veya proje adı

repository

string

Yasal uyarı için bir deponun adı veya kimliği

alertId

number

Yasal incelemeyi almak için yasal uyarının Gelişmiş Güvenlik uyarısı kimliği

ref

string

Döndürülenler

Promise<LegalReview>

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

Gizli dizi uyarısının özniteliklerini genişletme. Olası değerler None ve ValidationFingerprint şeklindedir. Varsayılan olarak None değerini alır. olarak ayarlanırsa expandValidationFingerprintyanıtın gizli diziyi şifrelenmemiş biçiminde içerebileceğini unutmayın. Bu verileri kullanırken lütfen dikkatli olun.

Döndürülenler

Promise<Alert>

getAlertInstances(string, number, string, string)

@refile belirtilen bir dalda uyarının örneklerini alın. @ref sağlanmazsa, bir uyarının örneklerini varsayılan dalda (uyarı varsayılan dalda varsa) veya en son etkilenen dalda döndürür.

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[]>

getAlertMetadata(string, number, string)

Bir uyarı meta veri alın.

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

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

Döndürülenler

Promise<AlertMetadata>

getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)

Uyarılar meta verileri alın.

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

Parametreler

alertMetadataBatchRequest

AlertMetadataBatchRequest

project

string

Proje kimliği veya proje adı

repository

string

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

Döndürülenler

Promise<AlertMetadata[]>

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

Depo için uyarı alma

function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, expand?: AlertListExpandOption, 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ılan değeri "id" olmalıdır

criteria

SearchCriteria

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

expand

AlertListExpandOption

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

Gizli dizi uyarısının özniteliklerini genişletme. Olası değerler None ve ValidationFingerprint şeklindedir. Varsayılan olarak None değerini alır. olarak ayarlanırsa expandValidationFingerprintyanıtın gizli diziyi şifrelenmemiş biçiminde içerebileceğini unutmayın. Bu verileri kullanırken lütfen dikkatli olun.

Döndürülenler

Promise<string>

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

Analiz sonuçlarının gönderildiği dalları döndürür.

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

Parametreler

project

string

Proje kimliği veya proje adı

repository

string

alertType

AlertType

Uyarı türü: Bağımlılık Tarama (1), Gizli Dizi (2), Kod QL (3) vb.

continuationToken

string

Dal adını temsil eden ve onu izleyen dalları alfabetik sırada getirmek için kullanılan bir dize değişkeni.

branchNameContains

string

Bu dizeyi içeren dalları dal adının herhangi bir yerine getirmek için kullanılan dize değişkeni büyük/küçük harfe duyarsız.

top

number

Arama ölçütlerini karşılayan en üst k dalları döndürmek için kullanılan bir int değişkeni.

includePullRequestBranches

boolean

Çekme isteği dallarının dahil edilip edilmeyeceğini gösteren bool değişkeni.

Döndürülenler

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

Kuruluş düzeyinde kimliklerine göre uyarılar alın. Yalnızca kullanıcının görüntüleme iznine sahip olduğu uyarıları yeniden çalıştırır. Yalnızca etkinleştirilmiş sku planlarının uyarılarını döndürür.

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

Parametreler

alertIds

number[]

Alınacak uyarı kimliklerinin listesi

Döndürülenler

Promise<Alert[]>

getSarif(number)

Sarif işleme işinin durumunu alma

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

Parametreler

sarifId

number

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

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>

getValidityData(string, string, number)

Bir uyarının geçerlilik ayrıntılarını alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

repository

string

Bir deponun adı veya kimliği

alertId

number

Uyarının kimliği

Döndürülenler

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Belirli bir uyarı için doğrulama işlemini başlatma

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

Parametreler

project

string

Proje kimliği veya proje adı

repository

string

Bir deponun adı veya kimliği

alertId

number

Uyarının kimliği

Döndürülenler

Promise<AlertValidationRequestStatus>

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[]>

uploadOrgSarif(string)

Kuruluş düzeyinde bir Sarif dosyası yükleyin

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

Parametreler

content

string

Karşıya yüklenecek içerik

Döndürülenler

Promise<number>

uploadSarif(string, string, string, String)

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

function uploadSarif(content: string, project: string, repository: string, notificationFlag?: 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

notificationFlag

String

Bunun bir ilerleme bildirimi olduğunu belirten üst bilgi

Döndürülenler

Promise<number>