AlertRestClient class
Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni
- Extends
Konstruktorok
| Alert |
Metódusok
| autofix |
Visszahívást kap az autofix csővezetéktől a futtatás eredményével. Idempotens: ismételt hívások egy már terminális állapotban lévő kérésre 200-at változtatás nélkül. |
| create |
Hozz létre automatikus javítási kérelmet a megadott riasztáshoz. |
| create |
Hozzon létre jogi felülvizsgálatot. Ez létrehozza a riasztáshoz társított jogi felülvizsgálatot. Tartalmazza a munkaelem URL-címét. |
| delete |
Lágyan törli az összes adatbázis összes pipeline elemzési adatait, így megtisztítja a kapcsolódó Advanced Security riasztásokat. |
| delete |
Lesoft-törli az elemzési adatokat egy adott csővezetékhez, így kitisztítja a kapcsolódó Advanced Security riasztásokat. |
| export |
Exportos riasztások egyetlen SARIF fájlként |
| get |
Riasztás kérése. |
| get |
Riasztás példányainak lekérése a megadott ágon @ref. Ha @ref nincs megadva, a riasztások példányait adja vissza az alapértelmezett ágon (ha a riasztás az alapértelmezett ágban található) vagy a legújabb érintett ágat. |
| get |
Szerezz egy figyelmeztető metaadatot. |
| get |
Szerezz értesítéseket, metaadatokat. |
| get |
Riasztások lekérése adattárakhoz |
| get |
Riasztás kérése. |
| get |
Értesítéseket kapjon riasztásazonosítók alapján. Jelenleg csak a titkos riasztások lekérését támogatja. |
| get |
Szerezd meg az összes automatikus javítási kérelmet a megadott riasztáshoz. |
| get |
Azokat az ágakat adja vissza, amelyekhez elemzési eredményeket küldtek. |
| get |
Riasztásokat kaphat az azonosítójuk alapján szervezeti szinten. Csak azokat a riasztásokat futtatja újra, amelyek megtekintésére a felhasználónak van engedélye. Csak az engedélyezett termékváltozati csomagok riasztásait adja vissza. |
| get |
A Sarif feldolgozási feladat állapotának lekérése |
| get |
|
| get |
|
| get |
Kérje le a riasztás érvényességi adatait. |
| initiate |
Egy adott riasztás érvényesítési folyamatának kezdeményezése |
| update |
Riasztás állapotának frissítése |
| update |
A csomagfrissítés riasztása ezt mondja. Csak belső használat — a bizonyító szkennerek használják az AI által generált tervezet értesítések áttételére Aktív vagy Elbocsátott állapotba. A Draft (határozatlan) jelzésű értesítések változatlanok maradnak. |
| update |
A riasztás metaadat-társításainak frissítése. |
| upload |
Sarif fájl feltöltése szervezeti szinten |
| upload |
Biztonsági riasztásokat tartalmazó Sarif feltöltése |
| upload |
Tölts fel egy SARIF-et a GitHub-ra, kódszkennelés egy GitOps alkalmazáson keresztül. |
Konstruktor adatai
AlertRestClient(IVssRestClientOptions)
Metódus adatai
autofixCallback(AutofixCallbackRequest, string, string, number)
Visszahívást kap az autofix csővezetéktől a futtatás eredményével. Idempotens: ismételt hívások egy már terminális állapotban lévő kérésre 200-at változtatás nélkül.
function autofixCallback(callbackRequest: AutofixCallbackRequest, project: string, repository: string, alertId: number): Promise<void>Paraméterek
- callbackRequest
- AutofixCallbackRequest
A callback hasznos rakomány, amely tartalmazza requestId-et, státuszt és opcionális pullRequestId-et.
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Az adattár neve vagy azonosítója.
- alertId
-
number
Az értesítés azonosítója, amelyhez automatikus fixet kell létrehozni.
Válaszok
Promise<void>
createAutofixRequest(string, number, string, string)
Hozz létre automatikus javítási kérelmet a megadott riasztáshoz.
function createAutofixRequest(project: string, alertId: number, repository: string, ref?: string): Promise<AutofixRequest>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- alertId
-
number
Az értesítés azonosítója, amelyhez automatikus fixet kell létrehozni.
- repository
-
string
Az adattár neve vagy azonosítója.
- ref
-
string
Opcionális Git hivatkozásokat (pl. refs/heads/feature/x) az autofixnek céloznia kell. Ha kihagyják, a tár alapértelmezett ágát használják.
Válaszok
Promise<AutofixRequest>
createLegalReview(string, string, number, string)
Hozzon létre jogi felülvizsgálatot. Ez létrehozza a riasztáshoz társított jogi felülvizsgálatot. Tartalmazza a munkaelem URL-címét.
function createLegalReview(project: string, repository: string, alertId: number, ref?: string): Promise<LegalReview>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
A jogi riasztás adattárának neve vagy azonosítója
- alertId
-
number
A jogi riasztás előzetes biztonsági riasztásazonosítója a jogi felülvizsgálat megszerzéséhez
- ref
-
string
Válaszok
Promise<LegalReview>
deleteAllPipelineAnalyses(string, string)
Lágyan törli az összes adatbázis összes pipeline elemzési adatait, így megtisztítja a kapcsolódó Advanced Security riasztásokat.
function deleteAllPipelineAnalyses(project: string, repository: string): Promise<void>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Az adattár neve vagy azonosítója.
Válaszok
Promise<void>
deletePipelineAnalysis(string, string, number)
Lesoft-törli az elemzési adatokat egy adott csővezetékhez, így kitisztítja a kapcsolódó Advanced Security riasztásokat.
function deletePipelineAnalysis(project: string, repository: string, adoPipelineId: number): Promise<void>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Az adattár neve vagy azonosítója.
- adoPipelineId
-
number
Az ADO vezeték azonosítója, amelynek elemzési adatait ki kell tisztítani.
Válaszok
Promise<void>
exportSarif(string, string, number[], string)
Exportos riasztások egyetlen SARIF fájlként
function exportSarif(project: string, repository: string, alertIds: number[], branchName?: string): Promise<any>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Egy adattár neve vagy azonosítója
- alertIds
-
number[]
Exportálandó riasztási azonosítók listája
- branchName
-
string
A célpont riasztásainak fiókneve. Ha nincs megadva, akkor az alapértelmezett ágat használják.
Válaszok
Promise<any>
getAlert(string, number, string, string, ExpandOption)
Riasztás kérése.
function getAlert(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<Alert>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- alertId
-
number
A lekérendő riasztás azonosítója
- repository
-
string
Egy olyan adattár neve vagy azonosítója, amely a riasztás részét képezi
- ref
-
string
- expand
- ExpandOption
Bontsa ki egy titkos riasztás attribútumait. A lehetséges értékek a és None .ValidationFingerprint Alapértelmezett érték: None. Vegye figyelembe, hogy ha expand a ValidationFingerprintbeállítás , a válasz titkosítatlan formában is tartalmazhatja a titkos kulcsot. Kérjük, legyen körültekintő, amikor ezeket az adatokat használja.
Válaszok
Promise<Alert>
getAlertInstances(string, number, string, string)
Riasztás példányainak lekérése a megadott ágon @ref. Ha @ref nincs megadva, a riasztások példányait adja vissza az alapértelmezett ágon (ha a riasztás az alapértelmezett ágban található) vagy a legújabb érintett ágat.
function getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<AlertAnalysisInstance[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- alertId
-
number
A lekérendő riasztás azonosítója
- repository
-
string
Egy olyan adattár neve vagy azonosítója, amely a riasztás részét képezi
- ref
-
string
Válaszok
Promise<AlertAnalysisInstance[]>
getAlertMetadata(string, number, string)
Szerezz egy figyelmeztető metaadatot.
function getAlertMetadata(project: string, alertId: number, repository: string): Promise<AlertMetadata>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- alertId
-
number
A lekérendő riasztás azonosítója
- repository
-
string
Egy olyan adattár neve vagy azonosítója, amely a riasztás részét képezi
Válaszok
Promise<AlertMetadata>
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)
Szerezz értesítéseket, metaadatokat.
function getAlertMetadataBatch(alertMetadataBatchRequest: AlertMetadataBatchRequest, project: string, repository: string): Promise<AlertMetadata[]>Paraméterek
- alertMetadataBatchRequest
- AlertMetadataBatchRequest
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Egy olyan adattár neve vagy azonosítója, amely a riasztás részét képezi
Válaszok
Promise<AlertMetadata[]>
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)
Riasztások lekérése adattárakhoz
function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, expand?: AlertListExpandOption, continuationToken?: string): Promise<PagedList<Alert>>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Az adattár neve vagy azonosítója
- top
-
number
A visszaadni kívánt riasztások maximális száma
- orderBy
-
string
Az "id" "firstSeen" "lastSeen" "fixedOn" vagy a "súlyosság" alapértelmezett értéke "id"
- criteria
- SearchCriteria
A visszaadott riasztások korlátozásának lehetőségei
- expand
- AlertListExpandOption
- continuationToken
-
string
Ha a visszaadhatónál több riasztás van, a rendszer egy folytatási jogkivonatot helyez el az "x-ms-continuationtoken" fejlécben. Használja ezt a jogkivonatot a riasztások következő oldalának lekéréséhez
Válaszok
getAlertSarif(string, number, string, string, ExpandOption)
Riasztás kérése.
function getAlertSarif(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<string>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- alertId
-
number
A lekérendő riasztás azonosítója
- repository
-
string
Egy olyan adattár neve vagy azonosítója, amely a riasztás részét képezi
- ref
-
string
- expand
- ExpandOption
Bontsa ki egy titkos riasztás attribútumait. A lehetséges értékek a és None .ValidationFingerprint Alapértelmezett érték: None. Vegye figyelembe, hogy ha expand a ValidationFingerprintbeállítás , a válasz titkosítatlan formában is tartalmazhatja a titkos kulcsot. Kérjük, legyen körültekintő, amikor ezeket az adatokat használja.
Válaszok
Promise<string>
getAlertsByIds(AlertBatchRequest, string, string, boolean)
Értesítéseket kapjon riasztásazonosítók alapján. Jelenleg csak a titkos riasztások lekérését támogatja.
function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string, includeSensitiveInformation?: boolean): Promise<Alert[]>Paraméterek
- request
- AlertBatchRequest
Kérés, amely tartalmaz riasztásazonosítókat és opcionális riasztástípus-szűrőt
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Az adattár neve vagy azonosítója
- includeSensitiveInformation
-
boolean
Csak titkos riasztásokra vonatkozik. Ha hamis (az alapértelmezett), a válaszból kihagyják a titkos riasztások validációs ujjlenyomatai 'ValidationFingerprintJson'-t. True-ra állítva, hogy beépítsd; Ne feledd, hogy a hitelesítési ujjlenyomat-JSON tartalmazhatja a titkosítatlan titkos és egyéb érzékeny adatokat, ezért légy óvatos a kéréskor.
Válaszok
Promise<Alert[]>
getAutofixRequestsByAlertId(string, number, string, string)
Szerezd meg az összes automatikus javítási kérelmet a megadott riasztáshoz.
function getAutofixRequestsByAlertId(project: string, alertId: number, repository: string, ref?: string): Promise<AutofixRequest[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- alertId
-
number
A riasztás azonosítója.
- repository
-
string
Az adattár neve vagy azonosítója.
- ref
-
string
Opcionális Git hivatkozásokat (pl. refs/heads/feature/x) az autofixnek céloznia kell. Ha kihagyják, a tár alapértelmezett ágát használják.
Válaszok
Promise<AutofixRequest[]>
getBranches(string, string, AlertType, string, string, number, boolean)
Azokat az ágakat adja vissza, amelyekhez elemzési eredményeket küldtek.
function getBranches(project: string, repository: string, alertType: AlertType, continuationToken?: string, branchNameContains?: string, top?: number, includePullRequestBranches?: boolean): Promise<Branch[]>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
- alertType
- AlertType
A riasztás típusa: Függőségek vizsgálata (1), Titkos kód (2), Kód QL (3) stb.
- continuationToken
-
string
Egy sztringváltozó, amely az ág nevét jelöli, és az azt követő ágak betűrendben történő lekérésére szolgál.
- branchNameContains
-
string
Sztringváltozó, amely a sztringet tartalmazó ágak lekérésére szolgál bárhol az ágnévben, a kis- és nagybetűk nem érzékenyek.
- top
-
number
A keresési feltételeknek megfelelő legfelső k ágak visszaadására használt int változó.
- includePullRequestBranches
-
boolean
Egy bool változó, amely azt jelzi, hogy a lekéréses kérelmek ágait is tartalmaznia kell-e.
Válaszok
Promise<Branch[]>
getOrgLevelAlertsByIds(number[])
Riasztásokat kaphat az azonosítójuk alapján szervezeti szinten. Csak azokat a riasztásokat futtatja újra, amelyek megtekintésére a felhasználónak van engedélye. Csak az engedélyezett termékváltozati csomagok riasztásait adja vissza.
function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>Paraméterek
- alertIds
-
number[]
A lekért riasztásazonosítók listája
Válaszok
Promise<Alert[]>
getSarif(number)
A Sarif feldolgozási feladat állapotának lekérése
function getSarif(sarifId: number): Promise<SarifUploadStatus>Paraméterek
- sarifId
-
number
A Sarif-azonosító a Sarif feltöltésekor lett visszaadva
Válaszok
Promise<SarifUploadStatus>
getSarifContent(number)
function getSarifContent(submissionId: number): Promise<any>Paraméterek
- submissionId
-
number
Válaszok
Promise<any>
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)
Kérje le a riasztás érvényességi adatait.
function getValidityData(project: string, repository: string, alertId: number): Promise<ValidationRequestInfo>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Egy adattár neve vagy azonosítója
- alertId
-
number
A riasztás azonosítója
Válaszok
Promise<ValidationRequestInfo>
initiateValidation(string, string, number)
Egy adott riasztás érvényesítési folyamatának kezdeményezése
function initiateValidation(project: string, repository: string, alertId: number): Promise<AlertValidationRequestStatus>Paraméterek
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Egy adattár neve vagy azonosítója
- alertId
-
number
A riasztás azonosítója
Válaszok
Promise<AlertValidationRequestStatus>
updateAlert(AlertStateUpdate, string, number, string)
Riasztás állapotának frissítése
function updateAlert(stateUpdate: AlertStateUpdate, project: string, alertId: number, repository: string): Promise<Alert>Paraméterek
- stateUpdate
- AlertStateUpdate
A riasztás új állapota
- project
-
string
Projektazonosító vagy projektnév
- alertId
-
number
A riasztás azonosítója
- repository
-
string
Az adattár neve vagy azonosítója
Válaszok
Promise<Alert>
updateAlertsBatch(AlertBatchStateUpdateRequest, string, string)
A csomagfrissítés riasztása ezt mondja. Csak belső használat — a bizonyító szkennerek használják az AI által generált tervezet értesítések áttételére Aktív vagy Elbocsátott állapotba. A Draft (határozatlan) jelzésű értesítések változatlanok maradnak.
function updateAlertsBatch(request: AlertBatchStateUpdateRequest, project: string, repository: string): Promise<Alert[]>Paraméterek
- request
- AlertBatchStateUpdateRequest
Riasztási állapot frissítéseket tartalmazó kérés
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Az adattár neve vagy azonosítója
Válaszok
Promise<Alert[]>
updateAlertsMetadata(AlertMetadata[], string, string)
A riasztás metaadat-társításainak frissítése.
function updateAlertsMetadata(alertsMetadata: AlertMetadata[], project: string, repository: string): Promise<AlertMetadataChange[]>Paraméterek
- alertsMetadata
A riasztásokhoz társítandó metaadatok listája.
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Az adattár neve vagy azonosítója.
Válaszok
Promise<AlertMetadataChange[]>
uploadOrgSarif(string)
Sarif fájl feltöltése szervezeti szinten
function uploadOrgSarif(content: string): Promise<number>Paraméterek
- content
-
string
Feltöltendő tartalom
Válaszok
Promise<number>
uploadSarif(string, string, string, String)
Biztonsági riasztásokat tartalmazó Sarif feltöltése
function uploadSarif(content: string, project: string, repository: string, notificationFlag?: String): Promise<number>Paraméterek
- content
-
string
Feltöltendő tartalom
- project
-
string
Projektazonosító vagy projektnév
- repository
-
string
Egy adattár neve vagy azonosítója
- notificationFlag
-
String
Fejléc, amely jelzi, hogy ez egy állapotértesítés
Válaszok
Promise<number>
uploadSarifToGitHub(string, string, string, string, string)
Tölts fel egy SARIF-et a GitHub-ra, kódszkennelés egy GitOps alkalmazáson keresztül.
function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>Paraméterek
- content
-
string
Feltöltendő tartalom
- project
-
string
Projektazonosító vagy projektnév
- hostname
-
string
A GitHub hosztnev (pl. github.com vagy microsoft.ghe.com)
- owner
-
string
A GitHub repoziórium tulajdonosa (szervezet vagy felhasználó)
- repo
-
string
A GitHub repoziórium neve
Válaszok
Promise<string>