Compartilhar via


AlertRestClient class

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends

Construtores

AlertRestClient(IVssRestClientOptions)

Métodos

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

Obter um alerta.

getAlertInstances(string, number, string, string)

Obter instâncias de um alerta.

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

Obter alertas para um repositório

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

Obter um alerta.

getSarif(number)

Obter a status do trabalho de processamento do Sarif

getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)

Atualizar o status de um alerta

updateAlertsMetadata(AlertMetadata[], string, string)

Atualizar associações de metadados de alerta.

uploadSarif(string, string, string)

Carregar um Sarif contendo alertas de segurança

Detalhes do construtor

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Parâmetros

Detalhes do método

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

Obter um alerta.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

alertId

number

ID do alerta a ser recuperado

repository

string

Nome ou id de um repositório do qual o alerta faz parte

ref

string

expand
ExpandOption

Expanda os atributos de alerta. As opções possíveis são {ValidationFingerprint, None}

Retornos

Promise<Alert>

getAlertInstances(string, number, string, string)

Obter instâncias de um alerta.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

alertId

number

ID do alerta a ser recuperado

repository

string

Nome ou id de um repositório do qual o alerta faz parte

ref

string

Retornos

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

Obter alertas para um repositório

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

Parâmetros

project

string

ID do projeto ou nome do projeto

repository

string

O nome ou a ID do repositório

top

number

O número máximo de alertas a serem retornados

orderBy

string

Deve ser "id" "firstSeen" "lastSeen" "fixedOn" ou "severity" O padrão é "id"

criteria
SearchCriteria

Opções para limitar os alertas retornados

continuationToken

string

Se houver mais alertas que podem ser retornados, um token de continuação será colocado no cabeçalho "x-ms-continuationtoken". Use esse token aqui para obter a próxima página de alertas

Retornos

Promise<PagedList<Alert>>

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

Obter um alerta.

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

Parâmetros

project

string

ID do projeto ou nome do projeto

alertId

number

ID do alerta a ser recuperado

repository

string

Nome ou id de um repositório do qual o alerta faz parte

ref

string

expand
ExpandOption

Expanda os atributos de alerta. As opções possíveis são {ValidationFingerprint, None}

Retornos

Promise<string>

getSarif(number)

Obter a status do trabalho de processamento do Sarif

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

Parâmetros

sarifId

number

ID do Sarif retornada quando o Sarif foi carregado

Retornos

getUxFilters(string, string, AlertType)

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

Parâmetros

project

string

ID do projeto ou nome do projeto

repository

string

alertType
AlertType

Retornos

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

Atualizar o status de um alerta

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

Parâmetros

stateUpdate
AlertStateUpdate

O novo status do alerta

project

string

ID do projeto ou nome do projeto

alertId

number

A ID do alerta

repository

string

O nome ou a ID do repositório

Retornos

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Atualizar associações de metadados de alerta.

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

Parâmetros

alertsMetadata

AlertMetadata[]

Uma lista de metadados a serem associados a alertas.

project

string

ID do projeto ou nome do projeto

repository

string

O nome ou a ID do repositório.

Retornos

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Carregar um Sarif contendo alertas de segurança

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

Parâmetros

content

string

Conteúdo a ser carregado

project

string

ID do projeto ou nome do projeto

repository

string

O nome ou a ID de um repositório

Retornos

Promise<number>