AlertRestClient class
Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's
- Uitbreiding
Constructors
| Alert |
Methoden
| autofix |
Ontvangt een callback van de autofix-pijplijn met het resultaat van de run. Idempotent: herhaalde oproepen voor een verzoek dat al in een terminale toestand is, geven 200 zonder wijzigingen terug. |
| create |
Maak een autofixverzoek aan voor de opgegeven melding. |
| create |
Creëer een juridische beoordeling. Hiermee wordt de juridische beoordeling gemaakt die aan de melding is gekoppeld. Het bevat de url van het beoordelingswerkitem. |
| delete |
Zacht verwijdert analysegegevens voor alle pijplijnen in een repository, waarbij de bijbehorende Advanced Security-waarschuwingen worden opgeruimd. |
| delete |
Zacht verwijdert analysegegevens voor een specifieke pijplijn, waarbij de bijbehorende Advanced Security-waarschuwingen worden opgeruimd. |
| export |
Exporteer waarschuwingen als één SARIF-bestand |
| get |
Ontvang een waarschuwing. |
| get |
Exemplaren van een waarschuwing ophalen voor een vertakking die is opgegeven met @ref. Als @ref dit niet het geval is, retourneert u exemplaren van een waarschuwing in een standaardbranch (als de waarschuwing in de standaardbranch bestaat) of de meest recente beïnvloede vertakking. |
| get |
Ontvang een waarschuwingsmetadata. |
| get |
Ontvang metadata van meldingen. |
| get |
Waarschuwingen voor een opslagplaats ophalen |
| get |
Ontvang een waarschuwing. |
| get |
Ontvang meldingen via waarschuwings-ID's Momenteel ondersteunt hij alleen het ophalen van geheime waarschuwingen. |
| get |
Ontvang alle autofixverzoeken voor de opgegeven melding. |
| get |
Retourneert de vertakkingen waarvoor analyseresultaten zijn verzonden. |
| get |
Ontvang waarschuwingen op basis van hun ID's op organisatieniveau. Waarschuwingen dat de gebruiker toestemming heeft om te bekijken, worden alleen opnieuw uitgevoerd. Retourneert alleen waarschuwingen van SKU-plannen die zijn ingeschakeld. |
| get |
De status van de Sarif-verwerkingstaak ophalen |
| get |
|
| get |
Bekijk de geldigheidsgegevens voor een waarschuwing. |
| initiate |
Het validatieproces voor een bepaalde waarschuwing initiëren |
| update |
De status van een waarschuwing bijwerken |
| update |
Metagegevenskoppelingen voor waarschuwingen bijwerken. |
| upload |
Een Sarif-bestand uploaden op organisatieniveau |
| upload |
Een Sarif met beveiligingswaarschuwingen uploaden |
| upload |
Upload een SARIF naar GitHub Code Scanning via een GitOps-app. |
Constructordetails
AlertRestClient(IVssRestClientOptions)
Methodedetails
autofixCallback(AutofixCallbackRequest, string, string, number)
Ontvangt een callback van de autofix-pijplijn met het resultaat van de run. Idempotent: herhaalde oproepen voor een verzoek dat al in een terminale toestand is, geven 200 zonder wijzigingen terug.
function autofixCallback(callbackRequest: AutofixCallbackRequest, project: string, repository: string, alertId: number): Promise<void>Parameters
- callbackRequest
- AutofixCallbackRequest
De callback-payload bevat requestId, status en optionele pullRequestId.
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van de opslagplaats.
- alertId
-
number
De ID van de melding om een autofix voor te maken.
Retouren
Promise<void>
createAutofixRequest(string, number, string)
Maak een autofixverzoek aan voor de opgegeven melding.
function createAutofixRequest(project: string, alertId: number, repository: string): Promise<AutofixRequest>Parameters
- project
-
string
Project-id of projectnaam
- alertId
-
number
De ID van de melding om een autofix voor te maken.
- repository
-
string
De naam of id van de opslagplaats.
Retouren
Promise<AutofixRequest>
createLegalReview(string, string, number, string)
Creëer een juridische beoordeling. Hiermee wordt de juridische beoordeling gemaakt die aan de melding is gekoppeld. Het bevat de url van het beoordelingswerkitem.
function createLegalReview(project: string, repository: string, alertId: number, ref?: string): Promise<LegalReview>Parameters
- project
-
string
Project-id of projectnaam
- repository
-
string
Naam of id van een repository voor de juridische signalering
- alertId
-
number
Voorafgaande beveiligingswaarschuwings-ID van de juridische waarschuwing om de juridische beoordeling te krijgen
- ref
-
string
Retouren
Promise<LegalReview>
deleteAllPipelineAnalyses(string, string)
Zacht verwijdert analysegegevens voor alle pijplijnen in een repository, waarbij de bijbehorende Advanced Security-waarschuwingen worden opgeruimd.
function deleteAllPipelineAnalyses(project: string, repository: string): Promise<void>Parameters
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van de opslagplaats.
Retouren
Promise<void>
deletePipelineAnalysis(string, string, number)
Zacht verwijdert analysegegevens voor een specifieke pijplijn, waarbij de bijbehorende Advanced Security-waarschuwingen worden opgeruimd.
function deletePipelineAnalysis(project: string, repository: string, adoPipelineId: number): Promise<void>Parameters
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van de opslagplaats.
- adoPipelineId
-
number
De ID van de ADO-pijplijn waarvan de analysegegevens moeten worden opgeschoond.
Retouren
Promise<void>
exportSarif(string, string, number[], string)
Exporteer waarschuwingen als één SARIF-bestand
function exportSarif(project: string, repository: string, alertIds: number[], branchName?: string): Promise<any>Parameters
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van een opslagplaats
- alertIds
-
number[]
Lijst van waarschuwings-ID's om te exporteren
- branchName
-
string
De naam van de vestiging van het doelwit waarschuwt. Indien niet gespecificeerd, wordt de standaardtak gebruikt.
Retouren
Promise<any>
getAlert(string, number, string, string, ExpandOption)
Ontvang een waarschuwing.
function getAlert(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<Alert>Parameters
- project
-
string
Project-id of projectnaam
- alertId
-
number
Id van waarschuwing die moet worden opgehaald
- repository
-
string
Naam of id van een opslagplaats waarvan de waarschuwing deel uitmaakt
- ref
-
string
- expand
- ExpandOption
Breid de kenmerken van een geheime melding uit. Mogelijke waarden zijn None en .ValidationFingerprint Standaardwaarde is None. Houd er rekening mee dat als expand deze is ingesteld op ValidationFingerprint, het antwoord het geheim in niet-versleutelde vorm kan bevatten. Wees voorzichtig bij het gebruik van deze gegevens.
Retouren
Promise<Alert>
getAlertInstances(string, number, string, string)
Exemplaren van een waarschuwing ophalen voor een vertakking die is opgegeven met @ref. Als @ref dit niet het geval is, retourneert u exemplaren van een waarschuwing in een standaardbranch (als de waarschuwing in de standaardbranch bestaat) of de meest recente beïnvloede vertakking.
function getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<AlertAnalysisInstance[]>Parameters
- project
-
string
Project-id of projectnaam
- alertId
-
number
Id van waarschuwing die moet worden opgehaald
- repository
-
string
Naam of id van een opslagplaats waarvan de waarschuwing deel uitmaakt
- ref
-
string
Retouren
Promise<AlertAnalysisInstance[]>
getAlertMetadata(string, number, string)
Ontvang een waarschuwingsmetadata.
function getAlertMetadata(project: string, alertId: number, repository: string): Promise<AlertMetadata>Parameters
- project
-
string
Project-id of projectnaam
- alertId
-
number
Id van waarschuwing die moet worden opgehaald
- repository
-
string
Naam of id van een opslagplaats waarvan de waarschuwing deel uitmaakt
Retouren
Promise<AlertMetadata>
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)
Ontvang metadata van meldingen.
function getAlertMetadataBatch(alertMetadataBatchRequest: AlertMetadataBatchRequest, project: string, repository: string): Promise<AlertMetadata[]>Parameters
- alertMetadataBatchRequest
- AlertMetadataBatchRequest
- project
-
string
Project-id of projectnaam
- repository
-
string
Naam of id van een opslagplaats waarvan de waarschuwing deel uitmaakt
Retouren
Promise<AlertMetadata[]>
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)
Waarschuwingen voor een opslagplaats ophalen
function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, expand?: AlertListExpandOption, continuationToken?: string): Promise<PagedList<Alert>>Parameters
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van de opslagplaats
- top
-
number
Het maximum aantal waarschuwingen dat moet worden geretourneerd
- orderBy
-
string
Moet 'id' 'firstSeen' 'lastSeen' 'fixedOn' of 'ernst' zijn, wordt standaard ingesteld op 'id'
- criteria
- SearchCriteria
Opties om de geretourneerde waarschuwingen te beperken
- expand
- AlertListExpandOption
- continuationToken
-
string
Als er meer waarschuwingen zijn dan kan worden geretourneerd, wordt een vervolgtoken in de header x-ms-continuationtoken geplaatst. Gebruik dit token hier om de volgende pagina met waarschuwingen op te halen
Retouren
getAlertSarif(string, number, string, string, ExpandOption)
Ontvang een waarschuwing.
function getAlertSarif(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<string>Parameters
- project
-
string
Project-id of projectnaam
- alertId
-
number
Id van waarschuwing die moet worden opgehaald
- repository
-
string
Naam of id van een opslagplaats waarvan de waarschuwing deel uitmaakt
- ref
-
string
- expand
- ExpandOption
Breid de kenmerken van een geheime melding uit. Mogelijke waarden zijn None en .ValidationFingerprint Standaardwaarde is None. Houd er rekening mee dat als expand deze is ingesteld op ValidationFingerprint, het antwoord het geheim in niet-versleutelde vorm kan bevatten. Wees voorzichtig bij het gebruik van deze gegevens.
Retouren
Promise<string>
getAlertsByIds(AlertBatchRequest, string, string)
Ontvang meldingen via waarschuwings-ID's Momenteel ondersteunt hij alleen het ophalen van geheime waarschuwingen.
function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string): Promise<Alert[]>Parameters
- request
- AlertBatchRequest
Verzoek met waarschuwings-ID's en optioneel waarschuwingstype filter
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van de opslagplaats
Retouren
Promise<Alert[]>
getAutofixRequestsByAlertId(string, number, string)
Ontvang alle autofixverzoeken voor de opgegeven melding.
function getAutofixRequestsByAlertId(project: string, alertId: number, repository: string): Promise<AutofixRequest[]>Parameters
- project
-
string
Project-id of projectnaam
- alertId
-
number
De id van de waarschuwing.
- repository
-
string
De naam of id van de opslagplaats.
Retouren
Promise<AutofixRequest[]>
getBranches(string, string, AlertType, string, string, number, boolean)
Retourneert de vertakkingen waarvoor analyseresultaten zijn verzonden.
function getBranches(project: string, repository: string, alertType: AlertType, continuationToken?: string, branchNameContains?: string, top?: number, includePullRequestBranches?: boolean): Promise<Branch[]>Parameters
- project
-
string
Project-id of projectnaam
- repository
-
string
- alertType
- AlertType
Het type waarschuwing: Afhankelijkheid scannen (1), Geheim (2), Code QL (3), enzovoort.
- continuationToken
-
string
Een tekenreeksvariabele die de naam van de vertakking vertegenwoordigt en wordt gebruikt om vertakkingen op te halen die deze in alfabetische volgorde volgen.
- branchNameContains
-
string
Een tekenreeksvariabele die wordt gebruikt om vertakkingen op te halen die deze tekenreeks ergens in de naam van de vertakking bevatten, hoofdlettergevoelig.
- top
-
number
Een int-variabele die wordt gebruikt om de bovenste k-vertakkingen te retourneren die voldoen aan de zoekcriteria.
- includePullRequestBranches
-
boolean
Een boolvariabele die aangeeft of pull-aanvraagvertakkingen al dan niet moeten worden opgenomen.
Retouren
Promise<Branch[]>
getOrgLevelAlertsByIds(number[])
Ontvang waarschuwingen op basis van hun ID's op organisatieniveau. Waarschuwingen dat de gebruiker toestemming heeft om te bekijken, worden alleen opnieuw uitgevoerd. Retourneert alleen waarschuwingen van SKU-plannen die zijn ingeschakeld.
function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>Parameters
- alertIds
-
number[]
Lijst met waarschuwings-ID's die u wilt ophalen
Retouren
Promise<Alert[]>
getSarif(number)
De status van de Sarif-verwerkingstaak ophalen
function getSarif(sarifId: number): Promise<SarifUploadStatus>Parameters
- sarifId
-
number
Sarif-id geretourneerd toen de Sarif werd geüpload
Retouren
Promise<SarifUploadStatus>
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)
Bekijk de geldigheidsgegevens voor een waarschuwing.
function getValidityData(project: string, repository: string, alertId: number): Promise<ValidationRequestInfo>Parameters
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van een opslagplaats
- alertId
-
number
De id van de waarschuwing
Retouren
Promise<ValidationRequestInfo>
initiateValidation(string, string, number)
Het validatieproces voor een bepaalde waarschuwing initiëren
function initiateValidation(project: string, repository: string, alertId: number): Promise<AlertValidationRequestStatus>Parameters
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van een opslagplaats
- alertId
-
number
De id van de waarschuwing
Retouren
Promise<AlertValidationRequestStatus>
updateAlert(AlertStateUpdate, string, number, string)
De status van een waarschuwing bijwerken
function updateAlert(stateUpdate: AlertStateUpdate, project: string, alertId: number, repository: string): Promise<Alert>Parameters
- stateUpdate
- AlertStateUpdate
De nieuwe status van de waarschuwing
- project
-
string
Project-id of projectnaam
- alertId
-
number
De id van de waarschuwing
- repository
-
string
De naam of id van de opslagplaats
Retouren
Promise<Alert>
updateAlertsMetadata(AlertMetadata[], string, string)
Metagegevenskoppelingen voor waarschuwingen bijwerken.
function updateAlertsMetadata(alertsMetadata: AlertMetadata[], project: string, repository: string): Promise<AlertMetadataChange[]>Parameters
- alertsMetadata
Een lijst met metagegevens die aan waarschuwingen moeten worden gekoppeld.
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van de opslagplaats.
Retouren
Promise<AlertMetadataChange[]>
uploadOrgSarif(string)
Een Sarif-bestand uploaden op organisatieniveau
function uploadOrgSarif(content: string): Promise<number>Parameters
- content
-
string
Te uploaden inhoud
Retouren
Promise<number>
uploadSarif(string, string, string, String)
Een Sarif met beveiligingswaarschuwingen uploaden
function uploadSarif(content: string, project: string, repository: string, notificationFlag?: String): Promise<number>Parameters
- content
-
string
Te uploaden inhoud
- project
-
string
Project-id of projectnaam
- repository
-
string
De naam of id van een opslagplaats
- notificationFlag
-
String
Header om aan te geven dat dit een voortgangsmelding is
Retouren
Promise<number>
uploadSarifToGitHub(string, string, string, string, string)
Upload een SARIF naar GitHub Code Scanning via een GitOps-app.
function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>Parameters
- content
-
string
Te uploaden inhoud
- project
-
string
Project-id of projectnaam
- hostname
-
string
De GitHub hostnaam (bijvoorbeeld github.com of microsoft.ghe.com)
- owner
-
string
De eigenaar van de GitHub-repository (organisatie of gebruiker)
- repo
-
string
De naam van de GitHub-repository
Retouren
Promise<string>