AlertRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Extends

RestClientBase

Konstruktorer

AlertRestClient(IVssRestClientOptions)

Metoder

createLegalReview(string, string, number, string)	Skapa juridisk granskning. Detta skapar den juridiska granskning som är associerad med aviseringen. Den innehåller URL:en för granskningsarbetsobjektet.
getAlert(string, number, string, string, ExpandOption)	Få en avisering.
getAlertInstances(string, number, string, string)	Hämta instanser av en avisering på en gren som anges med @ref. Om @ref inte anges returnerar du instanser av en avisering på standardgrenen (om aviseringen finns i standardgrenen) eller den senaste berörda grenen.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Hämta aviseringar för en lagringsplats
getAlertSarif(string, number, string, string, ExpandOption)	Få en avisering.
getBranches(string, string, AlertType, string, string, number, boolean)	Returnerar de grenar som analysresultatet skickades för.
getOrgLevelAlertsByIds(number[])	Få aviseringar med deras ID:n på organisationsnivå. Kör endast om aviseringar som användaren har behörighet att visa. Returnerar endast aviseringar för SKU-planer som är aktiverade.
getSarif(number)	Hämta status för Sarif-bearbetningsjobbet
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Hämta giltighetsinformationen för en avisering.
initiateValidation(string, string, number)	Initiera valideringsprocessen för en viss avisering
updateAlert(AlertStateUpdate, string, number, string)	Uppdatera status för en avisering
updateAlertsMetadata(AlertMetadata[], string, string)	Uppdatera metadataassociationer för aviseringar.
uploadOrgSarif(string)	Ladda upp en Sarif-fil på organisationsnivå
uploadSarif(string, string, string, String)	Ladda upp en Sarif som innehåller säkerhetsaviseringar

Konstruktorinformation

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metodinformation

createLegalReview(string, string, number, string)

Skapa juridisk granskning. Detta skapar den juridiska granskning som är associerad med aviseringen. Den innehåller URL:en för granskningsarbetsobjektet.

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

Namn eller ID för en lagringsplats för den juridiska aviseringen

alertId

number

Förhandssäkerhetsaviserings-ID för den juridiska aviseringen för att få den juridiska granskningen

ref

string

Returer

Promise<LegalReview>

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

Få en avisering.

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

Parametrar

project

string

Projekt-ID eller projektnamn

alertId

number

ID för avisering som ska hämtas

repository

string

Namn eller ID för en lagringsplats som aviseringen ingår i

ref

string

expand

ExpandOption

Expandera attributen för en hemlig avisering. Möjliga värden är None och ValidationFingerprint. Standardinställningen är None. Tänk på att om expand är inställt ValidationFingerprintpå kan svaret innehålla hemligheten i dess okrypterade form. Var försiktig när du använder dessa uppgifter.

Returer

Promise<Alert>

getAlertInstances(string, number, string, string)

Hämta instanser av en avisering på en gren som anges med @ref. Om @ref inte anges returnerar du instanser av en avisering på standardgrenen (om aviseringen finns i standardgrenen) eller den senaste berörda grenen.

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

Parametrar

project

string

Projekt-ID eller projektnamn

alertId

number

ID för avisering som ska hämtas

repository

string

Namn eller ID för en lagringsplats som aviseringen ingår i

ref

string

Returer

Promise<AlertAnalysisInstance[]>

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

Hämta aviseringar för en lagringsplats

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

Lagringsplatsens namn eller ID

top

number

Det maximala antalet aviseringar som ska returneras

orderBy

string

Måste vara "id" "firstSeen" "lastSeen" "fixedOn" eller "severity" Defaults to "id"

criteria

SearchCriteria

Alternativ för att begränsa de returnerade aviseringarna

expand

AlertListExpandOption

continuationToken

string

Om det finns fler aviseringar än vad som kan returneras placeras en fortsättningstoken i rubriken "x-ms-continuationtoken". Använd den token här för att hämta nästa sida med aviseringar

Returer

Promise<PagedList<Alert>>

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

Få en avisering.

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

Parametrar

project

string

Projekt-ID eller projektnamn

alertId

number

ID för avisering som ska hämtas

repository

string

Namn eller ID för en lagringsplats som aviseringen ingår i

ref

string

expand

ExpandOption

Expandera attributen för en hemlig avisering. Möjliga värden är None och ValidationFingerprint. Standardinställningen är None. Tänk på att om expand är inställt ValidationFingerprintpå kan svaret innehålla hemligheten i dess okrypterade form. Var försiktig när du använder dessa uppgifter.

Returer

Promise<string>

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

Returnerar de grenar som analysresultatet skickades för.

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

alertType

AlertType

Typ av avisering: Beroendegenomsökning (1), Hemlighet (2), Kod-QL (3) osv.

continuationToken

string

En strängvariabel som representerar grennamnet och används för att hämta grenar som följer den i alfabetisk ordning.

branchNameContains

string

En strängvariabel som används för att hämta grenar som innehåller den här strängen var som helst i grennamnet, skiftlägesokänslig.

top

number

En int-variabel som används för att returnera de översta k grenarna som uppfyller sökvillkoren.

includePullRequestBranches

boolean

En bool-variabel som anger om grenar för pull-begäran ska inkluderas eller inte.

Returer

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

Få aviseringar med deras ID:n på organisationsnivå. Kör endast om aviseringar som användaren har behörighet att visa. Returnerar endast aviseringar för SKU-planer som är aktiverade.

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

Parametrar

alertIds

number[]

Lista över aviserings-ID:t som ska hämtas

Returer

Promise<Alert[]>

getSarif(number)

Hämta status för Sarif-bearbetningsjobbet

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

Parametrar

sarifId

number

Sarif-ID returnerades när Sarif laddades upp

Returer

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

alertType

AlertType

Returer

Promise<UxFilters>

getValidityData(string, string, number)

Hämta giltighetsinformationen för en avisering.

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

Namnet eller ID:t för en lagringsplats

alertId

number

ID:t för aviseringen

Returer

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Initiera valideringsprocessen för en viss avisering

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

Namnet eller ID:t för en lagringsplats

alertId

number

ID:t för aviseringen

Returer

Promise<AlertValidationRequestStatus>

updateAlert(AlertStateUpdate, string, number, string)

Uppdatera status för en avisering

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

Parametrar

stateUpdate

AlertStateUpdate

Aviseringens nya status

project

string

Projekt-ID eller projektnamn

alertId

number

ID:t för aviseringen

repository

string

Lagringsplatsens namn eller ID

Returer

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Uppdatera metadataassociationer för aviseringar.

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

Parametrar

alertsMetadata

AlertMetadata[]

En lista över metadata som ska associeras med aviseringar.

project

string

Projekt-ID eller projektnamn

repository

string

Lagringsplatsens namn eller ID.

Returer

Promise<AlertMetadataChange[]>

uploadOrgSarif(string)

Ladda upp en Sarif-fil på organisationsnivå

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

Parametrar

content

string

Innehåll som ska laddas upp

Returer

Promise<number>

uploadSarif(string, string, string, String)

Ladda upp en Sarif som innehåller säkerhetsaviseringar

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

Parametrar

content

string

Innehåll som ska laddas upp

project

string

Projekt-ID eller projektnamn

repository

string

Namnet eller ID:t för en lagringsplats

notificationFlag

String

Rubrik för att signalera att det här är ett förloppsmeddelande

Returer

Promise<number>