AlertRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

AlertRestClient(IVssRestClientOptions)

Métodos

createLegalReview(string, string, number, string)	Crear revisión legal. Esto crea la revisión legal asociada a la alerta. Incluye la dirección URL del elemento de trabajo de revisión.
getAlert(string, number, string, string, ExpandOption)	Obtener una alerta.
getAlertInstances(string, number, string, string)	Obtiene instancias de una alerta en una rama especificada con @ref. Si no se proporciona @ref, devuelva instancias de una alerta en la rama predeterminada (si la alerta existe en la rama predeterminada) o en la rama afectada más reciente.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Obtención de alertas para un repositorio
getAlertSarif(string, number, string, string, ExpandOption)	Obtener una alerta.
getBranches(string, string, AlertType, string, string, number, boolean)	Devuelve las ramas para las que se enviaron los resultados del análisis.
getSarif(number)	Obtención del estado del trabajo de procesamiento de Sarif
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Obtenga los detalles de validez de una alerta.
initiateValidation(string, string, number)	Iniciar el proceso de validación de una alerta determinada
updateAlert(AlertStateUpdate, string, number, string)	Actualización del estado de una alerta
updateAlertsMetadata(AlertMetadata[], string, string)	Actualizar las asociaciones de metadatos de alerta.
uploadSarif(string, string, string, String)	Carga de un sarif que contiene alertas de seguridad

Detalles del constructor

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles del método

createLegalReview(string, string, number, string)

Crear revisión legal. Esto crea la revisión legal asociada a la alerta. Incluye la dirección URL del elemento de trabajo de revisión.

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

Nombre o id de un repositorio para la alerta legal

alertId

number

Identificación de alerta de seguridad anticipada de la alerta legal para obtener la revisión legal

ref

string

Devoluciones

Promise<LegalReview>

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

Obtener una alerta.

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

alertId

number

Identificador de alerta que se va a recuperar

repository

string

Nombre o identificador de un repositorio del que forma parte la alerta

ref

string

expand

ExpandOption

Expanda los atributos de alerta. Las opciones posibles son {ValidationFingerprint, None}

Devoluciones

Promise<Alert>

getAlertInstances(string, number, string, string)

Obtiene instancias de una alerta en una rama especificada con @ref. Si no se proporciona @ref, devuelva instancias de una alerta en la rama predeterminada (si la alerta existe en la rama predeterminada) o en la rama afectada más reciente.

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

alertId

number

Identificador de alerta que se va a recuperar

repository

string

Nombre o identificador de un repositorio del que forma parte la alerta

ref

string

Devoluciones

Promise<AlertAnalysisInstance[]>

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

Obtención de alertas para un repositorio

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

Nombre o identificador del repositorio

top

number

Número máximo de alertas que se van a devolver

orderBy

string

Debe ser "id" "firstSeen" "lastSeen" "fixedOn" o "severity" Defaults to "id"

criteria

SearchCriteria

Opciones para limitar las alertas devueltas

expand

AlertListExpandOption

continuationToken

string

Si hay más alertas de las que se pueden devolver, se coloca un token de continuación en el encabezado "x-ms-continuationtoken". Use ese token aquí para obtener la siguiente página de alertas.

Devoluciones

Promise<PagedList<Alert>>

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

Obtener una alerta.

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

alertId

number

Identificador de alerta que se va a recuperar

repository

string

Nombre o identificador de un repositorio del que forma parte la alerta

ref

string

expand

ExpandOption

Expanda los atributos de alerta. Las opciones posibles son {ValidationFingerprint, None}

Devoluciones

Promise<string>

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

Devuelve las ramas para las que se enviaron los resultados del análisis.

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

alertType

AlertType

El tipo de alerta: Análisis de dependencias (1), Secreto (2), QL de código (3), etc.

continuationToken

string

Variable de cadena que representa el nombre de la rama y se usa para capturar ramas que la siguen en orden alfabético.

branchNameContains

string

Variable de cadena que se usa para capturar ramas que contienen esta cadena en cualquier parte del nombre de la rama, sin distinción entre mayúsculas y minúsculas.

top

number

Variable int utilizada para devolver las ramas k principales que cumplen los criterios de búsqueda.

includePullRequestBranches

boolean

Variable bool que indica si se van a incluir o no ramas de solicitud de incorporación de cambios.

Devoluciones

Promise<Branch[]>

getSarif(number)

Obtención del estado del trabajo de procesamiento de Sarif

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

Parámetros

sarifId

number

Identificador sarif devuelto cuando se cargó el sarif

Devoluciones

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

alertType

AlertType

Devoluciones

Promise<UxFilters>

getValidityData(string, string, number)

Obtenga los detalles de validez de una alerta.

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

Nombre o identificador de un repositorio

alertId

number

Identificador de la alerta

Devoluciones

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Iniciar el proceso de validación de una alerta determinada

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

Nombre o identificador de un repositorio

alertId

number

Identificador de la alerta

Devoluciones

Promise<AlertValidationRequestStatus>

updateAlert(AlertStateUpdate, string, number, string)

Actualización del estado de una alerta

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

Parámetros

stateUpdate

AlertStateUpdate

Nuevo estado de la alerta

project

string

Id. de proyecto o nombre del proyecto

alertId

number

Identificador de la alerta

repository

string

Nombre o identificador del repositorio

Devoluciones

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Actualizar las asociaciones de metadatos de alerta.

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

Parámetros

alertsMetadata

AlertMetadata[]

Lista de metadatos que se van a asociar a las alertas.

project

string

Id. de proyecto o nombre del proyecto

repository

string

Nombre o identificador del repositorio.

Devoluciones

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string, String)

Carga de un sarif que contiene alertas de seguridad

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

Parámetros

content

string

Contenido que se va a cargar

project

string

Id. de proyecto o nombre del proyecto

repository

string

Nombre o identificador de un repositorio

notificationFlag

String

Encabezado para indicar que se trata de una notificación de progreso

Devoluciones

Promise<number>