AlertRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Alert |
Métodos
| get |
Obtener una alerta. |
| get |
Obtiene instancias de una alerta. |
| get |
Obtención de alertas para un repositorio |
| get |
Obtener una alerta. |
| get |
Obtención del estado del trabajo de procesamiento de Sarif |
| get |
|
| update |
Actualización del estado de una alerta |
| update |
Actualizar las asociaciones de metadatos de alerta. |
| upload |
Carga de un sarif que contiene alertas de seguridad |
Detalles del constructor
AlertRestClient(IVssRestClientOptions)
Detalles del método
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.
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, string)
Obtención de alertas para un repositorio
function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, continuationToken?: string): Promise<PagedList<Alert>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
El nombre o el 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" El valor predeterminado es "id".
- criteria
- SearchCriteria
Opciones para limitar las alertas devueltas
- 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
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>
getSarif(number)
Obtención del estado del trabajo de procesamiento de Sarif
function getSarif(sarifId: number): Promise<SarifUploadStatus>Parámetros
- sarifId
-
number
Id. de Sarif devuelto cuando se cargó 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>
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
El nuevo estado de la alerta
- project
-
string
Id. de proyecto o nombre del proyecto
- alertId
-
number
Identificador de la alerta
- repository
-
string
El nombre o el 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
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)
Carga de un sarif que contiene alertas de seguridad
function uploadSarif(content: string, project: string, repository: 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
Devoluciones
Promise<number>
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de