AlertRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

AlertRestClient(IVssRestClientOptions)

Metody

autofixCallback(AutofixCallbackRequest, string, string, number)	Přijímá zpětnou volbu z autofixové pipeline s výsledkem běhu. Idempotent: opakované volání pro požadavek již v terminálním stavu se vracejí 200 bez změn.
createAutofixRequest(string, number, string)	Vytvořte požadavek na automatickou opravu pro specifikované upozornění.
createLegalReview(string, string, number, string)	Vytvořte právní kontrolu. Tím se vytvoří právní kontrola spojená s výstrahou. Zahrnuje adresu URL pracovní položky kontroly.
deleteAllPipelineAnalyses(string, string)	Obnovitelné odstranění dat analýzy pro všechny kanály v úložišti, čištění přidružených výstrah Advanced Security.
deletePipelineAnalysis(string, string, number)	Obnovitelné odstranění dat analýzy pro konkrétní kanál, vyčištění přidružených výstrah Advanced Security.
exportSarif(string, string, number[], string)	Exportovat upozornění jako jeden SARIF soubor
getAlert(string, number, string, string, ExpandOption)	Získejte upozornění.
getAlertInstances(string, number, string, string)	Získejte instance výstrahy ve větvi zadané pomocí @ref. Pokud @ref není k dispozici, vraťte instance výstrahy ve výchozí větvi (pokud výstraha existuje ve výchozí větvi) nebo nejnovější ovlivněnou větev.
getAlertMetadata(string, number, string)	Získejte metadata upozornění.
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)	Získejte metadata upozornění.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Získání upozornění pro úložiště
getAlertSarif(string, number, string, string, ExpandOption)	Získejte upozornění.
getAlertsByIds(AlertBatchRequest, string, string)	Získejte výstrahy podle ID výstrah, které aktuálně podporují načítání jenom upozornění na tajné kódy.
getAutofixRequestsByAlertId(string, number, string)	Získejte všechny požadavky na automatické opravy pro specifikované upozornění.
getBranches(string, string, AlertType, string, string, number, boolean)	Vrátí větve, pro které byly odeslány výsledky analýzy.
getOrgLevelAlertsByIds(number[])	Dostávejte upozornění podle jejich ID na úrovni organizace. Znovu se spustí pouze výstrahy, k jejichž zobrazení má uživatel oprávnění. Vrátí pouze upozornění na plány skladových položek, které jsou povoleny.
getSarif(number)	Získání stavu úlohy zpracování Sarif
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Získejte podrobnosti o platnosti výstrahy.
initiateValidation(string, string, number)	Zahájení procesu ověřování pro danou výstrahu
updateAlert(AlertStateUpdate, string, number, string)	Aktualizace stavu výstrahy
updateAlertsMetadata(AlertMetadata[], string, string)	Aktualizace přidružení metadat upozornění
uploadOrgSarif(string)	Nahrání souboru Sarif na úrovni organizace
uploadSarif(string, string, string, String)	Nahrání sarif obsahující výstrahy zabezpečení
uploadSarifToGitHub(string, string, string, string, string)	Nahrajte SARIF na GitHub Kód skenování přes GitOps aplikaci.

Podrobnosti konstruktoru

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

autofixCallback(AutofixCallbackRequest, string, string, number)

Přijímá zpětnou volbu z autofixové pipeline s výsledkem běhu. Idempotent: opakované volání pro požadavek již v terminálním stavu se vracejí 200 bez změn.

function autofixCallback(callbackRequest: AutofixCallbackRequest, project: string, repository: string, alertId: number): Promise<void>

Parametry

callbackRequest

AutofixCallbackRequest

Payload zpětného volání obsahující requestId, status a volitelný pullRequestId.

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště.

alertId

number

ID upozornění, pro které se vytváří automatická oprava.

Návraty

Promise<void>

createAutofixRequest(string, number, string)

Vytvořte požadavek na automatickou opravu pro specifikované upozornění.

function createAutofixRequest(project: string, alertId: number, repository: string): Promise<AutofixRequest>

Parametry

project

string

ID projektu nebo název projektu

alertId

number

ID upozornění, pro které se vytváří automatická oprava.

repository

string

Název nebo ID úložiště.

Návraty

Promise<AutofixRequest>

createLegalReview(string, string, number, string)

Vytvořte právní kontrolu. Tím se vytvoří právní kontrola spojená s výstrahou. Zahrnuje adresu URL pracovní položky kontroly.

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště pro právní upozornění

alertId

number

Předběžné ID bezpečnostní výstrahy právní výstrahy pro získání právní kontroly

ref

string

Návraty

Promise<LegalReview>

deleteAllPipelineAnalyses(string, string)

Obnovitelné odstranění dat analýzy pro všechny kanály v úložišti, čištění přidružených výstrah Advanced Security.

function deleteAllPipelineAnalyses(project: string, repository: string): Promise<void>

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště.

Návraty

Promise<void>

deletePipelineAnalysis(string, string, number)

Obnovitelné odstranění dat analýzy pro konkrétní kanál, vyčištění přidružených výstrah Advanced Security.

function deletePipelineAnalysis(project: string, repository: string, adoPipelineId: number): Promise<void>

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště.

adoPipelineId

number

ID kanálu ADO, jehož data analýzy by se měla vyčistit.

Návraty

Promise<void>

exportSarif(string, string, number[], string)

Exportovat upozornění jako jeden SARIF soubor

function exportSarif(project: string, repository: string, alertIds: number[], branchName?: string): Promise<any>

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

alertIds

number[]

Seznam ID upozornění k exportu

branchName

string

Název pobočky cílového upozornění. Pokud není specifikováno, použije se výchozí větev.

Návraty

Promise<any>

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

Získejte upozornění.

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

Parametry

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy, která se má načíst

repository

string

Název nebo ID úložiště, které je výstrahou součástí

ref

string

expand

ExpandOption

Rozbalení atributů upozornění na tajný kód Možné hodnoty jsou None a ValidationFingerprint. Výchozí hodnota je None. Mějte na paměti, že pokud expand je nastavena ValidationFingerprintna , odpověď může obsahovat tajný kód v jeho nešifrované podobě. Při používání těchto dat buďte opatrní.

Návraty

Promise<Alert>

getAlertInstances(string, number, string, string)

Získejte instance výstrahy ve větvi zadané pomocí @ref. Pokud @ref není k dispozici, vraťte instance výstrahy ve výchozí větvi (pokud výstraha existuje ve výchozí větvi) nebo nejnovější ovlivněnou větev.

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

Parametry

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy, která se má načíst

repository

string

Název nebo ID úložiště, které je výstrahou součástí

ref

string

Návraty

Promise<AlertAnalysisInstance[]>

getAlertMetadata(string, number, string)

Získejte metadata upozornění.

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

Parametry

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy, která se má načíst

repository

string

Název nebo ID úložiště, které je výstrahou součástí

Návraty

Promise<AlertMetadata>

getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)

Získejte metadata upozornění.

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

Parametry

alertMetadataBatchRequest

AlertMetadataBatchRequest

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště, které je výstrahou součástí

Návraty

Promise<AlertMetadata[]>

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

Získání upozornění pro úložiště

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

top

number

Maximální počet výstrah, které se mají vrátit

orderBy

string

Musí být "id" "firstSeen" "lastSeen" "fixedOn" nebo "severity" Defaults to "id"

criteria

SearchCriteria

Možnosti omezení vrácených výstrah

expand

AlertListExpandOption

continuationToken

string

Pokud existuje více výstrah, než je možné vrátit, token pro pokračování se umístí do hlavičky x-ms-continuationtoken. Pomocí tohoto tokenu zde získáte další stránku upozornění.

Návraty

Promise<PagedList<Alert>>

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

Získejte upozornění.

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

Parametry

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy, která se má načíst

repository

string

Název nebo ID úložiště, které je výstrahou součástí

ref

string

expand

ExpandOption

Rozbalení atributů upozornění na tajný kód Možné hodnoty jsou None a ValidationFingerprint. Výchozí hodnota je None. Mějte na paměti, že pokud expand je nastavena ValidationFingerprintna , odpověď může obsahovat tajný kód v jeho nešifrované podobě. Při používání těchto dat buďte opatrní.

Návraty

Promise<string>

getAlertsByIds(AlertBatchRequest, string, string)

Získejte výstrahy podle ID výstrah, které aktuálně podporují načítání jenom upozornění na tajné kódy.

function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string): Promise<Alert[]>

Parametry

request

AlertBatchRequest

Požadavek obsahující ID upozornění a volitelný filtr typu upozornění

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

Návraty

Promise<Alert[]>

getAutofixRequestsByAlertId(string, number, string)

Získejte všechny požadavky na automatické opravy pro specifikované upozornění.

function getAutofixRequestsByAlertId(project: string, alertId: number, repository: string): Promise<AutofixRequest[]>

Parametry

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy.

repository

string

Název nebo ID úložiště.

Návraty

Promise<AutofixRequest[]>

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

Vrátí větve, pro které byly odeslány výsledky analýzy.

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

alertType

AlertType

Typ upozornění: Kontrola závislostí (1), tajný klíč (2), QL kódu (3) atd.

continuationToken

string

Řetězcová proměnná, která představuje název větve a slouží k načtení větví, které ji následují v abecedním pořadí.

branchNameContains

string

Řetězcová proměnná použitá k načtení větví, které obsahují tento řetězec kdekoli v názvu větve, nerozlišují velká a malá písmena.

top

number

Int proměnná používaná k vrácení horních větví k, které splňují kritéria hledání.

includePullRequestBranches

boolean

Logická proměnná označující, jestli se mají zahrnout větve žádostí o přijetí změn.

Návraty

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

Dostávejte upozornění podle jejich ID na úrovni organizace. Znovu se spustí pouze výstrahy, k jejichž zobrazení má uživatel oprávnění. Vrátí pouze upozornění na plány skladových položek, které jsou povoleny.

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

Parametry

alertIds

number[]

Seznam ID výstrah, které se mají načíst

Návraty

Promise<Alert[]>

getSarif(number)

Získání stavu úlohy zpracování Sarif

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

Parametry

sarifId

number

Id Sarif vráceno při nahrání sarifu

Návraty

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

alertType

AlertType

Návraty

Promise<UxFilters>

getValidityData(string, string, number)

Získejte podrobnosti o platnosti výstrahy.

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

alertId

number

ID výstrahy

Návraty

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Zahájení procesu ověřování pro danou výstrahu

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

alertId

number

ID výstrahy

Návraty

Promise<AlertValidationRequestStatus>

updateAlert(AlertStateUpdate, string, number, string)

Aktualizace stavu výstrahy

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

Parametry

stateUpdate

AlertStateUpdate

Nový stav výstrahy

project

string

ID projektu nebo název projektu

alertId

number

ID výstrahy

repository

string

Název nebo ID úložiště

Návraty

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Aktualizace přidružení metadat upozornění

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

Parametry

alertsMetadata

AlertMetadata[]

Seznam metadat, která se mají přidružit k upozorněním.

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště.

Návraty

Promise<AlertMetadataChange[]>

uploadOrgSarif(string)

Nahrání souboru Sarif na úrovni organizace

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

Parametry

content

string

Obsah k nahrání

Návraty

Promise<number>

uploadSarif(string, string, string, String)

Nahrání sarif obsahující výstrahy zabezpečení

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

Parametry

content

string

Obsah k nahrání

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

notificationFlag

String

Hlavička, která signalizují, že se jedná o oznámení o průběhu

Návraty

Promise<number>

uploadSarifToGitHub(string, string, string, string, string)

Nahrajte SARIF na GitHub Kód skenování přes GitOps aplikaci.

function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>

Parametry

content

string

Obsah k nahrání

project

string

ID projektu nebo název projektu

hostname

string

GitHub hostitelské jméno (např. github.com nebo microsoft.ghe.com)

owner

string

Vlastník repozitáře GitHub (organizace nebo uživatel)

repo

string

Název repozitáře GitHub

Návraty

Promise<string>