AlertRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends

RestClientBase

Konstruktoren

AlertRestClient(IVssRestClientOptions)

Methoden

createLegalReview(string, string, number, string)	Erstellen Sie eine rechtliche Überprüfung. Dadurch wird die rechtliche Überprüfung erstellt, die der Warnung zugeordnet ist. Sie enthält die URL der Arbeitsaufgabe überprüfen.
getAlert(string, number, string, string, ExpandOption)	Erhalten Sie eine Benachrichtigung.
getAlertInstances(string, number, string, string)	Rufen Sie Instanzen einer Warnung für eine Verzweigung ab, die mit @refangegeben ist. Wenn @ref nicht bereitgestellt wird, geben Sie Instanzen einer Warnung in Standardverzweigung zurück(wenn die Warnung in Standardverzweigung vorhanden ist) oder die neueste betroffene Verzweigung.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Abrufen von Warnungen für ein Repository
getAlertSarif(string, number, string, string, ExpandOption)	Erhalten Sie eine Benachrichtigung.
getBranches(string, string, AlertType, string, string, number, boolean)	Gibt die Verzweigungen zurück, für die Analyseergebnisse übermittelt wurden.
getOrgLevelAlertsByIds(number[])	Erhalten Sie Benachrichtigungen nach ihren IDs auf Organisationsebene. Nur Warnungen werden erneut ausgeführt, für die der Benutzer über die Berechtigung zum Anzeigen verfügt. Gibt nur Warnungen zu aktivierten SKU-Plänen zurück.
getSarif(number)	Abrufen des Status des Sarif-Verarbeitungsauftrags
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Rufen Sie die Gültigkeitsdetails für eine Warnung ab.
initiateValidation(string, string, number)	Initiieren des Überprüfungsprozesses für eine bestimmte Warnung
updateAlert(AlertStateUpdate, string, number, string)	Aktualisieren des Status einer Warnung
updateAlertsMetadata(AlertMetadata[], string, string)	Aktualisieren von Warnungsmetadatenzuordnungen.
uploadOrgSarif(string)	Hochladen einer Sarif-Datei auf Organisationsebene
uploadSarif(string, string, string, String)	Hochladen eines Sarifs mit Sicherheitswarnungen

Details zum Konstruktor

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Methode

createLegalReview(string, string, number, string)

Erstellen Sie eine rechtliche Überprüfung. Dadurch wird die rechtliche Überprüfung erstellt, die der Warnung zugeordnet ist. Sie enthält die URL der Arbeitsaufgabe überprüfen.

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

Parameter

project

string

Projekt-ID oder Projektname

repository

string

Name oder ID eines Repositorys für die rechtliche Warnung

alertId

number

Erweiterte Sicherheitswarnungs-ID der rechtlichen Warnung, um die rechtliche Überprüfung zu erhalten

ref

string

Gibt zurück

Promise<LegalReview>

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

Erhalten Sie eine Benachrichtigung.

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

Parameter

project

string

Projekt-ID oder Projektname

alertId

number

ID der abzurufenden Warnung

repository

string

Name oder ID eines Repositorys, in dem eine Warnung enthalten ist

ref

string

expand

ExpandOption

Erweitern Sie Attribute einer geheimen Warnung. Mögliche Werte sind None und ValidationFingerprint. Wird standardmäßig auf None festgelegt. Beachten Sie, dass die Antwort bei expand Festlegung auf ValidationFingerprintdas Geheimnis in unverschlüsselter Form enthalten kann. Seien Sie vorsichtig, wenn Sie diese Daten verwenden.

Gibt zurück

Promise<Alert>

getAlertInstances(string, number, string, string)

Rufen Sie Instanzen einer Warnung für eine Verzweigung ab, die mit @refangegeben ist. Wenn @ref nicht bereitgestellt wird, geben Sie Instanzen einer Warnung in Standardverzweigung zurück(wenn die Warnung in Standardverzweigung vorhanden ist) oder die neueste betroffene Verzweigung.

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

Parameter

project

string

Projekt-ID oder Projektname

alertId

number

ID der abzurufenden Warnung

repository

string

Name oder ID eines Repositorys, in dem eine Warnung enthalten ist

ref

string

Gibt zurück

Promise<AlertAnalysisInstance[]>

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

Abrufen von Warnungen für ein Repository

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

Parameter

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID des Repositorys

top

number

Die maximale Anzahl von Warnungen, die zurückgegeben werden sollen

orderBy

string

Muss "id" "firstSeen" "lastSeen" "fixedOn" oder "schweregrad" Standardwerte auf "id" sein

criteria

SearchCriteria

Optionen zum Einschränken der zurückgegebenen Warnungen

expand

AlertListExpandOption

continuationToken

string

Wenn mehr Warnungen vorhanden sind, als zurückgegeben werden können, wird ein Fortsetzungstoken im Header "x-ms-continuationtoken" platziert. Verwenden Sie dieses Token hier, um die nächste Seite mit Warnungen zu erhalten.

Gibt zurück

Promise<PagedList<Alert>>

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

Erhalten Sie eine Benachrichtigung.

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

Parameter

project

string

Projekt-ID oder Projektname

alertId

number

ID der abzurufenden Warnung

repository

string

Name oder ID eines Repositorys, in dem eine Warnung enthalten ist

ref

string

expand

ExpandOption

Erweitern Sie Attribute einer geheimen Warnung. Mögliche Werte sind None und ValidationFingerprint. Wird standardmäßig auf None festgelegt. Beachten Sie, dass die Antwort bei expand Festlegung auf ValidationFingerprintdas Geheimnis in unverschlüsselter Form enthalten kann. Seien Sie vorsichtig, wenn Sie diese Daten verwenden.

Gibt zurück

Promise<string>

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

Gibt die Verzweigungen zurück, für die Analyseergebnisse übermittelt wurden.

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

Parameter

project

string

Projekt-ID oder Projektname

repository

string

alertType

AlertType

Der Typ der Warnung: Abhängigkeitsscan (1), Geheimer Schlüssel (2), Code QL (3) usw.

continuationToken

string

Eine Zeichenfolgenvariable, die den Verzweigungsnamen darstellt und zum Abrufen von Verzweigungen verwendet wird, die ihr in alphabetischer Reihenfolge folgen.

branchNameContains

string

Eine Zeichenfolgenvariable, die zum Abrufen von Verzweigungen verwendet wird, die diese Zeichenfolge an einer beliebigen Stelle im Verzweigungsnamen enthalten, wobei die Groß-/Kleinschreibung nicht beachtet wird.

top

number

Eine Int-Variable, die verwendet wird, um die obersten k-Verzweigungen zurückzugeben, die die Suchkriterien erfüllen.

includePullRequestBranches

boolean

Eine Boolvariable, die angibt, ob Pullanforderungszweige eingeschlossen werden sollen.

Gibt zurück

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

Erhalten Sie Benachrichtigungen nach ihren IDs auf Organisationsebene. Nur Warnungen werden erneut ausgeführt, für die der Benutzer über die Berechtigung zum Anzeigen verfügt. Gibt nur Warnungen zu aktivierten SKU-Plänen zurück.

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

Parameter

alertIds

number[]

Liste der abzurufenden Warnungs-IDs

Gibt zurück

Promise<Alert[]>

getSarif(number)

Abrufen des Status des Sarif-Verarbeitungsauftrags

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

Parameter

sarifId

number

Sarif-ID, die zurückgegeben wurde, als die Sarif hochgeladen wurde

Gibt zurück

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parameter

project

string

Projekt-ID oder Projektname

repository

string

alertType

AlertType

Gibt zurück

Promise<UxFilters>

getValidityData(string, string, number)

Rufen Sie die Gültigkeitsdetails für eine Warnung ab.

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

Parameter

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID eines Repositorys

alertId

number

Die ID der Warnung

Gibt zurück

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Initiieren des Überprüfungsprozesses für eine bestimmte Warnung

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

Parameter

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID eines Repositorys

alertId

number

Die ID der Warnung

Gibt zurück

Promise<AlertValidationRequestStatus>

updateAlert(AlertStateUpdate, string, number, string)

Aktualisieren des Status einer Warnung

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

Parameter

stateUpdate

AlertStateUpdate

Der neue Status der Warnung

project

string

Projekt-ID oder Projektname

alertId

number

Die ID der Warnung

repository

string

Der Name oder die ID des Repositorys

Gibt zurück

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Aktualisieren von Warnungsmetadatenzuordnungen.

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

Parameter

alertsMetadata

AlertMetadata[]

Eine Liste der Metadaten, die Warnungen zugeordnet werden sollen.

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID des Repositorys.

Gibt zurück

Promise<AlertMetadataChange[]>

uploadOrgSarif(string)

Hochladen einer Sarif-Datei auf Organisationsebene

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

Parameter

content

string

Hochzuladende Inhalte

Gibt zurück

Promise<number>

uploadSarif(string, string, string, String)

Hochladen eines Sarifs mit Sicherheitswarnungen

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

Parameter

content

string

Hochzuladende Inhalte

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID eines Repositorys

notificationFlag

String

Kopfzeile, um zu signalisieren, dass es sich um eine Statusbenachrichtigung handelt

Gibt zurück

Promise<number>