AlertRestClient class
VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf
- Extends
Oluşturucular
Yöntemler
| get |
Uyarı alın. |
| get |
@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. |
| get |
Depo için uyarı alma |
| get |
Uyarı alın. |
| get |
Analiz sonuçlarının gönderildiği dalları döndürür. |
| get |
Sarif işleme işinin durumunu alma |
| get |
|
| update |
Uyarının durumunu güncelleştirme |
| update |
Uyarı meta veri ilişkilendirmelerini güncelleştirin. |
| upload |
Güvenlik uyarıları içeren bir Sarif'i karşıya yükleme |
AlertRestClient(IVssRestClientOptions)
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)
@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[]>
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
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>
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[]>
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)
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
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, 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>