AlertRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS
- Extends
Construtores
| Alert |
Métodos
| get |
Receba um alerta. |
| get |
Obter instâncias de um alerta. |
| get |
Obter alertas para um repositório |
| get |
Receba um alerta. |
| get |
Obter o status do trabalho de processamento Sarif |
| get |
|
| update |
Atualizar o status de um alerta |
| update |
Atualizar associações de metadados de alerta. |
| upload |
Carregar um Sarif contendo alertas de segurança |
Detalhes do Construtor
AlertRestClient(IVssRestClientOptions)
Detalhes de Método
getAlert(string, number, string, string, ExpandOption)
Receba 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 recuperar
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
- ref
-
string
- expand
- ExpandOption
Expanda atributos de alerta. As opções possíveis são {ValidationFingerprint, None}
Devoluções
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 recuperar
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
- ref
-
string
Devoluções
Promise<AlertAnalysisInstance[]>
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 ID do repositório
- top
-
number
O número máximo de alertas a retornar
- orderBy
-
string
Deve ser "id" "firstSeen" "lastSeen" "fixedOn" ou "severity" Padrão para "id"
- criteria
- SearchCriteria
Opções para limitar os alertas retornados
- continuationToken
-
string
Se houver mais alertas do 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
Devoluções
getAlertSarif(string, number, string, string, ExpandOption)
Receba 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 recuperar
- repository
-
string
Nome ou id de um repositório do qual o alerta faz parte
- ref
-
string
- expand
- ExpandOption
Expanda atributos de alerta. As opções possíveis são {ValidationFingerprint, None}
Devoluções
Promise<string>
getSarif(number)
Obter o status do trabalho de processamento Sarif
function getSarif(sarifId: number): Promise<SarifUploadStatus>Parâmetros
- sarifId
-
number
ID do Sarif retornado quando o Sarif foi carregado
Devoluções
Promise<SarifUploadStatus>
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
Devoluções
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 estado do alerta
- project
-
string
ID do projeto ou nome do projeto
- alertId
-
number
O ID do alerta
- repository
-
string
O nome ou ID do repositório
Devoluções
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
Uma lista de metadados a serem associados a alertas.
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID do repositório.
Devoluções
Promise<AlertMetadataChange[]>
uploadSarif(string, string, string, String)
Carregar um Sarif contendo alertas de segurança
function uploadSarif(content: string, project: string, repository: string, notificationFlag?: String): Promise<number>Parâmetros
- content
-
string
Conteúdo para carregar
- project
-
string
ID do projeto ou nome do projeto
- repository
-
string
O nome ou ID de um repositório
- notificationFlag
-
String
Cabeçalho para sinalizar que esta é uma notificação de progresso
Devoluções
Promise<number>