AlertRestClient class

Pakiet:

azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie

RestClientBase

Konstruktory

AlertRestClient(IVssRestClientOptions)

Metody

createLegalReview(string, string, number, string)	Utwórz przegląd prawny. Spowoduje to utworzenie przeglądu prawnego skojarzonego z alertem. Zawiera on adres URL elementu roboczego przeglądu.
getAlert(string, number, string, string, ExpandOption)	Uzyskiwanie alertu.
getAlertInstances(string, number, string, string)	Pobierz wystąpienia alertu w gałęzi określonej za pomocą @ref. Jeśli nie podano @ref, zwracaj wystąpienia alertu w gałęzi domyślnej (jeśli alert istnieje w gałęzi domyślnej) lub najnowszej gałęzi, której dotyczy problem.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Pobieranie alertów dla repozytorium
getAlertSarif(string, number, string, string, ExpandOption)	Uzyskiwanie alertu.
getBranches(string, string, AlertType, string, string, number, boolean)	Zwraca gałęzie, dla których przesłano wyniki analizy.
getOrgLevelAlertsByIds(number[])	Otrzymuj alerty według ich identyfikatorów na poziomie organizacji. Uruchamia tylko alerty, do których wyświetlania użytkownik ma uprawnienia. Zwraca tylko alerty dotyczące planów jednostek SKU, które są włączone.
getSarif(number)	Pobieranie stanu zadania przetwarzania Sarif
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Uzyskaj szczegółowe informacje o ważności alertu.
initiateValidation(string, string, number)	Inicjowanie procesu weryfikacji dla danego alertu
updateAlert(AlertStateUpdate, string, number, string)	Aktualizowanie stanu alertu
updateAlertsMetadata(AlertMetadata[], string, string)	Aktualizowanie skojarzeń metadanych alertu.
uploadOrgSarif(string)	Przekazywanie pliku Sarif na poziomie organizacji
uploadSarif(string, string, string, String)	Przekazywanie sarif zawierającego alerty zabezpieczeń

Szczegóły konstruktora

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły metody

createLegalReview(string, string, number, string)

Utwórz przegląd prawny. Spowoduje to utworzenie przeglądu prawnego skojarzonego z alertem. Zawiera on adres URL elementu roboczego przeglądu.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium wpisu prawnego

alertId

number

Identyfikator alertu zabezpieczeń z wyprzedzeniem alertu prawnego w celu uzyskania przeglądu prawnego

ref

string

Zwraca

Promise<LegalReview>

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

Uzyskiwanie alertu.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

alertId

number

Identyfikator alertu do pobrania

repository

string

Nazwa lub identyfikator repozytorium, którego częścią jest alert

ref

string

expand

ExpandOption

Rozwiń atrybuty alertu tajnego. Możliwe wartości to None i ValidationFingerprint. Wartość domyślna to None. Należy pamiętać, że jeśli expand ustawiono ValidationFingerprintwartość , odpowiedź może zawierać wpis tajny w postaci niezaszyfrowanej. Podczas korzystania z tych danych należy zachować ostrożność.

Zwraca

Promise<Alert>

getAlertInstances(string, number, string, string)

Pobierz wystąpienia alertu w gałęzi określonej za pomocą @ref. Jeśli nie podano @ref, zwracaj wystąpienia alertu w gałęzi domyślnej (jeśli alert istnieje w gałęzi domyślnej) lub najnowszej gałęzi, której dotyczy problem.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

alertId

number

Identyfikator alertu do pobrania

repository

string

Nazwa lub identyfikator repozytorium, którego częścią jest alert

ref

string

Zwraca

Promise<AlertAnalysisInstance[]>

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

Pobieranie alertów dla repozytorium

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

top

number

Maksymalna liczba alertów do zwrócenia

orderBy

string

Musi mieć wartość "id" "firstSeen" "lastSeen" "fixedOn" lub "ważność" Wartości domyślne do "id"

criteria

SearchCriteria

Opcje ograniczania zwracanych alertów

expand

AlertListExpandOption

continuationToken

string

Jeśli istnieje więcej alertów niż można zwrócić, token kontynuacji zostanie umieszczony w nagłówku "x-ms-continuationtoken". Użyj tego tokenu tutaj, aby uzyskać następną stronę alertów

Zwraca

Promise<PagedList<Alert>>

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

Uzyskiwanie alertu.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

alertId

number

Identyfikator alertu do pobrania

repository

string

Nazwa lub identyfikator repozytorium, którego częścią jest alert

ref

string

expand

ExpandOption

Rozwiń atrybuty alertu tajnego. Możliwe wartości to None i ValidationFingerprint. Wartość domyślna to None. Należy pamiętać, że jeśli expand ustawiono ValidationFingerprintwartość , odpowiedź może zawierać wpis tajny w postaci niezaszyfrowanej. Podczas korzystania z tych danych należy zachować ostrożność.

Zwraca

Promise<string>

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

Zwraca gałęzie, dla których przesłano wyniki analizy.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

alertType

AlertType

Typ alertu: Skanowanie zależności (1), Wpis tajny (2), Kod QL (3) itp.

continuationToken

string

Zmienna ciągu reprezentująca nazwę gałęzi i służy do pobierania gałęzi, które są zgodne z nią w kolejności alfabetycznej.

branchNameContains

string

Zmienna ciągu używana do pobierania gałęzi, które zawierają ten ciąg w dowolnym miejscu w nazwie gałęzi, bez uwzględniania wielkości liter.

top

number

Zmienna int używana do zwracania najważniejszych gałęzi k spełniających kryteria wyszukiwania.

includePullRequestBranches

boolean

Zmienna logiczna wskazująca, czy należy uwzględnić gałęzie żądań ściągnięcia.

Zwraca

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

Otrzymuj alerty według ich identyfikatorów na poziomie organizacji. Uruchamia tylko alerty, do których wyświetlania użytkownik ma uprawnienia. Zwraca tylko alerty dotyczące planów jednostek SKU, które są włączone.

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

Parametry

alertIds

number[]

Lista identyfikatorów alertów do pobrania

Zwraca

Promise<Alert[]>

getSarif(number)

Pobieranie stanu zadania przetwarzania Sarif

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

Parametry

sarifId

number

Identyfikator Sarif został zwrócony po przekazaniu sarifu

Zwraca

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

alertType

AlertType

Zwraca

Promise<UxFilters>

getValidityData(string, string, number)

Uzyskaj szczegółowe informacje o ważności alertu.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

alertId

number

Identyfikator alertu

Zwraca

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Inicjowanie procesu weryfikacji dla danego alertu

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

alertId

number

Identyfikator alertu

Zwraca

Promise<AlertValidationRequestStatus>

updateAlert(AlertStateUpdate, string, number, string)

Aktualizowanie stanu alertu

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

Parametry

stateUpdate

AlertStateUpdate

Nowy stan alertu

project

string

Identyfikator projektu lub nazwa projektu

alertId

number

Identyfikator alertu

repository

string

Nazwa lub identyfikator repozytorium

Zwraca

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Aktualizowanie skojarzeń metadanych alertu.

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

Parametry

alertsMetadata

AlertMetadata[]

Lista metadanych do skojarzenia z alertami.

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium.

Zwraca

Promise<AlertMetadataChange[]>

uploadOrgSarif(string)

Przekazywanie pliku Sarif na poziomie organizacji

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

Parametry

content

string

Zawartość do przekazania

Zwraca

Promise<number>

uploadSarif(string, string, string, String)

Przekazywanie sarif zawierającego alerty zabezpieczeń

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

Parametry

content

string

Zawartość do przekazania

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

notificationFlag

String

Nagłówek sygnalizujący, że jest to powiadomienie o postępie

Zwraca

Promise<number>