AlertRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Alert |
Métodos
| autofix |
Recibe una llamada de vuelta desde la cadena de autofix con el resultado de la ejecución. Idempotente: llamadas repetidas para una petición ya en estado terminal devuelven 200 sin cambios. |
| create |
Crea una solicitud de autofix para la alerta especificada. |
| create |
Crea un trabajo alerta. |
| create |
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. |
| delete |
Elimina temporalmente los datos de análisis de todas las canalizaciones de un repositorio y limpia las alertas de seguridad avanzada asociadas. |
| delete |
Elimina temporalmente los datos de análisis de una canalización específica, limpiando las alertas de Advanced Security asociadas. |
| export |
Exportar alertas como un solo archivo SARIF |
| get |
Descarga el blob completo de metadatos de IA para recibir una alerta de código de IA. |
| get |
Obtener una alerta. |
| get |
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. |
| get |
Recibe una alerta con metadatos. |
| get |
Recibe alertas y metadatos. |
| get |
Obtención de alertas para un repositorio |
| get |
Obtener una alerta. |
| get |
Obtener alertas por identificadores de alerta Actualmente solo admite la captura de alertas secretas. |
| get |
Recibe todas las solicitudes de autofix para la alerta especificada. |
| get |
Devuelve las ramas para las que se enviaron los resultados del análisis. |
| get |
Recibe alertas de reclutamiento para un repositorio. |
| get |
Recibe un trabajo alerta por identificación. |
| get |
Recibe las alertas de empleo asociadas a una alerta. |
| get |
Reciba alertas por sus identificadores a nivel de organización. Solo vuelve a ejecutar las alertas que el usuario tiene permiso para ver. Solo devuelve alertas de planes de SKU que están habilitados. |
| get |
Obtención del estado del trabajo de procesamiento de Sarif |
| get |
|
| get |
|
| get |
Obtenga los detalles de validez de una alerta. |
| initiate |
Iniciar el proceso de validación de una alerta determinada |
| query |
Consulta de alertas de un repositorio por vinculación de tipos de metadatos. |
| submit |
Durably admite un lote de evaluaciones de triaje neutrales para el proveedor. |
| update |
Actualización del estado de una alerta |
| update |
Alerta de actualización por lotes indica. |
| update |
Actualizar las asociaciones de metadatos de alerta. |
| update |
Actualiza un trabajo de alerta. |
| upload |
Cargar un archivo Sarif a nivel de organización |
| upload |
Carga de un sarif que contiene alertas de seguridad |
| upload |
Sube un SARIF a GitHub Code Scanning a través de una app de GitOps. |
Detalles del constructor
AlertRestClient(IVssRestClientOptions)
Detalles del método
autofixCallback(AutofixCallbackRequest, string, string)
Recibe una llamada de vuelta desde la cadena de autofix con el resultado de la ejecución. Idempotente: llamadas repetidas para una petición ya en estado terminal devuelven 200 sin cambios.
function autofixCallback(callbackRequest: AutofixCallbackRequest, project: string, repository: string): Promise<void>Parámetros
- callbackRequest
- AutofixCallbackRequest
La carga útil de callback que contiene requestId, status y pullRequestId opcional.
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador del repositorio.
Devoluciones
Promise<void>
createAutofixRequest(string, number, string, string)
Crea una solicitud de autofix para la alerta especificada.
function createAutofixRequest(project: string, alertId: number, repository: string, ref: string): Promise<AutofixRequest>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- alertId
-
number
El ID de la alerta para crear un autofix para.
- repository
-
string
Nombre o identificador del repositorio.
- ref
-
string
La referencia Git (por ejemplo, refs/heads/feature/x) que debería dirigirse el autofix.
Devoluciones
Promise<AutofixRequest>
createJob(any, string, string)
Crea un trabajo alerta.
function createJob(body: any, project: string, repository: string): Promise<AlertJob>Parámetros
- body
-
any
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador del repositorio
Devoluciones
Promise<AlertJob>
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>
deleteAllPipelineAnalyses(string, string)
Elimina temporalmente los datos de análisis de todas las canalizaciones de un repositorio y limpia las alertas de seguridad avanzada asociadas.
function deleteAllPipelineAnalyses(project: string, repository: string): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador del repositorio.
Devoluciones
Promise<void>
deletePipelineAnalysis(string, string, number)
Elimina temporalmente los datos de análisis de una canalización específica, limpiando las alertas de Advanced Security asociadas.
function deletePipelineAnalysis(project: string, repository: string, adoPipelineId: number): Promise<void>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador del repositorio.
- adoPipelineId
-
number
Identificador de la canalización de ADO cuyos datos de análisis se deben limpiar.
Devoluciones
Promise<void>
exportSarif(string, string, number[], string)
Exportar alertas como un solo archivo SARIF
function exportSarif(project: string, repository: string, alertIds: number[], branchName?: string): Promise<any>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador de un repositorio
- alertIds
-
number[]
Lista de IDs de alerta para exportar
- branchName
-
string
El nombre de la rama del objetivo alerta. Si no se especifica, se usará la rama predeterminada.
Devoluciones
Promise<any>
getAiMetadataContent(string, number, string)
Descarga el blob completo de metadatos de IA para recibir una alerta de código de IA.
function getAiMetadataContent(project: string, alertId: number, repository: string): Promise<any>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- alertId
-
number
ID de la alerta cuyo blob de metadatos de IA debería descargarse.
- repository
-
string
Nombre o ID del repositorio al que pertenece la alerta.
Devoluciones
Promise<any>
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 una alerta secreta. Los valores posibles son None y ValidationFingerprint. Tiene como valor predeterminado None. Tenga en cuenta que si expand se establece ValidationFingerprinten , la respuesta puede contener el secreto en su formulario sin cifrar. Tenga cuidado al usar estos datos.
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[]>
getAlertMetadata(string, number, string)
Recibe una alerta con metadatos.
function getAlertMetadata(project: string, alertId: number, repository: string): Promise<AlertMetadata>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
Devoluciones
Promise<AlertMetadata>
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)
Recibe alertas y metadatos.
function getAlertMetadataBatch(alertMetadataBatchRequest: AlertMetadataBatchRequest, project: string, repository: string): Promise<AlertMetadata[]>Parámetros
- alertMetadataBatchRequest
- AlertMetadataBatchRequest
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador de un repositorio del que forma parte la alerta
Devoluciones
Promise<AlertMetadata[]>
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
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 una alerta secreta. Los valores posibles son None y ValidationFingerprint. Tiene como valor predeterminado None. Tenga en cuenta que si expand se establece ValidationFingerprinten , la respuesta puede contener el secreto en su formulario sin cifrar. Tenga cuidado al usar estos datos.
Devoluciones
Promise<string>
getAlertsByIds(AlertBatchRequest, string, string, boolean)
Obtener alertas por identificadores de alerta Actualmente solo admite la captura de alertas secretas.
function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string, includeSensitiveInformation?: boolean): Promise<Alert[]>Parámetros
- request
- AlertBatchRequest
Solicitud que contiene IDs de alerta y filtro opcional de tipo de alerta
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador del repositorio
- includeSensitiveInformation
-
boolean
Solo se aplica a alertas secretas. Cuando es falsa (el valor predeterminado), se omite el 'ValidationFingerprintJson' de las huellas de validación de cada alerta secreta en la respuesta. Ponlo en verdadero para incluirlo; ten en cuenta que el JSON de la huella digital de validación puede contener el secreto sin cifrar y otros datos sensibles, así que ten precaución al solicitarlo.
Devoluciones
Promise<Alert[]>
getAutofixRequestsByAlertId(string, number, string, string)
Recibe todas las solicitudes de autofix para la alerta especificada.
function getAutofixRequestsByAlertId(project: string, alertId: number, repository: string, ref: string): Promise<AutofixRequest[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- alertId
-
number
Identificador de la alerta.
- repository
-
string
Nombre o identificador del repositorio.
- ref
-
string
La referencia Git (por ejemplo, refs/heads/feature/x) que debería dirigirse el autofix.
Devoluciones
Promise<AutofixRequest[]>
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[]>
getDraftAlerts(string, string, number, string, string, number, string)
Recibe alertas de reclutamiento para un repositorio.
function getDraftAlerts(project: string, repository: string, top?: number, orderBy?: string, continuationToken?: string, sarifSubmissionId?: number, triageState?: 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". Por defecto es "id". Cuando se proporciona triageState, solo se admite "id".
- 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.
- sarifSubmissionId
-
number
Si se proporciona, solo devuelva las alertas del Borrador del Código IA representadas por esta presentación SARIF
- triageState
-
string
Si se proporciona, solo devuelva instancias de alerta de Draft AI Code en este estado de flujo de trabajo de triage
Devoluciones
getJob(string, string, string)
Recibe un trabajo alerta por identificación.
function getJob(project: string, repository: string, jobId: string): Promise<AlertJob>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador del repositorio
- jobId
-
string
El identificador de trabajo asignado por el proveedor
Devoluciones
Promise<AlertJob>
getJobsForAlert(string, string, number, number, string)
Recibe las alertas de empleo asociadas a una alerta.
function getJobsForAlert(project: string, repository: string, alertId: number, top?: number, continuationToken?: string): Promise<PagedList<AlertJob>>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador del repositorio
- alertId
-
number
Identificador de la alerta
- top
-
number
El número máximo de empleos que deben regresar
- continuationToken
-
string
Si hay más trabajos de los que se pueden devolver, se coloca un token de continuación en la cabecera "x-ms-continuationtoken". Usa ese token aquí para conseguir la siguiente página de empleos
Devoluciones
getOrgLevelAlertsByIds(number[])
Reciba alertas por sus identificadores a nivel de organización. Solo vuelve a ejecutar las alertas que el usuario tiene permiso para ver. Solo devuelve alertas de planes de SKU que están habilitados.
function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>Parámetros
- alertIds
-
number[]
Lista de identificadores de alerta que se van a recuperar
Devoluciones
Promise<Alert[]>
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>
getSarifContent(number)
function getSarifContent(submissionId: number): Promise<any>Parámetros
- submissionId
-
number
Devoluciones
Promise<any>
getUxFilters(string, string, AlertType)
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>
queryAlerts(AlertMetadataQueryCriteria, string, string, number, string, AlertListExpandOption, string)
Consulta de alertas de un repositorio por vinculación de tipos de metadatos.
function queryAlerts(criteria: AlertMetadataQueryCriteria, project: string, repository: string, top?: number, orderBy?: string, expand?: AlertListExpandOption, continuationToken?: string): Promise<PagedList<Alert>>Parámetros
- criteria
- AlertMetadataQueryCriteria
Filtros de tipo de metadatos para limitar las alertas devueltas
- 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"
- expand
- AlertListExpandOption
Opciones para expandir la respuesta, por ejemplo, devolver recuentos de alertas en lugar de alertas
- 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
submitTriageSignals(TriageSignalSubmissionRequest, string, string)
Durably admite un lote de evaluaciones de triaje neutrales para el proveedor.
function submitTriageSignals(submission: TriageSignalSubmissionRequest, project: string, repository: string): Promise<TriageSignalSubmissionResponse>Parámetros
- submission
- TriageSignalSubmissionRequest
La señal de triaje para admitir.
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador del repositorio.
Devoluciones
Promise<TriageSignalSubmissionResponse>
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>
updateAlertsBatch(AlertBatchStateUpdateRequest, string, string)
Alerta de actualización por lotes indica.
function updateAlertsBatch(request: AlertBatchStateUpdateRequest, project: string, repository: string): Promise<Alert[]>Parámetros
- request
- AlertBatchStateUpdateRequest
Solicitud que contiene actualizaciones de estado de alerta
- project
-
string
Id. de proyecto o nombre del proyecto
- 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
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[]>
updateJob(any, string, string, string)
Actualiza un trabajo de alerta.
function updateJob(patch: any, project: string, repository: string, jobId: string): Promise<AlertJob>Parámetros
- patch
-
any
El parche que describe los campos a actualizar
- project
-
string
Id. de proyecto o nombre del proyecto
- repository
-
string
Nombre o identificador del repositorio
- jobId
-
string
El identificador de trabajo asignado por el proveedor
Devoluciones
Promise<AlertJob>
uploadOrgSarif(string)
Cargar un archivo Sarif a nivel de organización
function uploadOrgSarif(content: string): Promise<number>Parámetros
- content
-
string
Contenido que se va a cargar
Devoluciones
Promise<number>
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>
uploadSarifToGitHub(string, string, string, string, string)
Sube un SARIF a GitHub Code Scanning a través de una app de GitOps.
function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>Parámetros
- content
-
string
Contenido que se va a cargar
- project
-
string
Id. de proyecto o nombre del proyecto
- hostname
-
string
El nombre de anfitrión GitHub (por ejemplo, github.com o microsoft.ghe.com)
- owner
-
string
El propietario del repositorio de GitHub (organización o usuario)
- repo
-
string
El nombre del repositorio de GitHub
Devoluciones
Promise<string>